Twisted Interface

The Twisted interface is for use with the Twisted Python event and networking library which may be found at http://www.twistedmatrix.com. This documentation contains the API reference for how to use the txcouchbase module with Twisted.

For the most part, the txcouchbase API functions like its synchronous counterpart, couchbase, except for its asynchronous nature. Where the synchronous API returns a Result object, the txcouchbase API returns a Deferred which will have its callback invoked with a result.

As such, we will omit the mentions of the normal key value operations, which function identially to their synchronous conterparts documented in the Cluster Bucket, and Collection classes.

The TxDeferredClient mixin for Twisted is subclassed from the lower-level TxRawClient which returns AsyncGetResult etc objects rather than Deferred objects. This is largely due to performance reasons (Deferreds result in a 3x performance slowdown).

class txcouchbase.cluster.TxRawClientMixin

class txcouchbase.cluster.TxDeferredClientMixin

class txcouchbase.cluster.TxRawCluster

class txcouchbase.cluster.TxCluster

class txcouchbase.cluster.TxRawBucket

class txcouchbase.cluster.TxBucket

class txcouchbase.cluster.TxRawCollection

class txcouchbase.cluster.TxCollection

class txcouchbase.cluster.BatchedViewResult

class txcouchbase.cluster.BatchedQueryResult

class txcouchbase.cluster.BatchedAnalyticsResult

class txcouchbase.cluster.BatchedSearchResult