Class: Aerospike::Statement

Inherits:
Object
  • Object
show all
Defined in:
lib/aerospike/query/statement.rb

Overview

The Aerospike::Statement class represents a query or scan statement to be executed on the database. It provides a set of properties that define the query or scan, including namespace, set name, bin names, index name, filters, and operations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace, set_name, bin_names = []) ⇒ Statement

Returns a new instance of Statement.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aerospike/query/statement.rb', line 28

def initialize(namespace, set_name, bin_names=[])
  # Namespace determines query Namespace
  @namespace = namespace

  # SetName determines query Set name (Optional)
  @set_name = set_name

  # IndexName determines query index name (Optional)
  # If not set, the server will determine the index from the filter's bin name.
  @index_name = nil

  # BinNames detemines bin names (optional)
  @bin_names = bin_names

  # Filters determine query filters (Optional)
  # Currently, only one filter is allowed by the server on a secondary index lookup.
  # If multiple filters are necessary, see QueryFilter example for a workaround.
  # QueryFilter demonstrates how to add additional filters in an user-defined
  # aggregation function.
  @filters = []

  # Predicate expressions in postfix notation. If the expression is evaluated to false,
  # the record will be ommited in the results.
  #
  # This method is redundant because PredExp can now be set in the base Policy for
  # any transaction (including queries).
  #
  # NOTE : Policy.predexp takes precedence to this value. This value will be
  # deprecated in the future.
  @predexp = nil

  @package_name  = nil
  @function_name = nil
  @function_args = nil
  @operations = nil


  # Limit returned records per second (rps) rate for each server.
  # Will not apply rps limit if records_per_second is zero.
  # Currently only applicable to a query without a defined filter (scan).
  # Default is 0
  @records_per_second = 0

  # TaskId determines query task id. (Optional)
  @task_id = rand(RAND_MAX)

  # determines if the query should return data
  @return_data = true
end

Instance Attribute Details

#bin_names ⇒ Object

Returns the value of attribute bin_names.



24
25
26
 
# File 'lib/aerospike/query/statement.rb', line 24

def bin_names
  @bin_names
end

#filters ⇒ Object

Returns the value of attribute filters.



25
26
27
 
# File 'lib/aerospike/query/statement.rb', line 25

def filters
  @filters
end

#function_args ⇒ Object

Returns the value of attribute function_args.



25
26
27
 
# File 'lib/aerospike/query/statement.rb', line 25

def function_args
  @function_args
end

#function_name ⇒ Object

Returns the value of attribute function_name.



25
26
27
 
# File 'lib/aerospike/query/statement.rb', line 25

def function_name
  @function_name
end

#index_name ⇒ Object

Returns the value of attribute index_name.



24
25
26
 
# File 'lib/aerospike/query/statement.rb', line 24

def index_name
  @index_name
end

#namespace ⇒ Object

Returns the value of attribute namespace.



24
25
26
 
# File 'lib/aerospike/query/statement.rb', line 24

def namespace
  @namespace
end

#operations ⇒ Object

Returns the value of attribute operations.



25
26
27
 
# File 'lib/aerospike/query/statement.rb', line 25

def operations
  @operations
end

#package_name ⇒ Object

Returns the value of attribute package_name.



25
26
27
 
# File 'lib/aerospike/query/statement.rb', line 25

def package_name
  @package_name
end

#predexp ⇒ Object

Returns the value of attribute predexp.



26
27
28
 
# File 'lib/aerospike/query/statement.rb', line 26

def predexp
  @predexp
end

#records_per_second ⇒ Object

Returns the value of attribute records_per_second.



26
27
28
 
# File 'lib/aerospike/query/statement.rb', line 26

def records_per_second
  @records_per_second
end

#return_data ⇒ Object

Returns the value of attribute return_data.



26
27
28
 
# File 'lib/aerospike/query/statement.rb', line 26

def return_data
  @return_data
end

#set_name ⇒ Object

Returns the value of attribute set_name.



24
25
26
 
# File 'lib/aerospike/query/statement.rb', line 24

def set_name
  @set_name
end

#task_id ⇒ Object

Returns the value of attribute task_id.



24
25
26
 
# File 'lib/aerospike/query/statement.rb', line 24

def task_id
  @task_id
end

Instance Method Details

#is_scan? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/aerospike/query/statement.rb', line 85

def is_scan?
  return (filters.nil? || (filters.empty?))
end

#reset_task_id ⇒ Object 



95
96
97
98
99
100
 
# File 'lib/aerospike/query/statement.rb', line 95

def reset_task_id
  @task_id = rand(RAND_MAX)
  while @task_id == 0
    @task_id = rand(RAND_MAX)
  end
end

#set_aggregate_function(package_name, function_name, function_args = [], return_data = true) ⇒ Object 



78
79
80
81
82
83
 
# File 'lib/aerospike/query/statement.rb', line 78

def set_aggregate_function(package_name, function_name, function_args=[], return_data=true)
  @package_name  = package_name
  @function_name = function_name
  @function_args = function_args
  @return_data = return_data
end

#set_task_id ⇒ Object 



89
90
91
92
93
 
# File 'lib/aerospike/query/statement.rb', line 89

def set_task_id
  while @task_id == 0
    @task_id = rand(RAND_MAX)
  end
end