postgresql_adapter.rb 30.2 KB
Newer Older
1 2 3 4
# Make sure we're using pg high enough for type casts and Ruby 2.2+ compatibility
gem 'pg', '~> 0.18'
require 'pg'

S
Sean Griffin 已提交
5 6 7 8 9 10 11 12 13 14 15
require "active_record/connection_adapters/abstract_adapter"
require "active_record/connection_adapters/postgresql/column"
require "active_record/connection_adapters/postgresql/database_statements"
require "active_record/connection_adapters/postgresql/oid"
require "active_record/connection_adapters/postgresql/quoting"
require "active_record/connection_adapters/postgresql/referential_integrity"
require "active_record/connection_adapters/postgresql/schema_definitions"
require "active_record/connection_adapters/postgresql/schema_statements"
require "active_record/connection_adapters/postgresql/type_metadata"
require "active_record/connection_adapters/postgresql/utils"
require "active_record/connection_adapters/statement_pool"
16

17
require 'arel/visitors/bind_visitor'
18

D
Dan McClain 已提交
19 20
require 'ipaddr'

D
Initial  
David Heinemeier Hansson 已提交
21
module ActiveRecord
22
  module ConnectionHandling # :nodoc:
23 24 25
    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,
26 27
                         :tty, :sslmode, :requiressl, :sslcompression, :sslcert, :sslkey,
                         :sslrootcert, :sslcrl, :requirepeer, :krbsrvname, :gsslib, :service]
28

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

33
      conn_params.delete_if { |_, v| v.nil? }
34 35 36 37

      # 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 已提交
38

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

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

48
  module ConnectionAdapters
49
    # The PostgreSQL adapter works with the native C (https://bitbucket.org/ged/ruby-pg) driver.
50 51 52
    #
    # Options:
    #
53 54
    # * <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 已提交
55
    # * <tt>:port</tt> - Defaults to 5432.
56 57 58
    # * <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.
59
    # * <tt>:schema_search_path</tt> - An optional schema search path for the connection given
60
    #   as a string of comma-separated schema names. This is backward-compatible with the <tt>:schema_order</tt> option.
61
    # * <tt>:encoding</tt> - An optional client encoding that is used in a <tt>SET client_encoding TO
62
    #   <encoding></tt> call on the connection.
63
    # * <tt>:min_messages</tt> - An optional client min messages that is used in a
64
    #   <tt>SET client_min_messages TO <min_messages></tt> call on the connection.
65 66
    # * <tt>:variables</tt> - An optional hash of additional parameters that
    #   will be used in <tt>SET SESSION key = val</tt> calls on the connection.
67
    # * <tt>:insert_returning</tt> - An optional boolean to control the use of <tt>RETURNING</tt> for <tt>INSERT</tt> statements
68
    #   defaults to true.
69 70 71 72 73 74 75
    #
    # 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 .
76
    class PostgreSQLAdapter < AbstractAdapter
77
      ADAPTER_NAME = 'PostgreSQL'.freeze
78 79

      NATIVE_DATABASE_TYPES = {
80
        primary_key: "serial primary key",
A
Aaron Patterson 已提交
81
        bigserial: "bigserial",
82
        string:      { name: "character varying" },
83 84 85 86 87 88 89
        text:        { name: "text" },
        integer:     { name: "integer" },
        float:       { name: "float" },
        decimal:     { name: "decimal" },
        datetime:    { name: "timestamp" },
        time:        { name: "time" },
        date:        { name: "date" },
B
bUg 已提交
90 91 92 93 94 95
        daterange:   { name: "daterange" },
        numrange:    { name: "numrange" },
        tsrange:     { name: "tsrange" },
        tstzrange:   { name: "tstzrange" },
        int4range:   { name: "int4range" },
        int8range:   { name: "int8range" },
96 97
        binary:      { name: "bytea" },
        boolean:     { name: "boolean" },
A
Aaron Patterson 已提交
98
        bigint:      { name: "bigint" },
99 100 101 102 103 104
        xml:         { name: "xml" },
        tsvector:    { name: "tsvector" },
        hstore:      { name: "hstore" },
        inet:        { name: "inet" },
        cidr:        { name: "cidr" },
        macaddr:     { name: "macaddr" },
105
        uuid:        { name: "uuid" },
106
        json:        { name: "json" },
107
        jsonb:       { name: "jsonb" },
108
        ltree:       { name: "ltree" },
109
        citext:      { name: "citext" },
S
Sean Griffin 已提交
110 111 112
        point:       { name: "point" },
        bit:         { name: "bit" },
        bit_varying: { name: "bit varying" },
113
        money:       { name: "money" },
114 115
      }

