postgresql_adapter.rb 28.1 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'active_record/connection_adapters/abstract_adapter'
2
require 'active_record/connection_adapters/statement_pool'
3
require 'active_record/connection_adapters/postgresql/oid'
4
require 'active_record/connection_adapters/postgresql/cast'
5
require 'active_record/connection_adapters/postgresql/array_parser'
6 7 8 9
require 'active_record/connection_adapters/postgresql/quoting'
require 'active_record/connection_adapters/postgresql/schema_statements'
require 'active_record/connection_adapters/postgresql/database_statements'
require 'active_record/connection_adapters/postgresql/referential_integrity'
10
require 'active_record/connection_adapters/postgresql/column'
11
require 'arel/visitors/bind_visitor'
12 13 14

# Make sure we're using pg high enough for PGResult#values
gem 'pg', '~> 0.11'
15
require 'pg'
D
Initial  
David Heinemeier Hansson 已提交
16

D
Dan McClain 已提交
17 18
require 'ipaddr'

D
Initial  
David Heinemeier Hansson 已提交
19
module ActiveRecord
20
  module ConnectionHandling # :nodoc:
21 22 23
    VALID_CONN_PARAMS = [:host, :hostaddr, :port, :dbname, :user, :password, :connect_timeout,
                         :client_encoding, :options, :application_name, :fallback_application_name,
                         :keepalives, :keepalives_idle, :keepalives_interval, :keepalives_count,
24 25
                         :tty, :sslmode, :requiressl, :sslcompression, :sslcert, :sslkey,
                         :sslrootcert, :sslcrl, :requirepeer, :krbsrvname, :gsslib, :service]
26

D
Initial  
David Heinemeier Hansson 已提交
27
    # Establishes a connection to the database that's used by all Active Record objects
28
    def postgresql_connection(config)
29
      conn_params = config.symbolize_keys
D
Initial  
David Heinemeier Hansson 已提交
30

31
      conn_params.delete_if { |_, v| v.nil? }
32 33 34 35

      # Map ActiveRecords param names to PGs.
      conn_params[:user] = conn_params.delete(:username) if conn_params[:username]
      conn_params[:dbname] = conn_params.delete(:database) if conn_params[:database]
D
Initial  
David Heinemeier Hansson 已提交
36

37 38 39
      # Forward only valid config params to PGconn.connect.
      conn_params.keep_if { |k, _| VALID_CONN_PARAMS.include?(k) }

40
      # The postgres drivers don't allow the creation of an unconnected PGconn object,
41
      # so just pass a nil connection object for the time being.
42
      ConnectionAdapters::PostgreSQLAdapter.new(nil, logger, conn_params, config)
43 44
    end
  end
45

46
  module ConnectionAdapters
47
    # The PostgreSQL adapter works with the native C (https://bitbucket.org/ged/ruby-pg) driver.
48 49 50
    #
    # Options:
    #
51 52
    # * <tt>:host</tt> - Defaults to a Unix-domain socket in /tmp. On machines without Unix-domain sockets,
    #   the default is to connect to localhost.
P
Pratik Naik 已提交
53
    # * <tt>:port</tt> - Defaults to 5432.
54 55 56
    # * <tt>:username</tt> - Defaults to be the same as the operating system name of the user running the application.
    # * <tt>:password</tt> - Password to be used if the server demands password authentication.
    # * <tt>:database</tt> - Defaults to be the same as the user name.
57
    # * <tt>:schema_search_path</tt> - An optional schema search path for the connection given
58
    #   as a string of comma-separated schema names. This is backward-compatible with the <tt>:schema_order</tt> option.
59
    # * <tt>:encoding</tt> - An optional client encoding that is used in a <tt>SET client_encoding TO
60
    #   <encoding></tt> call on the connection.
61
    # * <tt>:min_messages</tt> - An optional client min messages that is used in a
62
    #   <tt>SET client_min_messages TO <min_messages></tt> call on the connection.
