Search:

Search all manuals
Search this manual
Manual
Membase Client Library: Python
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Parent Section
Membase Client Library: Python
Chapters

Chapter 2. Membase Client Library: Python Method Summary

The Membase Python library supports the full suite of API calls to Membase. A summary of the supported methods are listed in Table 2.1, “Python Client Library Method Summary”.

Table 2.1. Python Client Library Method Summary

MethodTitle
object.add(key, expiry, flags, value) Add a value with the specified key that does not already exist
object.append(key, value [, casunique ]) Append a value to an existing key
object.bucket_select(bucket) Select bucket
object.cas(key, expiry, flags, oldvalue, value) Compare and set a value providing the supplied CAS key matches
object.complete_onlineupdate() Stop onlineupdate
object.decr(key [, offset ] [, defaultvalue ] [, expiry ]) Decrement the value of an existing numeric key
object.delete(key [, casunique ] [, vbucket ]) Delete a key/value
object.delete_vbucket(vbucket) Delete vbucket
object.deregister_tap_client(tap-name) Deregister tap client
object.flush() Deletes all values from the corresponding bucket
object.gat(key, expiry) Get a value and update the expiration time for a given key
object.get(key [, vbucket ]) Get one or more key values
object.get_vbucket_state(vbucket) Get vbucket state
object.getl(key [, getl-expiry ]) Get the value for a key, lock the key from changes
object.getMulti(keyn) Get one or more key values
object.incr(key [, offset ] [, defaultvalue ] [, expiry ]) Increment the value of an existing numeric key
object.noop() Send a noop command
object.prepend(key, value [, casunique ]) Prepend a value to an existing key
object.replace(key, expiry, flags, value) Update an existing key with a new value
object.sasl_auth_plain(sasl-user, sasl-password [, sasl-for-user ]) Perform plain sasl auth
object.sasl_auth_start(sasl-mechanism, sasl-data) Start a sasl auth sessionds
object.sasl_mechanisms() Get the supported SASL methods
object.set(key, expiry, flags, value [, vbucket ]) Store a value using the specified key
object.set_flush_param(flush-param-key, flush-param-value) Set flush parameter
object.set_tap_param(tap-key, tap-value) Set tap parameter
object.set_vbucket_state(vbucket, vbucket-state) Set vbucket state
object.start_onlineupdate() Start onlineupdate
object.start_persistence() Start persistence
object.start_replication() Start replication
object.stat([ statname ]) Get the database statistics
object.stop_persistence() Stop persistence
object.stop_replication() Stop replication
object.sync_mutation(keyspecs) Sync mutation
object.sync_persistence(keyspecs) Sync persistence
object.sync_replication(sync-num-replicas, keyspecs) Sync replication
object.sync_replication_and_persistence(sync-num-replicas, keyspecs) Sync replication and persistence
object.sync_replication_or_persistence(sync-num-replicas, keyspecs) Sync replication or persistence
object.touch(key, expiry) Update the expiry time of an item
object.version() Returns the versions of all servers in the server pool