postgresql_adapter.rb 36.7 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'active_record/connection_adapters/abstract_adapter'
J
Jeremy Kemper 已提交
2
require 'active_support/core_ext/kernel/requires'
3
require 'active_support/core_ext/object/blank'
4 5 6

# Make sure we're using pg high enough for PGResult#values
gem 'pg', '~> 0.11'
7
require 'pg'
D
Initial  
David Heinemeier Hansson 已提交
8 9 10 11 12

module ActiveRecord
  class Base
    # Establishes a connection to the database that's used by all Active Record objects
    def self.postgresql_connection(config) # :nodoc:
13
      config = config.symbolize_keys
D
Initial  
David Heinemeier Hansson 已提交
14
      host     = config[:host]
15
      port     = config[:port] || 5432
16 17
      username = config[:username].to_s if config[:username]
      password = config[:password].to_s if config[:password]
D
Initial  
David Heinemeier Hansson 已提交
18

19
      if config.key?(:database)
D
Initial  
David Heinemeier Hansson 已提交
20 21 22 23 24
        database = config[:database]
      else
        raise ArgumentError, "No database specified. Missing argument: database."
      end

25
      # The postgres drivers don't allow the creation of an unconnected PGconn object,
26 27 28 29
      # so just pass a nil connection object for the time being.
      ConnectionAdapters::PostgreSQLAdapter.new(nil, logger, [host, port, nil, nil, database, username, password], config)
    end
  end
30

31 32 33 34 35 36 37
  module ConnectionAdapters
    # PostgreSQL-specific extensions to column definitions in a table.
    class PostgreSQLColumn < Column #:nodoc:
      # Instantiates a new PostgreSQL column definition in a table.
      def initialize(name, default, sql_type = nil, null = true)
        super(name, self.class.extract_value_from_default(default), sql_type, null)
      end
38

39 40 41
      # :stopdoc:
      class << self
        attr_accessor :money_precision
42 43 44 45 46 47 48 49 50 51
        def string_to_time(string)
          return string unless String === string

          case string
          when 'infinity'  then 1.0 / 0.0
          when '-infinity' then -1.0 / 0.0
          else
            super
          end
        end
52 53 54
      end
      # :startdoc:

55
      private
56
        def extract_limit(sql_type)
57 58 59 60 61
          case sql_type
          when /^bigint/i;    8
          when /^smallint/i;  2
          else super
          end
62 63
        end

64 65 66 67 68
        # Extracts the scale from PostgreSQL-specific data types.
        def extract_scale(sql_type)
          # Money type has a fixed scale of 2.
          sql_type =~ /^money/ ? 2 : super
        end
69

70 71
        # Extracts the precision from PostgreSQL-specific data types.
        def extract_precision(sql_type)
72 73 74 75 76
          if sql_type == 'money'
            self.class.money_precision
          else
            super
          end
77
        end
78

79 80 81 82 83 84 85
        # Maps PostgreSQL-specific data types to logical Rails types.
        def simplified_type(field_type)
          case field_type
            # Numeric and monetary types
            when /^(?:real|double precision)$/
              :float
            # Monetary types
86
            when 'money'
87 88 89 90 91
              :decimal
            # Character types
            when /^(?:character varying|bpchar)(?:\(\d+\))?$/
              :string
            # Binary data types
92
            when 'bytea'
93 94 95 96
              :binary
            # Date/time types
            when /^timestamp with(?:out)? time zone$/
              :datetime
97
            when 'interval'
98 99 100 101 102 103 104 105 106 107 108
              :string
            # Geometric types
            when /^(?:point|line|lseg|box|"?path"?|polygon|circle)$/
              :string
            # Network address types
            when /^(?:cidr|inet|macaddr)$/
              :string
            # Bit strings
            when /^bit(?: varying)?(?:\(\d+\))?$/
              :string
            # XML type
109
            when 'xml'
110
              :xml
111 112 113
            # tsvector type
            when 'tsvector'
              :tsvector
114 115
            # Arrays
            when /^\D+\[\]$/
116
              :string
117
            # Object identifier types
118
            when 'oid'
119
              :integer
120
            # UUID type
121
            when 'uuid'
122 123 124 125
              :string
            # Small and big integer types
            when /^(?:small|big)int$/
              :integer
126 127 128 129 130
            # Pass through all types that are not specific to PostgreSQL.
            else
              super
          end
        end
131

132 133 134
        # Extracts the value from a PostgreSQL column default definition.
        def self.extract_value_from_default(default)
          case default
