postgresql_adapter.rb 32.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 # :nodoc:
20 21 22
    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,
23 24
                         :tty, :sslmode, :requiressl, :sslcompression, :sslcert, :sslkey,
                         :sslrootcert, :sslcrl, :requirepeer, :krbsrvname, :gsslib, :service]
25

D
Initial  
David Heinemeier Hansson 已提交
26
    # Establishes a connection to the database that's used by all Active Record objects
27
    def postgresql_connection(config)
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

50 51
      def initialize(name, default, oid_type, sql_type = nil, null = true)
        @oid_type = oid_type
52
        default_value     = self.class.extract_value_from_default(default)
53

54 55
        if sql_type =~ /\[\]$/
          @array = true
56
          super(name, default_value, sql_type[0..sql_type.length - 3], null)
57 58
        else
          @array = false
59
          super(name, default_value, sql_type, null)
60
        end
61

62
        @default_function = default if has_default_function?(default_value, default)
63
      end
64

65 66 67 68 69 70 71 72
      def number?
        !array && super
      end

      def text?
        !array && super
      end

73 74
      # :stopdoc:
      class << self
75
        include ConnectionAdapters::PostgreSQLColumn::Cast
76
        include ConnectionAdapters::PostgreSQLColumn::ArrayParser
77
        attr_accessor :money_precision
78 79 80
      end
      # :startdoc:

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

144 145 146 147 148 149 150 151
      def type_cast_for_write(value)
        if @oid_type.respond_to?(:type_cast_for_write)
          @oid_type.type_cast_for_write(value)
        else
          super
        end
      end

152 153 154 155 156 157 158
      def type_cast(value)
        return if value.nil?
        return super if encoded?

        @oid_type.type_cast value
      end

159 160 161 162
      def accessor
        @oid_type.accessor
      end

163
      private
164

165
        def has_default_function?(default_value, default)
166
          !default_value && (%r{\w+\(.*\)} === default)
167 168
        end

169 170 171 172 173 174 175
        def extract_limit(sql_type)
          case sql_type
          when /^bigint/i;    8
          when /^smallint/i;  2
          when /^timestamp/i; nil
          else super
          end
176 177
        end

178 179 180 181 182
        # 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
183

184 185 186 187 188 189 190 191 192
        # 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
193 194
        end

195 196 197 198 199 200 201 202 203 204 205
        # 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
206 207
          when 'ltree'
            :ltree
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
          # 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
224
          when /^interval(?:|\(\d+\))$/
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
            :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
247 248 249
          # JSON type
          when 'json'
            :json
250 251 252
          # Small and big integer types
          when /^(?:small|big)int$/
            :integer
B
bUg 已提交
253 254
          when /(num|date|tstz|ts|int4|int8)range$/
            field_type.to_sym
255 256 257 258
          # Pass through all types that are not specific to PostgreSQL.
          else
            super
          end
259
        end
D
Initial  
David Heinemeier Hansson 已提交
260 261
    end

262
    # The PostgreSQL adapter works with the native C (https://bitbucket.org/ged/ruby-pg) driver.
263 264 265
    #
    # Options:
    #
266 267
    # * <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 已提交
268
    # * <tt>:port</tt> - Defaults to 5432.
269 270 271
    # * <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.
272
    # * <tt>:schema_search_path</tt> - An optional schema search path for the connection given
273
    #   as a string of comma-separated schema names. This is backward-compatible with the <tt>:schema_order</tt> option.
274
    # * <tt>:encoding</tt> - An optional client encoding that is used in a <tt>SET client_encoding TO
275
    #   <encoding></tt> call on the connection.
276
    # * <tt>:min_messages</tt> - An optional client min messages that is used in a
277
    #   <tt>SET client_min_messages TO <min_messages></tt> call on the connection.
278 279
    # * <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 已提交
280
    # * <tt>:insert_returning</tt> - An optional boolean to control the use or <tt>RETURNING</tt> for <tt>INSERT</tt> statements
281
    #   defaults to true.
282 283 284 285 286 287 288
    #
    # 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 .
289
    class PostgreSQLAdapter < AbstractAdapter
290 291 292 293
      class ColumnDefinition < ActiveRecord::ConnectionAdapters::ColumnDefinition
        attr_accessor :array
      end

