Couchbase API数据访问Guide

jieforest

options:

1. :include_docs       [true, false] Perform get with key on rows returned with key (non-reduce)
   
2. :descending         [true, false], reverse order of returned rows
   
3. :key                [String, Fixnum, Hash, Array] Return only rows with index key that match :key, simple and compound keys can be used (JSON encoded)
   
4. :keys               [Array] Return only rows that match array of keys (see :key), both simple and compound keys (JSON encoded)
   
5. :startkey           [String, Fixnum, Hash, Array] Range query from :start_key to :end_key (JSON encoded)
   
6. :endkey             [String, Fixnum, Hash, Array] Range query from :start_key to :end_key (JSON encoded)
   
7. :startkey_docid     [String] Document id to start with (to allow pagination for duplicate startkeys
   
8. :endkey_docid       [String] Last document id to include in the output (to allow pagination for duplicate startkeys)
   
9. :inclusive_end      [true, false] If true, specificed end key is included in result
   
10. :limit              [Fixnum] Limit the results returned
    
11. :skip               [Fixnum] Skip a number of results before returning (can be used with :limit to page through results)
    
12. :reduce             [true, false] Perform the reduce function defined in the view. If there is no reduce defined default is false and setting to true will return error.
    
13. :group              [true, false] Groups results using the view defined reduce function
    
14. :group_level        [Fixnum] Sets the grouping level for compound keys
    
15. :stale              [:false, :update_after, :ok] Consistency setting, :false initiates Design Document to update indexes before returning results, :update_after updates indexes after returning results, :ok doesn’t trigger indexers and returns existing indexed results
    
16. :body               [Hash] Takes same parameters as options but does it as a POST if the query has many parameters or is complex
    
17. :on_error           [:continue, :stop] Behavior setting if an error occurs during view query

复制代码

jieforest

.NET CONNECTING TO COUCHBASE

1. var config = new CouchbaseClientConfiguration();
   
2. config.Urls.Add(new Uri(“http://<hostname>:8091/pools/”));
   
3. config.Bucket = “<bucketname>”;
   
4. var client = new CouchbaseClient(config);

复制代码

WRITING DATA

Based on the storemode, Store and ExecuteStore may be an Add, Replace or Set operation. Execute API’s return the operation result.

Store Operations

1. 
   
2. object.Store(storemode, key, value)
   
3. object.Store(storemode, key, value, validfor)
   
4. object.Store(storemode, key, value, expiresat)

复制代码

jieforest

ExecuteStore Operations

1. object.ExecuteStore(storemode, key, value)
   
2. object.ExecuteStore(storemode, key, value, expiresat)
   
3. object.ExecuteStore(storemode, key, value, validfor)
   
4. object.ExecuteStore(storemode, key, value, ReplicateTo)
   
5. object.ExecuteStore(storemode, key, value, PersistTo)
   
6. object.ExecuteStore(storemode, key, value, PersistTo,
   
7. ReplicateTo)

复制代码

Parameters:

1. String key             Key used to reference the value.
   
2. Object value           Value to be stored
   
3. StoreMode storemode    Storage mode for a given key/value pair can be Add, Replace or Set.
   
4. Timespan validfor      Expiry timespan (in seconds) for key
   
5. DateTime expiresat     Explicit expiry time for key
   
6. Enum PersistsTo        Persist to one or more replicas. Master plus one, two, three replicas
   
7. Enum ReplicateTo       Replicate to zero or more replicas .NET

复制代码

jieforest

READING DATA

Get Operations

1. object.Get(key, expiry)
   
2. object.ExecuteGet(key, expiry)
   
3. object.ExecuteGet(key)
   
4. object.ExecuteGet(keyarray)
   
5. object.Get(key)
   
6. object.Get(keyarray)
   
7. object.GetWithCas(key)
   

复制代码

Parameters:

1. String key               Key used to reference the value. The key cannot contain control characters or whitespace
   
2. object expiry            Expiry time for the key in seconds. Values larger than 30*24*60*60 seconds (30 days) are interpreted as absolute times (from the epoch)
   
3. List <string> keyarray   Array of keys used to reference one or more values

复制代码

jieforest

UPDATING DATA

Update existing information on the server:

1. 
   
2. object.Append(key, value)
   
3. object.Append(key, casvalue, value)
   
4. object.ExecuteAppend(key, value)
   
5. object.ExecuteAppend(key, casvalue, value)
   
6. object.Cas(storemode, key, value)
   
7. object.Cas(storemode, key, value, casunique)
   
8. object.Cas(storemode, key, value, validfor, casunique)
   
9. object.ExecuteCas(storemode, key, value)
   
10. object.ExecuteCas(storemode, key, value, casunique)
    
11. object.ExecuteCas(storemode, key, value, expiresat, casunique)
    
12. object.ExecuteCas(storemode, key, value, validfor, casunique)
    
13. object.Decrement(key, defaultvalue, offset)
    
14. object.Decrement(key, defaultvalue, offset, casunique)
    
15. object.Decrement(key, defaultvalue, offset, expiresat, casunique)
    
16. object.Decrement(key, defaultvalue, offset, validfor, casunique)
    
17. object.Decrement(key, defaultvalue, offset, expiresat)
    
18. object.Decrement(key, defaultvalue, offset, validfor)
    
19. object.Decrement(key, defaultvalue, offset)
    
20. object.Decrement(key, defaultvalue, offset, casunique)
    
21. object.Decrement(key, defaultvalue, offset, validfor, casunique)
    
22. object.Decrement(key, defaultvalue, offset, expiresat)
    
23. object.Decrement(key, defaultvalue, offset, validfor)
    
24. object.ExecuteDecrement(key, defaultvalue, offset)
    
25. object.ExecuteDecrement(key, defaultvalue, offset, casunique)
    
26. object.ExecuteDecrement(key, defaultvalue, offset, expiresat, casunique)
    
27. object.ExecuteDecrement(key, defaultvalue, offset, validfor, casunique)
    
28. object.ExecuteDecrement(key, defaultvalue, offset, expiresat)
    
29. object.ExecuteDecrement(key, defaultvalue, offset, validfor)
    
30. object.ExecuteRemove(key)
    
31. object.Remove(key)
    
32. object.ExecuteIncrement(key, defaultvalue, offset)
    
33. object.ExecuteIncrement(key, defaultvalue, offset, casunique)
    
34. object.ExecuteIncrement(key, defaultvalue, offset, expiresat, casunique)
    
35. object.ExecuteIncrement(key, defaultvalue, offset, validfor, casunique)
    
36. object.ExecuteIncrement(key, defaultvalue, offset, expiresat)
    
37. object.ExecuteIncrement(key, defaultvalue, offset, validfor)
    
38. object.Increment(key, defaultvalue, offset)
    
39. object.Increment(key, defaultvalue, offset, casunique)
    
40. object.Increment(key, defaultvalue, offset, expiresat, casunique)
    
41. object.Increment(key, defaultvalue, offset, validfor, casunique)
    
42. object.Increment(key, defaultvalue, offset, expiresat)
    
43. object.Increment(key, defaultvalue, offset, validfor)
    
44. object.ExecutePrepend(key, value)
    
45. object.ExecutePrepend(key, casunique, value)
    
46. object.Prepend(key, value)
    
47. object.Prepend(key, casunique, value)
    
48. object.Touch(key, expiry)

复制代码

jieforest

Parameters:

1. String key               Key used to reference the value.
   
2. Object value             Value to be stored
   
3. StoreMode storemode      Storage mode for a given key/value pair mode for a given key/value pair
   
4. Timespan validfor        Expiry timespan (in seconds) for key
   
5. DateTime expiresat       Explicit expiry time for key
   
6. Object defaultvalue      Value to be stored if the key does not exists
   
7. offset                   Integer offset value to increment or decrement (default 1)
   
8. casunique                Unique value used to verify a key/valuecombination
   

复制代码

QUERYING DATA

With Couchbase Server 2.0, you can add views and query those views using your applications.
Create a view object to be used when querying a view :

1. GetView(designName, viewName)

复制代码

jieforest

Parameters:

1. String ddocname       Design document name
   
2. String viewname       View name within a design document
   

复制代码

Then create a new query object to be used when querying the view:

1. Query.new()
   
2. Query query = new Query();
   

复制代码

Once the view and query objects are available, the results of the server view can be accessed using:

1. client.query(view, query)

复制代码

jieforest

Parameters:

1. View view              View object associated with a server view
   
2. Query query            Query object associated with a server view
   

复制代码

Before accessing the view, a list of options can be set with the query object:

query.setKey(String key) to set the key to query in the view
query.setKey(ComplexKey key) to set the key to query in the view
query.setRangeStart(String startKey) to set the starting key
query.setRangeStart(ComplexKey startKey) to set the starting key
query.setRangeEnd(String endKey) to set the ending key
query.setRangeEnd(ComplexKey endKey) to set the ending key
query.setRange(String startKey, String endKey) to set a range
query.setRange(ComplexKey startKey, ComplexKey endKey)
query.setDescending(boolean descending) to sort in descending order
query.setIncludeDocs(boolean include) to include the JSON doc
query.setReduce(boolean reduce) execute the reduce function
query.setStale(Stale reduce) set to OK will not refresh the view even if it is stale, set to UPDATE_AFTER will update the view after the stale result is returned, FALSE will update the view and return the latest results.

The format of the returned information of the query method is:
ViewResponse or any of the other inherited objects such as
ViewResponseWithDocs, ViewResponseNoDocs, ViewResponseReduced.

The ViewResponse method provides an iterator() method for iterating through the rows as a ViewRow interface. The ViewResponse method also provides a getMap() method where the result is available as a map.

jieforest

RUBY CONNECTING TO COUCHBASE

1. client = Couchbase.connect(url, options = {});
   
2. client = Couchbase.connect(options = {});
   

复制代码

Hash Parameters:

1. :hostname             IP address for Couchbase Node (String)
   
2. :bucket               Bucket name (String) [optional, default is ‘default’]
   
3. :password             SASL password for Bucket (String) [optional]
   
4. :nodelist             Array of IP’s for Couchbase Nodes ([String]) like [’12.34.56.78:8091’, ’12.34.56.79’]

复制代码

1. client = Couchbase.bucket

复制代码

There is a shared single instance of the Couchbase connection object in the Couchbase-model gem and can be used once connected, or when settings are specified in /config/couchbase.yml, which connects on Rails startup.

jieforest

WRITING AND UPDATING DATA

Add Operations

The add method adds a value to the database with the specified key, but will fail (Couchbase::Error::KeyExists) if the key already exists in the database.

1. client.add(key, value, options = {})
   
2. client.add[key, options = {}] = value
   

复制代码

Replace Operations

The replace method will replace an existing key with a new value but will fail (Couchbase::Error::NotFound) if the key does not exist in the database.

1. client.replace(key, value, options = {})
   
2. client.replace[key, options = {}] = value
   

复制代码