Class: Couchbase::Collection::MutationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/collection_options.rb,
/code/couchbase-ruby-client/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:



154
155
156
157
158
 
# File 'lib/couchbase/collection_options.rb', line 154

def initialize
  @error = nil
  @id = 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



135
136
137
 
# File 'lib/couchbase/collection_options.rb', line 135

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:



142
143
144
 
# File 'lib/couchbase/collection_options.rb', line 142

def error
  @error
end

#id ⇒ String?

Returns identifier of the document (used in multi-operations like Couchbase::Collection#upsert_multi, Couchbase::Collection#remove_multi).

Returns:



146
147
148
 
# File 'lib/couchbase/collection_options.rb', line 146

def id
  @id
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



138
139
140
 
# File 'lib/couchbase/collection_options.rb', line 138

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)



149
150
151
 
# File 'lib/couchbase/collection_options.rb', line 149

def success?
  !error
end