63 64
    # * <tt>:variables</tt> - An optional hash of additional parameters that
    #   will be used in <tt>SET SESSION key = val</tt> calls on the connection.
A
AvnerCohen 已提交
65
    # * <tt>:insert_returning</tt> - An optional boolean to control the use or <tt>RETURNING</tt> for <tt>INSERT</tt> statements
66
    #   defaults to true.
67 68 69 70 71 72 73
    #
    # Any further options are used as connection parameters to libpq. See
    # http://www.postgresql.org/docs/9.1/static/libpq-connect.html for the
    # list of parameters.
    #
    # In addition, default connection parameters of libpq can be set per environment variables.
    # See http://www.postgresql.org/docs/9.1/static/libpq-envars.html .
74
    class PostgreSQLAdapter < AbstractAdapter
75 76 77 78
      class ColumnDefinition < ActiveRecord::ConnectionAdapters::ColumnDefinition
        attr_accessor :array
      end

79
      module ColumnMethods
80 81 82 83
        def xml(*args)
          options = args.extract_options!
          column(args[0], 'xml', options)
        end
84 85 86 87 88

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

B
bUg 已提交
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
        def int4range(name, options = {})
          column(name, 'int4range', options)
        end

        def int8range(name, options = {})
          column(name, 'int8range', options)
        end

        def tsrange(name, options = {})
          column(name, 'tsrange', options)
        end

        def tstzrange(name, options = {})
          column(name, 'tstzrange', options)
        end

        def numrange(name, options = {})
          column(name, 'numrange', options)
        end

        def daterange(name, options = {})
          column(name, 'daterange', options)
        end

114 115 116
        def hstore(name, options = {})
          column(name, 'hstore', options)
        end
117

118 119 120 121
        def ltree(name, options = {})
          column(name, 'ltree', options)
        end

122 123 124 125 126 127 128 129 130 131 132
        def inet(name, options = {})
          column(name, 'inet', options)
        end

        def cidr(name, options = {})
          column(name, 'cidr', options)
        end

        def macaddr(name, options = {})
          column(name, 'macaddr', options)
        end
133 134 135 136

        def uuid(name, options = {})
          column(name, 'uuid', options)
        end
137 138 139 140

        def json(name, options = {})
          column(name, 'json', options)
        end
141 142 143 144

        def citext(name, options = {})
          column(name, 'citext', options)
        end
145 146 147 148
      end

      class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
        include ColumnMethods
149

150 151 152 153 154 155 156 157 158 159
        # Defines the primary key field.
        # Use of the native PostgreSQL UUID type is supported, and can be used
        # by defining your tables as such:
        #
        #   create_table :stuffs, id: :uuid do |t|
        #     t.string :content
        #     t.timestamps
        #   end
        #
        # By default, this will use the +uuid_generate_v4()+ function from the
160
        # +uuid-ossp+ extension, which MUST be enabled on your database. To enable
161
        # the +uuid-ossp+ extension, you can use the +enable_extension+ method in your
162 163
        # migrations. To use a UUID primary key without +uuid-ossp+ enabled, you can
        # set the +:default+ option to +nil+:
164 165 166 167 168 169 170 171 172 173
        #
        #   create_table :stuffs, id: false do |t|
        #     t.primary_key :id, :uuid, default: nil
        #     t.uuid :foo_id
        #     t.timestamps
        #   end
        #
        # You may also pass a different UUID generation function from +uuid-ossp+
        # or another library.
        #
174 175 176 177
        # Note that setting the UUID primary key default value to +nil+ will
        # require you to assure that you always provide a UUID value before saving
        # a record (as primary keys cannot be +nil+). This might be done via the
        # +SecureRandom.uuid+ method and a +before_save+ callback, for instance.
A
Aaron Patterson 已提交
178
        def primary_key(name, type = :primary_key, options = {})
179 180
          return super unless type == :uuid
          options[:default] = options.fetch(:default, 'uuid_generate_v4()')