135 136 137 138 139 140 141 142
            # This is a performance optimization for Ruby 1.9.2 in development.
            # If the value is nil, we return nil straight away without checking
            # the regular expressions. If we check each regular expression,
            # Regexp#=== will call NilClass#to_str, which will trigger
            # method_missing (defined by whiny nil in ActiveSupport) which
            # makes this method very very slow.
            when NilClass
              nil
143
            # Numeric types
144 145
            when /\A\(?(-?\d+(\.\d*)?\)?)\z/
              $1
146
            # Character types
147
            when /\A'(.*)'::(?:character varying|bpchar|text)\z/m
148
              $1
149 150 151
            # Character types (8.1 formatting)
            when /\AE'(.*)'::(?:character varying|bpchar|text)\z/m
              $1.gsub(/\\(\d\d\d)/) { $1.oct.chr }
152
            # Binary data types
153
            when /\A'(.*)'::bytea\z/m
154 155
              $1
            # Date/time types
156
            when /\A'(.+)'::(?:time(?:stamp)? with(?:out)? time zone|date)\z/
157
              $1
158
            when /\A'(.*)'::interval\z/
159 160
              $1
            # Boolean type
161
            when 'true'
162
              true
163
            when 'false'
164 165
              false
            # Geometric types
166
            when /\A'(.*)'::(?:point|line|lseg|box|"?path"?|polygon|circle)\z/
167 168
              $1
            # Network address types
169
            when /\A'(.*)'::(?:cidr|inet|macaddr)\z/
170 171
              $1
            # Bit string types
172
            when /\AB'(.*)'::"?bit(?: varying)?"?\z/
173 174
              $1
            # XML type
175
            when /\A'(.*)'::xml\z/m
176 177
              $1
            # Arrays
178
            when /\A'(.*)'::"?\D+"?\[\]\z/
179 180
              $1
            # Object identifier types
181
            when /\A-?\d+\z/
182 183 184
              $1
            else
              # Anything else is blank, some user type, or some function
185
              # and we can't know the value of that, so return nil.
186 187 188
              nil
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
189 190
    end

191 192
    # The PostgreSQL adapter works both with the native C (http://ruby.scripting.ca/postgres/) and the pure
    # Ruby (available both as gem and from http://rubyforge.org/frs/?group_id=234&release_id=1944) drivers.
193 194 195
    #
    # Options:
    #
P
Pratik Naik 已提交
196 197 198 199 200
    # * <tt>:host</tt> - Defaults to "localhost".
    # * <tt>:port</tt> - Defaults to 5432.
    # * <tt>:username</tt> - Defaults to nothing.
    # * <tt>:password</tt> - Defaults to nothing.
    # * <tt>:database</tt> - The name of the database. No default, must be provided.
201
    # * <tt>:schema_search_path</tt> - An optional schema search path for the connection given
202
    #   as a string of comma-separated schema names.  This is backward-compatible with the <tt>:schema_order</tt> option.
203
    # * <tt>:encoding</tt> - An optional client encoding that is used in a <tt>SET client_encoding TO
204
    #   <encoding></tt> call on the connection.
205
    # * <tt>:min_messages</tt> - An optional client min messages that is used in a
206
    #   <tt>SET client_min_messages TO <min_messages></tt> call on the connection.
207
    class PostgreSQLAdapter < AbstractAdapter
208 209 210 211 212
      class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
        def xml(*args)
          options = args.extract_options!
          column(args[0], 'xml', options)
        end
213 214 215 216 217

        def tsvector(*args)
          options = args.extract_options!
          column(args[0], 'tsvector', options)
        end
218 219
      end

220
      ADAPTER_NAME = 'PostgreSQL'
221 222

      NATIVE_DATABASE_TYPES = {
223
        :primary_key => "serial primary key",
224 225 226 227 228 229 230 231 232 233
        :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" },
234
        :boolean     => { :name => "boolean" },
235 236
        :xml         => { :name => "xml" },
        :tsvector    => { :name => "tsvector" }
237 238
      }

239
      # Returns 'PostgreSQL' as adapter name for identification purposes.
240
      def adapter_name
241
        ADAPTER_NAME
242 243
      end

244 245
      # Returns +true+, since this connection adapter supports prepared statement
      # caching.
246 247 248 249
      def supports_statement_cache?
        true
      end

250 251
      # Initializes and connects a PostgreSQL adapter.
      def initialize(connection, logger, connection_parameters, config)
252
        super(connection, logger)
253
        @connection_parameters, @config = connection_parameters, config
254

255 256
        # @local_tz is initialized as nil to avoid warnings when connect tries to use it
        @local_tz = nil
257
        @table_alias_length = nil
258
        @statements = {}
259

260
        connect
261 262 263 264 265

        if postgresql_version < 80200
          raise "Your version of PostgreSQL (#{postgresql_version}) is too old, please upgrade!"
        end

