Class: Couchbase::Options::Upsert

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

Overview

Options for Collection#upsert

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, durability_level: :none, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|| ... } ⇒ Upsert

Creates an instance of options for Collection#upsert

Parameters:

  • expiry (Integer, #in_seconds, Time, 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

  • 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.

  • 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:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
# File 'lib/couchbase/options.rb', line 538

def initialize(expiry: nil,
               preserve_expiry: false,
               transcoder: JsonTranscoder.new,
               durability_level: :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 = Utils::Time.extract_expiry_time(expiry)
  @preserve_expiry = preserve_expiry
  @transcoder = transcoder
  @durability_level = durability_level
  yield self if block_given?
end

Instance Attribute Details

#durability_levelSymbol

Returns:

  • (Symbol)


509
510
511
# File 'lib/couchbase/options.rb', line 509

def durability_level
  @durability_level
end

#expiryInteger, ...

Returns:

  • (Integer, #in_seconds, nil)


507
508
509
# File 'lib/couchbase/options.rb', line 507

def expiry
  @expiry
end

#preserve_expiryBoolean

Returns:

  • (Boolean)


510
511
512
# File 'lib/couchbase/options.rb', line 510

def preserve_expiry
  @preserve_expiry
end

#transcoderJsonTranscoder, #encode(Object)

Returns:



508
509
510
# File 'lib/couchbase/options.rb', line 508

def transcoder
  @transcoder
end

Instance Method Details

#to_backendObject



554
555
556
557
558
559
560
561
# File 'lib/couchbase/options.rb', line 554

def to_backend
  {
    timeout: @timeout.respond_to?(:in_milliseconds) ? @timeout.public_send(:in_milliseconds) : @timeout,
    expiry: @expiry,
    preserve_expiry: @preserve_expiry,
    durability_level: @durability_level,
  }
end