Class: Sequel::Postgres::JSONBaseOp

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

Overview

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

In the method documentation examples, assume that:

json_op = Sequel.pg_json(:json)

Direct Known Subclasses

JSONBOp, JSONOp

Constant Summary collapse

GET = 
["(".freeze, " -> ".freeze, ")".freeze].freeze
GET_TEXT = 
["(".freeze, " ->> ".freeze, ")".freeze].freeze
GET_PATH = 
["(".freeze, " #> ".freeze, ")".freeze].freeze
GET_PATH_TEXT = 
["(".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 HStoreOpMethods

#hstore

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

#+, #coerce

Methods included from SQL::ComplexExpressionMethods

#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

#[](key) ⇒ Object Also known as: get

Get JSON array element or object field as json. If an array is given, gets the object at the specified path.

json_op[1] # (json -> 1)
json_op['a'] # (json -> 'a')
json_op[%w'a b'] # (json #> ARRAY['a', 'b'])



109
110
111
112
113
114
115
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 109

def [](key)
  if is_array?(key)
    json_op(GET_PATH, wrap_array(key))
  else
    json_op(GET, key)
  end
end

#array_elements ⇒ Object

Returns a set of json values for the elements in the json array.

json_op.array_elements # json_array_elements(json)



121
122
123
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 121

def array_elements
  function(:array_elements)
end

#array_elements_text ⇒ Object

Returns a set of text values for the elements in the json array.

json_op.array_elements_text # json_array_elements_text(json)



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

def array_elements_text
  function(:array_elements_text)
end

#array_length ⇒ Object

Get the length of the outermost json array.

json_op.array_length # json_array_length(json)



135
136
137
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 135

def array_length
  Sequel::SQL::NumericExpression.new(:NOOP, function(:array_length))
end

#each ⇒ Object

Returns a set of key and value pairs, where the keys are text and the values are JSON.

json_op.each # json_each(json)



143
144
145
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 143

def each
  function(:each)
end

#each_text ⇒ Object

Returns a set of key and value pairs, where the keys and values are both text.

json_op.each_text # json_each_text(json)



151
152
153
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 151

def each_text
  function(:each_text)
end

#extract(*a) ⇒ Object

Returns a json value for the object at the given path.

json_op.extract('a') # json_extract_path(json, 'a')
json_op.extract('a', 'b') # json_extract_path(json, 'a', 'b')



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

def extract(*a)
  self.class.new(function(:extract_path, *a))
end

#extract_text(*a) ⇒ Object

Returns a text value for the object at the given path.

json_op.extract_text('a') # json_extract_path_text(json, 'a')
json_op.extract_text('a', 'b') # json_extract_path_text(json, 'a', 'b')



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

def extract_text(*a)
  Sequel::SQL::StringExpression.new(:NOOP, function(:extract_path_text, *a))
end

#get_text(key) ⇒ Object

Get JSON array element or object field as text. If an array is given, gets the object at the specified path.

json_op.get_text(1) # (json ->> 1)
json_op.get_text('a') # (json ->> 'a')
json_op.get_text(%w'a b') # (json #>> ARRAY['a', 'b'])



177
178
179
180
181
182
183
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 177

def get_text(key)
  if is_array?(key)
    json_op(GET_PATH_TEXT, wrap_array(key))
  else
    json_op(GET_TEXT, key)
  end
end

#keys ⇒ Object

Returns a set of keys AS text in the json object.

json_op.keys # json_object_keys(json)



188
189
190
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 188

def keys
  function(:object_keys)
end

#populate(arg) ⇒ Object

Expands the given argument using the columns in the json.

json_op.populate(arg) # json_populate_record(arg, json)



195
196
197
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 195

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

#populate_set(arg) ⇒ Object

Expands the given argument using the columns in the json.

json_op.populate_set(arg) # json_populate_recordset(arg, json)



202
203
204
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 202

def populate_set(arg)
  SQL::Function.new(function_name(:populate_recordset), arg, self)
end

#strip_nulls ⇒ Object

Returns a json value stripped of all internal null values.

json_op.strip_nulls # json_strip_nulls(json)



209
210
211
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 209

def strip_nulls
  self.class.new(function(:strip_nulls))
end

#to_record ⇒ Object

Builds arbitrary record from json object. You need to define the structure of the record using #as on the resulting object:

json_op.to_record.as(:x, [Sequel.lit('a integer'), Sequel.lit('b text')]) # json_to_record(json) AS x(a integer, b text)



217
218
219
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 217

def to_record
  function(:to_record)
end

#to_recordset ⇒ Object

Builds arbitrary set of records from json array of objects. You need to define the structure of the records using #as on the resulting object:

json_op.to_recordset.as(:x, [Sequel.lit('a integer'), Sequel.lit('b text')]) # json_to_recordset(json) AS x(a integer, b text)



225
226
227
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 225

def to_recordset
  function(:to_recordset)
end

#typeof ⇒ Object

Returns the type of the outermost json value as text.

json_op.typeof # json_typeof(json)



232
233
234
 
# File 'lib/sequel/extensions/pg_json_ops.rb', line 232

def typeof
  function(:typeof)
end