module Sequel::Postgres::JSONDatabaseMethods
Methods enabling Database object integration with the json type.
Public Class Methods
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.
# File lib/sequel/extensions/pg_json.rb, line 145 def self.db_parse_json(s) parse_json(s) rescue Sequel::InvalidValue raise unless s.is_a?(String) parse_json("[#{s}]").first end
Same as ::db_parse_json, but consider the input as jsonb.
# File lib/sequel/extensions/pg_json.rb, line 153 def self.db_parse_jsonb(s) parse_json(s, true) rescue Sequel::InvalidValue raise unless s.is_a?(String) parse_json("[#{s}]").first end
# File lib/sequel/extensions/pg_json.rb, line 129 def self.extended(db) db.instance_exec do add_conversion_proc(114, JSONDatabaseMethods.method(:db_parse_json)) add_conversion_proc(3802, JSONDatabaseMethods.method(:db_parse_jsonb)) if respond_to?(:register_array_type) register_array_type('json', :oid=>199, :scalar_oid=>114) register_array_type('jsonb', :oid=>3807, :scalar_oid=>3802) end @schema_type_classes[:json] = [JSONHash, JSONArray] @schema_type_classes[:jsonb] = [JSONBHash, JSONBArray] end end
Parse the given string as json, returning either a JSONArray or JSONHash instance (or JSONBArray or JSONBHash instance if jsonb argument is true), or a String, Numeric, true, false, or nil if the json library used supports that.
# File lib/sequel/extensions/pg_json.rb, line 164 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) when String, Numeric, true, false, nil value else raise Sequel::InvalidValue, "unhandled json value: #{value.inspect} (from #{s.inspect})" end end
Public Instance Methods
Handle json and jsonb types in bound variables
# File lib/sequel/extensions/pg_json.rb, line 184 def bound_variable_arg(arg, conn) case arg when JSONArrayBase, JSONHashBase Sequel.object_to_json(arg) else super end end
Private Instance Methods
Handle json[] and jsonb[] types in bound variables.
# File lib/sequel/extensions/pg_json.rb, line 196 def bound_variable_array(a) case a when JSONHashBase, JSONArrayBase "\"#{Sequel.object_to_json(a).gsub('"', '\\"')}\"" else super end end
Make the column type detection recognize the json types.
# File lib/sequel/extensions/pg_json.rb, line 206 def schema_column_type(db_type) case db_type when 'json' :json when 'jsonb' :jsonb else super end end
Convert the value given to a JSONArray or JSONHash
# File lib/sequel/extensions/pg_json.rb, line 218 def typecast_value_json(value) case value when JSONArray, JSONHash value when Array JSONArray.new(value) when Hash JSONHash.new(value) when JSONBArray JSONArray.new(value.to_a) when JSONBHash JSONHash.new(value.to_hash) when String JSONDatabaseMethods.parse_json(value) else raise Sequel::InvalidValue, "invalid value for json: #{value.inspect}" end end
Convert the value given to a JSONBArray or JSONBHash
# File lib/sequel/extensions/pg_json.rb, line 238 def typecast_value_jsonb(value) case value when JSONBArray, JSONBHash value when Array JSONBArray.new(value) when Hash JSONBHash.new(value) when JSONArray JSONBArray.new(value.to_a) when JSONHash JSONBHash.new(value.to_hash) when String JSONDatabaseMethods.parse_json(value, true) else raise Sequel::InvalidValue, "invalid value for jsonb: #{value.inspect}" end end