116 117 118 119
      OID = PostgreSQL::OID #:nodoc:

      include PostgreSQL::Quoting
      include PostgreSQL::ReferentialIntegrity
120
      include PostgreSQL::SchemaStatements
121
      include PostgreSQL::DatabaseStatements
122
      include Savepoints
123

124
      def schema_creation # :nodoc:
125 126 127
        PostgreSQL::SchemaCreation.new self
      end

128 129 130
      def column_spec_for_primary_key(column)
        spec = {}
        if column.serial?
R
Ryuta Kamizono 已提交
131
          return unless column.bigint?
132 133 134 135 136 137 138 139 140 141 142
          spec[:id] = ':bigserial'
        elsif column.type == :uuid
          spec[:id] = ':uuid'
          spec[:default] = column.default_function.inspect
        else
          spec[:id] = column.type.inspect
          spec.merge!(prepare_column_options(column).delete_if { |key, _| [:name, :type, :null].include?(key) })
        end
        spec
      end

143
      # Adds +:array+ option to the default set provided by the
144
      # AbstractAdapter
145
      def prepare_column_options(column) # :nodoc:
146
        spec = super
147
        spec[:array] = 'true' if column.array?
148 149 150
        spec
      end

151
      # Adds +:array+ as a valid migration key
152 153 154 155
      def migration_keys
        super + [:array]
      end

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
      def schema_type(column)
        return super unless column.serial?

        if column.bigint?
          'bigserial'
        else
          'serial'
        end
      end
      private :schema_type

      def schema_default(column)
        if column.default_function
          column.default_function.inspect unless column.serial?
        else
          super
        end
      end
      private :schema_default

176 177
      # Returns +true+, since this connection adapter supports prepared statement
      # caching.
178 179 180 181
      def supports_statement_cache?
        true
      end

182 183 184 185
      def supports_index_sort_order?
        true
      end

186 187 188 189
      def supports_partial_index?
        true
      end

190 191 192 193
      def supports_transaction_isolation?
        true
      end

194 195 196 197
      def supports_foreign_keys?
        true
      end

198 199 200 201
      def supports_views?
        true
      end

202 203 204 205
      def supports_datetime_with_precision?
        true
      end

206 207 208 209
      def index_algorithms
        { concurrently: 'CONCURRENTLY' }
      end

210 211 212 213
      class StatementPool < ConnectionAdapters::StatementPool
        def initialize(connection, max)
          super
          @counter = 0
214
          @cache   = Hash.new { |h,pid| h[pid] = {} }
215 216
        end

217 218 219 220
        def each(&block); cache.each(&block); end
        def key?(key);    cache.key?(key); end
        def [](key);      cache[key]; end
        def length;       cache.length; end
221 222 223 224 225 226

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

        def []=(sql, key)
227 228
          while @max <= cache.size
            dealloc(cache.shift.last)
229 230
          end
          @counter += 1
231
          cache[sql] = key
232 233 234
        end

        def clear
235
          cache.each_value do |stmt_key|
236 237
            dealloc stmt_key
          end
238
          cache.clear
239 240
        end

241 242 243 244 245
        def delete(sql_key)
          dealloc cache[sql_key]
          cache.delete sql_key
        end

246
        private
247

248 249 250
          def cache
            @cache[Process.pid]
          end
251

252 253 254 255 256 257 258 259 260
          def dealloc(key)
            @connection.query "DEALLOCATE #{key}" if connection_active?
          end

          def connection_active?
            @connection.status == PGconn::CONNECTION_OK
          rescue PGError
            false
          end
261 262
      end

