Rolling

Get collection rollings

/ Get, / Rolling

Get collection rollings #

Returns rollings information about one or more collections.

Examples #

The following request gets the rollings information of all the collections under the default namespace:

GET /default:*/_rollings

Retrieve the rollings information of all the collections:

GET /_rollings

Request #

GET /<target>/_rollings

Path Parameters #

  • target
    (Optional, String) Comma-separated, names of the collections to get (wildcard supported)

Roll over a collection

/ Rolling, / Collection

Roll over a collection #

Allocate a new rolling for the collection now, regardless of whether the active rolling is full — subsequent writes go to the new rolling. This is the manual form of the automatic rollover that happens when a rolling reaches its document capacity.

The change is replicated through Raft (the same metadata request used by automatic rollovers), so the shard groups of the new rolling are created on every node.

...

Update rolling settings

/ Update, / Settings, / Rolling

Update rolling settings #

Adjust the replica count of an existing rolling: every shard group of the rolling gains new unassigned replica shards (allocated by the shard allocator when capacity allows) or has its extra replicas removed, and the rolling’s number_of_replicas setting is updated.

This is the leaf-most level of the layered settings model — it overrides the collection-level default for this rolling only.

Examples #

Scale the rolling 0 of my-collection from 1 to 2 replicas:

...

Reshard a rolling

/ Rolling, / Reshard, / Shard

Reshard a rolling #

Change the number of shards of a rolling, online. Splitting raises the shard count (finer partition ranges, e.g. 1 → 2); merging lowers it (e.g. 2 → 1).

The reshard builds a hidden target rolling while the source keeps serving every read and write. Existing documents are streamed into the target with their _id preserved, the write tail is replayed until the target converges, and a single metadata commit then swaps the target in atomically. Documents stay addressable under the same _id and _key throughout, including for writes issued while the reshard is building.

...