Class: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter

Inherits:
AbstractAdapter
  • Object
show all
Defined in:
lib/active_record/connection_adapters/postgresql_adapter.rb

Overview

The PostgreSQL adapter works both with the native C (ruby.scripting.ca/postgres/) and the pure Ruby (available both as gem and from rubyforge.org/frs/?group_id=234&release_id=1944) drivers.

Options:

  • :host - Defaults to “localhost”.

  • :port - Defaults to 5432.

  • :username - Defaults to nothing.

  • :password - Defaults to nothing.

  • :database - The name of the database. No default, must be provided.

  • :schema_search_path - An optional schema search path for the connection given as a string of comma-separated schema names. This is backward-compatible with the :schema_order option.

  • :encoding - An optional client encoding that is used in a SET client_encoding TO <encoding> call on the connection.

  • :min_messages - An optional client min messages that is used in a SET client_min_messages TO <min_messages> call on the connection.

  • :allow_concurrency - If true, use async query methods so Ruby threads don’t deadlock; otherwise, use blocking query methods.

Constant Summary collapse

ADAPTER_NAME = 
'PostgreSQL'.freeze
NATIVE_DATABASE_TYPES = 
{
  :primary_key => "serial primary key".freeze,
  :string      => { :name => "character varying", :limit => 255 },
  :text        => { :name => "text" },
  :integer     => { :name => "integer" },
  :float       => { :name => "float" },
  :decimal     => { :name => "decimal" },
  :datetime    => { :name => "timestamp" },
  :timestamp   => { :name => "timestamp" },
  :time        => { :name => "time" },
  :date        => { :name => "date" },
  :binary      => { :name => "bytea" },
  :boolean     => { :name => "boolean" },
  :xml         => { :name => "xml" }
}

Instance Attribute Summary

Attributes included from QueryCache

#query_cache, #query_cache_enabled

Instance Method Summary collapse

Methods inherited from AbstractAdapter

#current_savepoint_name, #decrement_open_transactions, #increment_open_transactions, #log_info, #open_transactions, #prefetch_primary_key?, #raw_connection, #requires_reloading?, #reset!, #reset_runtime, #supports_count_distinct?, #transaction_joinable=, #verify!

Methods included from QueryCache

#cache, #clear_query_cache, #columns_with_query_cache, dirties_query_cache, included, #select_all_with_query_cache, #uncached

Methods included from DatabaseLimits

#column_name_length, #columns_per_multicolumn_index, #columns_per_table, #in_clause_length, #indexes_per_table, #joins_per_query, #sql_query_length, #table_name_length

Methods included from Quoting

#quoted_false, #quoted_true

Methods included from DatabaseStatements

#add_limit!, #add_limit_offset!, #add_lock!, #case_sensitive_equality_operator, #delete, #empty_insert_statement, #insert_fixture, #limited_update_conditions, #reset_sequence!, #select_all, #select_one, #select_value, #select_values, #transaction, #update

Methods included from SchemaStatements

#add_column_options!, #add_index, #add_timestamps, #assume_migrated_upto_version, #change_table, #create_table, #drop_table, #dump_schema_information, #index_exists?, #index_name, #initialize_schema_migrations_table, #remove_column, #remove_index, #remove_timestamps, #rename_index, #structure_dump, #table_alias_for, #table_exists?

Constructor Details

#initialize(connection, logger, connection_parameters, config) ⇒ PostgreSQLAdapter

Initializes and connects a PostgreSQL adapter.



213
214
215
216
217
218
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 213

def initialize(connection, logger, connection_parameters, config)
  super(connection, logger)
  @connection_parameters, @config = connection_parameters, config

  connect
end

Instance Method Details

#active? ⇒ Boolean

Is this connection alive and ready for queries?

Returns:

  • (Boolean) 


221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 221

def active?
  if @connection.respond_to?(:status)
    @connection.status == PGconn::CONNECTION_OK
  else
    # We're asking the driver, not ActiveRecord, so use @connection.query instead of #query
    @connection.query 'SELECT 1'
    true
  end