263 264
      # Initializes and connects a PostgreSQL adapter.
      def initialize(connection, logger, connection_parameters, config)
265
        super(connection, logger)
266

267
        @visitor = Arel::Visitors::PostgreSQL.new self
268
        if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
269
          @prepared_statements = true
270
        else
271
          @prepared_statements = false
272 273
        end

274
        @connection_parameters, @config = connection_parameters, config
275

276 277
        # @local_tz is initialized as nil to avoid warnings when connect tries to use it
        @local_tz = nil
278 279
        @table_alias_length = nil

280
        connect
281
        add_pg_encoders
282
        @statements = StatementPool.new @connection,
283
                                        self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 })
284 285 286 287 288

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

289 290
        add_pg_decoders

291
        @type_map = Type::HashLookupTypeMap.new
292
        initialize_type_map(type_map)
293
        @local_tz = execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"]
294
        @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true
295 296
      end

X
Xavier Noria 已提交
297
      # Clears the prepared statements cache.
298 299 300 301
      def clear_cache!
        @statements.clear
      end

302 303 304 305
      def truncate(table_name, name = nil)
        exec_query "TRUNCATE TABLE #{quote_table_name(table_name)}", name, []
      end

306 307
      # Is this connection alive and ready for queries?
      def active?
308 309
        @connection.query 'SELECT 1'
        true
310
      rescue PGError
311
        false
312 313 314 315
      end

      # Close then reopen the connection.
      def reconnect!
316
        super
317 318
        @connection.reset
        configure_connection
319
      end
320

321 322
      def reset!
        clear_cache!
323 324 325 326 327 328
        reset_transaction
        unless @connection.transaction_status == ::PG::PQTRANS_IDLE
          @connection.query 'ROLLBACK'
        end
        @connection.query 'DISCARD ALL'
        configure_connection
329 330
      end

331 332
      # Disconnects from the database if already connected. Otherwise, this
      # method does nothing.
333
      def disconnect!
334
        super
335 336
        @connection.close rescue nil
      end
337

338
      def native_database_types #:nodoc:
339
        NATIVE_DATABASE_TYPES
340
      end
341

342
      # Returns true, since this connection adapter supports migrations.
343 344
      def supports_migrations?
        true
345 346
      end

347
      # Does PostgreSQL support finding primary key on non-Active Record tables?
348 349 350 351
      def supports_primary_key? #:nodoc:
        true
      end

352 353 354
      # Enable standard-conforming strings if available.
      def set_standard_conforming_strings
        old, self.client_min_messages = client_min_messages, 'panic'
355
        execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil
356 357
      ensure
        self.client_min_messages = old
358 359
      end

360 361 362
      def supports_ddl_transactions?
        true
      end
363

364 365 366 367
      def supports_explain?
        true
      end

368
      # Returns true if pg > 9.1
369
      def supports_extensions?
370
        postgresql_version >= 90100
371 372
      end

A
Andrew White 已提交
373 374 375 376 377
      # Range datatypes weren't introduced until PostgreSQL 9.2
      def supports_ranges?
        postgresql_version >= 90200
      end

378 379 380 381
      def supports_materialized_views?
        postgresql_version >= 90300
      end

382
      def enable_extension(name)
383
        exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
384 385
          reload_type_map
        }
386 387 388
      end

      def disable_extension(name)
389
        exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap {
390 391
          reload_type_map
        }
392 393 394
      end

      def extension_enabled?(name)
R
Rafael Mendonça França 已提交
395
        if supports_extensions?
396
          res = exec_query "SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL) as enabled",
397
            'SCHEMA'
398
          res.cast_values.first
399
        end
400 401
      end

402 403
      def extensions
        if supports_extensions?
404
          exec_query("SELECT extname from pg_extension", "SCHEMA").cast_values
405
        else
406
          super
407 408 409
        end
      end

410
      # Returns the configured supported identifier length supported by PostgreSQL
411
      def table_alias_length
K
kennyj 已提交
412
        @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
413
      end
414

415 416
      # Set the authorized user for this session
      def session_auth=(user)
417
        clear_cache!
