Class: Couchbase::Options::Replace

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

Overview

Options for Collection#replace

Constant Summary collapse

DEFAULT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

Replace.new.freeze

Instance Attribute Summary collapse

Attributes inherited from Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(expiry: nil, preserve_expiry: false, transcoder: JsonTranscoder.new, cas: nil, durability_level: :none, replicate_to: :none, persist_to: :none, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|| ... } ⇒ Replace

Creates an instance of options for Collection#replace

Parameters:

  • expiry (Integer, #in_seconds, nil) (defaults to: nil) —

    expiration time to associate with the document

  • preserve_expiry (Boolean) (defaults to: false) —

    if true and the document exists, the server will preserve current expiration for the document, otherwise will use #expiry from the operation.

  • transcoder (JsonTranscoder, #encode(Object)) (defaults to: JsonTranscoder.new) —

    used for encoding

  • cas (Integer, nil) (defaults to: nil) —

    a CAS value that will be taken into account on the server side for optimistic concurrency

  • durability_level (Symbol) (defaults to: :none) —

    level of durability

    :none

    no enhanced durability required for the mutation

    :majority

    the mutation must be replicated to a majority of the Data Service nodes (that is, held in the memory allocated to the bucket)

    :majority_and_persist_to_active

    The mutation must be replicated to a majority of the Data Service nodes. Additionally, it must be persisted (that is, written and synchronised to disk) on the node hosting the active partition (vBucket) for the data.

    :persist_to_majority

    The mutation must be persisted to a majority of the Data Service nodes. Accordingly, it will be written to disk on those nodes.

  • replicate_to (Symbol) (defaults to: :none) —

    number of nodes to replicate

    :none

    do not apply any replication requirements.

    :one

    wait for replication to at least one node.

    :two

    wait for replication to at least two nodes.

    :three

    wait for replication to at least three nodes.

  • persist_to (Symbol) (defaults to: :none) —

    number of nodes to persist

    :none

    do not apply any persistence requirements.

    :active

    wait for persistence to active node

    :one

    wait for persistence to at least one node.

    :two

    wait for persistence to at least two nodes.

    :three

    wait for persistence to at least three nodes.

    :four

    wait for persistence to four nodes (active and replicas).

  • timeout (Integer, #in_milliseconds, nil) (defaults to: nil)
  • retry_strategy (Proc, nil) (defaults to: nil) —

    the custom retry strategy, if set

  • client_context (Hash, nil) (defaults to: nil) —

    the client context data, if set

  • parent_span (Span, nil) (defaults to: nil) —

    if set holds the parent span, that should be used for this request

Yield Parameters:



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/couchbase/options.rb', line 833

def initialize(expiry: nil,
               preserve_expiry: false,
               transcoder: JsonTranscoder.new,
               cas: nil,
               durability_level: :none,
               replicate_to: :none,
               persist_to: :none,
               timeout: nil,
               retry_strategy: nil,
               client_context: nil,
               parent_span: nil)
  super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
  @expiry = expiry
  @preserve_expiry = preserve_expiry
  @transcoder = transcoder
  @cas = cas
  if durability_level != :none && (replicate_to != :none || persist_to != :none)
    raise ArgumentError, "durability_level conflicts with replicate_to and persist_to options"
  end

  @persist_to = persist_to
  @replicate_to = replicate_to
  @durability_level = durability_level
  yield self if block_given?
end

Instance Attribute Details

#cas ⇒ Integer?

Returns:

  • (Integer, nil) 


790
791
792
 
# File 'lib/couchbase/options.rb', line 790

def cas
  @cas
end

#durability_level ⇒ Symbol

Returns:

  • (Symbol) 


791
792
793
 
# File 'lib/couchbase/options.rb', line 791

def durability_level
  @durability_level
end

#expiry ⇒ Integer, ...

Returns:

  • (Integer, #in_seconds, nil) 


788
789
790
 
# File 'lib/couchbase/options.rb', line 788

def expiry
  @expiry
end

#preserve_expiry ⇒ Boolean

Returns:

  • (Boolean) 


792
793
794
 
# File 'lib/couchbase/options.rb', line 792

def preserve_expiry
  @preserve_expiry
end

#transcoder ⇒ JsonTranscoder, #encode(Object)

Returns:



789
790
791
 
# File 'lib/couchbase/options.rb', line 789

def transcoder
  @transcoder
end

Instance Method Details

#to_backend ⇒ Object 



859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/couchbase/options.rb', line 859

def to_backend
  {
    timeout: Utils::Time.extract_duration(@timeout),
    expiry: Utils::Time.extract_expiry_time(@expiry),
    preserve_expiry: @preserve_expiry,
    durability_level: @durability_level,
    persist_to: @persist_to,
    replicate_to: @replicate_to,
    cas: @cas,
  }
end