Module: Sequel::Postgres::JSONDatabaseMethods

Defined in:
lib/sequel/extensions/pg_json.rb

Overview

Methods enabling Database object integration with the json type.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.db_parse_json(s) ⇒ Object

Parse JSON data coming from the database. Since PostgreSQL allows non JSON data in JSON fields (such as plain numbers and strings), we don't want to raise an exception for that.



141
142
143
144
145
146
 
# File 'lib/sequel/extensions/pg_json.rb', line 141

def self.db_parse_json(s)
  parse_json(s)
rescue Sequel::InvalidValue
  raise unless s.is_a?(String)
  parse_json("[#{s}]").first
end

.db_parse_jsonb(s) ⇒ Object

Same as db_parse_json, but consider the input as jsonb.



149
150
151
152
153
154
 
# File 'lib/sequel/extensions/pg_json.rb', line 149

def self.db_parse_jsonb(s)
  parse_json(s, true)
rescue Sequel::InvalidValue
  raise unless s.is_a?(String)
  parse_json("[#{s}]").first
end

.extended(db) ⇒ Object 



130
131
132
133
134
135
136
 
# File 'lib/sequel/extensions/pg_json.rb', line 130

def self.extended(db)
  db.instance_eval do
    copy_conversion_procs([114, 199, 3802, 3807])
    @schema_type_classes[:json] = [JSONHash, JSONArray]
    @schema_type_classes[:jsonb] = [JSONBHash, JSONBArray]
  end
end

.parse_json(s, jsonb = false) ⇒ Object

Parse the given string as json, returning either a JSONArray or JSONHash instance, and raising an error if the JSON parsing does not yield an array or hash.



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/sequel/extensions/pg_json.rb', line 159

def self.parse_json(s, jsonb=false)
  begin
    value = Sequel.parse_json(s)
  rescue Sequel.json_parser_error_class => e
    raise Sequel.convert_exception_class(e, Sequel::InvalidValue)
  end

  case value
  when Array
    (jsonb ? JSONBArray : JSONArray).new(value)
  when Hash 
    (jsonb ? JSONBHash : JSONHash).new(value)
  else
    raise Sequel::InvalidValue, "unhandled json value: #{value.inspect} (from #{s.inspect})"
  end
end

Instance Method Details

#bound_variable_arg(arg, conn) ⇒ Object

Handle JSONArray and JSONHash in bound variables



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

def bound_variable_arg(arg, conn)
  case arg
  when JSONArrayBase, JSONHashBase
    Sequel.object_to_json(arg)
  else
    super
  end
end