266
        @local_tz = execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"]
267 268
      end

X
Xavier Noria 已提交
269
      # Clears the prepared statements cache.
270 271
      def clear_cache!
        @statements.each_value do |value|
272
          @connection.query "DEALLOCATE #{value}"
273 274 275 276
        end
        @statements.clear
      end

277 278
      # Is this connection alive and ready for queries?
      def active?
279 280
        @connection.status == PGconn::CONNECTION_OK
      rescue PGError
281
        false
282 283 284 285
      end

      # Close then reopen the connection.
      def reconnect!
286 287 288
        clear_cache!
        @connection.reset
        configure_connection
289
      end
290

291 292 293 294 295
      def reset!
        clear_cache!
        super
      end

296 297
      # Disconnects from the database if already connected. Otherwise, this
      # method does nothing.
298
      def disconnect!
299
        clear_cache!
300 301
        @connection.close rescue nil
      end
302

303
      def native_database_types #:nodoc:
304
        NATIVE_DATABASE_TYPES
305
      end
306

307
      # Returns true, since this connection adapter supports migrations.
308 309
      def supports_migrations?
        true
310 311
      end

312
      # Does PostgreSQL support finding primary key on non-Active Record tables?
313 314 315 316
      def supports_primary_key? #:nodoc:
        true
      end

317 318 319
      # Enable standard-conforming strings if available.
      def set_standard_conforming_strings
        old, self.client_min_messages = client_min_messages, 'panic'
320
        execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil
321 322
      ensure
        self.client_min_messages = old
323 324
      end

325
      def supports_insert_with_returning?
326
        true
327 328
      end

329 330 331
      def supports_ddl_transactions?
        true
      end
332

333
      # Returns true, since this connection adapter supports savepoints.
334 335 336
      def supports_savepoints?
        true
      end
337

338
      # Returns the configured supported identifier length supported by PostgreSQL
339
      def table_alias_length
340
        @table_alias_length ||= query('SHOW max_identifier_length')[0][0].to_i
341
      end
342

343 344
      # QUOTING ==================================================

345
      # Escapes binary strings for bytea input to the database.
346 347
      def escape_bytea(value)
        @connection.escape_bytea(value) if value
348 349 350 351 352
      end

      # 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.
353 354
      def unescape_bytea(value)
        @connection.unescape_bytea(value) if value
355 356
      end

357 358
      # Quotes PostgreSQL-specific data types for SQL input.
      def quote(value, column = nil) #:nodoc:
359 360
        return super unless column

A
Aaron Patterson 已提交
361
        case value
362 363 364
        when Float
          return super unless value.infinite? && column.type == :datetime
          "'#{value.to_s.downcase}'"
A
Aaron Patterson 已提交
365 366
        when Numeric
          return super unless column.sql_type == 'money'
367
          # Not truly string input, so doesn't require (or allow) escape string syntax.
368
          "'#{value}'"
A
Aaron Patterson 已提交
369 370 371 372 373 374 375 376 377 378 379
        when String
          case column.sql_type
          when 'bytea' then "'#{escape_bytea(value)}'"
          when 'xml'   then "xml '#{quote_string(value)}'"
          when /^bit/
            case value
            when /^[01]*$/      then "B'#{value}'" # Bit-string notation
            when /^[0-9A-F]*$/i then "X'#{value}'" # Hexadecimal notation
            end
          else
            super
380
          end
381 382 383 384 385
        else
          super
        end
      end

386 387 388 389 390 391
      def type_cast(value, column)
        return super unless column

        case value
        when String
          return super unless 'bytea' == column.sql_type
392
          { :value => value, :format => 1 }
393 394 395 396 397
        else
          super
        end
      end

398 399 400
      # Quotes strings for use in SQL input.
      def quote_string(s) #:nodoc:
        @connection.escape(s)
401 402
      end

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
      # Checks the following cases:
      #
      # - table_name
      # - "table.name"
      # - schema_name.table_name
      # - schema_name."table.name"
      # - "schema.name".table_name
      # - "schema.name"."table.name"
      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

422 423
      # Quotes column names for use in SQL queries.
      def quote_column_name(name) #:nodoc:
424
        PGconn.quote_ident(name.to_s)
425 426
      end

427 428 429
      # Quote date/time values for use in SQL input. Includes microseconds
      # if the value is a Time responding to usec.
      def quoted_date(value) #:nodoc:
430 431 432 433 434
        if value.acts_like?(:time) && value.respond_to?(:usec)
          "#{super}.#{sprintf("%06d", value.usec)}"
        else
          super
        end
435 436
      end

437 438
      # Set the authorized user for this session
      def session_auth=(user)
