Class: Sequel::Postgres::HStore

Inherits:
Hash show all
Includes:
SQL::AliasMethods
Defined in:
lib/sequel/extensions/pg_hstore.rb,
lib/sequel/extensions/pg_hstore_ops.rb

Defined Under Namespace

Modules: DatabaseMethods Classes: Parser

Constant Summary collapse

DEFAULT_PROC =

Default proc used for all underlying HStore hashes, so that even if you grab the underlying hash, it will still convert non-string keys to strings during lookup.

lambda{|h, k| h[k.to_s] unless k.is_a?(String)}
QUOTE = 
'"'.freeze
COMMA = 
",".freeze
KV_SEP = 
"=>".freeze
NULL = 
"NULL".freeze
ESCAPE_RE = 
/("|\\)/.freeze
ESCAPE_REPLACE = 
'\\\\\1'.freeze
HSTORE_CAST = 
'::hstore'.freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from SQL::AliasMethods

#as

Methods inherited from Hash

#&, #case, #hstore, #pg_json, #pg_jsonb, #sql_expr, #sql_negate, #sql_or, #|, #~

Class Method Details

._load(args) ⇒ Object

Use custom marshal loading, since underlying hash uses a default proc.



208
209
210
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 208

def self._load(args)
  new(Hash[Marshal.load(args)])
end

.parse(str) ⇒ Object

Parse the given string into an HStore, assuming the str is in PostgreSQL hstore output format.



214
215
216
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 214

def self.parse(str)
  new(Parser.new(str).parse)
end

Instance Method Details

#_dump ⇒ Object

Use custom marshal dumping, since underlying hash uses a default proc.



240
241
242
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 240

def _dump(*)
  Marshal.dump(to_a)
end

#fetch(key, *args, &block) ⇒ Object

Override to force the key argument to a string.



245
246
247
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 245

def fetch(key, *args, &block)
  super(key.to_s, *args, &block)
end

#merge(hash, &block) ⇒ Object

Convert the input hash to string keys and values before merging, and return a new HStore instance with the merged hash.



251
252
253
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 251

def merge(hash, &block)
  self.class.new(super(convert_hash(hash), &block))
end

#op ⇒ Object

Wrap the receiver in an HStoreOp so you can easily use the PostgreSQL hstore functions and operators with it.



319
320
321
 
# File 'lib/sequel/extensions/pg_hstore_ops.rb', line 319

def op
  HStoreOp.new(self)
end

#sql_literal_append(ds, sql) ⇒ Object

Append a literalize version of the hstore to the sql.



259
260
261
262
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 259

def sql_literal_append(ds, sql)
  ds.literal_append(sql, unquoted_literal)
  sql << HSTORE_CAST
end

#unquoted_literal ⇒ Object

Return a string containing the unquoted, unstring-escaped literal version of the hstore. Separated out for use by the bound argument code.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 267

def unquoted_literal
  str = String.new
  comma = false
  commas = COMMA
  quote = QUOTE
  kv_sep = KV_SEP
  null = NULL
  each do |k, v|
    str << commas if comma
    str << quote << escape_value(k) << quote
    str << kv_sep
    if v.nil?
      str << null
    else
      str << quote << escape_value(v) << quote
    end
    comma = true
  end
  str
end