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



82
83
84
 
# File 'lib/couchbase/key_value_scan.rb', line 82

def initialize(prefix)
  @prefix = prefix
end

Instance Attribute Details

#prefix ⇒ String

Returns:

  • (String) 


77
78
79
 
# File 'lib/couchbase/key_value_scan.rb', line 77

def prefix
  @prefix
end

Instance Method Details

#to_backend ⇒ Object

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



87
88
89
90
91
92
 
# File 'lib/couchbase/key_value_scan.rb', line 87

def to_backend
  {
    scan_type: :prefix,
    prefix: @prefix,
  }
end