A
Aaron Patterson 已提交
418
        exec_query "SET SESSION AUTHORIZATION #{user}"
419 420
      end

421 422
      def use_insert_returning?
        @use_insert_returning
423 424
      end

425 426 427 428
      def valid_type?(type)
        !native_database_types[type].nil?
      end

429
      def update_table_definition(table_name, base) #:nodoc:
430
        PostgreSQL::Table.new(table_name, base)
431 432
      end

433 434 435 436 437
      def lookup_cast_type(sql_type) # :nodoc:
        oid = execute("SELECT #{quote(sql_type)}::regtype::oid", "SCHEMA").first['oid'].to_i
        super(oid)
      end

438 439 440 441 442 443 444 445 446 447
      def column_name_for_operation(operation, node) # :nodoc:
        OPERATION_ALIASES.fetch(operation) { operation.downcase }
      end

      OPERATION_ALIASES = { # :nodoc:
        "maximum" => "max",
        "minimum" => "min",
        "average" => "avg",
      }

448
      protected
449

450
        # Returns the version of the connected PostgreSQL server.
451
        def postgresql_version
452
          @connection.server_version
453 454
        end

455 456 457 458
        # See http://www.postgresql.org/docs/9.1/static/errcodes-appendix.html
        FOREIGN_KEY_VIOLATION = "23503"
        UNIQUE_VIOLATION      = "23505"

459
        def translate_exception(exception, message)
460 461
          return exception unless exception.respond_to?(:result)

462
          case exception.result.try(:error_field, PGresult::PG_DIAG_SQLSTATE)
463
          when UNIQUE_VIOLATION
464
            RecordNotUnique.new(message, exception)
465
          when FOREIGN_KEY_VIOLATION
466
            InvalidForeignKey.new(message, exception)
467 468 469 470 471
          else
            super
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
472
      private
473

474
        def get_oid_type(oid, fmod, column_name, sql_type = '') # :nodoc:
475
          if !type_map.key?(oid)
476
            load_additional_types(type_map, [oid])
477 478
          end

479 480 481 482 483 484
          type_map.fetch(oid, fmod, sql_type) {
            warn "unknown OID #{oid}: failed to recognize type of '#{column_name}'. It will be treated as String."
            Type::Value.new.tap do |cast_type|
              type_map.register_type(oid, cast_type)
            end
          }
485 486
        end

487
        def initialize_type_map(m) # :nodoc:
488 489 490
          register_class_with_limit m, 'int2', Type::Integer
          register_class_with_limit m, 'int4', Type::Integer
          register_class_with_limit m, 'int8', Type::Integer
491
          m.alias_type 'oid', 'int2'
492
          m.register_type 'float4', Type::Float.new
493 494
          m.alias_type 'float8', 'float4'
          m.register_type 'text', Type::Text.new
S
Sean Griffin 已提交
495
          register_class_with_limit m, 'varchar', Type::String
496 497 498 499
          m.alias_type 'char', 'varchar'
          m.alias_type 'name', 'varchar'
          m.alias_type 'bpchar', 'varchar'
          m.register_type 'bool', Type::Boolean.new
S
Sean Griffin 已提交
500 501
          register_class_with_limit m, 'bit', OID::Bit
          register_class_with_limit m, 'varbit', OID::BitVarying
502
          m.alias_type 'timestamptz', 'timestamp'
503
          m.register_type 'date', Type::Date.new
504 505 506 507 508 509

          m.register_type 'money', OID::Money.new
          m.register_type 'bytea', OID::Bytea.new
          m.register_type 'point', OID::Point.new
          m.register_type 'hstore', OID::Hstore.new
          m.register_type 'json', OID::Json.new
510
          m.register_type 'jsonb', OID::Jsonb.new
511 512 513
          m.register_type 'cidr', OID::Cidr.new
          m.register_type 'inet', OID::Inet.new
          m.register_type 'uuid', OID::Uuid.new
514
          m.register_type 'xml', OID::Xml.new