# postgres-pr raises a NoMethodError when querying if no connection is available.
rescue PGError, NoMethodError
  false
end

#adapter_name ⇒ Object

Returns ‘PostgreSQL’ as adapter name for identification purposes.



208
209
210
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 208

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.



808
809
810
811
812
813
814
815
816
817
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 808

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

  # Add the column.
  execute("ALTER TABLE #{quote_table_name(table_name)} ADD COLUMN #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}")

  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_order_by_for_association_limiting!(sql, options) ⇒ Object

Returns an 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 string as a sub-select and ordering in that query.



907
908
909
910
911
912
913
914
915
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 907

def add_order_by_for_association_limiting!(sql, options) #:nodoc:
  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

#begin_db_transaction ⇒ Object

Begins a transaction.



535
536
537
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 535

def begin_db_transaction
  execute "BEGIN"
end

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

Changes the column of a table.



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 820

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

  begin
    execute "ALTER TABLE #{quoted_table_name} ALTER COLUMN #{quote_column_name(column_name)} TYPE #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
  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 #{type_to_sql(type, options[:limit], options[:precision], options[:scale])})"
      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.



846
847
848
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 846

def change_column_default(table_name, column_name, default)
  execute "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} SET DEFAULT #{quote(default)}"
end

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



850
851
852
853
854
855
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 850

def change_column_null(table_name, column_name, null, default = nil)
  unless null || default.nil?
    execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
  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.



711
712
713
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 711

def client_min_messages
  query('SHOW client_min_messages')[0][0]
end

#client_min_messages=(level) ⇒ Object

Set the client message level.



716
717
718
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 716

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

#columns(table_name, name = nil) ⇒ Object

Returns the list of all column definitions for a table.



673
674
675
676
677
678
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 673

def columns(table_name, name = nil)
  # Limit, precision, and scale are all handled by the superclass.
  column_definitions(table_name).collect do |name, type, default, notnull|
    PostgreSQLColumn.new(name, default, type, notnull == 'f')
  end
end

#commit_db_transaction ⇒ Object

Commits a transaction.



540
541
542
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 540

def commit_db_transaction
  execute "COMMIT"
end

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

Create a new PostgreSQL database. Options include :owner, :template, :encoding, :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'



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 583

def create_database(name, options = {})
  options = options.reverse_merge(:encoding => "utf8")

  option_string = options.symbolize_keys.sum do |key, value|
    case key
    when :owner
      " OWNER = \"#{value}\""
    when :template
      " TEMPLATE = \"#{value}\""
    when :encoding
      " ENCODING = '#{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 ⇒ Object 



557
558
559
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 557

def create_savepoint
  execute("SAVEPOINT #{current_savepoint_name}")
end

#current_database ⇒ Object

Returns the current database name.



681
682
683
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 681

def current_database
  query('select current_database()')[0][0]
end

#default_sequence_name(table_name, pk = nil) ⇒ Object

Returns the sequence name for a table’s primary key or some other specified key.



721
722
723
724
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 721

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

#disable_referential_integrity(&block) ⇒ Object

:nodoc:



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 432

def disable_referential_integrity(&block) #:nodoc:
  if supports_disable_referential_integrity?() then
    execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL" }.join(";"))
  end
  yield
ensure
  if supports_disable_referential_integrity?() then
    execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER ALL" }.join(";"))
  end
end

#disconnect! ⇒ Object

Close the connection.



246
247
248
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 246

def disconnect!
  @connection.close rescue nil
end

#distinct(columns, order_by) ⇒ Object

Returns a SELECT DISTINCT clause for a given set of columns and a given ORDER BY clause.

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

distinct("posts.id", "posts.created_at desc")



888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 888