439
        clear_cache!
A
Aaron Patterson 已提交
440
        exec_query "SET SESSION AUTHORIZATION #{user}"
441 442
      end

443 444
      # REFERENTIAL INTEGRITY ====================================

445
      def supports_disable_referential_integrity? #:nodoc:
446
        true
447 448
      end

449
      def disable_referential_integrity #:nodoc:
450
        if supports_disable_referential_integrity? then
451 452
          execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL" }.join(";"))
        end
453 454
        yield
      ensure
455
        if supports_disable_referential_integrity? then
456 457
          execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER ALL" }.join(";"))
        end
458
      end
459 460 461

      # DATABASE STATEMENTS ======================================

462 463 464 465 466 467
      # Executes a SELECT query and returns an array of rows. Each row is an
      # array of field values.
      def select_rows(sql, name = nil)
        select_raw(sql, name).last
      end

468
      # Executes an INSERT query and returns the new record's ID
469
      def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
470
        # Extract the table from the insert sql. Yuck.
471
        _, table = extract_schema_and_table(sql.split(" ", 4)[2])
472

473
        pk ||= primary_key(table)
474

475
        if pk
476 477 478
          select_value("#{sql} RETURNING #{quote_column_name(pk)}")
        else
          super
479
        end
480
      end
481
      alias :create :insert
482

483 484
      # create a 2D array representing the result set
      def result_as_array(res) #:nodoc:
485
        # check if we have any binary column and if they need escaping
486 487
        ftypes = Array.new(res.nfields) do |i|
          [i, res.ftype(i)]
488 489
        end

490 491 492 493 494 495
        rows = res.values
        return rows unless ftypes.any? { |_, x|
          x == BYTEA_COLUMN_TYPE_OID || x == MONEY_COLUMN_TYPE_OID
        }

        typehash = ftypes.group_by { |_, type| type }
496 497
        binaries = typehash[BYTEA_COLUMN_TYPE_OID] || []
        monies   = typehash[MONEY_COLUMN_TYPE_OID] || []
498 499 500

        rows.each do |row|
          # unescape string passed BYTEA field (OID == 17)
501 502
          binaries.each do |index, _|
            row[index] = unescape_bytea(row[index])
503 504 505 506 507 508
          end

          # If this is a money type column and there are any currency symbols,
          # then strip them off. Indeed it would be prettier to do this in
          # PostgreSQLColumn.string_to_decimal but would break form input
          # fields that call value_before_type_cast.
509
          monies.each do |index, _|
510 511 512 513 514 515 516 517 518 519
            data = row[index]
            # Because money output is formatted according to the locale, there are two
            # cases to consider (note the decimal separators):
            #  (1) $12,345,678.12
            #  (2) $12.345.678,12
            case data
            when /^-?\D+[\d,]+\.\d{2}$/  # (1)
              data.gsub!(/[^-\d.]/, '')
            when /^-?\D+[\d.]+,\d{2}$/  # (2)
              data.gsub!(/[^-\d,]/, '').sub!(/,/, '.')
520
            end
521 522 523 524 525 526
          end
        end
      end


      # Queries the database and returns the results in an Array-like object
527
      def query(sql, name = nil) #:nodoc:
528
        log(sql, name) do
529
          result_as_array @connection.async_exec(sql)
530
        end
531 532
      end

533
      # Executes an SQL statement, returning a PGresult object on success
534 535
      # or raising a PGError exception otherwise.
      def execute(sql, name = nil)
536
        log(sql, name) do
537
          @connection.async_exec(sql)
538
        end
539 540
      end

541 542
      def substitute_at(column, index)
        Arel.sql("$#{index + 1}")
543 544
      end

A
Aaron Patterson 已提交
545
      def exec_query(sql, name = 'SQL', binds = [])
546
        log(sql, name, binds) do
547 548
          result = binds.empty? ? exec_no_cache(sql, binds) :
                                  exec_cache(sql, binds)
549

550 551 552
          ret = ActiveRecord::Result.new(result.fields, result_as_array(result))
          result.clear
          return ret
553 554 555
        end
      end

556 557 558 559 560 561 562 563 564
      def exec_delete(sql, name = 'SQL', binds = [])
        log(sql, name, binds) do
          result = binds.empty? ? exec_no_cache(sql, binds) :
                                  exec_cache(sql, binds)
          affected = result.cmd_tuples
          result.clear
          affected
        end
      end
565
      alias :exec_update :exec_delete
566

