Class Sequel::Postgres::JSONOp
In: lib/sequel/extensions/pg_json_ops.rb
Parent: Sequel::SQL::Wrapper

The JSONOp 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)

Methods

Constants

GET = ["(".freeze, " -> ".freeze, ")".freeze].freeze
GET_TEXT = ["(".freeze, " ->> ".freeze, ")".freeze].freeze
GET_PATH = ["(".freeze, " #> ".freeze, ")".freeze].freeze
GET_PATH_TEXT = ["(".freeze, " #>> ".freeze, ")".freeze].freeze

Public Instance methods

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'])

[Source]

    # File lib/sequel/extensions/pg_json_ops.rb, line 73
73:       def [](key)
74:         if is_array?(key)
75:           json_op(GET_PATH, wrap_array(key))
76:         else
77:           json_op(GET, key)
78:         end
79:       end

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

  json_op.array_elements # json_oarray_elements(json)

[Source]

    # File lib/sequel/extensions/pg_json_ops.rb, line 85
85:       def array_elements
86:         function(:json_array_elements)
87:       end

Get the length of the outermost json array.

  json_op.array_length # json_array_length(json)

[Source]

    # File lib/sequel/extensions/pg_json_ops.rb, line 92
92:       def array_length
93:         Sequel::SQL::NumericExpression.new(:NOOP, function(:json_array_length))
94:       end

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

  json_op.each # json_each(json)

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 100
100:       def each
101:         function(:json_each)
102:       end

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

  json_op.each_text # json_each_text(json)

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 108
108:       def each_text
109:         function(:json_each_text)
110:       end

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')

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 116
116:       def extract(*a)
117:         JSONOp.new(function(:json_extract_path, *a))
118:       end

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')

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 124
124:       def extract_text(*a)
125:         Sequel::SQL::StringExpression.new(:NOOP, function(:json_extract_path_text, *a))
126:       end
get(key)

Alias for #[]

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'])

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 134
134:       def get_text(key)
135:         if is_array?(key)
136:           json_op(GET_PATH_TEXT, wrap_array(key))
137:         else
138:           json_op(GET_TEXT, key)
139:         end
140:       end

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

  json_op.keys # json_object_keys(json)

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 145
145:       def keys
146:         function(:json_object_keys)
147:       end

Return the receiver, since it is already a JSONOp.

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 150
150:       def pg_json
151:         self
152:       end

Expands the given argument using the columns in the json.

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

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 157
157:       def populate(arg)
158:         SQL::Function.new(:json_populate_record, arg, self)
159:       end

Expands the given argument using the columns in the json.

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

[Source]

     # File lib/sequel/extensions/pg_json_ops.rb, line 164
164:       def populate_set(arg)
165:         SQL::Function.new(:json_populate_recordset, arg, self)
166:       end

[Validate]