Module: ArJdbc::PostgreSQL

Included in:
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
Defined in:
lib/arjdbc/postgresql/adapter.rb,
lib/arjdbc/postgresql/column.rb,
lib/arjdbc/postgresql/oid_types.rb,
lib/arjdbc/postgresql/explain_support.rb,
lib/arjdbc/postgresql/schema_creation.rb

Overview

Strives to provide Rails built-in PostgreSQL adapter (API) compatibility.

Defined Under Namespace

Modules: Column Classes: SchemaCreation

Constant Summary collapse

ADAPTER_NAME = 
'PostgreSQL'.freeze
NATIVE_DATABASE_TYPES = 
{
  :primary_key => "serial primary key",
  :string => { :name => "character varying", :limit => 255 },
  :text => { :name => "text" },
  :integer => { :name => "integer" },
  :float => { :name => "float" },
  :numeric => { :name => "numeric" },
  :decimal => { :name => "decimal" }, # :limit => 1000
  :datetime => { :name => "timestamp" },
  :timestamp => { :name => "timestamp" },
  :time => { :name => "time" },
  :date => { :name => "date" },
  :binary => { :name => "bytea" },
  :boolean => { :name => "boolean" },
  :xml => { :name => "xml" },
  # AR-JDBC added :
  #:timestamptz => { :name => "timestamptz" },
  #:timetz => { :name => "timetz" },
  :money => { :name=>"money" },
  :char => { :name => "char" },
  :serial => { :name => "serial" }, # auto-inc integer, bigserial, smallserial
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.arel_visitor_type(config = nil) ⇒ Object 



32
33
34
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 32

def self.arel_visitor_type(config = nil)
  ::Arel::Visitors::PostgreSQL
end

.column_selector ⇒ Object

See Also:

  • ActiveRecord::ConnectionAdapters::JdbcColumn#column_types


5
6
7
 
# File 'lib/arjdbc/postgresql/column.rb', line 5

def self.column_selector
  [ /postgre/i, lambda { |cfg, column| column.extend(Column) } ]
end

.jdbc_connection_class ⇒ Object

See Also:



17
18
19
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 17

def self.jdbc_connection_class
  ::ActiveRecord::ConnectionAdapters::PostgreSQLJdbcConnection
end

Instance Method Details

#adapter_name ⇒ Object 



44
45
46
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 44

def adapter_name
  ADAPTER_NAME
end

#add_column(table_name, column_name, type, options = {}) ⇒ Object

Adds a new column to the named table. See TableDefinition#column for details of the options you can use.



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 993

def add_column(table_name, column_name, type, options = {})
  default = options[:default]
  notnull = options[:null] == false

  sql_type = type_to_sql(type, options[:limit], options[:precision], options[:scale])
  sql_type << "[]" if options[:array]

  # Add the column.
  execute("ALTER TABLE #{quote_table_name(table_name)} ADD COLUMN #{quote_column_name(column_name)} #{sql_type}")

  change_column_default(table_name, column_name, default) if options_include_default?(options)
  change_column_null(table_name, column_name, false, default) if notnull
end

#add_index(table_name, column_name, options = {}) ⇒ Object

unless const_defined? :SchemaCreation



1061
1062
1063
1064
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1061

def add_index(table_name, column_name, options = {})
  index_name, index_type, index_columns, index_options, index_algorithm, index_using = add_index_options(table_name, column_name, options)
  execute "CREATE #{index_type} INDEX #{index_algorithm} #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} #{index_using} (#{index_columns})#{index_options}"
end

#add_order_by_for_association_limiting!(sql, options) ⇒ Object

ORDER BY clause for the passed order option.

PostgreSQL does not allow arbitrary ordering when using DISTINCT ON, so we work around this by wrapping the SQL as a sub-select and ordering in that query.



797
798
799
800
801
802
803
804
805
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 797

def add_order_by_for_association_limiting!(sql, options)
  return sql if options[:order].blank?

  order = options[:order].split(',').collect { |s| s.strip }.reject(&:blank?)
  order.map! { |s| 'DESC' if s =~ /\bdesc$/i }
  order = order.zip((0...order.size).to_a).map { |s,i| "id_list.alias_#{i} #{s}" }.join(', ')

  sql.replace "SELECT * FROM (#{sql}) AS id_list ORDER BY #{order}"
end

#all_schemas ⇒ Object 



714
715
716
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 714

def all_schemas
  select('SELECT nspname FROM pg_namespace').map { |row| row["nspname"] }
end

#change_column(table_name, column_name, type, options = {}) ⇒ Object

Changes the column of a table.



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1008

def change_column(table_name, column_name, type, options = {})
  quoted_table_name = quote_table_name(table_name)

  sql_type = type_to_sql(type, options[:limit], options[:precision], options[:scale])
  sql_type << "[]" if options[:array]

  begin
    execute "ALTER TABLE #{quoted_table_name} ALTER COLUMN #{quote_column_name(column_name)} TYPE #{sql_type}"
  rescue ActiveRecord::StatementInvalid => e
    raise e if postgresql_version > 80000
    # This is PostgreSQL 7.x, so we have to use a more arcane way of doing it.
    begin
      begin_db_transaction
      tmp_column_name = "#{column_name}_ar_tmp"
      add_column(table_name, tmp_column_name, type, options)
      execute "UPDATE #{quoted_table_name} SET #{quote_column_name(tmp_column_name)} = CAST(#{quote_column_name(column_name)} AS #{sql_type})"
      remove_column(table_name, column_name)
      rename_column(table_name, tmp_column_name, column_name)
      commit_db_transaction
    rescue
      rollback_db_transaction
    end
  end

  change_column_default(table_name, column_name, options[:default]) if options_include_default?(options)
  change_column_null(table_name, column_name, options[:null], options[:default]) if options.key?(:null)
end

#change_column_default(table_name, column_name, default) ⇒ Object

Changes the default value of a table column.



1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1037

def change_column_default(table_name, column_name, default)
  if column = column_for(table_name, column_name) # (backwards) compatible with AR 3.x - 4.x
    execute "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} SET DEFAULT #{quote_default_value(default, column)}"
  else
    execute "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} SET DEFAULT #{quote(default)}"
  end
end

#change_column_null(table_name, column_name, null, default = nil) ⇒ Object

unless const_defined? :SchemaCreation



1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1045

def change_column_null(table_name, column_name, null, default = nil)
  unless null || default.nil?
    if column = column_for(table_name, column_name) # (backwards) compatible with AR 3.x - 4.x
      execute "UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote_default_value(default, column)} WHERE #{quote_column_name(column_name)} IS NULL"
    else
      execute "UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL"
    end
  end
  execute("ALTER TABLE #{quote_table_name(table_name)} ALTER #{quote_column_name(column_name)} #{null ? 'DROP' : 'SET'} NOT NULL")
end

#client_min_messages ⇒ Object

Returns the current client message level.



747
748
749
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 747

def client_min_messages
  select_value('SHOW client_min_messages', 'SCHEMA')
end

#client_min_messages=(level) ⇒ Object

Set the client message level.



752
753
754
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 752

def client_min_messages=(level)
  execute("SET client_min_messages TO '#{level}'", 'SCHEMA')
end

#collation ⇒ Object

Returns the current database collation.



605
606
607
608
609
610
611
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 605

def collation
  select_value(
    "SELECT pg_database.datcollate" <<
    " FROM pg_database" <<
    " WHERE pg_database.datname LIKE '#{current_database}'",
  'SCHEMA')
end

#columns(table_name, name = nil) ⇒ Object

Returns the list of all column definitions for a table.



1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1079

def columns(table_name, name = nil)
  klass = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
  column_definitions(table_name).map do |row|
    # name, type, default, notnull, oid, fmod
    name = row[0]; type = row[1]; default = row[2]
    notnull = row[3]; oid = row[4]; fmod = row[5]
    # oid = OID::TYPE_MAP.fetch(oid.to_i, fmod.to_i) { OID::Identity.new }
    notnull = notnull == 't' if notnull.is_a?(String) # JDBC gets true/false
    # for ID columns we get a bit of non-sense default :
    # e.g. "nextval('mixed_cases_id_seq'::regclass"
    if default =~ /^nextval\(.*?\:\:regclass\)$/
      default = nil
    elsif default =~ /^\(([-+]?[\d\.]+)\)$/ # e.g. "(-1)" for a negative default
      default = $1
    end
    klass.new(name, default, oid, type, ! notnull, fmod, self)
  end
end

#columns_for_distinct(columns, orders) ⇒ Object

PostgreSQL requires the ORDER BY columns in the select list for distinct queries, and requires that the ORDER BY include the distinct column.



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 774

def columns_for_distinct(columns, orders)
  if orders.is_a?(String)
    orders = orders.split(','); orders.each(&:strip!)
  end

  order_columns = orders.reject(&:blank?).map! do |column|
    column = column.is_a?(String) ? column.dup : column.to_sql # AREL node
    column.gsub!(/\s+(?:ASC|DESC)\s*/i, '') # remove any ASC/DESC modifiers
    column.gsub!(/\s*NULLS\s+(?:FIRST|LAST)?\s*/i, '')
    column
  end
  order_columns.reject!(&:empty?)
  i = -1; order_columns.map! { |column| "#{column} AS alias_#{i += 1}" }

  columns = [ columns ]; columns.flatten!
  columns.push( *order_columns ).join(', ')
end

#configure_connection ⇒ Object

Configures the encoding, verbosity, schema search path, and time zone of the connection. This is called on connection.connect and should not be called manually.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 74

def configure_connection
  #if encoding = config[:encoding]
    # The client_encoding setting is set by the driver and should not be altered.
    # If the driver detects a change it will abort the connection.
    # see http://jdbc.postgresql.org/documentation/91/connect.html
    # self.set_client_encoding(encoding)
  #end
  self.client_min_messages = config[:min_messages] || 'warning'
  self.schema_search_path = config[:schema_search_path] || config[:schema_order]

  # Use standard-conforming strings if available so we don't have to do the E'...' dance.
  set_standard_conforming_strings

  # If using Active Record's time zone support configure the connection to return
  # TIMESTAMP WITH ZONE types in UTC.
  # (SET TIME ZONE does not use an equals sign like other SET variables)
  if ActiveRecord::Base.default_timezone == :utc
    execute("SET time zone 'UTC'", 'SCHEMA')
  elsif tz = local_tz
    execute("SET time zone '#{tz}'", 'SCHEMA')
  end # if defined? ActiveRecord::Base.default_timezone

  # SET statements from :variables config hash
  # http://www.postgresql.org/docs/8.3/static/sql-set.html
  (config[:variables] || {}).map do |k, v|
    if v == ':default' || v == :default
      # Sets the value to the global or compile default
      execute("SET SESSION #{k.to_s} TO DEFAULT", 'SCHEMA')
    elsif ! v.nil?
      execute("SET SESSION #{k.to_s} TO #{quote(v)}", 'SCHEMA')
    end
  end
end

#create_database(name, options = {}) ⇒ Object

Create a new PostgreSQL database. Options include :owner, :template, :encoding, :collation, :ctype, :tablespace, and :connection_limit (note that MySQL uses :charset while PostgreSQL uses :encoding).

Example: create_database config[:database], config create_database 'foo_development', encoding: 'unicode'



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 669

def create_database(name, options = {})
  options = { :encoding => 'utf8' }.merge!(options.symbolize_keys)

  option_string = options.sum do |key, value|
    case key
    when :owner
      " OWNER = \"#{value}\""
    when :template
      " TEMPLATE = \"#{value}\""
    when :encoding
      " ENCODING = '#{value}'"
    when :collation
      " LC_COLLATE = '#{value}'"
    when :ctype
      " LC_CTYPE = '#{value}'"
    when :tablespace
      " TABLESPACE = \"#{value}\""
    when :connection_limit
      " CONNECTION LIMIT = #{value}"
    else
      ""
    end
  end

  execute "CREATE DATABASE #{quote_table_name(name)}#{option_string}"
end

#create_savepoint(name = current_savepoint_name(true)) ⇒ Object 



351
352
353
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 351

def create_savepoint(name = current_savepoint_name(true))
  log("SAVEPOINT #{name}", 'Savepoint') { super }
end

#create_schema(schema_name, pg_username = nil) ⇒ Object

Creates a schema for the given schema name.



701
702
703
704
705
706
707
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 701

def create_schema(schema_name, pg_username = nil)
  if pg_username.nil? # AR 4.0 compatibility - accepts only single argument
    execute "CREATE SCHEMA #{schema_name}"
  else
    execute("CREATE SCHEMA \"#{schema_name}\" AUTHORIZATION \"#{pg_username}\"")
  end
end

#ctype ⇒ Object

Returns the current database ctype.



614
615
616
617
618
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 614

def ctype
  select_value(
    "SELECT pg_database.datctype FROM pg_database WHERE pg_database.datname LIKE '#{current_database}'",
  'SCHEMA')
end

#current_database ⇒ Object

current database name



591
592
593
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 591

def current_database
  select_value('SELECT current_database()', 'SCHEMA')
end

#current_schema ⇒ Object

Returns the current schema name.



586
587
588
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 586

def current_schema
  select_value('SELECT current_schema', 'SCHEMA')
end

#default_sequence_name(table_name, pk = nil) ⇒ Object 



413
414
415
416
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 413

def default_sequence_name(table_name, pk = nil)
  default_pk, default_seq = pk_and_sequence_for(table_name)
  default_seq || "#{table_name}_#{pk || default_pk || 'id'}_seq"
end

#disable_extension(name) ⇒ Object 



373
374
375
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 373

def disable_extension(name)
  execute("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE")
end

#disable_referential_integrity ⇒ Object 



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 962

def disable_referential_integrity
  if supports_disable_referential_integrity?
    begin
      execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL" }.join(";"))
    rescue
      execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER USER" }.join(";"))
    end
  end
  yield
ensure
  if supports_disable_referential_integrity?
    begin
      execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER ALL" }.join(";"))
    rescue
      execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER USER" }.join(";"))
    end
  end
end

#distinct(columns, orders) ⇒ Object 



767
768
769
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 767

def distinct(columns, orders)
  "DISTINCT #{columns_for_distinct(columns, orders)}"
end

#drop_database(name) ⇒ Object 



696
697
698
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 696

def drop_database(name)
  execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
end

#drop_schema(schema_name) ⇒ Object

Drops the schema for the given schema name.



710
711
712
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 710

def drop_schema schema_name
  execute "DROP SCHEMA #{schema_name} CASCADE"
end

#enable_extension(name) ⇒ Object

NOTE: only since AR-4.0 but should not hurt on other versions



369
370
371
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 369

def enable_extension(name)
  execute("CREATE EXTENSION IF NOT EXISTS \"#{name}\"")
end

#encoding ⇒ Object

Returns the current database encoding format.



596
597
598
599
600
601
602
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 596

def encoding
  select_value(
    "SELECT pg_encoding_to_char(pg_database.encoding)" <<
    " FROM pg_database" <<
    " WHERE pg_database.datname LIKE '#{current_database}'",
  'SCHEMA')
end

#escape_bytea(string) ⇒ Object 



902
903
904
905
906
907
908
909
910
911
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 902

def escape_bytea(string)
  return unless string
  if supports_hex_escaped_bytea?
    "\\\\x#{string.unpack("H*")[0]}"
  else
    result = ''
    string.each_byte { |c| result << sprintf('\\\\%03o', c) }
    result
  end
end

#exec_insert(sql, name, binds, pk = nil, sequence_name = nil) ⇒ Object 



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 535

def exec_insert(sql, name, binds, pk = nil, sequence_name = nil)
  # NOTE: 3.2 does not pass the PK on #insert (passed only into #sql_for_insert) :
  #   sql, binds = sql_for_insert(to_sql(arel, binds), pk, id_value, sequence_name, binds)
  # 3.2 :
  #  value = exec_insert(sql, name, binds)
  # 4.x :
  #  value = exec_insert(sql, name, binds, pk, sequence_name)
  if use_insert_returning? && ( pk || (sql.is_a?(String) && sql =~ /RETURNING "?\S+"?$/) )
    exec_query(sql, name, binds) # due RETURNING clause returns a result set
  else
    result = super
    if pk
      unless sequence_name
        table_ref = extract_table_ref_from_insert_sql(sql)
        sequence_name = default_sequence_name(table_ref, pk)
        return result unless sequence_name
      end
      last_insert_id_result(sequence_name)
    else
      result
    end
  end
end

#extension_enabled?(name) ⇒ Boolean

Returns:

  • (Boolean) 


377
378
379
380
381
382
383
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 377

def extension_enabled?(name)
  if supports_extensions?
    rows = select_rows("SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL)", 'SCHEMA')
    available = rows.first.first # true/false or 't'/'f'
    available == true || available == 't'
  end
end

#extensions ⇒ Object 



385
386
387
388
389
390
391
392
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 385

def extensions
  if supports_extensions?
    rows = select_rows "SELECT extname from pg_extension", "SCHEMA"
    rows.map { |row| row.first }
  else
    []
  end
end

#index_algorithms ⇒ Object 



394
395
396
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 394

def index_algorithms
  { :concurrently => 'CONCURRENTLY' }
end

#index_name_length ⇒ Object 



1074
1075
1076
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1074

def index_name_length
  63
end

#indexes(table_name, name = nil) ⇒ Object

Returns an array of indexes for the given table.



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1164

def indexes(table_name, name = nil)
  # NOTE: maybe it's better to leave things of to the JDBC API ?!
  result = select_rows(<<-SQL, 'SCHEMA')
    SELECT distinct i.relname, d.indisunique, d.indkey, pg_get_indexdef(d.indexrelid), t.oid
    FROM pg_class t
    INNER JOIN pg_index d ON t.oid = d.indrelid
    INNER JOIN pg_class i ON d.indexrelid = i.oid
    WHERE i.relkind = 'i'
    AND d.indisprimary = 'f'
    AND t.relname = '#{table_name}'
    AND i.relnamespace IN (SELECT oid FROM pg_namespace WHERE nspname = ANY (current_schemas(false)) )
    ORDER BY i.relname
  SQL

  result.map! do |row|
    index_name = row[0]
    unique = row[1].is_a?(String) ? row[1] == 't' : row[1] # JDBC gets us a boolean
    indkey = row[2].is_a?(Java::OrgPostgresqlUtil::PGobject) ? row[2].value : row[2]
    indkey = indkey.split(" ")
    inddef = row[3]
    oid = row[4]

    columns = select_rows(<<-SQL, "SCHEMA")
      SELECT a.attnum, a.attname
      FROM pg_attribute a
      WHERE a.attrelid = #{oid}
      AND a.attnum IN (#{indkey.join(",")})
    SQL

    columns = Hash[ columns.each { |column| column[0] = column[0].to_s } ]
    column_names = columns.values_at(*indkey).compact

    unless column_names.empty?
      # add info on sort order for columns (only desc order is explicitly specified, asc is the default)
      desc_order_columns = inddef.scan(/(\w+) DESC/).flatten
      orders = desc_order_columns.any? ? Hash[ desc_order_columns.map { |column| [column, :desc] } ] : {}

      if ActiveRecord::VERSION::MAJOR > 3 # AR4 supports `where` and `using` index options
        where = inddef.scan(/WHERE (.+)$/).flatten[0]
        using = inddef.scan(/USING (.+?) /).flatten[0].to_sym

        IndexDefinition.new(table_name, index_name, unique, column_names, [], orders, where, nil, using)
      else
        IndexDefinition.new(table_name, index_name, unique, column_names, [], orders)
      end
    end
  end
  result.compact!
  result
end

#insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = []) ⇒ Object 



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 492

def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [])
  unless pk
    # Extract the table from the insert sql. Yuck.
    table_ref = extract_table_ref_from_insert_sql(sql)
    pk = primary_key(table_ref) if table_ref
  end

  if pk && use_insert_returning? # && id_value.nil?
    select_value("#{to_sql(sql, binds)} RETURNING #{quote_column_name(pk)}")
  else
    execute(sql, name, binds) # super
    unless id_value
      table_ref ||= extract_table_ref_from_insert_sql(sql)
      # If neither PK nor sequence name is given, look them up.
      if table_ref && ! ( pk ||= primary_key(table_ref) ) && ! sequence_name
        pk, sequence_name = pk_and_sequence_for(table_ref)
      end
      # If a PK is given, fallback to default sequence name.
      # Don't fetch last insert id for a table without a PK.
      if pk && sequence_name ||= default_sequence_name(table_ref, pk)
        id_value = last_insert_id(table_ref, sequence_name)
      end
    end
    id_value
  end
end

#last_insert_id(table, sequence_name = nil) ⇒ Object 



647
648
649
650
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 647

def last_insert_id(table, sequence_name = nil)
  sequence_name = table if sequence_name.nil? # AR-4.0 1 argument
  last_insert_id_result(sequence_name)
end

#last_insert_id_result(sequence_name) ⇒ Object 



652
653
654
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 652

def last_insert_id_result(sequence_name)
  select_value("SELECT currval('#{sequence_name}')", 'SQL')
end

#last_inserted_id(result) ⇒ Integer, NilClass

Take an id from the result of an INSERT query.

Returns:

  • (Integer, NilClass) 


639
640
641
642
643
644
645
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 639

def last_inserted_id(result)
  return nil if result.nil?
  return result if result.is_a? Integer
  # <ActiveRecord::Result @hash_rows=nil, @columns=["id"], @rows=[[3]]>
  # but it will work with [{ 'id' => 1 }] Hash wrapped results as well
  result.first.first[1] # .first = { "id"=>1 } .first = [ "id", 1 ]
end

#migration_keys ⇒ Object

Adds :array as a valid migration key.



254
255
256
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 254

def migration_keys
  super + [:array]
end

#multi_column_index_limit ⇒ Object

Gets the maximum number columns postgres has, default 32



757
758
759
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 757

def multi_column_index_limit
  defined?(@multi_column_index_limit) && @multi_column_index_limit || 32
end

#multi_column_index_limit=(limit) ⇒ Object

Sets the maximum number columns postgres has, default 32



762
763
764
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 762

def multi_column_index_limit=(limit)
  @multi_column_index_limit = limit
end

#native_database_types ⇒ Object 



241
242
243
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 241

def native_database_types
  NATIVE_DATABASE_TYPES
end

#pk_and_sequence_for(table) ⇒ Object

Find a table's primary key and sequence.



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 434

def pk_and_sequence_for(table)
  # try looking for a seq with a dependency on the table's primary key :
  result = select(<<-end_sql, 'PK and Serial Sequence')[0]
      SELECT attr.attname, seq.relname
      FROM pg_class      seq,
           pg_attribute  attr,
           pg_depend     dep,
           pg_constraint cons
      WHERE seq.oid           = dep.objid
        AND seq.relkind       = 'S'
        AND attr.attrelid     = dep.refobjid
        AND attr.attnum       = dep.refobjsubid
        AND attr.attrelid     = cons.conrelid
        AND attr.attnum       = cons.conkey[1]
        AND cons.contype      = 'p'
        AND dep.refobjid      = '#{quote_table_name(table)}'::regclass
    end_sql

  if result.nil? || result.empty?
    # if that fails, try parsing the primary key's default value :
    result = select(<<-end_sql, 'PK and Custom Sequence')[0]
        SELECT attr.attname,
          CASE
            WHEN pg_get_expr(def.adbin, def.adrelid) !~* 'nextval' THEN NULL
            WHEN split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2) ~ '.' THEN
              substr(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2),
                strpos(split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2), '.')+1)
            ELSE split_part(pg_get_expr(def.adbin, def.adrelid), '''', 2)
          END as relname
        FROM pg_class       t
        JOIN pg_attribute   attr ON (t.oid = attrelid)
        JOIN pg_attrdef     def  ON (adrelid = attrelid AND adnum = attnum)
        JOIN pg_constraint  cons ON (conrelid = adrelid AND adnum = conkey[1])
        WHERE t.oid = '#{quote_table_name(table)}'::regclass
          AND cons.contype = 'p'
          AND pg_get_expr(def.adbin, def.adrelid) ~* 'nextval|uuid_generate'
      end_sql
  end

  [ result['attname'], result['relname'] ]
rescue
  nil
end

#postgresql_version ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 48

def postgresql_version
  @postgresql_version ||=
    begin
      value = select_value('SELECT version()')
      if value =~ /PostgreSQL (\d+)\.(\d+)\.(\d+)/
        ($1.to_i * 10000) + ($2.to_i * 100) + $3.to_i
      else
        0
      end
    end
end

#prepare_column_options(column, types) ⇒ Object

Adds :array option to the default set provided by the AbstractAdapter.



246
247
248
249
250
251
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 246

def prepare_column_options(column, types)
  spec = super
  spec[:array] = 'true' if column.respond_to?(:array) && column.array
  spec[:default] = "\"#{column.default_function}\"" if column.default_function
  spec
end

#primary_key(table) ⇒ Object 



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 478

def primary_key(table)
  result = select(<<-end_sql, 'SCHEMA').first
    SELECT attr.attname
    FROM pg_attribute attr
    INNER JOIN pg_constraint cons ON attr.attrelid = cons.conrelid AND attr.attnum = cons.conkey[1]
    WHERE cons.contype = 'p'
      AND cons.conrelid = '#{quote_table_name(table)}'::regclass
  end_sql

  result && result['attname']
  # pk_and_sequence = pk_and_sequence_for(table)
  # pk_and_sequence && pk_and_sequence.first
end

#quote(value, column = nil) ⇒ String

Returns:

  • (String) 


809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 809

def quote(value, column = nil)
  return super unless column && column.type
  return value if sql_literal?(value)

  case value
  when Float
    if value.infinite? && ( column.type == :datetime || column.type == :timestamp )
      "'#{value.to_s.downcase}'"
    elsif value.infinite? || value.nan?
      "'#{value.to_s}'"
    else super
    end
  when Numeric
    if column.respond_to?(:sql_type) && column.sql_type == 'money'
      "'#{value}'"
    elsif column.type == :string || column.type == :text
      "'#{value}'"
    else super
    end
  when String
    return "E'#{escape_bytea(value)}'::bytea" if column.type == :binary
    return "xml '#{quote_string(value)}'" if column.type == :xml
    sql_type = column.respond_to?(:sql_type) && column.sql_type
    sql_type && sql_type[0, 3] == 'bit' ? quote_bit(value) : super
  when Array
    if AR4_COMPAT && column.array? # will be always falsy in AR < 4.0
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      "'#{column_class.array_to_string(value, column, self).gsub(/'/, "''")}'"
    elsif column.type == :json # only in AR-4.0
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      super(column_class.json_to_string(value), column)
    elsif column.type == :point # only in AR-4.0
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      super(column_class.point_to_string(value), column)
    else super
    end
  when Hash
    if column.type == :hstore # only in AR-4.0
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      super(column_class.hstore_to_string(value), column)
    elsif column.type == :json # only in AR-4.0
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      super(column_class.json_to_string(value), column)
    else super
    end
  when Range
    sql_type = column.respond_to?(:sql_type) && column.sql_type
    if sql_type && sql_type[-5, 5] == 'range' && AR4_COMPAT
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      escaped = quote_string(column_class.range_to_string(value))
      "'#{escaped}'::#{sql_type}"
    else super
    end
  when IPAddr
    if column.type == :inet || column.type == :cidr # only in AR-4.0
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      super(column_class.cidr_to_string(value), column)
    else super
    end
  else
    super
  end
end

#quote_bit(value) ⇒ String

Returns:

  • (String) 


885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 885

def quote_bit(value)
  case value
  # NOTE: as reported with #60 this is not quite "right" :
  #  "0103" will be treated as hexadecimal string
  #  "0102" will be treated as hexadecimal string
  #  "0101" will be treated as binary string
  #  "0100" will be treated as binary string
  # ... but is kept due Rails compatibility
  when /\A[01]*\Z/ then "B'#{value}'" # Bit-string notation
  when /\A[0-9A-F]*\Z/i then "X'#{value}'" # Hexadecimal notation
  end
end

#quote_column_name(name) ⇒ Object 



931
932
933
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 931

def quote_column_name(name)
  %("#{name.to_s.gsub("\"", "\"\"")}")
end

#quote_string(string) ⇒ String

Quotes a string, escaping any ' (single quote) and \ (backslash) chars.

Returns:

  • (String) 


876
877
878
879
880
881
882
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 876

def quote_string(string)
  quoted = string.gsub("'", "''")
  unless standard_conforming_strings?
    quoted.gsub!(/\\/, '\&\&')
  end
  quoted
end

#quote_table_name(name) ⇒ Object 



914
915
916
917
918
919
920
921
922
923
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 914

def quote_table_name(name)
  schema, name_part = extract_pg_identifier_from_name(name.to_s)

  unless name_part
    quote_column_name(schema)
  else
    table_name, name_part = extract_pg_identifier_from_name(name_part)
    "#{quote_column_name(schema)}.#{quote_column_name(table_name)}"
  end
end

#quote_table_name_for_assignment(table, attr) ⇒ Object 



926
927
928
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 926

def quote_table_name_for_assignment(table, attr)
  quote_column_name(attr)
end

#quoted_date(value) ⇒ Object

Quote date/time values for use in SQL input. Includes microseconds if the value is a Time responding to usec.



948
949
950
951
952
953
954
955
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 948

def quoted_date(value)
  result = super
  if value.acts_like?(:time) && value.respond_to?(:usec)
    result = "#{result}.#{sprintf("%06d", value.usec)}"
  end
  result = "#{result.sub(/^-/, '')} BC" if value.year < 0
  result
end

#recreate_database(name, options = {}) ⇒ Object 



656
657
658
659
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 656

def recreate_database(name, options = {})
  drop_database(name)
  create_database(name, options)
end

#release_savepoint(name = current_savepoint_name) ⇒ Object 



361
362
363
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 361

def release_savepoint(name = current_savepoint_name)
  log("RELEASE SAVEPOINT #{name}", 'Savepoint') { super }
end

#remove_index!(table_name, index_name) ⇒ Object 



1066
1067
1068
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1066

def remove_index!(table_name, index_name)
  execute "DROP INDEX #{quote_table_name(index_name)}"
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object

unless const_defined? :SchemaCreation



1056
1057
1058
1059
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1056

def rename_column(table_name, column_name, new_column_name)
  execute "ALTER TABLE #{quote_table_name(table_name)} RENAME COLUMN #{quote_column_name(column_name)} TO #{quote_column_name(new_column_name)}"
  rename_column_indexes(table_name, column_name, new_column_name) if respond_to?(:rename_column_indexes) # AR-4.0 SchemaStatements
end

#rename_index(table_name, old_name, new_name) ⇒ Object 



1070
1071
1072
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1070

def rename_index(table_name, old_name, new_name)
  execute "ALTER INDEX #{quote_column_name(old_name)} RENAME TO #{quote_table_name(new_name)}"
end

#rename_table(table_name, new_name) ⇒ Object 



981
982
983
984
985
986
987
988
989
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 981

def rename_table(table_name, new_name)
  execute "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}"
  pk, seq = pk_and_sequence_for(new_name)
  if seq == "#{table_name}_#{pk}_seq"
    new_seq = "#{new_name}_#{pk}_seq"
    execute "ALTER TABLE #{quote_table_name(seq)} RENAME TO #{quote_table_name(new_seq)}"
  end
  rename_table_indexes(table_name, new_name) if respond_to?(:rename_table_indexes) # AR-4.0 SchemaStatements
end

#reset_pk_sequence!(table, pk = nil, sequence = nil) ⇒ Object

Resets sequence to the max value of the table's primary key if present.



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 419

def reset_pk_sequence!(table, pk = nil, sequence = nil)
  if ! pk || ! sequence
    default_pk, default_sequence = pk_and_sequence_for(table)
    pk ||= default_pk; sequence ||= default_sequence
  end
  if pk && sequence
    quoted_sequence = quote_column_name(sequence)

    select_value <<-end_sql, 'Reset Sequence'
      SELECT setval('#{quoted_sequence}', (SELECT COALESCE(MAX(#{quote_column_name pk})+(SELECT increment_by FROM #{quoted_sequence}), (SELECT min_value FROM #{quoted_sequence})) FROM #{quote_table_name(table)}), false)
    end_sql
  end
end

#rollback_to_savepoint(name = current_savepoint_name) ⇒ Object 



356
357
358
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 356

def rollback_to_savepoint(name = current_savepoint_name)
  log("ROLLBACK TO SAVEPOINT #{name}", 'Savepoint') { super }
end

#schema_creation ⇒ Object 



37
38
39
 
# File 'lib/arjdbc/postgresql/schema_creation.rb', line 37

def schema_creation
  SchemaCreation.new self
end

#schema_exists?(name) ⇒ Boolean

Returns true if schema exists.

Returns:

  • (Boolean) 


581
582
583
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 581

def schema_exists?(name)
  select_value("SELECT COUNT(*) FROM pg_namespace WHERE nspname = '#{name}'", 'SCHEMA').to_i > 0
end

#schema_names ⇒ Object

Returns an array of schema names.



572
573
574
575
576
577
578
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 572

def schema_names
  select_values(
    "SELECT nspname FROM pg_namespace" <<
    " WHERE nspname !~ '^pg_.*' AND nspname NOT IN ('information_schema')" <<
    " ORDER by nspname;",
  'SCHEMA')
end

#schema_search_path ⇒ Object

Returns the active schema search path.



621
622
623
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 621

def schema_search_path
  @schema_search_path ||= select_value('SHOW search_path', 'SCHEMA')
end

#schema_search_path=(schema_csv) ⇒ Object

Sets the schema search path to a string of comma-separated schema names. Names beginning with $ have to be quoted (e.g. $user => '$user'). See: http://www.postgresql.org/docs/current/static/ddl-schemas.html

This should be not be called manually but set in database.yml.



630
631
632
633
634
635
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 630

def schema_search_path=(schema_csv)
  if schema_csv
    execute "SET search_path TO #{schema_csv}"
    @schema_search_path = schema_csv
  end
end

#session_auth=(user) ⇒ Object

Set the authorized user for this session.



399
400
401
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 399

def session_auth=(user)
  execute "SET SESSION AUTHORIZATION #{user}"
end

#set_client_encoding(encoding) ⇒ Object 



67
68
69
70
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 67

def set_client_encoding(encoding)
  ActiveRecord::Base.logger.warn "client_encoding is set by the driver and should not be altered, ('#{encoding}' ignored)"
  ActiveRecord::Base.logger.debug "Set the 'allowEncodingChanges' driver property (e.g. using config[:properties]) if you need to override the client encoding when doing a copy."
end

#set_standard_conforming_strings ⇒ Object

Enable standard-conforming strings if available.



259
260
261
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 259

def set_standard_conforming_strings
  self.standard_conforming_strings=(true)
end

#sql_for_insert(sql, pk, id_value, sequence_name, binds) ⇒ Object 



520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 520

def sql_for_insert(sql, pk, id_value, sequence_name, binds)
  unless pk
    # Extract the table from the insert sql. Yuck.
    table_ref = extract_table_ref_from_insert_sql(sql)
    pk = primary_key(table_ref) if table_ref
  end

  if pk && use_insert_returning?
    sql = "#{sql} RETURNING #{quote_column_name(pk)}"
  end

  [ sql, binds ]
end

#standard_conforming_strings=(enable) ⇒ Object

Enable standard-conforming strings if available.



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 264

def standard_conforming_strings=(enable)
  client_min_messages = self.client_min_messages
  begin
    self.client_min_messages = 'panic'
    value = enable ? "on" : "off"
    execute("SET standard_conforming_strings = #{value}", 'SCHEMA')
    @standard_conforming_strings = ( value == "on" )
  rescue
    @standard_conforming_strings = :unsupported
  ensure
    self.client_min_messages = client_min_messages
  end
end

#standard_conforming_strings? ⇒ Boolean

Returns:

  • (Boolean) 


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 278

def standard_conforming_strings?
  if @standard_conforming_strings.nil?
    client_min_messages = self.client_min_messages
    begin
      self.client_min_messages = 'panic'
      value = select_one('SHOW standard_conforming_strings', 'SCHEMA')['standard_conforming_strings']
      @standard_conforming_strings = ( value == "on" )
    rescue
      @standard_conforming_strings = :unsupported
    ensure
      self.client_min_messages = client_min_messages
    end
  end
  @standard_conforming_strings == true # return false if :unsupported
end

#structure_dump ⇒ Object

Deprecated.

no longer used - handled with (AR built-in) Rake tasks



719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 719

def structure_dump
  database = @config[:database]
  if database.nil?
    if @config[:url] =~ /\/([^\/]*)$/
      database = $1
    else
      raise "Could not figure out what database this url is for #{@config["url"]}"
    end
  end

  ENV['PGHOST']     = @config[:host] if @config[:host]
  ENV['PGPORT']     = @config[:port].to_s if @config[:port]
  ENV['PGPASSWORD'] = @config[:password].to_s if @config[:password]
  search_path = "--schema=#{@config[:schema_search_path]}" if @config[:schema_search_path]

  @connection.connection.close
  begin
    definition = `pg_dump -i -U "#{@config[:username]}" -s -x -O #{search_path} #{database}`
    raise "Error dumping database" if $?.exitstatus == 1

    # need to patch away any references to SQL_ASCII as it breaks the JDBC driver
    definition.gsub(/SQL_ASCII/, 'UNICODE')
  ensure
    reconnect!
  end
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


318
319
320
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 318

def supports_ddl_transactions?
  true
end

#supports_disable_referential_integrity? ⇒ Boolean

Returns:

  • (Boolean) 


958
959
960
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 958

def supports_disable_referential_integrity?
  true
end

#supports_extensions? ⇒ Boolean

Returns:

  • (Boolean) 


365
366
367
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 365

def supports_extensions?
  postgresql_version >= 90200
end

#supports_hex_escaped_bytea? ⇒ Boolean

Returns:

  • (Boolean) 


310
311
312
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 310

def supports_hex_escaped_bytea?
  postgresql_version >= 90000
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


326
327
328
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 326

def supports_index_sort_order?
  true
end

#supports_insert_with_returning? ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 314

def supports_insert_with_returning?
  postgresql_version >= 80200
end

#supports_migrations? ⇒ Boolean

Does PostgreSQL support migrations?

Returns:

  • (Boolean) 


295
296
297
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 295

def supports_migrations?
  true
end

#supports_partial_index? ⇒ Boolean

Returns:

  • (Boolean) 


330
331
332
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 330

def supports_partial_index?
  true
end

#supports_primary_key? ⇒ Boolean

Does PostgreSQL support finding primary key on non-Active Record tables?

Returns:

  • (Boolean) 


300
301
302
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 300

def supports_primary_key?
  true
end

#supports_ranges? ⇒ Boolean

Range data-types weren't introduced until PostgreSQL 9.2.

Returns:

  • (Boolean) 


335
336
337
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 335

def supports_ranges?
  postgresql_version >= 90200
end

#supports_savepoints? ⇒ Boolean

Returns:

  • (Boolean) 


346
347
348
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 346

def supports_savepoints?
  true
end

#supports_standard_conforming_strings? ⇒ Boolean

Does PostgreSQL support standard conforming strings?

Returns:

  • (Boolean) 


305
306
307
308
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 305

def supports_standard_conforming_strings?
  standard_conforming_strings?
  @standard_conforming_strings != :unsupported
end

#supports_transaction_isolation?(level = nil) ⇒ Boolean

Returns:

  • (Boolean) 


322
323
324
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 322

def supports_transaction_isolation?
  true
end

#table_alias_length ⇒ Object

Returns the configured supported identifier length supported by PostgreSQL, or report the default of 63 on PostgreSQL 7.x.



405
406
407
408
409
410
411
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 405

def table_alias_length
  @table_alias_length ||= (
    postgresql_version >= 80000 ?
      select_one('SHOW max_identifier_length')['max_identifier_length'].to_i :
        63
  )
end

#table_exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1132

def table_exists?(name)
  schema, table = extract_schema_and_table(name.to_s)
  return false unless table # abstract classes - nil table name

  binds = [[ nil, table.gsub(/(^"|"$)/,'') ]]
  binds << [ nil, schema ] if schema
  sql = <<-SQL
    SELECT COUNT(*) as table_count
    FROM pg_tables
    WHERE tablename = ?
    AND schemaname = #{schema ? "?" : "ANY (current_schemas(false))"}
  SQL

  log(sql, 'SCHEMA', binds) do
    @connection.execute_query_raw(sql, binds).first["table_count"] > 0
  end
end

#tables(name = nil) ⇒ Object 



1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 1124

def tables(name = nil)
  select_values(<<-SQL, 'SCHEMA')
    SELECT tablename
    FROM pg_tables
    WHERE schemaname = ANY (current_schemas(false))
  SQL
end

#type_cast(value, column, array_member = false) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 149

def type_cast(value, column, array_member = false)
  return super(value, nil) unless column

  case value
  when String
    return super(value, column) unless 'bytea' == column.sql_type
    value # { :value => value, :format => 1 }
  when Array
    case column.sql_type
    when 'point'
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      column_class.point_to_string(value)
    when 'json'
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      column_class.json_to_string(value)
    else
      return super(value, column) unless column.array?
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      column_class.array_to_string(value, column, self)
    end
  when NilClass
    if column.array? && array_member
      'NULL'
    elsif column.array?
      value
    else
      super(value, column)
    end
  when Hash
    case column.sql_type
    when 'hstore'
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      column_class.hstore_to_string(value)
    when 'json'
      column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
      column_class.json_to_string(value)
    else super(value, column)
    end
  when IPAddr
    return super unless column.sql_type == 'inet' || column.sql_type == 'cidr'
    column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
    column_class.cidr_to_string(value)
  when Range
    return super(value, column) unless /range$/ =~ column.sql_type
    column_class = ::ActiveRecord::ConnectionAdapters::PostgreSQLColumn
    column_class.range_to_string(value)
  else
    super(value, column)
  end
end

#type_to_sql(type, limit = nil, precision = nil, scale = nil) ⇒ Object

Maps logical Rails types to PostgreSQL-specific data types.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 112

def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  case type.to_sym
  when :'binary'
    # PostgreSQL doesn't support limits on binary (bytea) columns.
    # The hard limit is 1Gb, because of a 32-bit size field, and TOAST.
    case limit
    when nil, 0..0x3fffffff; super(type, nil, nil, nil)
    else raise(ActiveRecordError, "No binary type has byte size #{limit}.")
    end
  when :'text'
    # PostgreSQL doesn't support limits on text columns.
    # The hard limit is 1Gb, according to section 8.3 in the manual.
    case limit
    when nil, 0..0x3fffffff; super(type, nil, nil, nil)
    else raise(ActiveRecordError, "The limit on text can be at most 1GB - 1byte.")
    end
  when :'integer'
    return 'integer' unless limit

    case limit
      when 1, 2; 'smallint'
      when 3, 4; 'integer'
      when 5..8; 'bigint'
      else raise(ActiveRecordError, "No integer type has byte size #{limit}. Use a numeric with precision 0 instead.")
    end
  when :'datetime'
    return super unless precision

    case precision
      when 0..6; "timestamp(#{precision})"
      else raise(ActiveRecordError, "No timestamp type has precision of #{precision}. The allowed range of precision is from 0 to 6")
    end
  else
    super
  end
end

#use_insert_returning? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
63
64
65
 
# File 'lib/arjdbc/postgresql/adapter.rb', line 60

def use_insert_returning?
  if @use_insert_returning.nil?
    @use_insert_returning = supports_insert_with_returning?
  end
  @use_insert_returning
end