Couchbase Python Client Library Documentation

Prerequisites

• Couchbase Server (http://couchbase.com/download)

• Python development files

• A C compiler (except on Windows)

Contents:

• Cluster object
• Bucket object
• Scope object
• Collection object
  • Passing Arguments
  • Option Blocks
  • Integer Types
  • 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
  • Analytics Query 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
• ViewResult Object
  • Attributes
  • Row Processing
• Query Object
  • View Options
  • Result Range and Sorting Properties
  • Reduce Function Parameters
  • Pagination and Sampling
  • Control Options
  • Boolean Type
  • Numeric Type
  • JSON Value
  • JSON Array
  • String
  • Range Value
  • Unspecified Value
  • Convenience Constants
• Analytics Queries
• N1QL Queries
• Full Text Queries
  • Query Types
  • Parameters
  • Facets
• Result Objects
• Exception Objects
  • Exception Types and Classifiers
  • Base Exception Object
  • Exception Categories
  • Exception Details
• Transcoder Interface
• Using With and Without Threads
  • Using a Client from multiple threads
• Conversion Functions
• Item Objects
  • Creating Items
  • Class Reference
• Logging

Asynchronous APIs

• Twisted Interface
• asyncio 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

Management APIs

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

• Management Operations

Indices and tables

• Index

• Module Index

• Search Page