294
      module ColumnMethods
295 296 297 298
        def xml(*args)
          options = args.extract_options!
          column(args[0], 'xml', options)
        end
299 300 301 302 303

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

B
bUg 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
        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

329 330 331
        def hstore(name, options = {})
          column(name, 'hstore', options)
        end
332

333 334 335 336
        def ltree(name, options = {})
          column(name, 'ltree', options)
        end

337 338 339 340 341 342 343 344 345 346 347
        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
348 349 350 351

        def uuid(name, options = {})
          column(name, 'uuid', options)
        end
352 353 354 355

        def json(name, options = {})
          column(name, 'json', options)
        end
356 357 358 359
      end

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

361 362 363 364 365 366 367 368 369 370
        # 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
371
        # +uuid-ossp+ extension, which MUST be enabled on your database. To enable
372
        # the +uuid-ossp+ extension, you can use the +enable_extension+ method in your
373 374
        # migrations. To use a UUID primary key without +uuid-ossp+ enabled, you can
        # set the +:default+ option to +nil+:
375 376 377 378 379 380 381 382 383 384
        #
        #   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.
        #
385 386 387 388
        # 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 已提交
389
        def primary_key(name, type = :primary_key, options = {})
390 391
          return super unless type == :uuid
          options[:default] = options.fetch(:default, 'uuid_generate_v4()')
A
Aaron Patterson 已提交
392 393 394 395
          options[:primary_key] = true
          column name, type, options
        end

396 397 398 399 400 401 402 403 404 405
        def column(name, type = nil, options = {})
          super
          column = self[name]
          column.array = options[:array]

          self
        end

        private

406 407 408
          def create_column_definition(name, type)
            ColumnDefinition.new name, type
          end
409 410
      end

411 412 413 414
      class Table < ActiveRecord::ConnectionAdapters::Table
        include ColumnMethods
      end

415
      ADAPTER_NAME = 'PostgreSQL'
416 417

      NATIVE_DATABASE_TYPES = {
418 419 420 421 422 423 424 425 426 427
        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 已提交
428 429 430 431 432 433
        daterange:   { name: "daterange" },
        numrange:    { name: "numrange" },
        tsrange:     { name: "tsrange" },
        tstzrange:   { name: "tstzrange" },
        int4range:   { name: "int4range" },
        int8range:   { name: "int8range" },
434 435 436 437 438 439 440 441
        binary:      { name: "bytea" },
        boolean:     { name: "boolean" },
        xml:         { name: "xml" },
        tsvector:    { name: "tsvector" },
        hstore:      { name: "hstore" },
        inet:        { name: "inet" },
        cidr:        { name: "cidr" },
        macaddr:     { name: "macaddr" },
442
        uuid:        { name: "uuid" },
443
        json:        { name: "json" },
444
        ltree:       { name: "ltree" }
445 446
      }

447 448 449 450
      include Quoting
      include ReferentialIntegrity
      include SchemaStatements
      include DatabaseStatements
451
      include Savepoints
452

453
      # Returns 'PostgreSQL' as adapter name for identification purposes.
454
      def adapter_name
455
        ADAPTER_NAME
456 457
      end

458 459 460 461 462
      # 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
463
        spec[:default] = "\"#{column.default_function}\"" if column.default_function
464 465 466 467 468 469 470 471
        spec
      end

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

472 473
      # Returns +true+, since this connection adapter supports prepared statement
      # caching.
474 475 476 477
      def supports_statement_cache?
        true
      end

478 479 480 481
      def supports_index_sort_order?
        true
      end

482 483 484 485
      def supports_partial_index?
        true
      end

486 487 488 489
      def supports_transaction_isolation?
        true
      end

490 491 492 493
      def index_algorithms
        { concurrently: 'CONCURRENTLY' }
      end

494 495 496 497
      class StatementPool < ConnectionAdapters::StatementPool
        def initialize(connection, max)
          super
          @counter = 0
498
          @cache   = Hash.new { |h,pid| h[pid] = {} }
499 500
        end

501 502 503 504
        def each(&block); cache.each(&block); end
        def key?(key);    cache.key?(key); end
        def [](key);      cache[key]; end
        def length;       cache.length; end