567 568 569 570 571 572 573 574 575 576 577 578
      def sql_for_insert(sql, pk, id_value, sequence_name, binds)
        unless pk
          _, table = extract_schema_and_table(sql.split(" ", 4)[2])

          pk = primary_key(table)
        end

        sql = "#{sql} RETURNING #{quote_column_name(pk)}" if pk

        [sql, binds]
      end

579
      # Executes an UPDATE query and returns the number of affected tuples.
580
      def update_sql(sql, name = nil)
581
        super.cmd_tuples
582 583
      end

584 585
      # Begins a transaction.
      def begin_db_transaction
586 587 588
        execute "BEGIN"
      end

589 590
      # Commits a transaction.
      def commit_db_transaction
591 592
        execute "COMMIT"
      end
593

594 595
      # Aborts a transaction.
      def rollback_db_transaction
596 597
        execute "ROLLBACK"
      end
598

599 600
      def outside_transaction?
        @connection.transaction_status == PGconn::PQTRANS_IDLE
601
      end
602

J
Jonathan Viney 已提交
603 604 605 606 607 608 609 610
      def create_savepoint
        execute("SAVEPOINT #{current_savepoint_name}")
      end

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

611
      def release_savepoint
J
Jonathan Viney 已提交
612 613
        execute("RELEASE SAVEPOINT #{current_savepoint_name}")
      end
614

615 616
      # SCHEMA STATEMENTS ========================================

617 618 619 620 621
      def recreate_database(name) #:nodoc:
        drop_database(name)
        create_database(name)
      end

622 623 624
      # Create a new PostgreSQL database.  Options include <tt>:owner</tt>, <tt>:template</tt>,
      # <tt>:encoding</tt>, <tt>:tablespace</tt>, and <tt>:connection_limit</tt> (note that MySQL uses
      # <tt>:charset</tt> while PostgreSQL uses <tt>:encoding</tt>).
625 626 627 628 629 630 631 632 633 634
      #
      # Example:
      #   create_database config[:database], config
      #   create_database 'foo_development', :encoding => 'unicode'
      def create_database(name, options = {})
        options = options.reverse_merge(:encoding => "utf8")

        option_string = options.symbolize_keys.sum do |key, value|
          case key
          when :owner
635
            " OWNER = \"#{value}\""
636
          when :template
637
            " TEMPLATE = \"#{value}\""
638 639 640
          when :encoding
            " ENCODING = '#{value}'"
          when :tablespace
641
            " TABLESPACE = \"#{value}\""
642 643 644 645 646 647 648
          when :connection_limit
            " CONNECTION LIMIT = #{value}"
          else
            ""
          end
        end

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

652
      # Drops a PostgreSQL database.
653 654 655 656
      #
      # Example:
      #   drop_database 'matt_development'
      def drop_database(name) #:nodoc:
657
        execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
658 659
      end

660 661
      # Returns the list of all tables in the schema search path or a specified schema.
      def tables(name = nil)
662
        query(<<-SQL, 'SCHEMA').map { |row| row[0] }
663
          SELECT tablename
664 665 666 667 668 669
          FROM pg_tables
          WHERE schemaname = ANY (current_schemas(false))
        SQL
      end

      def table_exists?(name)
670 671
        schema, table = extract_schema_and_table(name.to_s)

672 673 674 675
        binds = [[nil, table.gsub(/(^"|"$)/,'')]]
        binds << [nil, schema] if schema

        exec_query(<<-SQL, 'SCHEMA', binds).rows.first[0].to_i > 0
676 677
            SELECT COUNT(*)
            FROM pg_tables
678 679
            WHERE tablename = $1
            #{schema ? "AND schemaname = $2" : ''}
680 681 682 683 684
        SQL
      end

      # Extracts the table and schema name from +name+
      def extract_schema_and_table(name)
685 686 687 688 689 690 691 692 693 694 695
        schema, table = name.split('.', 2)

        unless table # A table was provided without a schema
          table  = schema
          schema = nil
        end

        if name =~ /^"/ # Handle quoted table names
          table  = name
          schema = nil
        end
696
        [schema, table]
697 698
      end

699
      # Returns an array of indexes for the given table.
700
      def indexes(table_name, name = nil)
701 702
         schemas = schema_search_path.split(/,/).map { |p| quote(p) }.join(',')
         result = query(<<-SQL, name)
703
           SELECT distinct i.relname, d.indisunique, d.indkey, t.oid
704 705 706
           FROM pg_class t
           INNER JOIN pg_index d ON t.oid = d.indrelid
           INNER JOIN pg_class i ON d.indexrelid = i.oid
707 708 709
           WHERE i.relkind = 'i'
             AND d.indisprimary = 'f'
             AND t.relname = '#{table_name}'