A
Aaron Patterson 已提交
181 182 183 184
          options[:primary_key] = true
          column name, type, options
        end

185 186 187 188
        def citext(name, options = {})
          column(name, 'citext', options)
        end

189 190 191 192 193 194 195 196 197 198
        def column(name, type = nil, options = {})
          super
          column = self[name]
          column.array = options[:array]

          self
        end

        private

199 200 201
          def create_column_definition(name, type)
            ColumnDefinition.new name, type
          end
202 203
      end

204 205 206 207
      class Table < ActiveRecord::ConnectionAdapters::Table
        include ColumnMethods
      end

208
      ADAPTER_NAME = 'PostgreSQL'
209 210

      NATIVE_DATABASE_TYPES = {
211 212 213 214 215 216 217 218 219 220
        primary_key: "serial primary key",
        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" },
B
bUg 已提交
221 222 223 224 225 226
        daterange:   { name: "daterange" },
        numrange:    { name: "numrange" },
        tsrange:     { name: "tsrange" },
        tstzrange:   { name: "tstzrange" },
        int4range:   { name: "int4range" },
        int8range:   { name: "int8range" },
227 228 229 230 231 232 233 234
        binary:      { name: "bytea" },
        boolean:     { name: "boolean" },
        xml:         { name: "xml" },
        tsvector:    { name: "tsvector" },
        hstore:      { name: "hstore" },
        inet:        { name: "inet" },
        cidr:        { name: "cidr" },
        macaddr:     { name: "macaddr" },
235
        uuid:        { name: "uuid" },
236
        json:        { name: "json" },
237 238
        ltree:       { name: "ltree" },
        citext:      { name: "citext" }
239 240
      }

241 242 243 244
      include Quoting
      include ReferentialIntegrity
      include SchemaStatements
      include DatabaseStatements
245
      include Savepoints
246

247
      # Returns 'PostgreSQL' as adapter name for identification purposes.
248
      def adapter_name
249
        ADAPTER_NAME
250 251
      end

252 253 254 255 256
      # Adds `:array` option to the default set provided by the
      # AbstractAdapter
      def prepare_column_options(column, types)
        spec = super
        spec[:array] = 'true' if column.respond_to?(:array) && column.array
257
        spec[:default] = "\"#{column.default_function}\"" if column.default_function
258 259 260 261 262 263 264 265
        spec
      end

      # Adds `:array` as a valid migration key
      def migration_keys
        super + [:array]
      end

266 267
      # Returns +true+, since this connection adapter supports prepared statement
      # caching.
268 269 270 271
      def supports_statement_cache?
        true
      end

272 273 274 275
      def supports_index_sort_order?
        true
      end

276 277 278 279
      def supports_partial_index?
        true
      end

280 281 282 283
      def supports_transaction_isolation?
        true
      end

284 285 286 287
      def index_algorithms
        { concurrently: 'CONCURRENTLY' }
      end

288 289 290 291
      class StatementPool < ConnectionAdapters::StatementPool
        def initialize(connection, max)
          super
          @counter = 0
292
          @cache   = Hash.new { |h,pid| h[pid] = {} }
293 294
        end

295 296 297 298
        def each(&block); cache.each(&block); end
        def key?(key);    cache.key?(key); end
        def [](key);      cache[key]; end
        def length;       cache.length; end
299 300 301 302 303 304

        def next_key
          "a#{@counter + 1}"
        end

        def []=(sql, key)
305 306
          while @max <= cache.size
            dealloc(cache.shift.last)
307 308
          end
          @counter += 1
309
          cache[sql] = key
310 311 312
        end

        def clear
313
          cache.each_value do |stmt_key|
314 315
            dealloc stmt_key
          end
316
          cache.clear
317 318
        end

319 320 321 322 323
        def delete(sql_key)
          dealloc cache[sql_key]
          cache.delete sql_key
        end

324
        private
325

326 327 328
          def cache
            @cache[Process.pid]
          end
329

