Couchbase Cheat Sheet
|
This section documents the current Couchbase Server 7.6.x line as published at the Couchbase Server documentation, which is the reference these pages are written and verified against. No specific patch version is pinned. Some capabilities (Enterprise-Edition-only Analytics, auditing, encryption at rest, the Backup service and rack-zone awareness, and Capella-only App Services and Columnar) are linked, not documented in depth. This content was generated with the assistance of AI and should be verified against the official documentation before being relied on in production, as Couchbase iterates quickly. This section’s bibliography lists the reference material consulted while preparing these pages. |
A single-page, colour-coded summary of the Couchbase Server essentials — the cbq / cbsh and
couchbase:// connection-string one-liners, the bucket.scope.collection keyspace, the key-value API
(insert / upsert / replace / get / remove, counters, getAndLock) and the sub-document API
(lookupIn / mutateIn), CAS optimistic locking and the three durable-write levels, a SQL++
SELECT / JOIN / DML skeleton with WITH and recursive CTEs, CREATE INDEX forms (composite, partial,
array, covering) with EXPLAIN / ADVISE, the Full-Text Search query types and SEARCH(), an Eventing
OnUpdate skeleton, the distributed-transaction skeleton (transactions.run / BEGIN WORK … COMMIT WORK),
the rebalance / failover / XDCR one-liners, and an "embed vs. reference" decision strip — handy for quick
memorization or as a printable desk reference.
For the full explanation, every option, and additional examples, see the dedicated pages:
Getting started — What Couchbase Server is & how to run it.
Data & modeling — Buckets, scopes & collections, Documents, keys, metadata & expiration, Key-value & sub-document operations, Concurrency, locking & durable writes, and Document-oriented data modeling.
*Querying — SQL* -- xref:database/couchbase/sql-plus-plus-querying.adoc[Querying with SQL (SELECT & joins)] and SQL++ data modification, functions & transactions.
Indexing & search — Indexing with the Index service (and legacy Views) and Full-Text & Vector Search, Analytics & Eventing.
Distributed architecture & operations — Clusters, replication, failover & XDCR and Storage internals, security & administration.
SDKs & Mobile — SDKs, connectors & Couchbase Mobile.
Everything here is verified against the Couchbase Server documentation.