postgresql_adapter.rb 28.5 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 'arel/visitors/bind_visitor'
11 12 13

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

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

D
Initial  
David Heinemeier Hansson 已提交
18
module ActiveRecord
19
  module ConnectionHandling
20 21 22 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,
                         :tty, :sslmode, :requiressl, :sslcert, :sslkey, :sslrootcert, :sslcrl,
                         :requirepeer, :krbsrvname, :gsslib, :service]

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

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

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

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

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

45 46 47
  module ConnectionAdapters
    # PostgreSQL-specific extensions to column definitions in a table.
    class PostgreSQLColumn < Column #:nodoc:
48
      attr_accessor :array
49
      # Instantiates a new PostgreSQL column definition in a table.
50 51
      def initialize(name, default, oid_type, sql_type = nil, null = true)
        @oid_type = oid_type
52 53 54 55 56 57 58
        if sql_type =~ /\[\]$/
          @array = true
          super(name, self.class.extract_value_from_default(default), sql_type[0..sql_type.length - 3], null)
        else
          @array = false
          super(name, self.class.extract_value_from_default(default), sql_type, null)
        end
59
      end
60

61 62
      # :stopdoc:
      class << self
63
        include ConnectionAdapters::PostgreSQLColumn::Cast
64
        include ConnectionAdapters::PostgreSQLColumn::ArrayParser
65
        attr_accessor :money_precision
66 67 68
      end
      # :startdoc:

69 70 71 72 73 74 75 76 77 78 79
      # Extracts the value from a PostgreSQL column default definition.
      def self.extract_value_from_default(default)
        # 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.
        return default unless default

        case default
B
bUg 已提交
80 81
          when /\A'(.*)'::(num|date|tstz|ts|int4|int8)range\z/m
            $1
82 83 84
          # Numeric types
          when /\A\(?(-?\d+(\.\d*)?\)?)\z/
            $1
85
          # Character types