505 506 507 508 509 510

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

        def []=(sql, key)
511 512
          while @max <= cache.size
            dealloc(cache.shift.last)
513 514
          end
          @counter += 1
515
          cache[sql] = key
516 517 518
        end

        def clear
519
          cache.each_value do |stmt_key|
520 521
            dealloc stmt_key
          end
522
          cache.clear
523 524
        end

525 526 527 528 529
        def delete(sql_key)
          dealloc cache[sql_key]
          cache.delete sql_key
        end

530
        private
531

532 533 534
          def cache
            @cache[Process.pid]
          end
535

536 537 538 539 540 541 542 543 544
          def dealloc(key)
            @connection.query "DEALLOCATE #{key}" if connection_active?
          end

          def connection_active?
            @connection.status == PGconn::CONNECTION_OK
          rescue PGError
            false
          end
545 546
      end

547 548 549 550
      class BindSubstitution < Arel::Visitors::PostgreSQL # :nodoc:
        include Arel::Visitors::BindVisitor
      end

551 552
      # Initializes and connects a PostgreSQL adapter.
      def initialize(connection, logger, connection_parameters, config)
553
        super(connection, logger)
554

555
        if self.class.type_cast_config_to_boolean(config.fetch(:prepared_statements) { true })
556
          @prepared_statements = true
557 558
          @visitor = Arel::Visitors::PostgreSQL.new self
        else
559
          @visitor = unprepared_visitor
560 561
        end

562
        @connection_parameters, @config = connection_parameters, config
563

564 565
        # @local_tz is initialized as nil to avoid warnings when connect tries to use it
        @local_tz = nil
566 567
        @table_alias_length = nil

568
        connect
569
        @statements = StatementPool.new @connection,
570
                                        self.class.type_cast_config_to_integer(config.fetch(:statement_limit) { 1000 })
571 572 573 574 575

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

576 577
        @type_map = OID::TypeMap.new
        initialize_type_map(type_map)
578
        @local_tz = execute('SHOW TIME ZONE', 'SCHEMA').first["TimeZone"]
579
        @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true
580 581
      end

X
Xavier Noria 已提交
582
      # Clears the prepared statements cache.
583 584 585 586
      def clear_cache!
        @statements.clear
      end

587 588
      # Is this connection alive and ready for queries?
      def active?
589 590
        @connection.query 'SELECT 1'
        true
591
      rescue PGError
592
        false
593 594
      end

595 596 597 598
      def active_threadsafe?
        @connection.connect_poll != PG::PGRES_POLLING_FAILED
      end

599 600
      # Close then reopen the connection.
      def reconnect!
601
        super
602 603
        @connection.reset
        configure_connection
604
      end
605

606 607 608 609 610
      def reset!
        clear_cache!
        super
      end

611 612
      # Disconnects from the database if already connected. Otherwise, this
      # method does nothing.
613
      def disconnect!
614
        super
615 616
        @connection.close rescue nil
      end
617

618
      def native_database_types #:nodoc:
619
        NATIVE_DATABASE_TYPES
620
      end
621

622
      # Returns true, since this connection adapter supports migrations.
623 624
      def supports_migrations?
        true
625 626
      end

627
      # Does PostgreSQL support finding primary key on non-Active Record tables?
628 629 630 631
      def supports_primary_key? #:nodoc:
        true
      end

632 633 634
      # Enable standard-conforming strings if available.
      def set_standard_conforming_strings
        old, self.client_min_messages = client_min_messages, 'panic'
635
        execute('SET standard_conforming_strings = on', 'SCHEMA') rescue nil
636 637
      ensure
        self.client_min_messages = old
638 639
      end

640
      def supports_insert_with_returning?
641
        true
642 643
      end

644 645 646
      def supports_ddl_transactions?
        true
      end
647

648 649 650 651
      def supports_explain?
        true
      end

652
      # Returns true if pg > 9.1
653
      def supports_extensions?
654
        postgresql_version >= 90100
655 656
      end

A
Andrew White 已提交
657 658 659 660 661
      # Range datatypes weren't introduced until PostgreSQL 9.2
      def supports_ranges?
        postgresql_version >= 90200
      end

662
      def enable_extension(name)
