Class: Couchbase::Collection::MutationResult

Inherits:

Object

• Object
• Couchbase::Collection::MutationResult

Defined in:

lib/couchbase/collection_options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/collection_options.rb more...

Direct Known Subclasses

BinaryCollection::CounterResult, MutateInResult

Instance Attribute Summary

• #cas ⇒ Integer

  Holds the CAS value of the document after the mutation.

• #error ⇒ Error::CouchbaseError^?

  Error or nil (used in multi-operations like #upsert_multi, #remove_multi).

• #mutation_token ⇒ MutationToken

  If returned, holds the mutation token of the document after the mutation.

Instance Method Summary

• #initialize {|self| ... } ⇒ MutationResult constructor

  A new instance of MutationResult.

Constructor Details

#initialize {|self| ... } ⇒ MutationResult

Returns a new instance of MutationResult.

Yield Parameters:

• self (MutationResult)

# File 'lib/couchbase/collection_options.rb', line 116

def initialize
  @error = nil
  yield self if block_given?
end

Instance Attribute Details

#cas ⇒ Integer

Returns holds the CAS value of the document after the mutation.

Returns:

• (Integer) —

  holds the CAS value of the document after the mutation

# File 'lib/couchbase/collection_options.rb', line 106

def cas
  @cas
end

#error ⇒ Error::CouchbaseError^?

Returns error or nil (used in multi-operations like Couchbase::Collection#upsert_multi, Couchbase::Collection#remove_multi).

Returns:

• (Error::CouchbaseError, nil) —

  error or nil (used in multi-operations like Couchbase::Collection#upsert_multi, Couchbase::Collection#remove_multi)

# File 'lib/couchbase/collection_options.rb', line 113

def error
  @error
end

#mutation_token ⇒ MutationToken

Returns if returned, holds the mutation token of the document after the mutation.

Returns:

• (MutationToken) —

  if returned, holds the mutation token of the document after the mutation

# File 'lib/couchbase/collection_options.rb', line 109

def mutation_token
  @mutation_token
end