def distinct(columns, order_by) #:nodoc:
  return "DISTINCT #{columns}" if order_by.blank?

  # Construct a clean list of column names from the ORDER BY clause, removing
  # any ASC/DESC modifiers
  order_columns = order_by.split(',').collect { |s| s.split.first }
  order_columns.delete_if &:blank?
  order_columns = order_columns.zip((0...order_columns.size).to_a).map { |s,i| "#{s} AS alias_#{i}" }

  # Return a DISTINCT ON() clause that's distinct on the columns we want but includes
  # all the required columns for the ORDER BY to work properly.
  sql = "DISTINCT ON (#{columns}) #{columns}, "
  sql << order_columns * ', '
end

#drop_database(name) ⇒ Object

Drops a PostgreSQL database

Example:

drop_database 'matt_development'



610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 610

def drop_database(name) #:nodoc:
  if postgresql_version >= 80200
    execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
  else
    begin
      execute "DROP DATABASE #{quote_table_name(name)}"
    rescue ActiveRecord::StatementInvalid
      @logger.warn "#{name} database doesn't exist." if @logger
    end
  end
end

#encoding ⇒ Object

Returns the current database encoding format.



686
687
688
689
690
691
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 686

def encoding
  query(<<-end_sql)[0][0]
    SELECT pg_encoding_to_char(pg_database.encoding) FROM pg_database
    WHERE pg_database.datname LIKE '#{current_database}'
  end_sql
end

#escape_bytea(original_value) ⇒ Object

Escapes binary strings for bytea input to the database.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 293

def escape_bytea(original_value)
  if @connection.respond_to?(:escape_bytea)
    self.class.instance_eval do
      define_method(:escape_bytea) do |value|
        @connection.escape_bytea(value) if value
      end
    end
  elsif PGconn.respond_to?(:escape_bytea)
    self.class.instance_eval do
      define_method(:escape_bytea) do |value|
        PGconn.escape_bytea(value) if value
      end
    end
  else
    self.class.instance_eval do
      define_method(:escape_bytea) do |value|
        if value
          result = ''
          value.each_byte { |c| result << sprintf('\\\\%03o', c) }
          result
        end
      end
    end
  end
  escape_bytea(original_value)
end

#execute(sql, name = nil) ⇒ Object

Executes an SQL statement, returning a PGresult object on success or raising a PGError exception otherwise.



519
520
521
522
523
524
525
526
527
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 519

def execute(sql, name = nil)
  log(sql, name) do
    if @async
      @connection.async_exec(sql)
    else
      @connection.exec(sql)
    end
  end
end

#index_name_length ⇒ Object 



866
867
868
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 866

def index_name_length
  63
end

#indexes(table_name, name = nil) ⇒ Object

Returns the list of all indexes for a table.



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 634

