Couchbase · Schema

CapellaBucketCreateRequest

Request to create a Capella bucket

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name	Type	Description
name	string	Bucket name
type	string	Bucket type
memoryAllocationInMb	integer	Memory allocation in megabytes
bucketConflictResolution	string
durabilityLevel	string
replicas	integer
flush	boolean
timeToLiveInSeconds	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CapellaBucketCreateRequest",
  "title": "CapellaBucketCreateRequest",
  "type": "object",
  "description": "Request to create a Capella bucket",
  "required": [
    "name",
    "memoryAllocationInMb"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Bucket name"
    },
    "type": {
      "type": "string",
      "description": "Bucket type",
      "enum": [
        "couchbase",
        "ephemeral"
      ],
      "default": "couchbase"
    },
    "memoryAllocationInMb": {
      "type": "integer",
      "description": "Memory allocation in megabytes",
      "minimum": 100
    },
    "bucketConflictResolution": {
      "type": "string",
      "enum": [
        "seqno",
        "lww"
      ],
      "default": "seqno"
    },
    "durabilityLevel": {
      "type": "string",
      "enum": [
        "none",
        "majority",
        "majorityAndPersistActive",
        "persistToMajority"
      ],
      "default": "none"
    },
    "replicas": {
      "type": "integer",
      "minimum": 1,
      "maximum": 3,
      "default": 1
    },
    "flush": {
      "type": "boolean",
      "default": false
    },
    "timeToLiveInSeconds": {
      "type": "integer",
      "default": 0
    }
  }
}