Class: Couchbase::SamplingScan

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

Overview

A sampling scan performs a scan that randomly selects documents up to a configured limit

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(limit, seed = nil) ⇒ SamplingScan

Creates an instance of a SamplingScan scan type

Parameters:

  • limit (Integer)

    the maximum number of documents the sampling scan can return

  • seed (Integer, nil) (defaults to: nil)

    the seed used for the random number generator that selects the documents. If not set, a seed is generated at random



111
112
113
114
# File 'lib/couchbase/key_value_scan.rb', line 111

def initialize(limit, seed = nil)
  @limit = limit
  @seed = seed
end

Instance Attribute Details

#limitInteger

Returns:

  • (Integer)


101
102
103
# File 'lib/couchbase/key_value_scan.rb', line 101

def limit
  @limit
end

#seedInteger?

Returns:

  • (Integer, nil)


102
103
104
# File 'lib/couchbase/key_value_scan.rb', line 102

def seed
  @seed
end