module Sequel::Postgres::JSONDatabaseMethods

  1. lib/sequel/extensions/pg_json.rb
Parent: Postgres

Methods enabling Database object integration with the json type.

Methods

Public Class

  1. db_parse_json
  2. extended
  3. parse_json

Public Instance

  1. bound_variable_arg

Public Class methods

db_parse_json (s)

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.

[show source] 
# File lib/sequel/extensions/pg_json.rb, line 106
def self.db_parse_json(s)
  parse_json(s)
rescue Sequel::InvalidValue
  raise unless s.is_a?(String)
  parse_json("[#{s}]").first
end
extended (db)
[show source] 
# File lib/sequel/extensions/pg_json.rb, line 96
def self.extended(db)
  db.instance_eval do
    copy_conversion_procs([114, 199])
    @schema_type_classes[:json] = [JSONHash, JSONArray]
  end
end
parse_json (s)

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.

[show source] 
# File lib/sequel/extensions/pg_json.rb, line 116
def self.parse_json(s)
  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
    JSONArray.new(value)
  when Hash 
    JSONHash.new(value)
  else
    raise Sequel::InvalidValue, "unhandled json value: #{value.inspect} (from #{s.inspect})"
  end
end

Public Instance methods

bound_variable_arg (arg, conn)

Handle JSONArray and JSONHash in bound variables

[show source] 
# File lib/sequel/extensions/pg_json.rb, line 134
def bound_variable_arg(arg, conn)
  case arg
  when JSONArray, JSONHash
    Sequel.object_to_json(arg)
  else
    super
  end
end