515 516 517 518 519 520 521 522 523 524 525 526 527 528
          m.register_type 'tsvector', OID::SpecializedString.new(:tsvector)
          m.register_type 'macaddr', OID::SpecializedString.new(:macaddr)
          m.register_type 'citext', OID::SpecializedString.new(:citext)
          m.register_type 'ltree', OID::SpecializedString.new(:ltree)

          # FIXME: why are we keeping these types as strings?
          m.alias_type 'interval', 'varchar'
          m.alias_type 'path', 'varchar'
          m.alias_type 'line', 'varchar'
          m.alias_type 'polygon', 'varchar'
          m.alias_type 'circle', 'varchar'
          m.alias_type 'lseg', 'varchar'
          m.alias_type 'box', 'varchar'

529 530
          register_class_with_precision m, 'time', Type::Time
          register_class_with_precision m, 'timestamp', OID::DateTime
S
Sean Griffin 已提交
531

532
          m.register_type 'numeric' do |_, fmod, sql_type|
S
Sean Griffin 已提交
533
            precision = extract_precision(sql_type)
S
Sean Griffin 已提交
534
            scale = extract_scale(sql_type)
S
Sean Griffin 已提交
535

536 537 538 539 540 541 542 543
            # The type for the numeric depends on the width of the field,
            # so we'll do something special here.
            #
            # When dealing with decimal columns:
            #
            # places after decimal  = fmod - 4 & 0xffff
            # places before decimal = (fmod - 4) >> 16 & 0xffff
            if fmod && (fmod - 4 & 0xffff).zero?
544 545
              # FIXME: Remove this class, and the second argument to
              # lookups on PG
546 547 548 549
              Type::DecimalWithoutScale.new(precision: precision)
            else
              OID::Decimal.new(precision: precision, scale: scale)
            end
S
Sean Griffin 已提交
550 551
          end

552 553 554
          load_additional_types(m)
        end

S
Sean Griffin 已提交
555 556
        def extract_limit(sql_type) # :nodoc:
          case sql_type
557 558 559 560 561 562
          when /^bigint/i, /^int8/i
            8
          when /^smallint/i
            2
          else
            super
S
Sean Griffin 已提交
563 564 565
          end
        end

566
        # Extracts the value from a PostgreSQL column default definition.
S
Sean Griffin 已提交
567
        def extract_value_from_default(default) # :nodoc:
568
          case default
569 570 571 572 573 574
            # Quoted types
            when /\A[\(B]?'(.*)'::/m
              $1.gsub(/''/, "'")
            # Boolean types
            when 'true', 'false'
              default
575
            # Numeric types
576
            when /\A\(?(-?\d+(\.\d*)?)\)?(::bigint)?\z/
577 578 579 580 581 582 583 584 585 586 587
              $1
            # Object identifier types
            when /\A-?\d+\z/
              $1
            else
              # Anything else is blank, some user type, or some function
              # and we can't know the value of that, so return nil.
              nil
          end
        end

588
        def extract_default_function(default_value, default) # :nodoc:
589 590 591
          default if has_default_function?(default_value, default)
        end

592
        def has_default_function?(default_value, default) # :nodoc:
593 594 595
          !default_value && (%r{\w+\(.*\)} === default)
        end

596
        def load_additional_types(type_map, oids = nil) # :nodoc:
597
          if supports_ranges?
598
            query = <<-SQL
599
              SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, r.rngsubtype, t.typtype, t.typbasetype
600 601 602 603
              FROM pg_type as t
              LEFT JOIN pg_range as r ON oid = rngtypid
            SQL
          else
604
            query = <<-SQL
605
              SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, t.typtype, t.typbasetype
606 607 608
              FROM pg_type as t
            SQL
          end
609 610 611 612 613

          if oids
            query += "WHERE t.oid::integer IN (%s)" % oids.join(", ")
          end

614 615 616
          initializer = OID::TypeMapInitializer.new(type_map)
          records = execute(query, 'SCHEMA')
          initializer.run(records)
617 618
        end

619
        FEATURE_NOT_SUPPORTED = "0A000" #:nodoc:
620

621 622 623 624 625 626 627 628
        def execute_and_clear(sql, name, binds)
          result = without_prepared_statement?(binds) ? exec_no_cache(sql, name, binds) :
                                                        exec_cache(sql, name, binds)
          ret = yield result
          result.clear
          ret
        end

629
        def exec_no_cache(sql, name, binds)
630
          log(sql, name, binds) { @connection.async_exec(sql, []) }
631
        end
632

633
        def exec_cache(sql, name, binds)
634
          stmt_key = prepare_statement(sql)
S
Sean Griffin 已提交
635
          type_casted_binds = binds.map { |attr| type_cast(attr.value_for_database) }
636

S
Sean Griffin 已提交
637 638
          log(sql, name, binds, stmt_key) do
            @connection.exec_prepared(stmt_key, type_casted_binds)
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
          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
657 658 659 660 661 662 663 664 665 666 667 668 669
          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)
