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" }
}
PQTRANS_IDLE =

ruby-pg defines Ruby constants for transaction status, ruby-postgres does not.

defined?(PGconn::PQTRANS_IDLE) ? PGconn::PQTRANS_IDLE : 0

Instance Method Summary collapse

Methods inherited from AbstractAdapter

#decrement_open_transactions, #increment_open_transactions, #log_info, #open_transactions, #prefetch_primary_key?, #quote_table_name, #raw_connection, #requires_reloading?, #reset!, #reset_runtime, #supports_count_distinct?, #verify!

Methods included from QueryCache

#cache, #uncached

Methods included from Quoting

#quote_table_name, #quoted_false, #quoted_string_prefix, #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, #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_name, #initialize_schema_migrations_table, #remove_column, #remove_timestamps, #structure_dump, #table_alias_for, #table_exists?

Constructor Details

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

Initializes and connects a PostgreSQL adapter.



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

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) 


214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 214

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.



201
202
203
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 201

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.



801
802
803
804
805
806
807
808
809
810
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 801

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.



897
898
899
900
901
902
903
904
905
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 897

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.



518
519
520
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 518

def begin_db_transaction
  execute "BEGIN"
end

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

Changes the column of a table.



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 813

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.



839
840
841
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 839

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 



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

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.



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

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

#client_min_messages=(level) ⇒ Object

Set the client message level.



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

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.



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

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.



523
524
525
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 523

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'



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

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

#current_database ⇒ Object

Returns the current database name.



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

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.



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

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:



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

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.



239
240
241
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 239

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



878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 878

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'



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

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.



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

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(value) ⇒ Object

Escapes binary strings for bytea input to the database.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 285

def escape_bytea(value)
  if 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(value)
end

#execute(sql, name = nil) ⇒ Object

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



502
503
504
505
506
507
508
509
510
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 502

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

#indexes(table_name, name = nil) ⇒ Object

Returns the list of all indexes for a table.



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
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 636

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, a.attname
       FROM pg_class t, pg_class i, pg_index d, pg_attribute a
     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}) )
       AND a.attrelid = t.oid
       AND ( d.indkey[0]=a.attnum OR d.indkey[1]=a.attnum
          OR d.indkey[2]=a.attnum OR d.indkey[3]=a.attnum
          OR d.indkey[4]=a.attnum OR d.indkey[5]=a.attnum
          OR d.indkey[6]=a.attnum OR d.indkey[7]=a.attnum
          OR d.indkey[8]=a.attnum OR d.indkey[9]=a.attnum )
    ORDER BY i.relname
  SQL

  current_index = nil
  indexes = []

  result.each do |row|
    if current_index != row[0]
      indexes << IndexDefinition.new(table_name, row[0], row[1] == "t", [])
      current_index = row[0]
    end

    indexes.last.columns << row[2]
  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



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
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 435

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:



243
244
245
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 243

def native_database_types #:nodoc:
  NATIVE_DATABASE_TYPES
end

#pk_and_sequence_for(table) ⇒ Object

Returns a table’s primary key and belonging sequence.



746
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
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 746

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      = '#{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 = '#{table}'::regclass
        AND cons.contype = 'p'
        AND def.adsrc ~* 'nextval'
    end_sql
  end

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

#query(sql, name = nil) ⇒ Object

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



489
490
491
492
493
494
495
496
497
498
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 489

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.



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 353

def quote(value, column = nil) #:nodoc:
  if value.kind_of?(String) && column && column.type == :binary
    "#{quoted_string_prefix}'#{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.



392
393
394
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 392

def quote_column_name(name) #:nodoc:
  %("#{name}")
end

#quote_string(s) ⇒ Object

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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 374

def quote_string(s) #:nodoc:
  if 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(s)
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.



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

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.



228
229
230
231
232
233
234
235
236
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 228

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

#recreate_database(name) ⇒ Object

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



573
574
575
576
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 573

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

#remove_index(table_name, options = {}) ⇒ Object

Drops an index from a table.



856
857
858
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 856

def remove_index(table_name, options = {})
  execute "DROP INDEX #{index_name(table_name, options)}"
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object

Renames a column in a table.



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

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.



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

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.



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

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



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 467

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.



528
529
530
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 528

def rollback_db_transaction
  execute "ROLLBACK"
end

#schema_search_path ⇒ Object

Returns the active schema search path.



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

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.



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

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.



430
431
432
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 430

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

#supports_ddl_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_ddl_transactions?
  true
end

#supports_disable_referential_integrity? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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) 


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

def supports_insert_with_returning?
  postgresql_version >= 80200
end

#supports_migrations? ⇒ Boolean

Does PostgreSQL support migrations?

Returns:

  • (Boolean) 


248
249
250
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 248

def supports_migrations?
  true
end

#supports_standard_conforming_strings? ⇒ Boolean

Does PostgreSQL support standard conforming strings?

Returns:

  • (Boolean) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 253

def supports_standard_conforming_strings?
  # Temporarily set the client message level above error to prevent unintentional
  # error messages in the logs when working on a PostgreSQL database server that
  # does not support standard conforming strings.
  client_min_messages_old = client_min_messages
  self.client_min_messages = 'panic'

  # postgres-pr does not raise an exception when client_min_messages is set higher
  # than error and "SHOW standard_conforming_strings" fails, but returns an empty
  # PGresult instead.
  has_support = query('SHOW standard_conforming_strings')[0][0] rescue false
  self.client_min_messages = client_min_messages_old
  has_support
end

#table_alias_length ⇒ Object

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



278
279
280
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 278

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.



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

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

#transaction(start_db_transaction = true) ⇒ Object

Wrap a block in a transaction. Returns result of block.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 542

def transaction(start_db_transaction = true)
  transaction_open = false
  begin
    if block_given?
      if start_db_transaction
        begin_db_transaction
        transaction_open = true
      end
      yield
    end
  rescue Exception => database_transaction_rollback
    if transaction_open && transaction_active?
      transaction_open = false
      rollback_db_transaction
    end
    raise unless database_transaction_rollback.is_a? ActiveRecord::Rollback
  end
ensure
  if transaction_open && transaction_active?
    begin
      commit_db_transaction
    rescue Exception => database_transaction_rollback
      rollback_db_transaction
      raise
    end
  end
end

#transaction_active? ⇒ Boolean

Check whether a transaction is active.

Returns:

  • (Boolean) 


537
538
539
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 537

def transaction_active?
  @connection.transaction_status != PQTRANS_IDLE
end

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

Maps logical Rails types to PostgreSQL-specific data types.



861
862
863
864
865
866
867
868
869
870
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 861

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(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.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 309

def unescape_bytea(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 PGconn.respond_to?(:unescape_bytea)
    self.class.instance_eval do
      define_method(:unescape_bytea) do |value|
        if value =~ /\\\d{3}/
          PGconn.unescape_bytea(value)
        else
          value
        end
      end
    end
  else
    self.class.instance_eval do
      define_method(:unescape_bytea) do |value|
        if value =~ /\\\d{3}/
          result = ''
          i, max = 0, value.size
          while i < max
            char = value[i]
            if char == ?\\
              if value[i+1] == ?\\
                char = ?\\
                i += 1
              else
                char = value[i+1..i+3].oct
                i += 3
              end
            end
            result << char
            i += 1
          end
          result
        else
          value
        end
      end
    end
  end
  unescape_bytea(value)
end

#update_sql(sql, name = nil) ⇒ Object

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



513
514
515
 
# File 'lib/active_record/connection_adapters/postgresql_adapter.rb', line 513

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