663
        exec_query("CREATE EXTENSION IF NOT EXISTS \"#{name}\"").tap {
664 665
          reload_type_map
        }
666 667 668
      end

      def disable_extension(name)
669
        exec_query("DROP EXTENSION IF EXISTS \"#{name}\" CASCADE").tap {
670 671
          reload_type_map
        }
672 673 674
      end

      def extension_enabled?(name)
R
Rafael Mendonça França 已提交
675
        if supports_extensions?
676
          res = exec_query "SELECT EXISTS(SELECT * FROM pg_available_extensions WHERE name = '#{name}' AND installed_version IS NOT NULL) as enabled",
677
            'SCHEMA'
678
          res.column_types['enabled'].type_cast res.rows.first.first
679
        end
680 681
      end

682 683 684 685 686
      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
687
          super
688 689 690
        end
      end

691
      # Returns the configured supported identifier length supported by PostgreSQL
692
      def table_alias_length
K
kennyj 已提交
693
        @table_alias_length ||= query('SHOW max_identifier_length', 'SCHEMA')[0][0].to_i
694
      end
695

696 697
      # Set the authorized user for this session
      def session_auth=(user)
698
        clear_cache!
A
Aaron Patterson 已提交
699
        exec_query "SET SESSION AUTHORIZATION #{user}"
700 701
      end

702
      module Utils
703 704
        extend self

705 706 707 708 709 710 711 712 713 714
        # 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>
715
        def extract_schema_and_table(name)
