Couchbase Python Client Library Documentation

Prerequisites

• Couchbase Server (http://couchbase.com/download)
• libcouchbase version 2.9.0 or greater (Bundled in Windows installer)
• libcouchbase development files.
• Python development files
• A C compiler (except on Windows)

Contents:

• Bucket object
  • Passing Arguments
  • Key and Value Format
  • Single-Key Data Methods
  • Multi-Key Data Methods
  • Batch Operation Pipeline
  • MapReduce/View Methods
  • N1QL Query Methods
  • Full-Text Search Methods
  • Design Document Management
  • N1QL Index Management
  • Flushing (clearing) the Bucket
  • Informational Methods
  • Item API Methods
  • Durability Constraints
  • Attributes
  • Private APIs
  • Additional Connection Options
• Sub-Document API
  • Lookup Operations
  • Mutation Operations
  • Result Object
  • Path Syntax
• Datastructures API
• Querying Views
  • View Object
  • Query Object
  • Geospatial Views
• Analytics Queries
• N1QL Queries
• Full Text Queries
  • Query Types
  • Parameters
  • Facets
• Result Objects
  • Observe Results
• Exception Objects
  • Exception Types and Classifiers
  • Base Exception Object
  • Exception Categories
  • Exception Details
• Transcoder Interface
• Using With and Without Threads
  • Using a Bucket from multiple threads
• Conversion Functions
• Item Objects
  • Creating Items
  • Class Reference
• Logging

Asynchronous APIs

• Twisted Interface
• gevent Interface

Internal APIs

These are internal APIs whose interfaces are subject to change. They may nevertheless be helpful for debugging or extending existing functionality.

• Asynchronous Interface
  • Key-Value Interface
  • Views Interface
  • I/O Interface

Administrative APIs

These APIs allow simple manipulation of buckets themselves. They require administrative privileges. Currently these APIs are only available for the synchronous couchbase interface.

• Administrative Operations

Indices and tables

• Index
• Module Index
• Search Page