Class: Couchbase::PrefixScan

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

Overview

A prefix scan performs a scan that includes all documents whose keys start with the given prefix

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prefix) ⇒ PrefixScan

Creates an instance of a PrefixScan scan type

Parameters:

  • prefix (String, nil)

    the prefix all document keys should start with



86
87
88
# File 'lib/couchbase/key_value_scan.rb', line 86

def initialize(prefix)
  @prefix = prefix
end

Instance Attribute Details

#prefixString

Returns:

  • (String)


79
80
81
# File 'lib/couchbase/key_value_scan.rb', line 79

def prefix
  @prefix
end