Class: Sequel::Postgres::HStoreOp

Inherits:
SQL::Wrapper show all
Defined in:
lib/sequel/extensions/pg_hstore_ops.rb

Overview

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

Constant Summary collapse

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

Instance Attribute Summary

Attributes inherited from SQL::Wrapper

#value

Instance Method Summary collapse

Methods inherited from SQL::Wrapper

#initialize

Methods included from RangeOpMethods

#pg_range

Methods included from ArrayOpMethods

#pg_array

Methods included from JSONOpMethods

#pg_json, #pg_jsonb

Methods included from InetOpMethods

#pg_inet

Methods included from PGRowOp::ExpressionMethods

#pg_row

Methods included from SQL::SubscriptMethods

#sql_subscript

Methods included from SQL::StringMethods

#ilike, #like

Methods included from SQL::PatternMatchMethods

#=~

Methods included from SQL::OrderMethods

#asc, #desc

Methods included from SQL::NumericMethods

#+

Methods included from SQL::ComplexExpressionMethods

#extract, #sql_boolean, #sql_number, #sql_string

Methods included from SQL::CastMethods

#cast, #cast_numeric, #cast_string

Methods included from SQL::BooleanMethods

#~

Methods included from SQL::AliasMethods

#as

Methods inherited from SQL::Expression

#==, attr_reader, #eql?, #hash, inherited, #inspect, #lit, #sql_literal

Constructor Details

This class inherits a constructor from Sequel::SQL::Wrapper

Instance Method Details

#-(other) ⇒ Object

Delete entries from an hstore using the subtraction operator:

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



100
101
102
103
104
105
106
107
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 100

def -(other)
  other = if other.is_a?(String) && !other.is_a?(Sequel::LiteralString)
    Sequel.cast_string(other)
  else
    wrap_input_array(wrap_input_hash(other))
  end
  HStoreOp.new(super)
end

#[](key) ⇒ Object

Lookup the value for the given key in an hstore:

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



112
113
114
115
116
117
118
119
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 112

def [](key)
  v = Sequel::SQL::PlaceholderLiteralString.new(LOOKUP, [value, wrap_input_array(key)])
  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))
    wrap_output_array(v)
  else
    Sequel::SQL::StringExpression.new(:NOOP, v)
  end
end

#contain_all(other) ⇒ Object

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

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



124
125
126
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 124

def contain_all(other)
  bool_op(CONTAIN_ALL, wrap_input_array(other))
end

#contain_any(other) ⇒ Object

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

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



131
132
133
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 131

def contain_any(other)
  bool_op(CONTAIN_ANY, wrap_input_array(other))
end

#contained_by(other) ⇒ Object

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

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



145
146
147
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 145

def contained_by(other)
  bool_op(CONTAINED_BY, wrap_input_hash(other))
end

#contains(other) ⇒ Object

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

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



138
139
140
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 138

def contains(other)
  bool_op(CONTAINS, wrap_input_hash(other))
end

#defined(key) ⇒ Object

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

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



152
153
154
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 152

def defined(key)
  Sequel::SQL::BooleanExpression.new(:NOOP, function(:defined, key))
end

#delete(key) ⇒ Object

Delete the matching entries from the receiver:

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



159
160
161
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 159

def delete(key)
  HStoreOp.new(function(:delete, wrap_input_array(wrap_input_hash(key))))
end

#each ⇒ Object

Transform the receiver into a set of keys and values:

hstore_op.each # each(hstore)



166
167
168
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 166

def each
  function(:each)
end

#has_key?(key) ⇒ Boolean Also known as: include?, key?, member?, exist?

Check if the receiver contains the given key:

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

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 173

def has_key?(key)
  bool_op(HAS_KEY, key)
end

#hstore ⇒ Object

Return the receiver.



182
183
184
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 182

def hstore
  self
end

#keys ⇒ Object Also known as: akeys

Return the keys as a PostgreSQL array:

hstore_op.keys # akeys(hstore)



189
190
191
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 189

def keys
  wrap_output_array(function(:akeys))
end

#merge(other) ⇒ Object Also known as: concat

Merge a given hstore into the receiver:

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



197
198
199
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 197

def merge(other)
  HStoreOp.new(Sequel::SQL::PlaceholderLiteralString.new(CONCAT, [self, wrap_input_hash(other)]))
end

#populate(record) ⇒ Object

Create a new record populated with entries from the receiver:

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



205
206
207
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 205

def populate(record)
  SQL::Function.new(:populate_record, record, self)
end

#record_set(record) ⇒ Object

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

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



212
213
214
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 212

def record_set(record)
  Sequel::SQL::PlaceholderLiteralString.new(RECORD_SET, [record, value])
end

#skeys ⇒ Object

Return the keys as a PostgreSQL set:

hstore_op.skeys # skeys(hstore)



219
220
221
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 219

def skeys
  function(:skeys)
end

#slice(keys) ⇒ Object

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

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



226
227
228
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 226

def slice(keys)
  HStoreOp.new(function(:slice, wrap_input_array(keys)))
end

#svals ⇒ Object

Return the values as a PostgreSQL set:

hstore_op.svals # svals(hstore)



233
234
235
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 233

def svals
  function(:svals)
end

#to_array ⇒ Object

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

hstore_op.to_array # hstore_to_array(hstore)



241
242
243
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 241

def to_array
  wrap_output_array(function(:hstore_to_array))
end

#to_matrix ⇒ Object

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

hstore_op.to_matrix # hstore_to_matrix(hstore)



249
250
251
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 249

def to_matrix
  wrap_output_array(function(:hstore_to_matrix))
end

#values ⇒ Object Also known as: avals

Return the values as a PostgreSQL array:

hstore_op.values # avals(hstore)



256
257
258
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 256

def values
  wrap_output_array(function(:avals))
end