generated: '2026-10-04'
method: derived
generator: derive-data-model.py
source:
- openapi/couchbase-allowed-cidrs-api-openapi.yml
- openapi/couchbase-analytics-admin-api-openapi.yml
- openapi/couchbase-analytics-configuration-api-openapi.yml
- openapi/couchbase-analytics-library-api-openapi.yml
- openapi/couchbase-analytics-query-api-openapi.yml
- openapi/couchbase-analytics-settings-api-openapi.yml
- openapi/couchbase-api-keys-api-openapi.yml
- openapi/couchbase-authentication-api-openapi.yml
- openapi/couchbase-buckets-api-openapi.yml
- openapi/couchbase-changes-api-openapi.yml
- openapi/couchbase-cluster-api-openapi.yml
- openapi/couchbase-cluster-references-api-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 81
  entities_in_spec: 81
  relationships: 11
entities:
- name: ActiveRequest
  fields: 8
  description: An active query request
- name: AllDocsResponse
  fields: 3
  description: Response for _all_docs request
- name: AllDocsResponse_2
  fields: 3
  description: Response from _all_docs
- name: AllowedCIDR
  fields: 6
  description: Allowed IP/CIDR for cluster access
- name: AllowedCIDRCreateRequest
  fields: 3
  description: Request to add an allowed CIDR
- name: AnalyticsClusterStatus
  fields: 2
  description: Analytics cluster status information
- name: AnalyticsNodeConfig
  fields: 3
  description: Analytics node-level configuration
- name: AnalyticsQueryRequest
  fields: 7
  description: Analytics query execution request
- name: AnalyticsQueryResult
  fields: 7
  description: Analytics query execution result
- name: AnalyticsServiceConfig
  fields: 9
  description: Analytics service configuration
- name: AnalyticsSettings
  fields: 1
  description: Cluster-level analytics settings
- name: ApiKeyCreateRequest
  fields: 6
  description: Request to create an API key
- name: ApiKeyCreateResponse
  fields: 2
  description: Response after creating an API key
- name: AuditInfo
  fields: 5
  description: Audit timestamps
- name: AutoCompactionSettings
  fields: 3
  description: Auto-compaction configuration
- name: BackupClusterInfo
  fields: 3
  description: Cluster backup information
- name: BackupPlan
  fields: 5
  description: Backup plan definition
- name: BackupRepository
  fields: 6
  description: Backup repository configuration and status
- name: BackupRepositoryCreateRequest
  fields: 3
  description: Request to create a backup repository
- name: BackupTask
  fields: 6
  description: Backup or restore task record
- name: Bucket
  fields: 10
  description: Bucket configuration and statistics
- name: BucketCreateRequest
  fields: 7
  description: Request body for creating a new bucket
- name: BucketUpdateRequest
  fields: 3
  description: Request body for updating a bucket
- name: CapellaBucket
  fields: 10
  description: Bucket in a Capella cluster
- name: CapellaBucketCreateRequest
  fields: 8
  description: Request to create a Capella bucket
- name: CapellaBucketUpdateRequest
  fields: 5
  description: Request to update a Capella bucket
- name: CapellaScope
  fields: 2
  description: Scope within a Capella bucket
- name: ChangesResponse
  fields: 3
  description: Changes feed response
- name: ChangesResponse_2
  fields: 3
  description: Changes feed response
- name: Cluster
  fields: 11
  description: Capella database cluster
- name: ClusterCreateRequest
  fields: 7
  description: Request to create a new cluster
- name: ClusterUpdateRequest
  fields: 4
  description: Request to update an existing cluster
- name: CompletedRequest
  fields: 8
  description: A completed query request
- name: DatabaseConfig
  fields: 9
  description: Database configuration
- name: DatabaseCredential
  fields: 4
  description: Database access credential
- name: DatabaseCredentialCreateRequest
  fields: 3
  description: Request to create database credentials
- name: DatabaseInfo
  fields: 6
  description: Database information
- name: DatabaseInfo_2
  fields: 6
  description: Database information
- name: Document
  fields: 5
  description: A Sync Gateway document