716 717 718 719 720
          table, schema = name.scan(/[^".\s]+|"[^"]*"/)[0..1].collect{|m| m.gsub(/(^"|"$)/,'') }.reverse
          [schema, table]
        end
      end

721 722
      def use_insert_returning?
        @use_insert_returning
723 724
      end

725 726 727 728
      def valid_type?(type)
        !native_database_types[type].nil?
      end

729 730 731 732
      def update_table_definition(table_name, base) #:nodoc:
        Table.new(table_name, base)
      end

733
      protected
734

735
        # Returns the version of the connected PostgreSQL server.
736
        def postgresql_version
737
          @connection.server_version
738 739
        end

740 741 742 743
        # See http://www.postgresql.org/docs/9.1/static/errcodes-appendix.html
        FOREIGN_KEY_VIOLATION = "23503"
        UNIQUE_VIOLATION      = "23505"

744
        def translate_exception(exception, message)
745 746
          return exception unless exception.respond_to?(:result)

747
          case exception.result.try(:error_field, PGresult::PG_DIAG_SQLSTATE)
748
          when UNIQUE_VIOLATION
749
            RecordNotUnique.new(message, exception)
750
          when FOREIGN_KEY_VIOLATION
751
            InvalidForeignKey.new(message, exception)
752 753 754 755 756
          else
            super
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
757
      private
758

759 760 761 762
        def type_map
          @type_map
        end

763
        def reload_type_map
764 765
          type_map.clear
          initialize_type_map(type_map)
766 767
        end

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
        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

787
        def initialize_type_map(type_map)
788
          result = execute('SELECT oid, typname, typelem, typdelim, typinput FROM pg_type', 'SCHEMA')
789
          leaves, nodes = result.partition { |row| row['typelem'] == '0' }
790

791 792
          # populate the leaf nodes
          leaves.find_all { |row| OID.registered_type? row['typname'] }.each do |row|
793
            type_map[row['oid'].to_i] = OID::NAMES[row['typname']]
794 795
          end

796 797
          records_by_oid = result.group_by { |row| row['oid'] }

798 799
          arrays, nodes = nodes.partition { |row| row['typinput'] == 'array_in' }

800
          # populate composite types
801 802
          nodes.each do |row|
            add_oid row, records_by_oid, type_map
803
          end
804 805

          # populate array types
806 807 808
          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
809
          end
810 811
        end

812
        FEATURE_NOT_SUPPORTED = "0A000" #:nodoc:
813

814 815
        def exec_no_cache(sql, name, binds)
          log(sql, name, binds) { @connection.async_exec(sql) }
816
        end
817

818
        def exec_cache(sql, name, binds)
819
          stmt_key = prepare_statement(sql)
820 821 822
          type_casted_binds = binds.map { |col, val|
            [col, type_cast(val, col)]
          }
823

824
          log(sql, name, type_casted_binds, stmt_key) do
825
            @connection.send_query_prepared(stmt_key, type_casted_binds.map { |_, val| val })
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
            @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
846 847 848 849 850 851 852 853 854 855 856 857 858
          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)
859
          unless @statements.key? sql_key
860
            nextkey = @statements.next_key
861 862 863
            begin
              @connection.prepare nextkey, sql
            rescue => e
A
Aaron Patterson 已提交
864
              raise translate_exception_class(e, sql)
865
            end
866 867
            # Clear the queue
            @connection.get_last_result
868
            @statements[sql_key] = nextkey
869
          end
870
          @statements[sql_key]
871
        end
872

P
Pratik Naik 已提交
873
        # The internal PostgreSQL identifier of the money data type.
874
        MONEY_COLUMN_TYPE_OID = 790 #:nodoc:
875 876
        # The internal PostgreSQL identifier of the BYTEA data type.
        BYTEA_COLUMN_TYPE_OID = 17 #:nodoc:
877 878 879 880

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

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

888
          configure_connection
889 890 891 892 893 894
        rescue ::PG::Error => error
          if error.message.include?("does not exist")
            raise ActiveRecord::NoDatabaseError.new(error.message)
          else
            raise error
          end
895 896
        end

897
        # Configures the encoding, verbosity, schema search path, and time zone of the connection.
898
        # This is called by #connect and should not be called manually.
899 900
        def configure_connection
          if @config[:encoding]
901
            @connection.set_client_encoding(@config[:encoding])
902
          end
903
          self.client_min_messages = @config[:min_messages] || 'warning'
904
          self.schema_search_path = @config[:schema_search_path] || @config[:schema_order]
905 906 907 908

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

909
          # If using Active Record's time zone support configure the connection to return
910
          # TIMESTAMP WITH ZONE types in UTC.
911
          # (SET TIME ZONE does not use an equals sign like other SET variables)
912
          if ActiveRecord::Base.default_timezone == :utc
913
            execute("SET time zone 'UTC'", 'SCHEMA')
914
          elsif @local_tz
915
            execute("SET time zone '#{@local_tz}'", 'SCHEMA')
916
          end
917 918 919 920 921 922 923 924 925 926 927 928

          # 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
929 930
        end

931
        # Returns the current ID of a table's sequence.
932
        def last_insert_id(sequence_name) #:nodoc:
933 934 935
          Integer(last_insert_id_value(sequence_name))
        end

D
Doug Cole 已提交
936 937 938 939 940
        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:
941
          exec_query("SELECT currval('#{sequence_name}')", 'SQL')
D
Initial  
David Heinemeier Hansson 已提交
942 943
        end

944
        # Executes a SELECT query and returns the results, performing any data type
945
        # conversions that are required to be performed here instead of in PostgreSQLColumn.
946
        def select(sql, name = nil, binds = [])
947
          exec_query(sql, name, binds)
948 949
        end

950
        # Returns the list of a table's column names, data types, and default values.
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
        #
        # 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
968
        def column_definitions(table_name) #:nodoc:
969
          exec_query(<<-end_sql, 'SCHEMA').rows
970 971
              SELECT a.attname, format_type(a.atttypid, a.atttypmod),
                     pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod
972 973 974 975 976
                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
977
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
978
        end
979 980

        def extract_pg_identifier_from_name(name)
981
          match_data = name.start_with?('"') ? name.match(/\"([^\"]+)\"/) : name.match(/([^\.]+)/)
982 983

          if match_data
984 985
            rest = name[match_data[0].length, name.length]
            rest = rest[1, rest.length] if rest.start_with? "."
J
José Valim 已提交
986
            [match_data[1], (rest.length > 0 ? rest : nil)]
987 988
          end
        end
989

990
        def extract_table_ref_from_insert_sql(sql)
991
          sql[/into\s+([^\(]*).*values\s*\(/im]
992 993 994
          $1.strip if $1
        end

995 996
        def create_table_definition(name, temporary, options, as = nil)
          TableDefinition.new native_database_types, name, temporary, options, as
997
        end
D
Initial  
David Heinemeier Hansson 已提交
998 999 1000
    end
  end
end