def indexes(table_name, name = nil)
   schemas = schema_search_path.split(/,/).map { |p| quote(p) }.join(',')
   result = query(<<-SQL, name)
     SELECT distinct i.relname, d.indisunique, d.indkey, t.oid
       FROM pg_class t, pg_class i, pg_index d
     WHERE i.relkind = 'i'
       AND d.indexrelid = i.oid
       AND d.indisprimary = 'f'
       AND t.oid = d.indrelid
       AND t.relname = '#{table_name}'
       AND i.relnamespace IN (SELECT oid FROM pg_namespace WHERE nspname IN (#{schemas}) )
    ORDER BY i.relname
  SQL


  indexes = []

  indexes = result.map do |row|
    index_name = row[0]
    unique = row[1] == 't'
    indkey = row[2].split(" ")
    oid = row[3]

    columns = query(<<-SQL, "Columns for index #{row[0]} on #{table_name}").inject({}) {|attlist, r| attlist[r[1]] = r[0]; attlist}
    SELECT a.attname, a.attnum
    FROM pg_attribute a
    WHERE a.attrelid = #{oid}
    AND a.attnum IN (#{indkey.join(",")})
    SQL

    column_names = indkey.map {|attnum| columns[attnum] }
    IndexDefinition.new(table_name, index_name, unique, column_names)

  end

  indexes
end

#insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) ⇒ Object

Executes an INSERT query and returns the new record’s ID



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
477
478
479
480
481
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 452

def insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
  # Extract the table from the insert sql. Yuck.
  table = sql.split(" ", 4)[2].gsub('"', '')

  # Try an insert with 'returning id' if available (PG >= 8.2)
  if supports_insert_with_returning?
    pk, sequence_name = *pk_and_sequence_for(table) unless pk
    if pk
      id = select_value("#{sql} RETURNING #{quote_column_name(pk)}")
      clear_query_cache
      return id
    end
  end

  # Otherwise, insert then grab last_insert_id.
  if insert_id = super
    insert_id
  else
    # If neither pk nor sequence name is given, look them up.
    unless pk || sequence_name
      pk, sequence_name = *pk_and_sequence_for(table)
    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, pk)
      last_insert_id(table, sequence_name)
    end
  end
end

#native_database_types ⇒ Object

:nodoc:



250
251
252
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 250

def native_database_types #:nodoc:
  NATIVE_DATABASE_TYPES
end

#outside_transaction? ⇒ Boolean

The ruby-pg driver supports inspecting the transaction status, while the ruby-postgres driver does not.

Returns:

  • (Boolean) 


552
553
554
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 552

def outside_transaction?
  @connection.transaction_status == PGconn::PQTRANS_IDLE
end

#pk_and_sequence_for(table) ⇒ Object

Returns a table’s primary key and belonging sequence.



747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 747

def pk_and_sequence_for(table) #:nodoc:
  # First try looking for a sequence with a dependency on the
  # given table's primary key.
  result = query(<<-end_sql, 'PK and serial sequence')[0]
    SELECT attr.attname, seq.relname
    FROM pg_class      seq,
         pg_attribute  attr,
         pg_depend     dep,
         pg_namespace  name,
         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? or result.empty?
    # If that fails, try parsing the primary key's default value.
    # Support the 7.x and 8.0 nextval('foo'::text) as well as
    # the 8.1+ nextval('foo'::regclass).
    result = query(<<-end_sql, 'PK and custom sequence')[0]
      SELECT attr.attname,
        CASE
          WHEN split_part(def.adsrc, '''', 2) ~ '.' THEN
            substr(split_part(def.adsrc, '''', 2),
                   strpos(split_part(def.adsrc, '''', 2), '.')+1)
          ELSE split_part(def.adsrc, '''', 2)
        END
      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 def.adsrc ~* 'nextval'
    end_sql
  end

  # [primary_key, sequence]
  [result.first, result.last]
rescue
  nil
end

#primary_key(table) ⇒ Object

Returns just a table’s primary key



796
797
798
799
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 796

def primary_key(table)
  pk_and_sequence = pk_and_sequence_for(table)
  pk_and_sequence && pk_and_sequence.first
end

#query(sql, name = nil) ⇒ Object

Queries the database and returns the results in an Array-like object



506
507
508
509
510
511
512
513
514
515
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 506

def query(sql, name = nil) #:nodoc:
  log(sql, name) do
    if @async
      res = @connection.async_exec(sql)
    else
      res = @connection.exec(sql)
    end
    return result_as_array(res)
  end
end

#quote(value, column = nil) ⇒ Object

Quotes PostgreSQL-specific data types for SQL input.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 345

def quote(value, column = nil) #:nodoc:
  if value.kind_of?(String) && column && column.type == :binary
    "'#{escape_bytea(value)}'"
  elsif value.kind_of?(String) && column && column.sql_type == 'xml'
    "xml '#{quote_string(value)}'"
  elsif value.kind_of?(Numeric) && column && column.sql_type == 'money'
    # Not truly string input, so doesn't require (or allow) escape string syntax.
    "'#{value.to_s}'"
  elsif value.kind_of?(String) && column && column.sql_type =~ /^bit/
    case value
      when /^[01]*$/
        "B'#{value}'" # Bit-string notation
      when /^[0-9A-F]*$/i
        "X'#{value}'" # Hexadecimal notation
    end
  else
    super
  end
end

#quote_column_name(name) ⇒ Object

Quotes column names for use in SQL queries.



409
410
411
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 409

def quote_column_name(name) #:nodoc:
  PGconn.quote_ident(name.to_s)
end

#quote_string(original_value) ⇒ Object

Quotes strings for use in SQL input in the postgres driver for better performance.



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 366

def quote_string(original_value) #:nodoc:
  if @connection.respond_to?(:escape)
    self.class.instance_eval do
      define_method(:quote_string) do |s|
        @connection.escape(s)
      end
    end
  elsif PGconn.respond_to?(:escape)
    self.class.instance_eval do
      define_method(:quote_string) do |s|
        PGconn.escape(s)
      end
    end
  else
    # There are some incorrectly compiled postgres drivers out there
    # that don't define PGconn.escape.
    self.class.instance_eval do
      remove_method(:quote_string)
    end
  end
  quote_string(original_value)
end

#quote_table_name(name) ⇒ Object

Checks the following cases:

  • table_name

  • “table.name”

  • schema_name.table_name

  • schema_name.“table.name”

  • “schema.name”.table_name

  • “schema.name”.“table.name”



397
398
399
400
401
402
403
404
405
406
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 397

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

#quoted_date(value) ⇒ Object

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



415
416
417
418
419
420
421
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 415

def quoted_date(value) #:nodoc:
  if value.acts_like?(:time) && value.respond_to?(:usec)
    "#{super}.#{sprintf("%06d", value.usec)}"
  else
    super
  end
end

#reconnect! ⇒ Object

Close then reopen the connection.



235
236
237
238
239
240
241
242
243
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 235

def reconnect!
  if @connection.respond_to?(:reset)
    @connection.reset
    configure_connection
  else
    disconnect!
    connect
  end
end

#recreate_database(name) ⇒ Object

SCHEMA STATEMENTS ========================================



571
572
573
574
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 571

def recreate_database(name) #:nodoc:
  drop_database(name)
  create_database(name)
end

#release_savepoint ⇒ Object 



565
566
567
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 565

def release_savepoint
  execute("RELEASE SAVEPOINT #{current_savepoint_name}")
end

#remove_index!(table_name, index_name) ⇒ Object

:nodoc:



862
863
864
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 862

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

#rename_column(table_name, column_name, new_column_name) ⇒ Object

Renames a column in a table.



858
859
860
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 858

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)}"
end

#rename_table(name, new_name) ⇒ Object

Renames a table.



802
803
804
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 802

def rename_table(name, new_name)
  execute "ALTER TABLE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}"
end

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

Resets the sequence of a table’s primary key to the maximum value.



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 727

def reset_pk_sequence!(table, pk = nil, sequence = nil) #:nodoc:
  unless pk and sequence
    default_pk, default_sequence = pk_and_sequence_for(table)
    pk ||= default_pk
    sequence ||= default_sequence
  end
  if pk
    if 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
    else
      @logger.warn "#{table} has primary key #{pk} with no default sequence" if @logger
    end
  end
end

#result_as_array(res) ⇒ Object

create a 2D array representing the result set



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 484

def result_as_array(res) #:nodoc:
  # check if we have any binary column and if they need escaping
  unescape_col = []
  for j in 0...res.nfields do
    # unescape string passed BYTEA field (OID == 17)
    unescape_col << ( res.ftype(j)==17 )
  end

  ary = []
  for i in 0...res.ntuples do
    ary << []
    for j in 0...res.nfields do
      data = res.getvalue(i,j)
      data = unescape_bytea(data) if unescape_col[j] and data.is_a?(String)
      ary[i] << data
    end
  end
  return ary
end

#rollback_db_transaction ⇒ Object

Aborts a transaction.



545
546
547
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 545

def rollback_db_transaction
  execute "ROLLBACK"
end

#rollback_to_savepoint ⇒ Object 



561
562
563
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 561

def rollback_to_savepoint
  execute("ROLLBACK TO SAVEPOINT #{current_savepoint_name}")
end

#schema_search_path ⇒ Object

Returns the active schema search path.



706
707
708
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 706

def schema_search_path
  @schema_search_path ||= query('SHOW search_path')[0][0]
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: www.postgresql.org/docs/current/static/ddl-schemas.html

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



698
699
700
701
702
703
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 698

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

#select_rows(sql, name = nil) ⇒ Object

Executes a SELECT query and returns an array of rows. Each row is an array of field values.



447
448
449
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 447

def select_rows(sql, name = nil)
  select_raw(sql, name).last
end

#set_standard_conforming_strings ⇒ Object

Enable standard-conforming strings if available.



265
266
267
268
269
270
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 265

def set_standard_conforming_strings
  old, self.client_min_messages = client_min_messages, 'panic'
  execute('SET standard_conforming_strings = on') rescue nil
ensure
  self.client_min_messages = old
end

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 276

def supports_ddl_transactions?
  true
end

#supports_disable_referential_integrity? ⇒ Boolean

REFERENTIAL INTEGRITY ====================================

Returns:

  • (Boolean) 


425
426
427
428
429
430
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 425

def supports_disable_referential_integrity?() #:nodoc:
  version = query("SHOW server_version")[0][0].split('.')
  (version[0].to_i >= 8 && version[1].to_i >= 1) ? true : false
rescue
  return false
end

#supports_insert_with_returning? ⇒ Boolean

Returns:

  • (Boolean) 


272
273
274
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 272

def supports_insert_with_returning?
  postgresql_version >= 80200
end

#supports_migrations? ⇒ Boolean

Does PostgreSQL support migrations?

Returns:

  • (Boolean) 


255
256
257
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 255

def supports_migrations?
  true
end

#supports_primary_key? ⇒ Boolean

Does PostgreSQL support finding primary key on non-ActiveRecord tables?

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 260

def supports_primary_key? #:nodoc:
  true
end

#supports_savepoints? ⇒ Boolean

Returns:

  • (Boolean) 


280
281
282
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 280

def supports_savepoints?
  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.



286
287
288
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 286

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

#tables(name = nil) ⇒ Object

Returns the list of all tables in the schema search path or a specified schema.



624
625
626
627
628
629
630
631
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 624

def tables(name = nil)
  schemas = schema_search_path.split(/,/).map { |p| quote(p) }.join(',')
  query(<<-SQL, name).map { |row| row[0] }
    SELECT tablename
      FROM pg_tables
     WHERE schemaname IN (#{schemas})
  SQL
end

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

Maps logical Rails types to PostgreSQL-specific data types.



871
872
873
874
875
876
877
878
879
880
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 871

def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  return super unless type.to_s == 'integer'

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

#unescape_bytea(original_value) ⇒ Object

Unescapes bytea output from a database to the binary string it represents. NOTE: This is NOT an inverse of escape_bytea! This is only to be used

on escaped binary output from database drive.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 323

def unescape_bytea(original_value)
  # In each case, check if the value actually is escaped PostgreSQL bytea output
  # or an unescaped Active Record attribute that was just written.
  if @connection.respond_to?(:unescape_bytea)
    self.class.instance_eval do
      define_method(:unescape_bytea) do |value|
        @connection.unescape_bytea(value) if value
      end
    end
  elsif PGconn.respond_to?(:unescape_bytea)
    self.class.instance_eval do
      define_method(:unescape_bytea) do |value|
        PGconn.unescape_bytea(value) if value
      end
    end
  else
    raise 'Your PostgreSQL connection does not support unescape_bytea. Try upgrading to pg 0.9.0 or later.'
  end
  unescape_bytea(original_value)
end

#update_sql(sql, name = nil) ⇒ Object

Executes an UPDATE query and returns the number of affected tuples.



530
531
532
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 530

def update_sql(sql, name = nil)
  super.cmd_tuples
end