Secure 5.1.1: Couchbase updateBucket

Couchbase updateBucket

Last updated: July 13, 2026

Updates the settings of an existing Couchbase bucket. All attributes must be specified on every update because the Couchbase SDK writes all bucket settings together in a single call.

Known limitations:

All attributes must be specified even if you only intend to change one value. The SDK updates all settings at once.
bucketType and storageBackend cannot be changed after bucket creation. To change either, you must drop and recreate the bucket.
There is no automatic rollback support.

Available attributes

Attribute	Type	Description	Required
`bucketName`	String	The name of the bucket to update.	Yes
`compressionMode`	String	Controls document compression. `OFF` disables compression. `PASSIVE` compresses only when the client requests it. `ACTIVE` enables server-side proactive compression.	Yes
`flushEnabled`	Boolean	When `true`, enables the flush operation on this bucket.	Yes
`maxExpiryInHours`	Long	Maximum TTL for all documents in the bucket, in hours.	Yes
`numReplicas`	Integer	Number of replica copies of each document (0–3).	Yes
`ramQuotaMB`	Long	RAM quota allocated to this bucket across all nodes, in megabytes.	Yes
`timeoutInSeconds`	Long	How long to wait for the update operation to complete before timing out.	Yes

<?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:updateBucket>
            <ext:bucketName>myBucket</ext:bucketName>
            <ext:compressionMode>PASSIVE</ext:compressionMode>
            <ext:flushEnabled>false</ext:flushEnabled>
            <ext:maxExpiryInHours>2</ext:maxExpiryInHours>
            <ext:numReplicas>1</ext:numReplicas>
            <ext:ramQuotaMB>256</ext:ramQuotaMB>
            <ext:timeoutInSeconds>18</ext:timeoutInSeconds>
        </ext:updateBucket>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "1",
        "author": "liquibase",
        "updateBucket": {
          "bucketName": "myBucket",
          "compressionMode": "PASSIVE",
          "flushEnabled": false,
          "maxExpiryInHours": 2,
          "numReplicas": 1,
          "ramQuotaMB": 256,
          "timeoutInSeconds": 18
        }
      }
    }
  ]
}

databaseChangeLog:
  - changeSet:
      id: '1'
      author: liquibase
      updateBucket:
        bucketName: myBucket
        compressionMode: PASSIVE
        flushEnabled: false
        maxExpiryInHours: 2
        numReplicas: 1
        ramQuotaMB: 256
        timeoutInSeconds: 18

<?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:updateBucket>
            <ext:bucketName>myBucket</ext:bucketName>
            <ext:compressionMode>PASSIVE</ext:compressionMode>
            <ext:flushEnabled>false</ext:flushEnabled>
            <ext:maxExpiryInHours>2</ext:maxExpiryInHours>
            <ext:numReplicas>1</ext:numReplicas>
            <ext:ramQuotaMB>256</ext:ramQuotaMB>
            <ext:timeoutInSeconds>18</ext:timeoutInSeconds>
        </ext:updateBucket>
    </changeSet>

</databaseChangeLog>

{
  "databaseChangeLog": [
    {
      "changeSet": {
        "id": "1",
        "author": "liquibase",
        "updateBucket": {
          "bucketName": "myBucket",
          "compressionMode": "PASSIVE",
          "flushEnabled": false,
          "maxExpiryInHours": 2,
          "numReplicas": 1,
          "ramQuotaMB": 256,
          "timeoutInSeconds": 18
        }
      }
    }
  ]
}

databaseChangeLog:
  - changeSet:
      id: '1'
      author: liquibase
      updateBucket:
        bucketName: myBucket
        compressionMode: PASSIVE
        flushEnabled: false
        maxExpiryInHours: 2
        numReplicas: 1
        ramQuotaMB: 256
        timeoutInSeconds: 18

Couchbase updateBucket

Available attributes

XML example

JSON example

YAML example

More like this