- name: DocumentResponse
  fields: 3
  description: Response after creating or updating a document
- name: DocumentWriteResponse
  fields: 3
  description: Response from a document write operation
- name: Document_2
  fields: 4
  description: A Sync Gateway document
- name: EventingConfig
  fields: 2
  description: Eventing Service configuration
- name: EventingFunction
  fields: 5
  description: Eventing Function definition
- name: EventingFunctionStats
  fields: 3
  description: Execution statistics for an Eventing Function
- name: EventingStatus
  fields: 2
  description: Status of all Eventing Functions
- name: IndexSettings
  fields: 5
  description: Index service configuration
- name: Node
  fields: 8
  description: Information about a cluster node
- name: NodesInfo
  fields: 1
  description: Information about cluster nodes
- name: Organization
  fields: 5
  description: Capella organization
- name: PaginatedResponse
  fields: 2
  description: Paginated response wrapper
- name: PoolDetails
  fields: 5
  description: Detailed information about the default pool
- name: Pools
  fields: 6
  description: Cluster pool information
- name: PreparedStatement
  fields: 4
  description: A cached prepared statement
- name: Project
  fields: 4
  description: Capella project within an organization
- name: ProjectCreateRequest
  fields: 2
  description: Request to create or update a project
- name: QueryRequest
  fields: 10
  description: SQL++ query execution request
- name: QueryResult
  fields: 8
  description: SQL++ query execution result
- name: QuerySettings
  fields: 12
  description: Query service configuration settings
- name: QueryVitals
  fields: 15
  description: Query service vital statistics
- name: RemoteClusterCreateRequest
  fields: 7
  description: Request to create or update a remote cluster reference
- name: RemoteClusterReference
  fields: 8
  description: Remote cluster reference for XDCR
- name: ReplicationConfig
  fields: 10
  description: Inter-Sync Gateway replication
- name: ReplicationCreateRequest
  fields: 7
  description: Request to create an XDCR replication
- name: ReplicationSettings
  fields: 12
  description: XDCR replication settings
- name: RestoreRequest
  fields: 8
  description: Restore operation request
- name: Role
  fields: 4
  description: Available role definition
- name: RoleConfig
  fields: 2
  description: Role configuration
- name: RoleInfo
  fields: 3
  description: Role information
- name: ScopesList
  fields: 2
  description: List of scopes in a bucket
- name: SearchIndexDefinition
  fields: 8
  description: Full Text Search index definition
- name: SearchIndexList
  fields: 2
  description: List of all search index definitions
- name: SearchIndexResponse
  fields: 2
  description: Single search index definition response
- name: SearchQueryRequest
  fields: 9
  description: Full-text search query request
- name: SearchQueryResult
  fields: 6
  description: Full-text search query result
- name: ServerGroups
  fields: 1
  description: Server groups configuration
- name: ServiceGroup
  fields: 3
  description: Service group within a cluster
- name: SessionResponse
  fields: 3
  description: Session creation response
- name: User
  fields: 4
  description: User account information
- name: UserConfig
  fields: 6
  description: User configuration
- name: UserInfo
  fields: 7
  description: User information
relationships:
- from: AllowedCIDR
  to: AuditInfo
  type: has_one
  via: audit
- from: PoolDetails
  to: Node
  type: has_many
  via: nodes
- from: Cluster
  to: ServiceGroup
  type: has_many
  via: serviceGroups
- from: Cluster
  to: AuditInfo
  type: has_one
  via: audit
- from: ClusterCreateRequest
  to: ServiceGroup
  type: has_many
  via: serviceGroups
- from: ClusterUpdateRequest
  to: ServiceGroup
  type: has_many
  via: serviceGroups
- from: DatabaseCredential
  to: AuditInfo
  type: has_one
  via: audit
- from: NodesInfo
  to: Node
  type: has_many
  via: nodes
- from: Organization
  to: AuditInfo
  type: has_one
  via: audit
- from: Project
  to: AuditInfo
  type: has_one
  via: audit
- from: SearchIndexResponse
  to: SearchIndexDefinition
  type: has_one
  via: indexDef