Class: Couchbase::Collection::MutationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/collection_options.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MutationResult.

Yield Parameters:



126
127
128
129
# File 'lib/couchbase/collection_options.rb', line 126

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

Instance Attribute Details

#casInteger

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

Returns:

  • (Integer)

    holds the CAS value of the document after the mutation



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

def cas
  @cas
end

#errorError::CouchbaseError?

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

Returns:



118
119
120
# File 'lib/couchbase/collection_options.rb', line 118

def error
  @error
end

#mutation_tokenMutationToken

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



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

def mutation_token
  @mutation_token
end

Instance Method Details

#success?Boolean

Returns true if error was not associated with the result (useful for multi-operations).

Returns:

  • (Boolean)

    true if error was not associated with the result (useful for multi-operations)



121
122
123
# File 'lib/couchbase/collection_options.rb', line 121

def success?
  !error
end