670
          unless @statements.key? sql_key
671
            nextkey = @statements.next_key
672 673 674
            begin
              @connection.prepare nextkey, sql
            rescue => e
A
Aaron Patterson 已提交
675
              raise translate_exception_class(e, sql)
676
            end
677 678
            # Clear the queue
            @connection.get_last_result
679
            @statements[sql_key] = nextkey
680
          end
681
          @statements[sql_key]
682
        end
683

684 685 686
        # Connects to a PostgreSQL server and sets up the adapter depending on the
        # connected server's characteristics.
        def connect
687
          @connection = PGconn.connect(@connection_parameters)
688 689 690 691

          # 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.
692
          OID::Money.precision = (postgresql_version >= 80300) ? 19 : 10
693

694
          configure_connection
695 696
        rescue ::PG::Error => error
          if error.message.include?("does not exist")
697
            raise ActiveRecord::NoDatabaseError.new(error.message, error)
698
          else
699
            raise
700
          end
701 702
        end

703
        # Configures the encoding, verbosity, schema search path, and time zone of the connection.
704
        # This is called by #connect and should not be called manually.
705 706
        def configure_connection
          if @config[:encoding]
707
            @connection.set_client_encoding(@config[:encoding])
708
          end
709
          self.client_min_messages = @config[:min_messages] || 'warning'
710
          self.schema_search_path = @config[:schema_search_path] || @config[:schema_order]
711 712 713 714

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

715
          # If using Active Record's time zone support configure the connection to return
716
          # TIMESTAMP WITH ZONE types in UTC.
717
          # (SET TIME ZONE does not use an equals sign like other SET variables)
718
          if ActiveRecord::Base.default_timezone == :utc
719
            execute("SET time zone 'UTC'", 'SCHEMA')
720
          elsif @local_tz
721
            execute("SET time zone '#{@local_tz}'", 'SCHEMA')
722
          end
723 724 725 726 727 728 729

          # 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
730
              execute("SET SESSION #{k} TO DEFAULT", 'SCHEMA')
731
            elsif !v.nil?
732
              execute("SET SESSION #{k} TO #{quote(v)}", 'SCHEMA')
733 734
            end
          end
735 736
        end

737
        # Returns the current ID of a table's sequence.
738
        def last_insert_id(sequence_name) #:nodoc:
739 740 741
          Integer(last_insert_id_value(sequence_name))
        end

D
Doug Cole 已提交
742 743 744 745 746
        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:
747
          exec_query("SELECT currval('#{sequence_name}')", 'SQL')
D
Initial  
David Heinemeier Hansson 已提交
748 749
        end

750
        # Returns the list of a table's column names, data types, and default values.
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
        #
        # 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
768
        def column_definitions(table_name) # :nodoc:
769
          exec_query(<<-end_sql, 'SCHEMA').rows
770 771
              SELECT a.attname, format_type(a.atttypid, a.atttypmod),
                     pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod
772 773 774 775 776
                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
777
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
778
        end
779

780
        def extract_table_ref_from_insert_sql(sql) # :nodoc:
