Class: Hash

Inherits:
Object show all
Defined in:
lib/sequel/extensions/core_extensions.rb,
lib/sequel/extensions/pg_json.rb,
lib/sequel/extensions/pg_hstore.rb

Overview

Sequel extends Hash to add methods to implement the SQL DSL.

Instance Method Summary collapse

Instance Method Details

#&(ce) ⇒ Object

Return a Sequel::SQL::BooleanExpression created from this hash, matching all of the conditions in this hash and the condition specified by the given argument.

{:a=>1} & :b # SQL: a = 1 AND b
{:a=>true} & ~:b # SQL: a IS TRUE AND NOT b



109
110
111
 
# File 'lib/sequel/extensions/core_extensions.rb', line 109

def &(ce)
  ::Sequel::SQL::BooleanExpression.new(:AND, self, ce)
end

#case(*args) ⇒ Object

Return a Sequel::SQL::CaseExpression with this hash as the conditions and the given default value. Note that the order of the conditions will be arbitrary on ruby 1.8, so all conditions should be orthogonal.

{{:a=>[2,3]}=>1}.case(0) # SQL: CASE WHEN a IN (2, 3) THEN 1 ELSE 0 END
{:a=>1, :b=>2}.case(:d, :c) # SQL: CASE c WHEN a THEN 1 WHEN b THEN 2 ELSE d END
                              #  or: CASE c WHEN b THEN 2 WHEN a THEN 1 ELSE d END



139
140
141
 
# File 'lib/sequel/extensions/core_extensions.rb', line 139

def case(*args)
  ::Sequel::SQL::CaseExpression.new(to_a, *args)
end

#hstore ⇒ Object

Create a new HStore using the receiver as the input hash. Note that the HStore created will not use the receiver as the backing store, since it has to modify the hash. To get the new backing store, use:

hash.hstore.to_hash



356
357
358
 
# File 'lib/sequel/extensions/pg_hstore.rb', line 356

def hstore
  Sequel::Postgres::HStore.new(self)
end

#pg_json ⇒ Object

Return a Sequel::Postgres::JSONHash proxy to the receiver. This is mostly useful as a short cut for creating JSONHash objects that didn’t come from the database.



342
343
344
 
# File 'lib/sequel/extensions/pg_json.rb', line 342

def pg_json
  Sequel::Postgres::JSONHash.new(self)
end

#pg_jsonb ⇒ Object

Return a Sequel::Postgres::JSONHash proxy to the receiver. This is mostly useful as a short cut for creating JSONHash objects that didn’t come from the database.



349
350
351
 
# File 'lib/sequel/extensions/pg_json.rb', line 349

def pg_jsonb
  Sequel::Postgres::JSONBHash.new(self)
end

#sql_expr ⇒ Object

Return a Sequel::SQL::BooleanExpression created from this hash, matching all of the conditions. Rarely do you need to call this explicitly, as Sequel generally assumes that hashes specify this type of condition.

{:a=>true}.sql_expr # SQL: a IS TRUE
{:a=>1, :b=>[2, 3]}.sql_expr # SQL: a = 1 AND b IN (2, 3)



149
150
151
 
# File 'lib/sequel/extensions/core_extensions.rb', line 149

def sql_expr
  ::Sequel::SQL::BooleanExpression.from_value_pairs(self)
end

#sql_negate ⇒ Object

Return a Sequel::SQL::BooleanExpression created from this hash, matching none of the conditions.

{:a=>true}.sql_negate # SQL: a IS NOT TRUE
{:a=>1, :b=>[2, 3]}.sql_negate # SQL: a != 1 AND b NOT IN (2, 3)



158
159
160
 
# File 'lib/sequel/extensions/core_extensions.rb', line 158

def sql_negate
  ::Sequel::SQL::BooleanExpression.from_value_pairs(self, :AND, true)
end

#sql_or ⇒ Object

Return a Sequel::SQL::BooleanExpression created from this hash, matching any of the conditions.

{:a=>true}.sql_or # SQL: a IS TRUE
{:a=>1, :b=>[2, 3]}.sql_or # SQL: a = 1 OR b IN (2, 3)



167
168
169
 
# File 'lib/sequel/extensions/core_extensions.rb', line 167

def sql_or
  ::Sequel::SQL::BooleanExpression.from_value_pairs(self, :OR)
end

#|(ce) ⇒ Object

Return a Sequel::SQL::BooleanExpression created from this hash, matching all of the conditions in this hash or the condition specified by the given argument.

{:a=>1} | :b # SQL: a = 1 OR b
{:a=>true} | ~:b # SQL: a IS TRUE OR NOT b



119
120
121
 
# File 'lib/sequel/extensions/core_extensions.rb', line 119

def |(ce)
  ::Sequel::SQL::BooleanExpression.new(:OR, self, ce)
end

#~ ⇒ Object

Return a Sequel::SQL::BooleanExpression created from this hash, not matching all of the conditions.

~{:a=>true} # SQL: a IS NOT TRUE
~{:a=>1, :b=>[2, 3]} # SQL: a != 1 OR b NOT IN (2, 3)



128
129
130
 
# File 'lib/sequel/extensions/core_extensions.rb', line 128

def ~
  ::Sequel::SQL::BooleanExpression.from_value_pairs(self, :OR, true)
end