710
             AND i.relnamespace IN (SELECT oid FROM pg_namespace WHERE nspname IN (#{schemas}) )
711 712 713
          ORDER BY i.relname
        SQL

714

715
        result.map do |row|
716 717 718 719 720
          index_name = row[0]
          unique = row[1] == 't'
          indkey = row[2].split(" ")
          oid = row[3]

721 722
          columns = Hash[query(<<-SQL, "Columns for index #{row[0]} on #{table_name}")]
          SELECT a.attnum, a.attname
723 724 725 726 727
          FROM pg_attribute a
          WHERE a.attrelid = #{oid}
          AND a.attnum IN (#{indkey.join(",")})
          SQL

728 729
          column_names = columns.values_at(*indkey).compact
          column_names.empty? ? nil : IndexDefinition.new(table_name, index_name, unique, column_names)
730
        end.compact
731 732
      end

733 734
      # Returns the list of all column definitions for a table.
      def columns(table_name, name = nil)
735
        # Limit, precision, and scale are all handled by the superclass.
736 737
        column_definitions(table_name).collect do |column_name, type, default, notnull|
          PostgreSQLColumn.new(column_name, default, type, notnull == 'f')
D
Initial  
David Heinemeier Hansson 已提交
738 739 740
        end
      end

741 742 743 744 745 746 747 748 749 750 751 752 753
      # Returns the current database name.
      def current_database
        query('select current_database()')[0][0]
      end

      # Returns the current database encoding format.
      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

754 755 756 757 758 759
      # 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.
      def schema_search_path=(schema_csv)
760 761
        if schema_csv
          execute "SET search_path TO #{schema_csv}"
762
          @schema_search_path = schema_csv
763
        end
D
Initial  
David Heinemeier Hansson 已提交
764 765
      end

766 767
      # Returns the active schema search path.
      def schema_search_path
768
        @schema_search_path ||= query('SHOW search_path')[0][0]
769
      end
770

771 772
      # Returns the current client message level.
      def client_min_messages
773
        query('SHOW client_min_messages', 'SCHEMA')[0][0]
774 775 776 777
      end

      # Set the client message level.
      def client_min_messages=(level)
778
        execute("SET client_min_messages TO '#{level}'", 'SCHEMA')
779 780 781 782
      end

      # Returns the sequence name for a table's primary key or some other specified key.
      def default_sequence_name(table_name, pk = nil) #:nodoc:
783 784 785 786 787 788 789 790 791 792
        serial_sequence(table_name, pk || 'id').split('.').last
      rescue ActiveRecord::StatementInvalid
        "#{table_name}_#{pk || 'id'}_seq"
      end

      def serial_sequence(table, column)
        result = exec_query(<<-eosql, 'SCHEMA', [[nil, table], [nil, column]])
          SELECT pg_get_serial_sequence($1, $2)
        eosql
        result.rows.first.first
793 794
      end

795 796
      # Resets the sequence of a table's primary key to the maximum value.
      def reset_pk_sequence!(table, pk = nil, sequence = nil) #:nodoc:
797 798
        unless pk and sequence
          default_pk, default_sequence = pk_and_sequence_for(table)
799

800 801 802
          pk ||= default_pk
          sequence ||= default_sequence
        end
803

804 805 806 807 808 809 810 811 812 813
        if @logger && pk && !sequence
          @logger.warn "#{table} has primary key #{pk} with no 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
814 815 816
        end
      end

817 818
      # Returns a table's primary key and belonging sequence.
      def pk_and_sequence_for(table) #:nodoc:
819 820
        # First try looking for a sequence with a dependency on the
        # given table's primary key.
821
        result = exec_query(<<-end_sql, 'SCHEMA').rows.first
822
          SELECT attr.attname, seq.relname
823
          FROM pg_class seq
A
Akira Matsuda 已提交
824
          INNER JOIN pg_depend dep ON seq.oid = dep.objid
825 826 827 828 829
          INNER JOIN pg_attribute attr ON attr.attrelid = dep.refobjid AND attr.attnum = dep.refobjsubid
          INNER JOIN pg_constraint cons ON attr.attrelid = cons.conrelid AND attr.attnum = cons.conkey[1]
          WHERE seq.relkind  = 'S'
            AND cons.contype = 'p'
            AND dep.refobjid = '#{quote_table_name(table)}'::regclass
830
        end_sql
831

832
        # [primary_key, sequence]
833
        [result.first, result.last]
834 835
      rescue
        nil
836 837
      end

838 839
      # Returns just a table's primary key
      def primary_key(table)
840 841
        row = exec_query(<<-end_sql, 'SCHEMA', [[nil, table]]).rows.first
          SELECT DISTINCT(attr.attname)
842 843 844 845 846
          FROM pg_attribute attr
          INNER JOIN pg_depend dep ON attr.attrelid = dep.refobjid AND attr.attnum = dep.refobjsubid
          INNER JOIN pg_constraint cons ON attr.attrelid = cons.conrelid AND attr.attnum = cons.conkey[1]
          WHERE cons.contype = 'p'
            AND dep.refobjid = $1::regclass
847 848 849
        end_sql

        row && row.first
850 851
      end

852
      # Renames a table.
853 854 855
      #
      # Example:
      #   rename_table('octopuses', 'octopi')
856
      def rename_table(name, new_name)
857
        execute "ALTER TABLE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}"
858
      end
859

860 861
      # Adds a new column to the named table.
      # See TableDefinition#column for details of the options you can use.
S
Scott Barron 已提交
862
      def add_column(table_name, column_name, type, options = {})
863 864
        add_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ADD COLUMN #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
        add_column_options!(add_column_sql, options)
865

866
        execute add_column_sql
S
Scott Barron 已提交
867
      end
D
Initial  
David Heinemeier Hansson 已提交
868

869 870
      # Changes the column of a table.
      def change_column(table_name, column_name, type, options = {})
871 872
        quoted_table_name = quote_table_name(table_name)

873
        execute "ALTER TABLE #{quoted_table_name} ALTER COLUMN #{quote_column_name(column_name)} TYPE #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
874

875 876
        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)
877
      end
878

879 880
      # Changes the default value of a table column.
      def change_column_default(table_name, column_name, default)
881
        execute "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} SET DEFAULT #{quote(default)}"
882
      end
883

884 885
      def change_column_null(table_name, column_name, null, default = nil)
        unless null || default.nil?
886
          execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
887
        end
888
        execute("ALTER TABLE #{quote_table_name(table_name)} ALTER #{quote_column_name(column_name)} #{null ? 'DROP' : 'SET'} NOT NULL")
889 890
      end

891 892
      # Renames a column in a table.
      def rename_column(table_name, column_name, new_column_name)
893
        execute "ALTER TABLE #{quote_table_name(table_name)} RENAME COLUMN #{quote_column_name(column_name)} TO #{quote_column_name(new_column_name)}"
894
      end
895

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

900 901 902 903
      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

904 905
      def index_name_length
        63
906
      end
907

908 909
      # Maps logical Rails types to PostgreSQL-specific data types.
      def type_to_sql(type, limit = nil, precision = nil, scale = nil)
910
        return super unless type.to_s == 'integer'
911
        return 'integer' unless limit
912

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

921
      # Returns a SELECT DISTINCT clause for a given set of columns and a given ORDER BY clause.
922 923 924
      #
      # PostgreSQL requires the ORDER BY columns in the select list for distinct queries, and
      # requires that the ORDER BY include the distinct column.
925
      #
926
      #   distinct("posts.id", "posts.created_at desc")
927 928
      def distinct(columns, orders) #:nodoc:
        return "DISTINCT #{columns}" if orders.empty?
929

930 931
        # Construct a clean list of column names from the ORDER BY clause, removing
        # any ASC/DESC modifiers
932
        order_columns = orders.collect { |s| s =~ /^(.+)\s+(ASC|DESC)\s*$/i ? $1 : s }
933
        order_columns.delete_if { |c| c.blank? }
934
        order_columns = order_columns.zip((0...order_columns.size).to_a).map { |s,i| "#{s} AS alias_#{i}" }
935

936
        "DISTINCT #{columns}, #{order_columns * ', '}"
937
      end
938

939
      protected
940
        # Returns the version of the connected PostgreSQL server.
941
        def postgresql_version
942
          @connection.server_version
943 944
        end

945 946 947
        def translate_exception(exception, message)
          case exception.message
          when /duplicate key value violates unique constraint/
948
            RecordNotUnique.new(message, exception)
949
          when /violates foreign key constraint/
950
            InvalidForeignKey.new(message, exception)
951 952 953 954 955
          else
            super
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
956
      private
957 958 959 960 961 962 963 964 965
      def exec_no_cache(sql, binds)
        @connection.async_exec(sql)
      end

      def exec_cache(sql, binds)
        unless @statements.key? sql
          nextkey = "a#{@statements.length + 1}"
          @connection.prepare nextkey, sql
          @statements[sql] = nextkey
966
        end
967 968 969 970 971 972 973 974 975 976

        key = @statements[sql]

        # Clear the queue
        @connection.get_last_result
        @connection.send_query_prepared(key, binds.map { |col, val|
          type_cast(val, col)
        })
        @connection.block
        @connection.get_last_result
977 978
      end

P
Pratik Naik 已提交
979
        # The internal PostgreSQL identifier of the money data type.
980
        MONEY_COLUMN_TYPE_OID = 790 #:nodoc:
981 982
        # The internal PostgreSQL identifier of the BYTEA data type.
        BYTEA_COLUMN_TYPE_OID = 17 #:nodoc:
983 984 985 986 987 988 989 990 991

        # Connects to a PostgreSQL server and sets up the adapter depending on the
        # connected server's characteristics.
        def connect
          @connection = PGconn.connect(*@connection_parameters)

          # Money type has a fixed precision of 10 in PostgreSQL 8.2 and below, and as of
          # PostgreSQL 8.3 it has a fixed precision of 19. PostgreSQLColumn.extract_precision
          # should know about this but can't detect it there, so deal with it here.
992 993
          PostgreSQLColumn.money_precision = (postgresql_version >= 80300) ? 19 : 10

994 995 996
          configure_connection
        end

997
        # Configures the encoding, verbosity, schema search path, and time zone of the connection.
998
        # This is called by #connect and should not be called manually.
999 1000
        def configure_connection
          if @config[:encoding]
1001
            @connection.set_client_encoding(@config[:encoding])
1002
          end
1003 1004
          self.client_min_messages = @config[:min_messages] if @config[:min_messages]
          self.schema_search_path = @config[:schema_search_path] || @config[:schema_order]
1005 1006 1007 1008

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

1009
          # If using Active Record's time zone support configure the connection to return
1010
          # TIMESTAMP WITH ZONE types in UTC.
1011
          if ActiveRecord::Base.default_timezone == :utc
1012
            execute("SET time zone 'UTC'", 'SCHEMA')
1013
          elsif @local_tz
1014
            execute("SET time zone '#{@local_tz}'", 'SCHEMA')
1015
          end
1016 1017
        end

1018
        # Returns the current ID of a table's sequence.
1019 1020 1021
        def last_insert_id(sequence_name) #:nodoc:
          r = exec_query("SELECT currval($1)", 'SQL', [[nil, sequence_name]])
          Integer(r.rows.first.first)
D
Initial  
David Heinemeier Hansson 已提交
1022 1023
        end

1024
        # Executes a SELECT query and returns the results, performing any data type
1025
        # conversions that are required to be performed here instead of in PostgreSQLColumn.
1026
        def select(sql, name = nil, binds = [])
A
Aaron Patterson 已提交
1027
          exec_query(sql, name, binds).to_a
1028 1029 1030
        end

        def select_raw(sql, name = nil)
1031
          res = execute(sql, name)
1032
          results = result_as_array(res)
1033
          fields = res.fields
1034
          res.clear
1035
          return fields, results
M
Marcel Molina 已提交
1036 1037
        end

1038
        # Returns the list of a table's column names, data types, and default values.
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
        #
        # The underlying query is roughly:
        #  SELECT column.name, column.type, default.value
        #    FROM column LEFT JOIN default
        #      ON column.table_id = default.table_id
        #     AND column.num = default.column_num
        #   WHERE column.table_id = get_table_id('table_name')
        #     AND column.num > 0
        #     AND NOT column.is_dropped
        #   ORDER BY column.num
        #
        # If the table name is not prefixed with a schema, the database will
        # take the first match from the schema search path.
        #
        # Query implementation notes:
        #  - format_type includes the column size constraint, e.g. varchar(50)
        #  - ::regclass is a function that gives the id for a table name
1056
        def column_definitions(table_name) #:nodoc:
1057
          exec_query(<<-end_sql, 'SCHEMA').rows
1058
            SELECT a.attname, format_type(a.atttypid, a.atttypmod), d.adsrc, a.attnotnull
1059 1060
              FROM pg_attribute a LEFT JOIN pg_attrdef d
                ON a.attrelid = d.adrelid AND a.attnum = d.adnum
1061
             WHERE a.attrelid = '#{quote_table_name(table_name)}'::regclass
1062 1063 1064
               AND a.attnum > 0 AND NOT a.attisdropped
             ORDER BY a.attnum
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
1065
        end
1066 1067

        def extract_pg_identifier_from_name(name)
1068
          match_data = name.start_with?('"') ? name.match(/\"([^\"]+)\"/) : name.match(/([^\.]+)/)
1069 1070

          if match_data
1071 1072
            rest = name[match_data[0].length, name.length]
            rest = rest[1, rest.length] if rest.start_with? "."
1073 1074 1075
            [match_data[1], (rest.length > 0 ? rest : nil)]
          end
        end
1076 1077 1078 1079

      def table_definition
        TableDefinition.new(self)
      end
D
Initial  
David Heinemeier Hansson 已提交
1080 1081 1082
    end
  end
end