A newer version of this documentation is available.

View Latest

Index Lifecycle

  • concept
    An overview of the lifecycle of a Global Secondary Index, from creation and building to updates and scans.

    In Couchbase Server 7.0 and later, a Global Secondary Index is created on a single collection — not on an entire bucket. (A collection may, of course, have multiple indexes.) By carefully planning the structure of your data, and storing documents of different types in separate collections, you can improve performance at every stage in the lifecycle of an index.

    Index Creation

    Index creation happens in two phases: the creation phase and the build phase. During the creation phase, the Index Service validates the user input, decides the host node for the index, and creates the index metadata on the host node. The build phase cannot start until the creation phase is complete.

    Index Building

    During the build phase, the Index Service reads the documents from the Data Service and builds the index.

    index lifecycle build
    1. The projector requests a DCP stream on the specified collection.

    2. DCP streams only the documents in the collection.

    3. The projector evaluates each document and extracts the indexed field(s).

    4. The indexed fields are forwarded to the indexer.

    Refer to Index Building for further details.

    Index Updates

    When a Global Secondary Index has been created on a collection, the index is updated when documents within the collection are updated.

    index lifecycle update 1
    index lifecycle update 2
    1. The projector keeps a bucket-level DCP stream open for updates — this limits the number of DCP connections.

    2. When a document within the collection is updated, the projector utilizes the collection ID available with each mutation, and only evaluates the indexes defined for that collection.

    3. The projector only sends updated indexed fields for the qualified indexes within the collection.

    There is no additional processing or disk overhead for indexes on unrelated collections.

    Refer to Database Change Protocol (DCP) for further details.

    Index Scans

    When a query needs to make use of a Global Secondary Index, the index is scanned.

    index lifecycle scan
    • If the index consistency is not_bounded, the scan proceeds without waiting for the index to be updated.

    • If the scan consistency is at_plus or request_plus, the scan coordinator waits for the index to be updated for that collection only, and then performs the scan.

    The scan coordinator does not need to wait for indexes on other collections to be updated, even if documents in other collections are being mutated.

    Refer to Index Scans and Index Consistency for further details.