330 331 332 333 334 335 336 337 338
          def dealloc(key)
            @connection.query "DEALLOCATE #{key}" if connection_active?
          end

          def connection_active?
            @connection.status == PGconn::CONNECTION_OK
          rescue PGError
            false
          end
339 340
      end

341 342 343 344
      class BindSubstitution < Arel::Visitors::PostgreSQL # :nodoc:
        include Arel::Visitors::BindVisitor
      end

345 346
      # Initializes and connects a PostgreSQL adapter.
      def initialize(connection, logger, connection_parameters, config)
347
        super(connection, logger)
348

349
        if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
350
          @prepared_statements = true
351 352
          @visitor = Arel::Visitors::PostgreSQL.new self
        else
353
          @visitor = unprepared_visitor
354 355
        end

356
        @connection_parameters, @config = connection_parameters, config
357

358 359
        # @local_tz is initialized as nil to avoid warnings when connect tries to use it
        @local_tz = nil
360 361
        @table_alias_length = nil

362
        connect
363
        @statements = StatementPool.new @connection,
364
                                        self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 })
365 366 367 368 369

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

370 371
        @type_map = OID::TypeMap.new
        initialize_type_map(type_map)
372
        @local_tz = execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"]
373
        @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true
374 375
      end

X
Xavier Noria 已提交
376
      # Clears the prepared statements cache.
377 378 379 380
      def clear_cache!
        @statements.clear
      end

381 382
      # Is this connection alive and ready for queries?
      def active?
383 384
        @connection.query 'SELECT 1'
        true
385
      rescue PGError
386
        false
387 388 389 390
      end

      # Close then reopen the connection.
      def reconnect!
391
        super
392 393
        @connection.reset
        configure_connection
394
      end
395

396 397
      def reset!
        clear_cache!
398 399 400 401 402 403
        reset_transaction
        unless @connection.transaction_status == ::PG::PQTRANS_IDLE
          @connection.query 'ROLLBACK'
        end
        @connection.query 'DISCARD ALL'
        configure_connection
404 405
      end

406 407
      # Disconnects from the database if already connected. Otherwise, this
      # method does nothing.
408
      def disconnect!
409
        super
410 411
        @connection.close rescue nil
      end
412

413
      def native_database_types #:nodoc:
414
        NATIVE_DATABASE_TYPES
415
      end
416

417
      # Returns true, since this connection adapter supports migrations.
418 419
      def supports_migrations?
        true
420 421
      end

422
      # Does PostgreSQL support finding primary key on non-Active Record tables?
423 424 425 426
      def supports_primary_key? #:nodoc:
        true
      end

427 428 429
      # Enable standard-conforming strings if available.
      def set_standard_conforming_strings
        old, self.client_min_messages = client_min_messages, 'panic'
430
        execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil
431 432
      ensure
        self.client_min_messages = old
433 434
      end

435
      def supports_insert_with_returning?
436
        true
437 438
      end

439 440 441
      def supports_ddl_transactions?
        true
      end
442

443 444 445 446
      def supports_explain?
        true
      end

447
      # Returns true if pg > 9.1
448
      def supports_extensions?
449
        postgresql_version >= 90100
450 451
      end

A
Andrew White 已提交
452 453 454 455 456
      # Range datatypes weren't introduced until PostgreSQL 9.2
      def supports_ranges?
        postgresql_version >= 90200
      end

457
      def enable_extension(name)
458
        exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
459 460
          reload_type_map
        }
461 462 463
      end

      def disable_extension(name)
464
        exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap {
465 466
          reload_type_map
        }
467 468 469
      end

      def extension_enabled?(name)
R
Rafael Mendonça França 已提交
470
        if supports_extensions?
471
          res = exec_query "SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL) as enabled",
472
            'SCHEMA'
473
          res.column_types['enabled'].type_cast res.rows.first.first
474
        end
475 476
      end

477 478 479 480 481
      def extensions
        if supports_extensions?
          res = exec_query "SELECT extname from pg_extension", "SCHEMA"
          res.rows.map { |r| res.column_types['extname'].type_cast r.first }
        else
