Skip to main content


Project description

Why add another layer to the SDK?

  • Inconsistent data types in Couchbase documents can be a real pain.
  • Better management of multiple Couchbase connections.
  • Readability of Couchbase documents in the Python source code while still being able to use Couchbase SDK’s operations.


  • This was originally forked from and inspired by couchbasekit.
  • Validate Couchbase documents.
  • Represent Couchbase documents as Python objects.
  • Easily manage multiple Couchbase connections.
  • Supports Couchbase Python SDK 2.0 operations.
  • There are data retrieval operations that are already included in couchbasekit but I haven’t thoroughly tested it with PyCouchbase.


At the command line:

$ easy_install pycouchbase

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv pycouchbase
$ pip install pycouchbase

Getting Started

Let us go through a simple example.

Import everything we need:

import datetime

from pycouchbase import Connection
from pycouchbase import Document, register_view
from pycouchbase.fields import EmailField, ChoiceField

Declare the Document class:

# You can define your own field/data type

class Gender(ChoiceField):
    CHOICES = {
        'M': 'Male',
        'F': 'Female',

class Author(Document):
    __bucket_name__ = 'couchbasekit_samples'
    __key_field__ = 'slug'  # optional
    doc_type = 'author'
    structure = {
        'slug': unicode,
        'first_name': unicode,
        'last_name': unicode,
        'gender': Gender,
        'email': EmailField,
        'has_book': bool,
        'age': int,
        'created_at': datetime.datetime,
    default_values = {  # optional
        'has_book': False,
        # don't worry about the timezone info!
        # it's auto assigned as to UTC, so all you have to do is:
        'created_at': datetime.datetime.utcnow,
    required_fields = (  # optional

Validate and save your document:

local_connection = Connection.auth(server='localhost')
author = Author()
bucket = author.get_bucket(local_connection)

    'slug': u'douglas_adams',
    'first_name': u'Douglas',
    'last_name': u'Adams',
    'gender': Gender('M'),
    'email': EmailField(''),

# Try to validate before saving
        rvs = bucket.insert(author.slug, author.encode())
    except KeyExistsError as why:
except Author.StructureError as why:
    # when the data structure is invalid

Save multiple documents:

local_connection = Connection.auth(server='localhost')
author = Author()

list_data = [{
    'slug': u'douglas_adams',
    'first_name': u'Douglas',
    'last_name': u'Adams',
    'gender': Gender('M'),
    'email': EmailField(''),
}, {
    'slug': u'isaac_asimov',
    'first_name': u'Isaac',
    'last_name': u'Asimov',
    'gender': Gender('M'),
    'email': EmailField(''),

    bucket = author.get_bucket(local_connection)
    updated_authors = {}

    for d in list_data:
            # validate!
                d['slug']: author.encode()
        except author.StructureError as why:

    # save multiple data
    rvs = bucket.upsert_multi(updated_authors)
except CouchbaseNetworkError as why:

Manage multiple connections:

connection_1 = Connection.auth(server='server_1')
connection_2 = Connection.auth(server='server_2')

# where doc_1 and doc_2 are document objects
bucket_1 = doc_1.get_bucket(connection_1)
bucket_2 = doc_2.get_bucket(connection_2)

Bucket objects can support any Couchbase Python SDK 2.0 operations:

bucket_1.insert('key_or_id', value)

More about Couchbase SDK’s supported operations here:


0.1.0 (2015-01-11)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pycouchbase, version 0.1.0b1
Filename, size File type Python version Upload date Hashes
Filename, size pycouchbase-0.1.0b1-py2.py3-none-any.whl (20.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pycouchbase-0.1.0b1.tar.gz (26.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page