Secure 5.1.1: Couchbase createPrimaryQueryIndex

Couchbase createPrimaryQueryIndex

Last updated: July 13, 2026

Creates a primary N1QL query index on a Couchbase collection. A primary index covers all documents in the collection, enabling queries that do not specify a predicate.

Known limitations:

Each collection can have at most one primary index.
Primary indexes are less efficient than secondary indexes for queries with specific predicates. For filtered queries, use createQueryIndex instead.

Available attributes

Attribute	Type	Description	Required
`bucketName`	String	The name of the bucket containing the collection.	Yes
`collectionName`	String	The name of the collection to index.	Yes
`scopeName`	String	The name of the scope containing the collection.	Yes
`indexName`	String	The name of the primary index. If omitted, Couchbase names it `#primary`.	No
`deferred`	Boolean	When `true`, the index is created in a deferred state. Build it with `BUILD INDEX` before use.	No
`numReplicas`	Integer	Number of index replicas to create.	No

<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.19.xsd
        http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-couchbase-ext.xsd">

    <changeSet id="1" author="liquibase">
        <ext:createPrimaryQueryIndex>
            <ext:bucketName>myBucket</ext:bucketName>
            <ext:collectionName>myCollection</ext:collectionName>
            <ext:deferred>false</ext:deferred>
            <ext:indexName>myPrimaryIndex</ext:indexName>
            <ext:numReplicas>0</ext:numReplicas>
            <ext:scopeName>myScope</ext:scopeName>
        </ext:createPrimaryQueryIndex>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "1",
        "author": "liquibase",
        "createPrimaryQueryIndex": {
          "bucketName": "myBucket",
          "collectionName": "myCollection",
          "deferred": false,
          "indexName": "myPrimaryIndex",
          "numReplicas": 0,
          "scopeName": "myScope"
        }
      }
    }
  ]
}

databaseChangeLog:
  - changeSet:
      id: '1'
      author: liquibase
      createPrimaryQueryIndex:
        bucketName: myBucket
        collectionName: myCollection
        deferred: false
        indexName: myPrimaryIndex
        numReplicas: 0
        scopeName: myScope

<?xml version="1.0" encoding="UTF-8"?>
<databaseChangeLog
        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.19.xsd
        http://www.liquibase.org/xml/ns/dbchangelog-ext http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-couchbase-ext.xsd">

    <changeSet id="1" author="liquibase">
        <ext:createPrimaryQueryIndex>
            <ext:bucketName>myBucket</ext:bucketName>
            <ext:collectionName>myCollection</ext:collectionName>
            <ext:deferred>false</ext:deferred>
            <ext:indexName>myPrimaryIndex</ext:indexName>
            <ext:numReplicas>0</ext:numReplicas>
            <ext:scopeName>myScope</ext:scopeName>
        </ext:createPrimaryQueryIndex>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "1",
        "author": "liquibase",
        "createPrimaryQueryIndex": {
          "bucketName": "myBucket",
          "collectionName": "myCollection",
          "deferred": false,
          "indexName": "myPrimaryIndex",
          "numReplicas": 0,
          "scopeName": "myScope"
        }
      }
    }
  ]
}

databaseChangeLog:
  - changeSet:
      id: '1'
      author: liquibase
      createPrimaryQueryIndex:
        bucketName: myBucket
        collectionName: myCollection
        deferred: false
        indexName: myPrimaryIndex
        numReplicas: 0
        scopeName: myScope

Couchbase createPrimaryQueryIndex

Available attributes

XML example

JSON example

YAML example

More like this