781
          sql[/into\s+([^\(]*).*values\s*\(/im]
782 783 784
          $1.strip if $1
        end

785
        def create_table_definition(name, temporary = false, options = nil, as = nil) # :nodoc:
786
          PostgreSQL::TableDefinition.new native_database_types, name, temporary, options, as
787
        end
S
Sean Griffin 已提交
788 789 790 791 792 793 794 795 796 797 798 799 800 801

        def can_perform_case_insensitive_comparison_for?(column)
          @case_insensitive_cache ||= {}
          @case_insensitive_cache[column.sql_type] ||= begin
            sql = <<-end_sql
              SELECT exists(
                SELECT * FROM pg_proc
                INNER JOIN pg_cast
                  ON casttarget::text::oidvector = proargtypes
                WHERE proname = 'lower'
                  AND castsource = '#{column.sql_type}'::regtype::oid
              )
            end_sql
            execute_and_clear(sql, "SCHEMA", []) do |result|
802
              result.getvalue(0, 0)
S
Sean Griffin 已提交
803 804 805
            end
          end
        end
806

807 808 809 810 811 812 813 814 815
        def add_pg_encoders
          map = PG::TypeMapByClass.new
          map[Integer] = PG::TextEncoder::Integer.new
          map[TrueClass] = PG::TextEncoder::Boolean.new
          map[FalseClass] = PG::TextEncoder::Boolean.new
          map[Float] = PG::TextEncoder::Float.new
          @connection.type_map_for_queries = map
        end

816 817 818 819 820 821 822 823 824 825 826
        def add_pg_decoders
          coders_by_name = {
            'int2' => PG::TextDecoder::Integer,
            'int4' => PG::TextDecoder::Integer,
            'int8' => PG::TextDecoder::Integer,
            'oid' => PG::TextDecoder::Integer,
            'float4' => PG::TextDecoder::Float,
            'float8' => PG::TextDecoder::Float,
            'bool' => PG::TextDecoder::Boolean,
          }
          query = <<-SQL
827
            SELECT t.oid, t.typname
828 829 830 831
            FROM pg_type as t
          SQL
          coders = execute_and_clear(query, "SCHEMA", []) do |result|
            result
832
              .map { |row| construct_coder(row, coders_by_name[row['typname']]) }
833 834 835 836 837 838 839 840 841 842
              .compact
          end

          map = PG::TypeMapByOid.new
          coders.each { |coder| map.add_coder(coder) }
          @connection.type_map_for_results = map
        end

        def construct_coder(row, coder_class)
          return unless coder_class
843
          coder_class.new(oid: row['oid'].to_i, name: row['typname'])
844
        end
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863

        ActiveRecord::Type.add_modifier({ array: true }, OID::Array, adapter: :postgresql)
        ActiveRecord::Type.add_modifier({ range: true }, OID::Range, adapter: :postgresql)
        ActiveRecord::Type.register(:bit, OID::Bit, adapter: :postgresql)
        ActiveRecord::Type.register(:bit_varying, OID::BitVarying, adapter: :postgresql)
        ActiveRecord::Type.register(:binary, OID::Bytea, adapter: :postgresql)
        ActiveRecord::Type.register(:cidr, OID::Cidr, adapter: :postgresql)
        ActiveRecord::Type.register(:date_time, OID::DateTime, adapter: :postgresql)
        ActiveRecord::Type.register(:decimal, OID::Decimal, adapter: :postgresql)
        ActiveRecord::Type.register(:enum, OID::Enum, adapter: :postgresql)
        ActiveRecord::Type.register(:hstore, OID::Hstore, adapter: :postgresql)
        ActiveRecord::Type.register(:inet, OID::Inet, adapter: :postgresql)
        ActiveRecord::Type.register(:json, OID::Json, adapter: :postgresql)
        ActiveRecord::Type.register(:jsonb, OID::Jsonb, adapter: :postgresql)
        ActiveRecord::Type.register(:money, OID::Money, adapter: :postgresql)
        ActiveRecord::Type.register(:point, OID::Point, adapter: :postgresql)
        ActiveRecord::Type.register(:uuid, OID::Uuid, adapter: :postgresql)
        ActiveRecord::Type.register(:vector, OID::Vector, adapter: :postgresql)
        ActiveRecord::Type.register(:xml, OID::Xml, adapter: :postgresql)
D
Initial  
David Heinemeier Hansson 已提交
864 865 866
    end
  end
end