86
          when /\A\(?'(.*)'::.*\b(?:character varying|bpchar|text)\z/m
87
            $1
88
          # Binary data types
89 90
          when /\A'(.*)'::bytea\z/m
            $1
91
          # Date/time types
92 93 94 95 96 97 98 99 100
          when /\A'(.+)'::(?:time(?:stamp)? with(?:out)? time zone|date)\z/
            $1
          when /\A'(.*)'::interval\z/
            $1
          # Boolean type
          when 'true'
            true
          when 'false'
            false
101
          # Geometric types
102 103
          when /\A'(.*)'::(?:point|line|lseg|box|"?path"?|polygon|circle)\z/
            $1
104
          # Network address types
105 106 107 108 109
          when /\A'(.*)'::(?:cidr|inet|macaddr)\z/
            $1
          # Bit string types
          when /\AB'(.*)'::"?bit(?: varying)?"?\z/
            $1
110
          # XML type
111 112
          when /\A'(.*)'::xml\z/m
            $1
113
          # Arrays
114 115
          when /\A'(.*)'::"?\D+"?\[\]\z/
            $1
116 117 118
          # Hstore
          when /\A'(.*)'::hstore\z/
            $1
119 120 121
          # JSON
          when /\A'(.*)'::json\z/
            $1
122
          # Object identifier types
123 124
          when /\A-?\d+\z/
            $1
125
          else
126 127 128
            # Anything else is blank, some user type, or some function
            # and we can't know the value of that, so return nil.
            nil
129
        end
130
      end
131

132 133 134 135 136 137 138
      def type_cast(value)
        return if value.nil?
        return super if encoded?

        @oid_type.type_cast value
      end

139
      private
140 141 142 143 144 145 146 147

        def extract_limit(sql_type)
          case sql_type
          when /^bigint/i;    8
          when /^smallint/i;  2
          when /^timestamp/i; nil
          else super
          end
148 149
        end

150 151 152 153 154
        # 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
155

156 157 158 159 160 161 162 163 164
        # Extracts the precision from PostgreSQL-specific data types.
        def extract_precision(sql_type)
          if sql_type == 'money'
            self.class.money_precision
          elsif sql_type =~ /timestamp/i
            $1.to_i if sql_type =~ /\((\d+)\)/
          else
            super
          end
165 166
        end

167 168 169 170 171 172 173 174 175 176 177
        # 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
          when 'money'
            :decimal
          when 'hstore'
            :hstore
178 179
          when 'ltree'
            :ltree
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
          # Network address types
          when 'inet'
            :inet
          when 'cidr'
            :cidr
          when 'macaddr'
            :macaddr
          # Character types
          when /^(?:character varying|bpchar)(?:\(\d+\))?$/
            :string
          # Binary data types
          when 'bytea'
            :binary
          # Date/time types
          when /^timestamp with(?:out)? time zone$/
            :datetime
196
          when /^interval(?:|\(\d+\))$/
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
            :string
          # Geometric types
          when /^(?:point|line|lseg|box|"?path"?|polygon|circle)$/
            :string
          # Bit strings
          when /^bit(?: varying)?(?:\(\d+\))?$/
            :string
          # XML type
          when 'xml'
            :xml
          # tsvector type
          when 'tsvector'
            :tsvector
          # Arrays
          when /^\D+\[\]$/
            :string
          # Object identifier types
          when 'oid'
            :integer
          # UUID type
          when 'uuid'
            :uuid
219 220 221
          # JSON type
          when 'json'
            :json
222 223 224
          # Small and big integer types
          when /^(?:small|big)int$/
            :integer
B
bUg 已提交
225 226
          when /(num|date|tstz|ts|int4|int8)range$/
            field_type.to_sym
227 228 229 230
          # Pass through all types that are not specific to PostgreSQL.
          else
            super
          end
231
        end
D
Initial  
David Heinemeier Hansson 已提交
232 233
    end

234
    # The PostgreSQL adapter works with the native C (https://bitbucket.org/ged/ruby-pg) driver.
235 236 237
    #
    # Options:
    #
238 239
    # * <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 已提交
240
    # * <tt>:port</tt> - Defaults to 5432.
241 242 243
    # * <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.
244
    # * <tt>:schema_search_path</tt> - An optional schema search path for the connection given
245
    #   as a string of comma-separated schema names. This is backward-compatible with the <tt>:schema_order</tt> option.
246
    # * <tt>:encoding</tt> - An optional client encoding that is used in a <tt>SET client_encoding TO
247
    #   <encoding></tt> call on the connection.
248
    # * <tt>:min_messages</tt> - An optional client min messages that is used in a
249
    #   <tt>SET client_min_messages TO <min_messages></tt> call on the connection.
250 251
    # * <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 已提交
252
    # * <tt>:insert_returning</tt> - An optional boolean to control the use or <tt>RETURNING</tt> for <tt>INSERT</tt> statements
253
    #   defaults to true.
254 255 256 257 258 259 260
    #
    # 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 .
261
    class PostgreSQLAdapter < AbstractAdapter
262 263 264 265
      class ColumnDefinition < ActiveRecord::ConnectionAdapters::ColumnDefinition
        attr_accessor :array
      end

266 267 268 269 270
      class TableDefinition < ActiveRecord::ConnectionAdapters::TableDefinition
        def xml(*args)
          options = args.extract_options!
          column(args[0], 'xml', options)
        end
271 272 273 274 275

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

B
bUg 已提交
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
        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

301 302 303
        def hstore(name, options = {})
          column(name, 'hstore', options)
        end
304

305 306 307 308
        def ltree(name, options = {})
          column(name, 'ltree', options)
        end

309 310 311 312 313 314 315 316 317 318 319
        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
320 321 322 323

        def uuid(name, options = {})
          column(name, 'uuid', options)
        end
324 325 326 327

        def json(name, options = {})
          column(name, 'json', options)
        end
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344

        def column(name, type = nil, options = {})
          super
          column = self[name]
          column.array = options[:array]

          self
        end

        private

        def new_column_definition(base, name, type)
          definition = ColumnDefinition.new base, name, type
          @columns << definition
          @columns_hash[name] = definition
          definition
        end
345 346
      end

347
      ADAPTER_NAME = 'PostgreSQL'
348 349

      NATIVE_DATABASE_TYPES = {
350 351 352 353 354 355 356 357 358 359
        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 已提交
360 361 362 363 364 365
        daterange:   { name: "daterange" },
        numrange:    { name: "numrange" },
        tsrange:     { name: "tsrange" },
        tstzrange:   { name: "tstzrange" },
        int4range:   { name: "int4range" },
        int8range:   { name: "int8range" },
366 367 368 369 370 371 372 373
        binary:      { name: "bytea" },
        boolean:     { name: "boolean" },
        xml:         { name: "xml" },
        tsvector:    { name: "tsvector" },
        hstore:      { name: "hstore" },
        inet:        { name: "inet" },
        cidr:        { name: "cidr" },
        macaddr:     { name: "macaddr" },
374
        uuid:        { name: "uuid" },
375
        json:        { name: "json" },
376
        ltree:       { name: "ltree" }
377 378
      }

379 380 381 382 383
      include Quoting
      include ReferentialIntegrity
      include SchemaStatements
      include DatabaseStatements

384
      # Returns 'PostgreSQL' as adapter name for identification purposes.
385
      def adapter_name
386
        ADAPTER_NAME
387 388
      end

389 390 391 392 393 394 395 396 397 398 399 400 401
      # 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
        spec
      end

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

402 403
      # Returns +true+, since this connection adapter supports prepared statement
      # caching.
404 405 406 407
      def supports_statement_cache?
        true
      end

408 409 410 411
      def supports_index_sort_order?
        true
      end

412 413 414 415
      def supports_partial_index?
        true
      end

416 417 418 419
      def supports_transaction_isolation?
        true
      end

420 421 422 423
      class StatementPool < ConnectionAdapters::StatementPool
        def initialize(connection, max)
          super
          @counter = 0
424
          @cache   = Hash.new { |h,pid| h[pid] = {} }
425 426
        end

427 428 429 430
        def each(&block); cache.each(&block); end
        def key?(key);    cache.key?(key); end
        def [](key);      cache[key]; end
        def length;       cache.length; end
431 432 433 434 435 436

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

        def []=(sql, key)
437 438
          while @max <= cache.size
            dealloc(cache.shift.last)
439 440
          end
          @counter += 1
441
          cache[sql] = key
442 443 444
        end

        def clear
445
          cache.each_value do |stmt_key|
446 447
            dealloc stmt_key
          end
448
          cache.clear
449 450
        end

451 452 453 454 455
        def delete(sql_key)
          dealloc cache[sql_key]
          cache.delete sql_key
        end

456
        private
457

458 459 460
          def cache
            @cache[Process.pid]
          end
461

462 463 464 465 466 467 468 469 470
          def dealloc(key)
            @connection.query "DEALLOCATE #{key}" if connection_active?
          end

          def connection_active?
            @connection.status == PGconn::CONNECTION_OK
          rescue PGError
            false
          end
471 472
      end

473 474 475 476
      class BindSubstitution < Arel::Visitors::PostgreSQL # :nodoc:
        include Arel::Visitors::BindVisitor
      end

477 478
      # Initializes and connects a PostgreSQL adapter.
      def initialize(connection, logger, connection_parameters, config)
479
        super(connection, logger)
480 481 482 483 484 485 486

        if config.fetch(:prepared_statements) { true }
          @visitor = Arel::Visitors::PostgreSQL.new self
        else
          @visitor = BindSubstitution.new self
        end

487
        @connection_parameters, @config = connection_parameters, config
488

489 490
        # @local_tz is initialized as nil to avoid warnings when connect tries to use it
        @local_tz = nil
491 492
        @table_alias_length = nil

493
        connect
494 495
        @statements = StatementPool.new @connection,
                                        config.fetch(:statement_limit) { 1000 }
496 497 498 499 500

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

501
        initialize_type_map
502
        @local_tz = execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"]
503
        @use_insert_returning = @config.key?(:insert_returning) ? @config[:insert_returning] : true
504 505
      end

X
Xavier Noria 已提交
506
      # Clears the prepared statements cache.
507 508 509 510
      def clear_cache!
        @statements.clear
      end

511 512
      # Is this connection alive and ready for queries?
      def active?
513 514
        @connection.query 'SELECT 1'
        true
515
      rescue PGError
516
        false
517 518 519 520
      end

      # Close then reopen the connection.
      def reconnect!
521
        super
522 523
        @connection.reset
        configure_connection
524
      end
525

526 527 528 529 530
      def reset!
        clear_cache!
        super
      end

531 532
      # Disconnects from the database if already connected. Otherwise, this
      # method does nothing.
533
      def disconnect!
534
        super
535 536
        @connection.close rescue nil
      end
537

538
      def native_database_types #:nodoc:
539
        NATIVE_DATABASE_TYPES
540
      end
541

542
      # Returns true, since this connection adapter supports migrations.
543 544
      def supports_migrations?
        true
545 546
      end

547
      # Does PostgreSQL support finding primary key on non-Active Record tables?
548 549 550 551
      def supports_primary_key? #:nodoc:
        true
      end

552 553 554
      # Enable standard-conforming strings if available.
      def set_standard_conforming_strings
        old, self.client_min_messages = client_min_messages, 'panic'
555
        execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil
556 557
      ensure
        self.client_min_messages = old
558 559
      end

560
      def supports_insert_with_returning?
561
        true
562 563
      end

564 565 566
      def supports_ddl_transactions?
        true
      end
567

568
      # Returns true, since this connection adapter supports savepoints.
569 570 571
      def supports_savepoints?
        true
      end
572

573 574 575 576 577
      # Returns true.
      def supports_explain?
        true
      end

A
Aaron Patterson 已提交
578
      # Returns true if pg > 9.2
579 580 581 582
      def supports_extensions?
        postgresql_version >= 90200
      end

A
Andrew White 已提交
583 584 585 586 587
      # Range datatypes weren't introduced until PostgreSQL 9.2
      def supports_ranges?
        postgresql_version >= 90200
      end

588
      def enable_extension(name)
589 590 591
        exec_query("CREATE EXTENSION IF NOT EXISTS #{name}").tap {
          reload_type_map
        }
592 593 594
      end

      def disable_extension(name)
595 596 597
        exec_query("DROP EXTENSION IF EXISTS #{name} CASCADE").tap {
          reload_type_map
        }
598 599 600
      end

      def extension_enabled?(name)
R
Rafael Mendonça França 已提交
601
        if supports_extensions?
602 603 604 605
          res = exec_query "SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL)",
            'SCHEMA'
          res.column_types['exists'].type_cast res.rows.first.first
        end
606 607
      end

608
      # Returns the configured supported identifier length supported by PostgreSQL
609
      def table_alias_length
K
kennyj 已提交
610
        @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
611
      end
612

613 614 615 616 617 618 619
      def add_column_options!(sql, options)
        if options[:array] || options[:column].try(:array)
          sql << '[]'
        end
        super
      end

620 621
      # Set the authorized user for this session
      def session_auth=(user)
622
        clear_cache!
A
Aaron Patterson 已提交
623
        exec_query "SET SESSION AUTHORIZATION #{user}"
624 625
      end

626
      module Utils
627 628
        extend self

629 630 631 632 633 634 635 636 637 638
        # 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>
639
        def extract_schema_and_table(name)
640 641 642 643 644
          table, schema = name.scan(/[^".\s]+|"[^"]*"/)[0..1].collect{|m| m.gsub(/(^"|"$)/,'') }.reverse
          [schema, table]
        end
      end

645 646
      def use_insert_returning?
        @use_insert_returning
647 648
      end

649
      protected
650

651
        # Returns the version of the connected PostgreSQL server.
652
        def postgresql_version
653
          @connection.server_version
654 655
        end

656 657 658 659
        # See http://www.postgresql.org/docs/9.1/static/errcodes-appendix.html
        FOREIGN_KEY_VIOLATION = "23503"
        UNIQUE_VIOLATION      = "23505"

660
        def translate_exception(exception, message)
661
          case exception.result.try(:error_field, PGresult::PG_DIAG_SQLSTATE)
662
          when UNIQUE_VIOLATION
663
            RecordNotUnique.new(message, exception)
664
          when FOREIGN_KEY_VIOLATION
665
            InvalidForeignKey.new(message, exception)
666 667 668 669 670
          else
            super
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
671
      private
672

673 674 675 676 677
        def reload_type_map
          OID::TYPE_MAP.clear
          initialize_type_map
        end

678
        def initialize_type_map
679
          result = execute('SELECT oid, typname, typelem, typdelim, typinput FROM pg_type', 'SCHEMA')
680
          leaves, nodes = result.partition { |row| row['typelem'] == '0' }
681

682 683 684 685 686
          # populate the leaf nodes
          leaves.find_all { |row| OID.registered_type? row['typname'] }.each do |row|
            OID::TYPE_MAP[row['oid'].to_i] = OID::NAMES[row['typname']]
          end

687 688
          arrays, nodes = nodes.partition { |row| row['typinput'] == 'array_in' }

689 690 691 692 693
          # populate composite types
          nodes.find_all { |row| OID::TYPE_MAP.key? row['typelem'].to_i }.each do |row|
            vector = OID::Vector.new row['typdelim'], OID::TYPE_MAP[row['typelem'].to_i]
            OID::TYPE_MAP[row['oid'].to_i] = vector
          end
694 695 696 697 698 699

          # populate array types
          arrays.find_all { |row| OID::TYPE_MAP.key? row['typelem'].to_i }.each do |row|
            array = OID::Array.new  OID::TYPE_MAP[row['typelem'].to_i]
            OID::TYPE_MAP[row['oid'].to_i] = array
          end
700 701
        end

702 703
        FEATURE_NOT_SUPPORTED = "0A000" # :nodoc:

704 705
        def exec_no_cache(sql, binds)
          @connection.async_exec(sql)
706
        end
707

708
        def exec_cache(sql, binds)
709 710 711 712 713 714 715 716 717 718 719 720 721 722
          stmt_key = prepare_statement sql

          # Clear the queue
          @connection.get_last_result
          @connection.send_query_prepared(stmt_key, binds.map { |col, val|
            type_cast(val, col)
          })
          @connection.block
          @connection.get_last_result
        rescue PGError => e
          # 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
723
          begin
724 725 726 727 728 729 730 731 732
            code = e.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
733 734 735 736 737 738 739 740 741 742 743 744 745
          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)
746
          unless @statements.key? sql_key
747
            nextkey = @statements.next_key
748
            @connection.prepare nextkey, sql
749
            @statements[sql_key] = nextkey
750
          end
751
          @statements[sql_key]
752
        end
753

P
Pratik Naik 已提交
754
        # The internal PostgreSQL identifier of the money data type.
755
        MONEY_COLUMN_TYPE_OID = 790 #:nodoc:
756 757
        # The internal PostgreSQL identifier of the BYTEA data type.
        BYTEA_COLUMN_TYPE_OID = 17 #:nodoc:
758 759 760 761

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

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

769 770 771
          configure_connection
        end

772
        # Configures the encoding, verbosity, schema search path, and time zone of the connection.
773
        # This is called by #connect and should not be called manually.
774 775
        def configure_connection
          if @config[:encoding]
776
            @connection.set_client_encoding(@config[:encoding])
777
          end
778
          self.client_min_messages = @config[:min_messages] || 'warning'
779
          self.schema_search_path = @config[:schema_search_path] || @config[:schema_order]
780 781 782 783

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

784
          # If using Active Record's time zone support configure the connection to return
785
          # TIMESTAMP WITH ZONE types in UTC.
786
          # (SET TIME ZONE does not use an equals sign like other SET variables)
787
          if ActiveRecord::Base.default_timezone == :utc
788
            execute("SET time zone 'UTC'", 'SCHEMA')
789
          elsif @local_tz
790
            execute("SET time zone '#{@local_tz}'", 'SCHEMA')
791
          end
792 793 794 795 796 797 798 799 800 801 802 803

          # 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
804 805
        end

806
        # Returns the current ID of a table's sequence.
807
        def last_insert_id(sequence_name) #:nodoc:
808 809 810
          Integer(last_insert_id_value(sequence_name))
        end

D
Doug Cole 已提交
811 812 813 814 815
        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:
816
          exec_query("SELECT currval('#{sequence_name}')", 'SQL')
D
Initial  
David Heinemeier Hansson 已提交
817 818
        end

819
        # Executes a SELECT query and returns the results, performing any data type
820
        # conversions that are required to be performed here instead of in PostgreSQLColumn.
821
        def select(sql, name = nil, binds = [])
822
          exec_query(sql, name, binds)
823 824 825
        end

        def select_raw(sql, name = nil)
826
          res = execute(sql, name)
827
          results = result_as_array(res)
828
          fields = res.fields
829
          res.clear
830
          return fields, results
M
Marcel Molina 已提交
831 832
        end

833
        # Returns the list of a table's column names, data types, and default values.
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
        #
        # 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
851
        def column_definitions(table_name) #:nodoc:
852
          exec_query(<<-end_sql, 'SCHEMA').rows
853 854
              SELECT a.attname, format_type(a.atttypid, a.atttypmod),
                     pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod
855 856 857 858 859
                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
860
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
861
        end
862 863

        def extract_pg_identifier_from_name(name)
864
          match_data = name.start_with?('"') ? name.match(/\"([^\"]+)\"/) : name.match(/([^\.]+)/)
865 866

          if match_data
867 868
            rest = name[match_data[0].length, name.length]
            rest = rest[1, rest.length] if rest.start_with? "."
J
José Valim 已提交
869
            [match_data[1], (rest.length > 0 ? rest : nil)]
870 871
          end
        end
872

873 874 875 876 877
        def extract_table_ref_from_insert_sql(sql)
          sql[/into\s+([^\(]*).*values\s*\(/i]
          $1.strip if $1
        end

878 879 880
        def table_definition
          TableDefinition.new(self)
        end
D
Initial  
David Heinemeier Hansson 已提交
881 882 883
    end
  end
end