Search:

Search all manuals
Search this manual
Manual
Couchbase API Reference 1.1
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Parent Section
Couchbase API Reference 1.1
Child Sections
Chapters

Chapter 1. Couchbase Protocol Reference

Table of Contents

1.1. add
1.2. addServer
1.3. append
1.4. bucket-select
1.5. cas
1.6. complete-onlineupdate
1.7. connect
1.8. decr
1.9. delete
1.10. delete-vbucket
1.11. deregister-tap-client
1.12. durability
1.13. flush
1.14. gat
1.15. get
1.16. get-vbucket-state
1.17. getclientversion
1.18. getl
1.19. getNumReplicas
1.20. getOption
1.21. gets
1.22. getServerList
1.23. gettimeout
1.24. getVersion
1.25. getview
1.26. incr
1.27. noop
1.28. observe
1.29. prepend
1.30. query
1.31. query-class
1.32. replace
1.33. restore-file
1.34. sasl-auth-plain
1.35. sasl-auth-start
1.36. sasl-mechanism
1.37. set
1.38. set-flush-param
1.39. set-tap-param
1.40. set-vbucket-state
1.41. setOption
1.42. settimeout
1.43. start-onlineupdate
1.44. start-persistence
1.45. start-replication
1.46. stat
1.47. stop-persistence
1.48. stop-replication
1.49. sync-mutation
1.50. sync-persistence
1.51. sync-replication
1.52. sync-replication-and-persistence
1.53. sync-replication-or-persistence
1.54. touch
1.55. unl
    

add key value expiry

Add a value with the specified key that does not already exist

addServer host port [ weight ]

Add a server to the connection pool

append key value

Append a value to an existing key

bucket-select bucket

Select bucket

cas key flags expiry value_length casunique

Compare and set a value providing the supplied CAS key matches

complete-onlineupdate

Stop onlineupdate

connect url username password

Create connection to Couchbase Server

decr key offset

Decrement the value of an existing numeric key

delete key [ casunique ]

Delete a key/value

delete-vbucket vbucket

Delete vbucket

deregister-tap-client tap-name

Deregister tap client

durability

Wait until the durability of a document has been reached

flush

Deletes all values from the corresponding bucket

gat key expiry

Get a value and update the expiration time for a given key

get key [ keyn ]

Get one or more key values

get-vbucket-state vbucket

Get vbucket state

getclientversion

Returns the version of the client library

getl key [ getl-expiry ]

Get the value for a key, lock the key from changes

getNumReplicas

Returns the number of replicas for the configured bucket

getOption option

Retrieve an option

gets key

Get single key value with CAS value

getServerList

Returns the list of servers in the server pool

gettimeout

Get the currently configured timeout value for operations

getVersion

Returns the versions of all servers in the server pool

getview ddocname viewname

Create a view object

incr key offset

Increment the value of an existing numeric key

noop

Send a noop command

observe

Get the durability of a document

prepend key value

Prepend a value to an existing key

query view query

Query a view

query-class

Create a query object

replace key value expiry

Update an existing key with a new value

restore-file filename

Initiate restore of a given file

sasl-auth-plain sasl-user sasl-password [ sasl-for-user ]

Perform plain sasl auth

sasl-auth-start sasl-mechanism sasl-data

Start a sasl auth sessionds

sasl-mechanism

Get the supported SASL methods

set key value expiry

Store a value using the specified key

set-flush-param flush-param-key flush-param-value

Set flush parameter

set-tap-param tap-key tap-value

Set tap parameter

set-vbucket-state vbucket vbucket-state

Set vbucket state

setOption option mixed

Specify an option

settimeout

Set the configured timeout value for operations

start-onlineupdate

Start onlineupdate

start-persistence

Start persistence

start-replication

Start replication

stat [ statname ] [ statvalue ]

Get the database statistics

stop-persistence

Stop persistence

stop-replication

Stop replication

sync-mutation keyspecs

Sync mutation

sync-persistence keyspecs

Sync persistence

sync-replication sync-num-replicas keyspecs

Sync replication

sync-replication-and-persistence sync-num-replicas keyspecs

Sync replication and persistence

sync-replication-or-persistence sync-num-replicas keyspecs

Sync replication or persistence

touch key expiry

Update the expiry time of an item

unl

Unlock a previously locked key