Class: Couchbase::Bucket
- Inherits:
-
Object
- Object
- Couchbase::Bucket
- Defined in:
- ext/couchbase_ext/couchbase_ext.c,
lib/couchbase/bucket.rb,
ext/couchbase_ext/couchbase_ext.c
Overview
This class in charge of all stuff connected to communication with Couchbase.
Defined Under Namespace
Classes: CouchRequest
Constant Summary collapse
- FMT_MASK =
Bitmask for flag bits responsible for format
0x03
- FMT_DOCUMENT =
Document format. The (default) format supports most of ruby types which could be mapped to JSON data (hashes, arrays, strings, numbers). Future version will be able to run map/reduce queries on the values in the document form (hashes).
0x00
- FMT_MARSHAL =
Marshal format. The format which supports transparent serialization of ruby objects with standard
Marshal.dump
andMarhal.load
methods. 0x01
- FMT_PLAIN =
Plain format. The format which force client don’t apply any conversions to the value, but it should be passed as String. It could be useful for building custom algorithms or formats. For example implement set: dustin.github.com/2011/02/17/memcached-set.html
0x02
Instance Attribute Summary collapse
-
#authority ⇒ String
readonly
The authority (“hostname:port”) of the current node.
-
#bucket ⇒ String
(also: #name)
readonly
The bucket name of the current connection.
- #default_arithmetic_init ⇒ Fixnum, true
-
#default_flags ⇒ Fixnum
Default flags for new values.
-
#default_format ⇒ Symbol
Default format for new values.
-
#default_observe_timeout ⇒ Fixnum
The default timeout value for #observe_and_wait operation in microseconds.
-
#environment ⇒ Symbol
readonly
The environment of the connection (
:development
or:production
). -
#hostname ⇒ String
readonly
The hostname of the current node.
-
#key_prefix ⇒ String
The library will prepend
key_prefix
to each key to provide simple namespacing. -
#num_replicas ⇒ Fixnum
readonly
The numbers of the replicas for each node in the cluster.
-
#on_error {|op, key, exc| ... } ⇒ Proc
Error callback for asynchronous mode.
-
#password ⇒ String
readonly
The password used to connect to the cluster.
-
#pool ⇒ String
readonly
The pool name of the current connection.
-
#port ⇒ Fixnum
readonly
The port of the current node.
-
#quiet ⇒ true, false
(also: #quiet?)
Flag specifying behaviour for operations on missing keys.
-
#timeout ⇒ Fixnum
The timeout for the operations in microseconds.
-
#url ⇒ String
readonly
The config url for this connection.
-
#username ⇒ String
readonly
The user name used to connect to the cluster.
Instance Method Summary collapse
-
#add(key, value, options = {}) {|ret| ... } ⇒ Fixnum
Add the item to the database, but fail if the object exists already.
-
#append(key, value, options = {}) ⇒ Fixnum
Append this object to the existing object.
-
#async? ⇒ true, false
Check whether the connection asynchronous.
-
#cas(key, options = {}) {|value| ... } ⇒ Fixnum
(also: #compare_and_swap)
Compare and swap value.
-
#connected? ⇒ true, false
Check whether the instance connected to the cluster.
-
#create_periodic_timer(interval, &block) ⇒ Couchbase::Timer
Create and register periodic timer.
-
#create_timer(interval, &block) ⇒ Couchbase::Timer
Create and register one-shot timer.
-
#decr(key, delta = 1, options = {}) {|ret| ... } ⇒ Fixnum
(also: #decrement)
Decrement the value of an existing numeric key.
-
#delete(key, options = {}) ⇒ true, ...
Delete the specified key.
-
#delete_design_doc(id, rev = nil) ⇒ true, false
Delete design doc with given id and revision.
-
#design_docs ⇒ Hash
Fetch design docs stored in current bucket.
-
#disconnect ⇒ true
Close the connection to the cluster.
-
#flush {|ret| ... } ⇒ true
Delete contents of the bucket.
-
#get(*args) ⇒ Object
(also: #[])
Obtain an object stored in Couchbase by given key.
-
#incr(key, delta = 1, options = {}) {|ret| ... } ⇒ Fixnum
(also: #increment)
Increment the value of an existing numeric key.
-
#initialize(*args) ⇒ Bucket
constructor
Initialize new Bucket.
-
#initialize_copy(orig) ⇒ Couchbase::Bucket
Initialize copy.
-
#inspect ⇒ String
Returns a string containing a human-readable representation of the Bucket.
- #make_http_request(*args) {|res| ... } ⇒ Couchbase::Bucket::CouchRequest
-
#observe(*keys, options = {}) {|ret| ... } ⇒ Hash<String, Array<Result>>, Array<Result>
Observe key state.
-
#observe_and_wait(*keys, &block) ⇒ Fixnum, Hash<String, Fixnum>
Wait for persistence condition.
-
#prepend(key, value, options = {}) ⇒ Object
Prepend this object to the existing object.
-
#reconnect(*args) ⇒ Object
Reconnect the bucket.
-
#replace(key, value, options = {}) ⇒ Fixnum
Replace the existing object in the database.
-
#run(*args) {|bucket| ... } ⇒ nil
Run the event loop.
-
#save_design_doc(data) ⇒ true, false
Update or create design doc with supplied views.
-
#set(key, value, options = {}) {|ret| ... } ⇒ Fixnum
(also: #[]=)
Unconditionally store the object in the Couchbase.
-
#stats(arg = nil) {|ret| ... } ⇒ Hash
Request server statistics.
-
#stop ⇒ nil
Stop the event loop.
-
#touch(*args) ⇒ Object
Update the expiry time of an item.
-
#unlock(*args) ⇒ Object
Unlock key.
-
#version {|ret| ... } ⇒ Hash
Returns versions of the server for each node in the cluster.
Constructor Details
#initialize(url, options = {}) ⇒ Bucket #initialize(options = {}) ⇒ Bucket
Initialize new Bucket.
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'ext/couchbase_ext/bucket.c', line 401
VALUE
cb_bucket_init(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
bucket->self = self;
bucket->exception = Qnil;
bucket->type = LCB_TYPE_BUCKET;
bucket->hostname = rb_str_new2("localhost");
bucket->port = 8091;
bucket->pool = cb_vStrDefault;
rb_str_freeze(bucket->pool);
bucket->bucket = cb_vStrDefault;
rb_str_freeze(bucket->bucket);
bucket->username = Qnil;
bucket->password = Qnil;
bucket->async = 0;
bucket->quiet = 0;
bucket->default_ttl = 0;
bucket->default_flags = 0;
bucket->default_format = cb_sym_document;
bucket->default_observe_timeout = 2500000;
bucket->on_error_proc = Qnil;
bucket->timeout = 0;
bucket->environment = cb_sym_production;
bucket->key_prefix_val = Qnil;
bucket->node_list = Qnil;
bucket->object_space = rb_hash_new();
do_scan_connection_options(bucket, argc, argv);
do_connect(bucket);
return self;
}
|
Instance Attribute Details
#authority ⇒ String (readonly)
The authority (“hostname:port”) of the current node
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 |
# File 'ext/couchbase_ext/bucket.c', line 759
VALUE
cb_bucket_authority_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
VALUE old_hostname = bucket->hostname;
uint16_t old_port = bucket->port;
VALUE hostname = cb_bucket_hostname_get(self);
cb_bucket_port_get(self);
if (hostname != old_hostname || bucket->port != old_port) {
char port_s[8];
snprintf(port_s, sizeof(port_s), ":%u", bucket->port);
bucket->authority = rb_str_dup(hostname);
rb_str_cat2(bucket->authority, port_s);
rb_str_freeze(bucket->authority);
}
return bucket->authority;
}
|
#bucket ⇒ String (readonly) Also known as: name
The bucket name of the current connection
784 785 786 787 788 789 |
# File 'ext/couchbase_ext/bucket.c', line 784
VALUE
cb_bucket_bucket_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->bucket;
}
|
#default_arithmetic_init ⇒ Fixnum, true
677 678 679 680 681 682 |
# File 'ext/couchbase_ext/bucket.c', line 677
VALUE
cb_bucket_default_arithmetic_init_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return ULL2NUM(bucket->default_arith_init);
}
|
#default_flags ⇒ Fixnum
Amending format bit will also change #default_format value
Default flags for new values.
The library reserves last two lower bits to store the format of the value. The can be masked via FMT_MASK constant.
581 582 583 584 585 586 |
# File 'ext/couchbase_ext/bucket.c', line 581
VALUE
cb_bucket_default_flags_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return ULONG2NUM(bucket->default_flags);
}
|
#default_format ⇒ Symbol
Amending default_format will also change #default_flags value
Default format for new values.
It uses flags field to store the format. It accepts either the Symbol (:document
, :marshal
, :plain
) or Fixnum (use constants FMT_DOCUMENT, FMT_MARSHAL, FMT_PLAIN) and silently ignores all other value.
Here is some notes regarding how to choose the format:
-
:document
(default) format supports most of ruby types which could be mapped to JSON data (hashes, arrays, strings, numbers). Future version will be able to run map/reduce queries on the values in the document form (hashes). -
:plain
format if you no need any conversions to be applied to your data, but your data should be passed as String. It could be useful for building custom algorithms or formats. For example implement set: dustin.github.com/2011/02/17/memcached-set.html -
:marshal
format if you’d like to transparently serialize your ruby object with standardMarshal.dump
andMarhal.load
methods.
598 599 600 601 602 603 |
# File 'ext/couchbase_ext/bucket.c', line 598
VALUE
cb_bucket_default_format_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->default_format;
}
|
#default_observe_timeout ⇒ Fixnum
The default timeout value for #observe_and_wait operation in microseconds
873 874 875 876 877 878 |
# File 'ext/couchbase_ext/bucket.c', line 873
VALUE
cb_bucket_default_observe_timeout_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return INT2FIX(bucket->default_observe_timeout);
}
|
#environment ⇒ Symbol (readonly)
The environment of the connection (:development
or :production
)
839 840 841 842 843 844 |
# File 'ext/couchbase_ext/bucket.c', line 839
VALUE
cb_bucket_environment_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->environment;
}
|
#hostname ⇒ String (readonly)
The hostname of the current node
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 |
# File 'ext/couchbase_ext/bucket.c', line 721
VALUE
cb_bucket_hostname_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
if (bucket->handle) {
const char * host = lcb_get_host(bucket->handle);
unsigned long len = RSTRING_LEN(bucket->hostname);
if (len != strlen(host) || strncmp(RSTRING_PTR(bucket->hostname), host, len) != 0) {
bucket->hostname = STR_NEW_CSTR(host);
rb_str_freeze(bucket->hostname);
}
}
return bucket->hostname;
}
|
#key_prefix ⇒ String
Returns The library will prepend key_prefix
to each key to provide simple namespacing.
698 699 700 701 702 703 |
# File 'ext/couchbase_ext/bucket.c', line 698
VALUE
cb_bucket_key_prefix_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->key_prefix_val;
}
|
#num_replicas ⇒ Fixnum (readonly)
The numbers of the replicas for each node in the cluster
853 854 855 856 857 858 859 860 861 862 863 |
# File 'ext/couchbase_ext/bucket.c', line 853
VALUE
cb_bucket_num_replicas_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
int32_t nr = lcb_get_num_replicas(bucket->handle);
if (nr < 0) {
return Qnil;
} else {
return INT2FIX(nr);
}
}
|
#on_error {|op, key, exc| ... } ⇒ Proc
Error callback for asynchronous mode.
This callback is using to deliver exceptions in asynchronous mode.
645 646 647 648 649 650 651 652 653 654 655 |
# File 'ext/couchbase_ext/bucket.c', line 645
VALUE
cb_bucket_on_error_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
if (rb_block_given_p()) {
return cb_bucket_on_error_set(self, rb_block_proc());
} else {
return bucket->on_error_proc;
}
}
|
#password ⇒ String (readonly)
The password used to connect to the cluster
824 825 826 827 828 829 |
# File 'ext/couchbase_ext/bucket.c', line 824
VALUE
cb_bucket_password_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->password;
}
|
#pool ⇒ String (readonly)
The pool name of the current connection
797 798 799 800 801 802 |
# File 'ext/couchbase_ext/bucket.c', line 797
VALUE
cb_bucket_pool_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->pool;
}
|
#port ⇒ Fixnum (readonly)
The port of the current node
743 744 745 746 747 748 749 750 751 |
# File 'ext/couchbase_ext/bucket.c', line 743
VALUE
cb_bucket_port_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
if (bucket->handle) {
bucket->port = atoi(lcb_get_port(bucket->handle));
}
return UINT2NUM(bucket->port);
}
|
#quiet ⇒ true, false Also known as: quiet?
Flag specifying behaviour for operations on missing keys
If it is true
, the operations will silently return nil
or false
instead of raising Error::NotFound.
563 564 565 566 567 568 |
# File 'ext/couchbase_ext/bucket.c', line 563
VALUE
cb_bucket_quiet_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->quiet ? Qtrue : Qfalse;
}
|
#timeout ⇒ Fixnum
Returns The timeout for the operations in microseconds. The client will raise Error::Timeout exception for all commands which weren’t completed in given timeslot.
657 658 659 660 661 662 |
# File 'ext/couchbase_ext/bucket.c', line 657
VALUE
cb_bucket_timeout_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return ULONG2NUM(bucket->timeout);
}
|
#url ⇒ String (readonly)
The config url for this connection.
Generally it is the bootstrap URL, but it could be different after cluster upgrade. This url is used to fetch the cluster configuration.
902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 |
# File 'ext/couchbase_ext/bucket.c', line 902
VALUE
cb_bucket_url_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
VALUE str;
(void)cb_bucket_authority_get(self);
str = rb_str_buf_new2("http://");
rb_str_append(str, bucket->authority);
rb_str_buf_cat2(str, "/pools/");
rb_str_append(str, bucket->pool);
rb_str_buf_cat2(str, "/buckets/");
rb_str_append(str, bucket->bucket);
rb_str_buf_cat2(str, "/");
return str;
}
|
#username ⇒ String (readonly)
The user name used to connect to the cluster
811 812 813 814 815 816 |
# File 'ext/couchbase_ext/bucket.c', line 811
VALUE
cb_bucket_username_get(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->username;
}
|
Instance Method Details
#add(key, value, options = {}) {|ret| ... } ⇒ Fixnum
Add the item to the database, but fail if the object exists already
323 324 325 326 327 |
# File 'ext/couchbase_ext/store.c', line 323
VALUE
cb_bucket_add(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_store(LCB_ADD, argc, argv, self);
}
|
#append(key, value, options = {}) ⇒ Fixnum
This operation is kind of data-aware from server point of view. This mean that the server treats value as binary stream and just perform concatenation, therefore it won’t work with :marshal
and :document
formats, because of lack of knowledge how to merge values in these formats. See #cas for workaround.
Append this object to the existing object
451 452 453 454 455 |
# File 'ext/couchbase_ext/store.c', line 451
VALUE
cb_bucket_append(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_store(LCB_APPEND, argc, argv, self);
}
|
#async? ⇒ true, false
Check whether the connection asynchronous.
By default all operations are synchronous and block waiting for results, but you can make them asynchronous and run event loop explicitly. (see #run)
556 557 558 559 560 561 |
# File 'ext/couchbase_ext/bucket.c', line 556
VALUE
cb_bucket_async_p(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->async ? Qtrue : Qfalse;
}
|
#cas(key, options = {}) {|value| ... } ⇒ Fixnum Also known as: compare_and_swap
Compare and swap value.
Reads a key’s value from the server and yields it to a block. Replaces the key’s value with the result of the block as long as the key hasn’t been updated in the meantime, otherwise raises Error::KeyExists. CAS stands for “compare and swap”, and avoids the need for manual key mutexing. Read more info here:
In asynchronous mode it will yield result twice, first for #get with Result#operation equal to :get
and second time for #set with Result#operation equal to :set
.
82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/couchbase/bucket.rb', line 82 def cas(key, = {}) if async? block = Proc.new get(key) do |ret| val = block.call(ret) # get new value from caller set(ret.key, val, .merge(:cas => ret.cas, :flags => ret.flags), &block) end else val, flags, ver = get(key, :extended => true) val = yield(val) # get new value from caller set(key, val, .merge(:cas => ver, :flags => flags)) end end |
#connected? ⇒ true, false
Check whether the instance connected to the cluster.
528 529 530 531 532 533 |
# File 'ext/couchbase_ext/bucket.c', line 528
VALUE
cb_bucket_connected_p(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
return bucket->handle ? Qtrue : Qfalse;
}
|
#create_periodic_timer(interval, &block) ⇒ Couchbase::Timer
Create and register periodic timer
258 259 260 |
# File 'lib/couchbase/bucket.rb', line 258 def create_periodic_timer(interval, &block) Timer.new(self, interval, :periodic => true, &block) end |
#create_timer(interval, &block) ⇒ Couchbase::Timer
Create and register one-shot timer
251 252 253 |
# File 'lib/couchbase/bucket.rb', line 251 def create_timer(interval, &block) Timer.new(self, interval, &block) end |
#decr(key, delta = 1, options = {}) {|ret| ... } ⇒ Fixnum Also known as: decrement
that server values stored and transmitted as unsigned numbers, therefore if you try to decrement negative or zero key, you will always get zero.
Decrement the value of an existing numeric key
The decrement methods reduce the value of a given key if the corresponding value can be parsed to an integer value. These operations are provided at a protocol level to eliminate the need to get, update, and reset a simple integer value in the database. It supports the use of an explicit offset value that will be used to reduce the stored value in the database.
308 309 310 311 312 |
# File 'ext/couchbase_ext/arithmetic.c', line 308
VALUE
cb_bucket_decr(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_arithmetic(-1, argc, argv, self);
}
|
#delete(key, options = {}) ⇒ true, ...
Delete the specified key
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'ext/couchbase_ext/delete.c', line 100
VALUE
cb_bucket_delete(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE rv, exc;
VALUE args, proc;
lcb_error_t err;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
rb_funcall(args, cb_id_flatten_bang, 0);
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_remove;
params.bucket = bucket;
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
ctx->quiet = params.cmd.remove.quiet;
ctx->proc = cb_gc_protect(bucket, proc);
rv = rb_hash_new();
ctx->rv = &rv;
ctx->bucket = bucket;
ctx->exception = Qnil;
ctx->nqueries = params.cmd.remove.num;
err = lcb_remove(bucket->handle, (const void *)ctx,
params.cmd.remove.num, params.cmd.remove.ptr);
cb_params_destroy(¶ms);
exc = cb_check_error(err, "failed to schedule delete request", Qnil);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
rb_exc_raise(cb_gc_unprotect(bucket, exc));
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
if (params.cmd.remove.num > 1) {
return rv; /* return as a hash {key => true, ...} */
} else {
VALUE vv = Qnil;
rb_hash_foreach(rv, cb_first_value_i, (VALUE)&vv);
return vv;
}
return rv;
}
}
|
#delete_design_doc(id, rev = nil) ⇒ true, false
Delete design doc with given id and revision.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/couchbase/bucket.rb', line 182 def delete_design_doc(id, rev = nil) ddoc = design_docs[id.sub(/^_design\//, '')] unless ddoc yield nil if block_given? return nil end path = Utils.build_query(ddoc.id, :rev => rev || ddoc.['rev']) req = make_http_request(path, :method => :delete, :extended => true) rv = nil req.on_body do |res| rv = res val = MultiJson.load(res.value) if block_given? if res.success? && val['error'] res.error = Error::View.new("delete_design_doc", val['error']) end yield(res) end end req.continue unless async? rv.success? or raise res.error end end |
#design_docs ⇒ Hash
Fetch design docs stored in current bucket
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/couchbase/bucket.rb', line 102 def design_docs req = make_http_request("/pools/default/buckets/#{bucket}/ddocs", :type => :management, :extended => true) docmap = {} req.on_body do |body| res = MultiJson.load(body.value) res["rows"].each do |obj| if obj['doc'] obj['doc']['value'] = obj['doc'].delete('json') end doc = ViewRow.wrap(self, obj) key = doc.id.sub(/^_design\//, '') next if self.environment == :production && key =~ /dev_/ docmap[key] = doc end yield(docmap) if block_given? end req.continue async? ? nil : docmap end |
#disconnect ⇒ true
Close the connection to the cluster
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'ext/couchbase_ext/bucket.c', line 1108
VALUE
cb_bucket_disconnect(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
if (bucket->handle) {
lcb_destroy(bucket->handle);
lcb_destroy_io_ops(bucket->io);
bucket->handle = NULL;
bucket->io = NULL;
return Qtrue;
} else {
rb_raise(cb_eConnectError, "closed connection");
return Qfalse;
}
}
|
#flush {|ret| ... } ⇒ true
Delete contents of the bucket
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/couchbase/bucket.rb', line 232 def flush if !async? && block_given? raise ArgumentError, "synchronous mode doesn't support callbacks" end req = make_http_request("/pools/default/buckets/#{bucket}/controller/doFlush", :type => :management, :method => :post, :extended => true) res = nil req.on_body do |r| res = r res.instance_variable_set("@operation", :flush) yield(res) if block_given? end req.continue true end |
#get(*keys, options = {}) {|ret| ... } ⇒ Object, ... #get(keys, options = {}) ⇒ Hash Also known as: []
Obtain an object stored in Couchbase by given key.
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'ext/couchbase_ext/get.c', line 220
VALUE
cb_bucket_get(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE args, rv, proc, exc;
size_t ii;
lcb_error_t err = LCB_SUCCESS;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_get;
params.bucket = bucket;
params.cmd.get.keys_ary = cb_gc_protect(bucket, rb_ary_new());
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
ctx->extended = params.cmd.get.extended;
ctx->quiet = params.cmd.get.quiet;
ctx->force_format = params.cmd.get.forced_format;
ctx->proc = cb_gc_protect(bucket, proc);
ctx->bucket = bucket;
rv = rb_hash_new();
ctx->rv = &rv;
ctx->exception = Qnil;
ctx->nqueries = params.cmd.get.num;
if (params.cmd.get.replica) {
err = lcb_get_replica(bucket->handle, (const void *)ctx,
params.cmd.get.num, params.cmd.get.ptr_gr);
} else {
err = lcb_get(bucket->handle, (const void *)ctx,
params.cmd.get.num, params.cmd.get.ptr);
}
cb_params_destroy(¶ms);
cb_gc_unprotect(bucket, params.cmd.get.keys_ary);
exc = cb_check_error(err, "failed to schedule get request", Qnil);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
cb_gc_unprotect(bucket, exc);
rb_exc_raise(exc);
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
if (params.cmd.get.gat || params.cmd.get.assemble_hash ||
(params.cmd.get.extended && (params.cmd.get.num > 1 || params.cmd.get.array))) {
return rv; /* return as a hash {key => [value, flags, cas], ...} */
}
if (params.cmd.get.num > 1 || params.cmd.get.array) {
VALUE *keys_ptr, ret;
ret = rb_ary_new();
keys_ptr = RARRAY_PTR(params.cmd.get.keys_ary);
for (ii = 0; ii < params.cmd.get.num; ++ii) {
rb_ary_push(ret, rb_hash_aref(rv, keys_ptr[ii]));
}
return ret; /* return as an array [value1, value2, ...] */
} else {
VALUE vv = Qnil;
rb_hash_foreach(rv, cb_first_value_i, (VALUE)&vv);
return vv;
}
}
}
|
#incr(key, delta = 1, options = {}) {|ret| ... } ⇒ Fixnum Also known as: increment
that server values stored and transmitted as unsigned numbers, therefore if you try to store negative number and then increment or decrement it will cause overflow. (see “Integer overflow” example below)
Increment the value of an existing numeric key
The increment methods allow you to increase a given stored integer value. These are the incremental equivalent of the decrement operations and work on the same basis; updating the value of a key if it can be parsed to an integer. The update operation occurs on the server and is provided at the protocol level. This simplifies what would otherwise be a two-stage get and set operation.
217 218 219 220 221 |
# File 'ext/couchbase_ext/arithmetic.c', line 217
VALUE
cb_bucket_incr(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_arithmetic(+1, argc, argv, self);
}
|
#initialize_copy(orig) ⇒ Couchbase::Bucket
Initialize copy
Initializes copy of the object, used by #dup
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
# File 'ext/couchbase_ext/bucket.c', line 445
VALUE
cb_bucket_init_copy(VALUE copy, VALUE orig)
{
struct cb_bucket_st *copy_b;
struct cb_bucket_st *orig_b;
if (copy == orig)
return copy;
if (TYPE(orig) != T_DATA || TYPE(copy) != T_DATA ||
RDATA(orig)->dfree != (RUBY_DATA_FUNC)cb_bucket_free) {
rb_raise(rb_eTypeError, "wrong argument type");
}
copy_b = DATA_PTR(copy);
orig_b = DATA_PTR(orig);
copy_b->self = copy_b->self;
copy_b->port = orig_b->port;
copy_b->authority = orig_b->authority;
copy_b->hostname = orig_b->hostname;
copy_b->pool = orig_b->pool;
copy_b->bucket = orig_b->bucket;
copy_b->username = orig_b->username;
copy_b->password = orig_b->password;
copy_b->async = orig_b->async;
copy_b->quiet = orig_b->quiet;
copy_b->default_format = orig_b->default_format;
copy_b->default_flags = orig_b->default_flags;
copy_b->default_ttl = orig_b->default_ttl;
copy_b->environment = orig_b->environment;
copy_b->timeout = orig_b->timeout;
copy_b->exception = Qnil;
if (orig_b->on_error_proc != Qnil) {
copy_b->on_error_proc = rb_funcall(orig_b->on_error_proc, cb_id_dup, 0);
}
copy_b->key_prefix_val = orig_b->key_prefix_val;
do_connect(copy_b);
return copy;
}
|
#inspect ⇒ String
Returns a string containing a human-readable representation of the Couchbase::Bucket.
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'ext/couchbase_ext/bucket.c', line 927
VALUE
cb_bucket_inspect(VALUE self)
{
VALUE str;
struct cb_bucket_st *bucket = DATA_PTR(self);
char buf[200];
str = rb_str_buf_new2("#<");
rb_str_buf_cat2(str, rb_obj_classname(self));
snprintf(buf, 25, ":%p \"", (void *)self);
(void)cb_bucket_authority_get(self);
rb_str_buf_cat2(str, buf);
rb_str_buf_cat2(str, "http://");
rb_str_append(str, bucket->authority);
rb_str_buf_cat2(str, "/pools/");
rb_str_append(str, bucket->pool);
rb_str_buf_cat2(str, "/buckets/");
rb_str_append(str, bucket->bucket);
rb_str_buf_cat2(str, "/");
snprintf(buf, 150, "\" default_format=:%s, default_flags=0x%x, quiet=%s, connected=%s, timeout=%u",
rb_id2name(SYM2ID(bucket->default_format)),
bucket->default_flags,
bucket->quiet ? "true" : "false",
bucket->handle ? "true" : "false",
bucket->timeout);
rb_str_buf_cat2(str, buf);
if (RTEST(bucket->key_prefix_val)) {
rb_str_buf_cat2(str, ", key_prefix=");
rb_str_append(str, rb_inspect(bucket->key_prefix_val));
}
rb_str_buf_cat2(str, ">");
return str;
}
|
#make_http_request(*args) {|res| ... } ⇒ Couchbase::Bucket::CouchRequest
412 413 414 415 416 417 418 419 420 421 |
# File 'ext/couchbase_ext/http.c', line 412
VALUE
cb_bucket_make_http_request(int argc, VALUE *argv, VALUE self)
{
VALUE args[4]; /* bucket, path, options, block */
args[0] = self;
rb_scan_args(argc, argv, "11&", &args[1], &args[2], &args[3]);
return rb_class_new_instance(4, args, cb_cCouchRequest);
}
|
#observe(*keys, options = {}) {|ret| ... } ⇒ Hash<String, Array<Result>>, Array<Result>
Observe key state
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'ext/couchbase_ext/observe.c', line 113
VALUE
cb_bucket_observe(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE args, rv, proc, exc;
lcb_error_t err;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_observe;
params.bucket = bucket;
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
ctx->proc = cb_gc_protect(bucket, proc);
ctx->bucket = bucket;
rv = rb_hash_new();
ctx->rv = &rv;
ctx->exception = Qnil;
ctx->nqueries = params.cmd.observe.num;
err = lcb_observe(bucket->handle, (const void *)ctx,
params.cmd.observe.num, params.cmd.observe.ptr);
cb_params_destroy(¶ms);
exc = cb_check_error(err, "failed to schedule observe request", Qnil);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
cb_gc_unprotect(bucket, exc);
rb_exc_raise(exc);
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
if (params.cmd.observe.num > 1 || params.cmd.observe.array) {
return rv; /* return as a hash {key => {}, ...} */
} else {
VALUE vv = Qnil;
rb_hash_foreach(rv, cb_first_value_i, (VALUE)&vv);
return vv; /* return first value */
}
}
}
|
#observe_and_wait(*keys, &block) ⇒ Fixnum, Hash<String, Fixnum>
Wait for persistence condition
This operation is useful when some confidence needed regarding the state of the keys. With two parameters :replicated
and :persisted
it allows to set up the waiting rule.
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 |
# File 'lib/couchbase/bucket.rb', line 286 def observe_and_wait(*keys, &block) = {:timeout => default_observe_timeout} .update(keys.pop) if keys.size > 1 && keys.last.is_a?(Hash) () if block && !async? raise ArgumentError, "synchronous mode doesn't support callbacks" end if keys.size == 0 raise ArgumentError, "at least one key is required" end if keys.size == 1 && keys[0].is_a?(Hash) key_cas = keys[0] else key_cas = keys.flatten.reduce({}) do |h, kk| h[kk] = nil # set CAS to nil h end end if async? do_observe_and_wait(key_cas, , &block) else res = do_observe_and_wait(key_cas, , &block) while res.nil? unless async? if keys.size == 1 && (keys[0].is_a?(String) || keys[0].is_a?(Symbol)) return res.values.first else return res end end end end |
#prepend(key, value, options = {}) ⇒ Object
This operation is kind of data-aware from server point of view. This mean that the server treats value as binary stream and just perform concatenation, therefore it won’t work with :marshal
and :document
formats, because of lack of knowledge how to merge values in these formats. See #cas for workaround.
Prepend this object to the existing object
510 511 512 513 514 |
# File 'ext/couchbase_ext/store.c', line 510
VALUE
cb_bucket_prepend(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_store(LCB_PREPEND, argc, argv, self);
}
|
#reconnect(url, options = {}) ⇒ Couchbase::Bucket #reconnect(options = {}) ⇒ Couchbase::Bucket
Reconnect the bucket
Reconnect the bucket using initial configuration with optional redefinition.
510 511 512 513 514 515 516 517 518 519 |
# File 'ext/couchbase_ext/bucket.c', line 510
VALUE
cb_bucket_reconnect(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
do_scan_connection_options(bucket, argc, argv);
do_connect(bucket);
return self;
}
|
#replace(key, value, options = {}) ⇒ Fixnum
Replace the existing object in the database
371 372 373 374 375 |
# File 'ext/couchbase_ext/store.c', line 371
VALUE
cb_bucket_replace(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_store(LCB_REPLACE, argc, argv, self);
}
|
#run(*args) {|bucket| ... } ⇒ nil
Run the event loop.
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 |
# File 'ext/couchbase_ext/bucket.c', line 1061
VALUE
cb_bucket_run(int argc, VALUE *argv, VALUE self)
{
VALUE args[3];
rb_need_block();
args[0] = self;
rb_scan_args(argc, argv, "01&", &args[1], &args[2]);
rb_ensure(do_run, (VALUE)args, ensure_run, (VALUE)args);
return Qnil;
}
|
#save_design_doc(data) ⇒ true, false
Update or create design doc with supplied views
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/couchbase/bucket.rb', line 132 def save_design_doc(data) attrs = case data when String MultiJson.load(data) when IO MultiJson.load(data.read) when Hash data else raise ArgumentError, "Document should be Hash, String or IO instance" end rv = nil id = attrs.delete('_id').to_s attrs['language'] ||= 'javascript' if id !~ /\A_design\// rv = Result.new(:operation => :http_request, :key => id, :error => ArgumentError.new("'_id' key must be set and start with '_design/'.")) yield rv if block_given? raise rv.error unless async? end req = make_http_request(id, :body => MultiJson.dump(attrs), :method => :put, :extended => true) req.on_body do |res| rv = res val = MultiJson.load(res.value) if block_given? if res.success? && val['error'] res.error = Error::View.new("save_design_doc", val['error']) end yield(res) end end req.continue unless async? rv.success? or raise res.error end end |
#set(key, value, options = {}) {|ret| ... } ⇒ Fixnum Also known as: []=
Unconditionally store the object in the Couchbase
267 268 269 270 271 |
# File 'ext/couchbase_ext/store.c', line 267
VALUE
cb_bucket_set(int argc, VALUE *argv, VALUE self)
{
return cb_bucket_store(LCB_SET, argc, argv, self);
}
|
#stats(arg = nil) {|ret| ... } ⇒ Hash
Request server statistics.
Fetches stats from each node in cluster. Without a key specified the server will respond with a “default” set of statistical information. In asynchronous mode each statistic is returned in separate call where the Result object yielded (#key
contains the name of the statistical item and the #value
contains the value, the #node
will indicate the server address). In synchronous mode it returns the hash of stats keys and node-value pairs as a value.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'ext/couchbase_ext/stats.c', line 107
VALUE
cb_bucket_stats(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE rv, exc, args, proc;
lcb_error_t err;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_stats;
params.bucket = bucket;
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
rv = rb_hash_new();
ctx->rv = &rv;
ctx->bucket = bucket;
ctx->proc = cb_gc_protect(bucket, proc);
ctx->exception = Qnil;
ctx->nqueries = params.cmd.stats.num;
err = lcb_server_stats(bucket->handle, (const void *)ctx,
params.cmd.stats.num, params.cmd.stats.ptr);
exc = cb_check_error(err, "failed to schedule stat request", Qnil);
cb_params_destroy(¶ms);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
cb_gc_unprotect(bucket, exc);
rb_exc_raise(exc);
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
return rv;
}
return Qnil;
}
|
#stop ⇒ nil
Stop the event loop.
1091 1092 1093 1094 1095 1096 1097 |
# File 'ext/couchbase_ext/bucket.c', line 1091
VALUE
cb_bucket_stop(VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
lcb_breakout(bucket->handle);
return Qnil;
}
|
#touch(key, options = {}) {|ret| ... } ⇒ true, false #touch(keys) {|ret| ... } ⇒ Hash
Update the expiry time of an item
The touch
method allow you to update the expiration time on a given key. This can be useful for situations where you want to prevent an item from expiring without resetting the associated value. For example, for a session database you might want to keep the session alive in the database each time the user accesses a web page without explicitly updating the session value, keeping the user’s session active and available.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'ext/couchbase_ext/touch.c', line 124
VALUE
cb_bucket_touch(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE args, rv, proc, exc;
lcb_error_t err;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
rb_funcall(args, cb_id_flatten_bang, 0);
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_touch;
params.bucket = bucket;
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
ctx->proc = cb_gc_protect(bucket, proc);
ctx->bucket = bucket;
rv = rb_hash_new();
ctx->rv = &rv;
ctx->exception = Qnil;
ctx->quiet = params.cmd.touch.quiet;
ctx->nqueries = params.cmd.touch.num;
err = lcb_touch(bucket->handle, (const void *)ctx,
params.cmd.touch.num, params.cmd.touch.ptr);
cb_params_destroy(¶ms);
exc = cb_check_error(err, "failed to schedule touch request", Qnil);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
rb_exc_raise(cb_gc_unprotect(bucket, exc));
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
if (params.cmd.touch.num > 1) {
return rv; /* return as a hash {key => true, ...} */
} else {
VALUE vv = Qnil;
rb_hash_foreach(rv, cb_first_value_i, (VALUE)&vv);
return vv;
}
}
}
|
#unlock(key, options = {}) ⇒ true, false #unlock(keys) {|ret| ... } ⇒ Hash
Unlock key
The unlock
method allow you to unlock key once locked by #get with :lock
option.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'ext/couchbase_ext/unlock.c', line 114
VALUE
cb_bucket_unlock(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE args, rv, proc, exc;
lcb_error_t err;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
rb_funcall(args, cb_id_flatten_bang, 0);
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_unlock;
params.bucket = bucket;
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
ctx->proc = cb_gc_protect(bucket, proc);
ctx->bucket = bucket;
rv = rb_hash_new();
ctx->rv = &rv;
ctx->exception = Qnil;
ctx->quiet = params.cmd.unlock.quiet;
ctx->nqueries = params.cmd.unlock.num;
err = lcb_unlock(bucket->handle, (const void *)ctx,
params.cmd.unlock.num, params.cmd.unlock.ptr);
cb_params_destroy(¶ms);
exc = cb_check_error(err, "failed to schedule unlock request", Qnil);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
rb_exc_raise(cb_gc_unprotect(bucket, exc));
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
if (params.cmd.unlock.num > 1) {
return rv; /* return as a hash {key => true, ...} */
} else {
VALUE vv = Qnil;
rb_hash_foreach(rv, cb_first_value_i, (VALUE)&vv);
return vv;
}
}
}
|
#version {|ret| ... } ⇒ Hash
Returns versions of the server for each node in the cluster
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'ext/couchbase_ext/version.c', line 88
VALUE
cb_bucket_version(int argc, VALUE *argv, VALUE self)
{
struct cb_bucket_st *bucket = DATA_PTR(self);
struct cb_context_st *ctx;
VALUE rv, exc, args, proc;
lcb_error_t err;
struct cb_params_st params;
if (bucket->handle == NULL) {
rb_raise(cb_eConnectError, "closed connection");
}
rb_scan_args(argc, argv, "0*&", &args, &proc);
if (!bucket->async && proc != Qnil) {
rb_raise(rb_eArgError, "synchronous mode doesn't support callbacks");
}
memset(¶ms, 0, sizeof(struct cb_params_st));
params.type = cb_cmd_version;
params.bucket = bucket;
cb_params_build(¶ms, RARRAY_LEN(args), args);
ctx = calloc(1, sizeof(struct cb_context_st));
if (ctx == NULL) {
rb_raise(cb_eClientNoMemoryError, "failed to allocate memory for context");
}
rv = rb_hash_new();
ctx->rv = &rv;
ctx->bucket = bucket;
ctx->exception = Qnil;
ctx->proc = cb_gc_protect(bucket, proc);
ctx->nqueries = params.cmd.version.num;
err = lcb_server_versions(bucket->handle, (const void *)ctx,
params.cmd.version.num, params.cmd.version.ptr);
exc = cb_check_error(err, "failed to schedule version request", Qnil);
cb_params_destroy(¶ms);
if (exc != Qnil) {
free(ctx);
rb_exc_raise(exc);
}
bucket->nbytes += params.npayload;
if (bucket->async) {
cb_maybe_do_loop(bucket);
return Qnil;
} else {
if (ctx->nqueries > 0) {
/* we have some operations pending */
lcb_wait(bucket->handle);
}
exc = ctx->exception;
free(ctx);
if (exc != Qnil) {
cb_gc_unprotect(bucket, exc);
rb_exc_raise(exc);
}
exc = bucket->exception;
if (exc != Qnil) {
bucket->exception = Qnil;
rb_exc_raise(exc);
}
return rv;
}
}
|