Class Sequel::Postgres::HStoreOp
In: lib/sequel/extensions/pg_hstore_ops.rb
Parent: Sequel::SQL::Wrapper

The HStoreOp class is a simple container for a single object that defines methods that yield Sequel expression objects representing PostgreSQL hstore operators and functions.

In the method documentation examples, assume that:

  hstore_op = :hstore.hstore

Methods

-   []   akeys   avals   concat   contain_all   contain_any   contained_by   contains   defined   delete   each   exist?   has_key?   hstore   include?   key?   keys   member?   merge   populate   record_set   skeys   slice   svals   to_array   to_matrix   values  

Constants

CONCAT = ["(".freeze, " || ".freeze, ")".freeze].freeze
CONTAIN_ALL = ["(".freeze, " ?& ".freeze, ")".freeze].freeze
CONTAIN_ANY = ["(".freeze, " ?| ".freeze, ")".freeze].freeze
CONTAINS = ["(".freeze, " @> ".freeze, ")".freeze].freeze
CONTAINED_BY = ["(".freeze, " <@ ".freeze, ")".freeze].freeze
HAS_KEY = ["(".freeze, " ? ".freeze, ")".freeze].freeze
LOOKUP = ["(".freeze, " -> ".freeze, ")".freeze].freeze
RECORD_SET = ["(".freeze, " #= ".freeze, ")".freeze].freeze

Public Instance methods

Delete entries from an hstore using the subtraction operator:

  hstore_op - 'a' # (hstore - 'a')

[Source]

    # File lib/sequel/extensions/pg_hstore_ops.rb, line 92
92:       def -(other)
93:         other = if other.is_a?(String) && !other.is_a?(Sequel::LiteralString)
94:           Sequel.cast_string(other)
95:         else
96:           wrap_input_array(wrap_input_hash(other))
97:         end
98:         HStoreOp.new(super)
99:       end

Lookup the value for the given key in an hstore:

  hstore_op['a'] # (hstore -> 'a')

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 104
104:       def [](key)
105:         v = Sequel::SQL::PlaceholderLiteralString.new(LOOKUP, [value, wrap_input_array(key)])
106:         if key.is_a?(Array) || (defined?(Sequel::Postgres::PGArray) && key.is_a?(Sequel::Postgres::PGArray)) || (defined?(Sequel::Postgres::ArrayOp) && key.is_a?(Sequel::Postgres::ArrayOp))
107:           wrap_output_array(v)
108:         else
109:           Sequel::SQL::StringExpression.new(:NOOP, v)
110:         end
111:       end
akeys()

Alias for keys

avals()

Alias for values

concat(other)

Alias for merge

Check if the receiver contains all of the keys in the given array:

  hstore_op.contain_all(:a) # (hstore ?& a)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 116
116:       def contain_all(other)
117:         bool_op(CONTAIN_ALL, wrap_input_array(other))
118:       end

Check if the receiver contains any of the keys in the given array:

  hstore_op.contain_any(:a) # (hstore ?| a)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 123
123:       def contain_any(other)
124:         bool_op(CONTAIN_ANY, wrap_input_array(other))
125:       end

Check if the other hstore contains all entries in the receiver:

  hstore_op.contained_by(:h) # (hstore <@ h)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 137
137:       def contained_by(other)
138:         bool_op(CONTAINED_BY, wrap_input_hash(other))
139:       end

Check if the receiver contains all entries in the other hstore:

  hstore_op.contains(:h) # (hstore @> h)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 130
130:       def contains(other)
131:         bool_op(CONTAINS, wrap_input_hash(other))
132:       end

Check if the receiver contains a non-NULL value for the given key:

  hstore_op.defined('a') # defined(hstore, 'a')

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 144
144:       def defined(key)
145:         Sequel::SQL::BooleanExpression.new(:NOOP, function(:defined, key))
146:       end

Delete the matching entries from the receiver:

  hstore_op.delete('a') # delete(hstore, 'a')

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 151
151:       def delete(key)
152:         HStoreOp.new(function(:delete, wrap_input_array(wrap_input_hash(key))))
153:       end

Transform the receiver into a set of keys and values:

  hstore_op.each # each(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 158
158:       def each
159:         function(:each)
160:       end
exist?(key)

Alias for has_key?

Check if the receiver contains the given key:

  hstore_op.has_key?('a') # (hstore ? 'a')

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 165
165:       def has_key?(key)
166:         bool_op(HAS_KEY, key)
167:       end

Return the receiver.

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 174
174:       def hstore
175:         self
176:       end
include?(key)

Alias for has_key?

key?(key)

Alias for has_key?

Return the keys as a PostgreSQL array:

  hstore_op.keys # akeys(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 181
181:       def keys
182:         wrap_output_array(function(:akeys))
183:       end
member?(key)

Alias for has_key?

Merge a given hstore into the receiver:

  hstore_op.merge(:a) # (hstore || a)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 189
189:       def merge(other)
190:         HStoreOp.new(Sequel::SQL::PlaceholderLiteralString.new(CONCAT, [self, wrap_input_hash(other)]))
191:       end

Create a new record populated with entries from the receiver:

  hstore_op.populate(:a) # populate_record(a, hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 197
197:       def populate(record)
198:         SQL::Function.new(:populate_record, record, self)
199:       end

Update the values in a record using entries in the receiver:

  hstore_op.record_set(:a) # (a #= hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 204
204:       def record_set(record)
205:         Sequel::SQL::PlaceholderLiteralString.new(RECORD_SET, [record, value])
206:       end

Return the keys as a PostgreSQL set:

  hstore_op.skeys # skeys(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 211
211:       def skeys
212:         function(:skeys)
213:       end

Return an hstore with only the keys in the given array:

  hstore_op.slice(:a) # slice(hstore, a)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 218
218:       def slice(keys)
219:         HStoreOp.new(function(:slice, wrap_input_array(keys)))
220:       end

Return the values as a PostgreSQL set:

  hstore_op.svals # svals(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 225
225:       def svals
226:         function(:svals)
227:       end

Return a flattened array of the receiver with alternating keys and values:

  hstore_op.to_array # hstore_to_array(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 233
233:       def to_array
234:         wrap_output_array(function(:hstore_to_array))
235:       end

Return a nested array of the receiver, with arrays of 2 element (key/value) arrays:

  hstore_op.to_matrix # hstore_to_matrix(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 241
241:       def to_matrix
242:         wrap_output_array(function(:hstore_to_matrix))
243:       end

Return the values as a PostgreSQL array:

  hstore_op.values # avals(hstore)

[Source]

     # File lib/sequel/extensions/pg_hstore_ops.rb, line 248
248:       def values
249:         wrap_output_array(function(:avals))
250:       end

[Validate]