482
          super
483 484 485
        end
      end

486
      # Returns the configured supported identifier length supported by PostgreSQL
487
      def table_alias_length
K
kennyj 已提交
488
        @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
489
      end
490

491 492
      # Set the authorized user for this session
      def session_auth=(user)
493
        clear_cache!
A
Aaron Patterson 已提交
494
        exec_query "SET SESSION AUTHORIZATION #{user}"
495 496
      end

497
      module Utils
498 499
        extend self

500 501 502 503 504 505 506 507 508 509
        # Returns an array of <tt>[schema_name, table_name]</tt> extracted from +name+.
        # +schema_name+ is nil if not specified in +name+.
        # +schema_name+ and +table_name+ exclude surrounding quotes (regardless of whether provided in +name+)
        # +name+ supports the range of schema/table references understood by PostgreSQL, for example:
        #
        # * <tt>table_name</tt>
        # * <tt>"table.name"</tt>
        # * <tt>schema_name.table_name</tt>
        # * <tt>schema_name."table.name"</tt>
        # * <tt>"schema.name"."table name"</tt>
510
        def extract_schema_and_table(name)
511 512 513 514 515
          table, schema = name.scan(/[^".\s]+|"[^"]*"/)[0..1].collect{|m| m.gsub(/(^"|"$)/,'') }.reverse
          [schema, table]
        end
      end

516 517
      def use_insert_returning?
        @use_insert_returning
518 519
      end

520 521 522 523
      def valid_type?(type)
        !native_database_types[type].nil?
      end

524 525 526 527
      def update_table_definition(table_name, base) #:nodoc:
        Table.new(table_name, base)
      end

528
      protected
529

530
        # Returns the version of the connected PostgreSQL server.
531
        def postgresql_version
532
          @connection.server_version
533 534
        end

535 536 537 538
        # See http://www.postgresql.org/docs/9.1/static/errcodes-appendix.html
        FOREIGN_KEY_VIOLATION = "23503"
        UNIQUE_VIOLATION      = "23505"

539
        def translate_exception(exception, message)
540 541
          return exception unless exception.respond_to?(:result)

542
          case exception.result.try(:error_field, PGresult::PG_DIAG_SQLSTATE)
543
          when UNIQUE_VIOLATION
544
            RecordNotUnique.new(message, exception)
545
          when FOREIGN_KEY_VIOLATION
546
            InvalidForeignKey.new(message, exception)
547 548 549 550 551
          else
            super
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
552
      private
553

554 555 556 557
        def type_map
          @type_map
        end

558
        def reload_type_map
559 560
          type_map.clear
          initialize_type_map(type_map)
561 562
        end

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
        def add_oid(row, records_by_oid, type_map)
          return type_map if type_map.key? row['type_elem'].to_i

          if OID.registered_type? row['typname']
            # this composite type is explicitly registered
            vector = OID::NAMES[row['typname']]
          else
            # use the default for composite types
            unless type_map.key? row['typelem'].to_i
              add_oid records_by_oid[row['typelem']], records_by_oid, type_map
            end

            vector = OID::Vector.new row['typdelim'], type_map[row['typelem'].to_i]
          end

          type_map[row['oid'].to_i] = vector
          type_map
        end

582
        def initialize_type_map(type_map)
583 584
          if supports_ranges?
            result = execute(<<-SQL, 'SCHEMA')
585
              SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, r.rngsubtype, t.typtype, t.typbasetype
586 587 588 589 590 591 592 593 594 595
              FROM pg_type as t
              LEFT JOIN pg_range as r ON oid = rngtypid
            SQL
          else
            result = execute(<<-SQL, 'SCHEMA')
              SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput
              FROM pg_type as t
            SQL
          end
          ranges, nodes = result.partition { |row| row['typinput'] == 'range_in' }
596
          domains, nodes = nodes.partition { |row| row['typtype'] == 'd' }
597 598
          leaves, nodes = nodes.partition { |row| row['typelem'] == '0' }
          arrays, nodes = nodes.partition { |row| row['typinput'] == 'array_in' }
599

600 601 602 603 604 605
          # populate the enum types
          enums, leaves = leaves.partition { |row| row['typinput'] == 'enum_in' }
          enums.each do |row|
            type_map[row['oid'].to_i] = OID::Enum.new
          end

606
          # populate the base types
607
          leaves.find_all { |row| OID.registered_type? row['typname'] }.each do |row|
608
            type_map[row['oid'].to_i] = OID::NAMES[row['typname']]
609 610
          end

611 612
          records_by_oid = result.group_by { |row| row['oid'] }

613
          # populate composite types
614 615
          nodes.each do |row|
            add_oid row, records_by_oid, type_map
616
          end
617 618

          # populate array types
619 620 621
          arrays.find_all { |row| type_map.key? row['typelem'].to_i }.each do |row|
            array = OID::Array.new  type_map[row['typelem'].to_i]
            type_map[row['oid'].to_i] = array
622
          end
623 624 625 626

          # populate range types
          ranges.find_all { |row| type_map.key? row['rngsubtype'].to_i }.each do |row|
            subtype = type_map[row['rngsubtype'].to_i]
V
Vipul A M 已提交
627
            range = OID::Range.new subtype
628 629
            type_map[row['oid'].to_i] = range
          end
630 631 632 633 634 635 636 637 638

          # populate domain types
          domains.each do |row|
            if base_type = type_map[row["typbasetype"].to_i]
              type_map[row['oid'].to_i] = base_type
            else
              warn "unknown base type (OID: #{row["typbasetype"].to_i}) for domain #{row["typname"]}."
            end
          end
639 640
        end

641
        FEATURE_NOT_SUPPORTED = "0A000" #:nodoc:
642

643 644
        def exec_no_cache(sql, name, binds)
          log(sql, name, binds) { @connection.async_exec(sql) }
645
        end
646

647
        def exec_cache(sql, name, binds)
648
          stmt_key = prepare_statement(sql)
649 650 651
          type_casted_binds = binds.map { |col, val|
            [col, type_cast(val, col)]
          }
652

653
          log(sql, name, type_casted_binds, stmt_key) do
654
            @connection.send_query_prepared(stmt_key, type_casted_binds.map { |_, val| val })
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
            @connection.block
            @connection.get_last_result
          end
        rescue ActiveRecord::StatementInvalid => e
          pgerror = e.original_exception

          # Get the PG code for the failure.  Annoyingly, the code for
          # prepared statements whose return value may have changed is
          # FEATURE_NOT_SUPPORTED.  Check here for more details:
          # http://git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/cache/plancache.c#l573
          begin
            code = pgerror.result.result_error_field(PGresult::PG_DIAG_SQLSTATE)
          rescue
            raise e
          end
          if FEATURE_NOT_SUPPORTED == code
            @statements.delete sql_key(sql)
            retry
          else
            raise e
675 676 677 678 679 680 681 682 683 684 685 686 687
          end
        end

        # Returns the statement identifier for the client side cache
        # of statements
        def sql_key(sql)
          "#{schema_search_path}-#{sql}"
        end

        # Prepare the statement if it hasn't been prepared, return
        # the statement key.
        def prepare_statement(sql)
          sql_key = sql_key(sql)
688
          unless @statements.key? sql_key
689
            nextkey = @statements.next_key
690 691 692
            begin
              @connection.prepare nextkey, sql
            rescue => e
A
Aaron Patterson 已提交
693
              raise translate_exception_class(e, sql)
694
            end
695 696
            # Clear the queue
            @connection.get_last_result
697
            @statements[sql_key] = nextkey
698
          end
699
          @statements[sql_key]
700
        end
701

P
Pratik Naik 已提交
702
        # The internal PostgreSQL identifier of the money data type.
703
        MONEY_COLUMN_TYPE_OID = 790 #:nodoc:
704 705
        # The internal PostgreSQL identifier of the BYTEA data type.
        BYTEA_COLUMN_TYPE_OID = 17 #:nodoc:
706 707 708 709

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

          # 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.
715 716
          PostgreSQLColumn.money_precision = (postgresql_version >= 80300) ? 19 : 10

717
          configure_connection
718 719 720 721 722 723
        rescue ::PG::Error => error
          if error.message.include?("does not exist")
            raise ActiveRecord::NoDatabaseError.new(error.message)
          else
            raise error
          end
724 725
        end

726
        # Configures the encoding, verbosity, schema search path, and time zone of the connection.
727
        # This is called by #connect and should not be called manually.
728 729
        def configure_connection
          if @config[:encoding]
730
            @connection.set_client_encoding(@config[:encoding])
731
          end
732
          self.client_min_messages = @config[:min_messages] || 'warning'
733
          self.schema_search_path = @config[:schema_search_path] || @config[:schema_order]
734 735 736 737

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

738
          # If using Active Record's time zone support configure the connection to return
739
          # TIMESTAMP WITH ZONE types in UTC.
740
          # (SET TIME ZONE does not use an equals sign like other SET variables)
741
          if ActiveRecord::Base.default_timezone == :utc
742
            execute("SET time zone 'UTC'", 'SCHEMA')
743
          elsif @local_tz
744
            execute("SET time zone '#{@local_tz}'", 'SCHEMA')
745
          end
746 747 748 749 750 751 752 753 754 755 756 757

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

760
        # Returns the current ID of a table's sequence.
761
        def last_insert_id(sequence_name) #:nodoc:
762 763 764
          Integer(last_insert_id_value(sequence_name))
        end

D
Doug Cole 已提交
765 766 767 768 769
        def last_insert_id_value(sequence_name)
          last_insert_id_result(sequence_name).rows.first.first
        end

        def last_insert_id_result(sequence_name) #:nodoc:
770
          exec_query("SELECT currval('#{sequence_name}')", 'SQL')
D
Initial  
David Heinemeier Hansson 已提交
771 772
        end

773
        # Executes a SELECT query and returns the results, performing any data type
774
        # conversions that are required to be performed here instead of in PostgreSQLColumn.
775
        def select(sql, name = nil, binds = [])
776
          exec_query(sql, name, binds)
777 778
        end

779
        # Returns the list of a table's column names, data types, and default values.
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
        #
        # 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
797
        def column_definitions(table_name) #:nodoc:
798
          exec_query(<<-end_sql, 'SCHEMA').rows
799 800
              SELECT a.attname, format_type(a.atttypid, a.atttypmod),
                     pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod
801 802 803 804 805
                FROM pg_attribute a LEFT JOIN pg_attrdef d
                  ON a.attrelid = d.adrelid AND a.attnum = d.adnum
               WHERE a.attrelid = '#{quote_table_name(table_name)}'::regclass
                 AND a.attnum > 0 AND NOT a.attisdropped
               ORDER BY a.attnum
806
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
807
        end
808 809

        def extract_pg_identifier_from_name(name)
810
          match_data = name.start_with?('"') ? name.match(/\"([^\"]+)\"/) : name.match(/([^\.]+)/)
811 812

          if match_data
813 814
            rest = name[match_data[0].length, name.length]
            rest = rest[1, rest.length] if rest.start_with? "."
J
José Valim 已提交
815
            [match_data[1], (rest.length > 0 ? rest : nil)]
816 817
          end
        end
818

819
        def extract_table_ref_from_insert_sql(sql)
820
          sql[/into\s+([^\(]*).*values\s*\(/im]
821 822 823
          $1.strip if $1
        end

824 825
        def create_table_definition(name, temporary, options, as = nil)
          TableDefinition.new native_database_types, name, temporary, options, as
826
        end
D
Initial  
David Heinemeier Hansson 已提交
827 828 829
    end
  end
end