Search:

Search all manuals
Search this manual
Manual
Couchbase Client Library Ruby 1.0
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Parent Section
Couchbase Client Library Ruby 1.0
Child Sections
Chapters

Chapter 3. Ruby Method Summary

Table of Contents

3.1. Synchronous Method Calls
3.2. Asynchronous Method Calls

The Ruby Client Library supports the full suite of API calls to Couchbase. A summary of the supported methods are listed in Table 3.1, “Ruby Client Library Method Summary”.

Table 3.1. Ruby Client Library Method Summary

MethodTitle
object.add(key, value, options) Add a value with the specified key that does not already exist
object.append(key, value [, ruby-append-options ]) Append a value to an existing key
object.cas(key [, ruby-cas-options ]) Compare and set a value providing the supplied CAS key matches
object.connect([ url ] [, bucket-symbol ] [, username ] [, password ] [, ruby-connect-options ]) Create connection to Couchbase Server
object.new([ url ] [, bucket-symbol ] [, username ] [, password ] [, ruby-connect-options ]) New alias for creating Couchbase client instance.
object.decrement(key [, offset ] [, ruby-incr-decr-options ]) Decrement the value of an existing numeric key
object.delete(key [, ruby-delete-options ]) Delete a key/value
object.flush() Deletes all values from the corresponding bucket
object.get(keyn [, ruby-get-options ] [, ruby-get-keys ]) Get one or more key values
object.increment(key [, offset ] [, ruby-incr-decr-options ]) Increment the value of an existing numeric key
object.prepend(key, value [, ruby-prepend-options ]) Prepend a value to an existing key
object.replace(key, value [, ruby-replace-options ]) Update an existing key with a new value
object.set(key, value, options) Store a value using the specified key
object.stats([ statname ]) Get the database statistics
object.touch-many(keyn) Update the expiry time of an item
object.touch-one(key [, ruby-touch-options ] [, ruby-touch-keys ]) Update the expiry time of an item