123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter

Overview

Active Record PostgreSQL Adapter

The PostgreSQL adapter works with the native C (github.com/ged/ruby-pg) driver.

Options:

  • :host - Defaults to a Unix-domain socket in /tmp. On machines without Unix-domain sockets, the default is to connect to localhost.

  • :port - Defaults to 5432.

  • :username - Defaults to be the same as the operating system name of the user running the application.

  • :password - Password to be used if the server demands password authentication.

  • :database - Defaults to be the same as the username.

  • :schema_search_path - An optional schema search path for the connection given as a string of comma-separated schema names. This is backward-compatible with the :schema_order option.

  • :encoding - An optional client encoding that is used in a SET client_encoding TO <encoding> call on the connection.

  • :min_messages - An optional client min messages that is used in a SET client_min_messages TO <min_messages> call on the connection.

  • :variables - An optional hash of additional parameters that will be used in SET SESSION key = val calls on the connection.

  • :insert_returning - An optional boolean to control the use of RETURNING for INSERT statements defaults to true.

Any further options are used as connection parameters to libpq. See www.postgresql.org/docs/current/static/libpq-connect.html for the list of parameters.

In addition, default connection parameters of libpq can be set per environment variables. See www.postgresql.org/docs/current/static/libpq-envars.html .

Constant Summary

::ActiveSupport::Callbacks - Included

CALLBACK_FILTER_TYPES

DatabaseStatements - Included

DEFAULT_INSERT_VALUE, HIGH_PRECISION_CURRENT_TIMESTAMP

AbstractAdapter - Inherited

ADAPTER_NAME, COMMENT_REGEX, DEFAULT_READ_QUERY, EXCEPTION_IMMEDIATE, EXCEPTION_NEVER, EXTENDED_TYPE_MAPS, SIMPLE_INT, TYPE_MAP

PostgreSQL::Quoting - Included

QUOTED_COLUMN_NAMES, QUOTED_TABLE_NAMES

PostgreSQL::DatabaseStatements - Included

HIGH_PRECISION_CURRENT_TIMESTAMP, IDLE_TRANSACTION_STATUSES, READ_QUERY

Class Attribute Summary

Class Method Summary

Instance Attribute Summary

PostgreSQL::SchemaStatements - Included

#client_min_messages

Returns the current client message level.

#client_min_messages=

Set the client message level.

#schema_search_path

Returns the active schema search path.

#schema_search_path=

Sets the schema search path to a string of comma-separated schema names.

AbstractAdapter - Inherited

#__callbacks,
#active?

Checks whether the connection to the database is still active.

#connected?

Checks whether the connection to the database was established.

#database_exists?,
#in_use?
#lock, #logger, #owner, #pool, #pool=,
#prepared_statements
#preventing_writes?

Determines whether writes are currently being prevented.

#replica?,
#requires_reloading?

Returns true if its required to reload the connection between requests for development mode.

#savepoint_errors_invalidate_transactions?

Do TransactionRollbackErrors on savepoints affect the parent transaction?

#supports_advisory_locks?

Does this adapter support application-enforced advisory locking?

#supports_bulk_alter?,
#supports_check_constraints?

Does this adapter support creating check constraints?

#supports_comments?

Does this adapter support metadata comments on database objects (tables, columns, indexes)?

#supports_comments_in_create?

Can comments for tables, columns, and indexes be specified in create/alter table statements?

#supports_common_table_expressions?, #supports_concurrent_connections?,
#supports_datetime_with_precision?

Does this adapter support datetime with precision?

#supports_ddl_transactions?

Does this adapter support DDL rollbacks in transactions? That is, would CREATE TABLE or ALTER TABLE get rolled back by a transaction?

#supports_deferrable_constraints?

Does this adapter support creating deferrable constraints?

#supports_exclusion_constraints?

Does this adapter support creating exclusion constraints?

#supports_explain?

Does this adapter support explain?

#supports_expression_index?

Does this adapter support expression indices?

#supports_extensions?

Does this adapter support database extensions?

#supports_foreign_keys?

Does this adapter support creating foreign key constraints?

#supports_foreign_tables?

Does this adapter support foreign/external tables?

#supports_index_include?

Does this adapter support including non-key columns?

#supports_index_sort_order?

Does this adapter support index sort order?

#supports_indexes_in_create?

Does this adapter support creating indexes in the same statement as creating the table?

#supports_insert_conflict_target?, #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_returning?,
#supports_json?

Does this adapter support JSON data type?

#supports_lazy_transactions?,
#supports_materialized_views?

Does this adapter support materialized views?

#supports_nulls_not_distinct?,
#supports_optimizer_hints?

Does this adapter support optimizer hints?

#supports_partial_index?

Does this adapter support partial indices?

#supports_partitioned_indexes?, #supports_restart_db_transaction?,
#supports_savepoints?

Does this adapter support savepoints?

#supports_transaction_isolation?

Does this adapter support setting the isolation level for a transaction?

#supports_unique_constraints?

Does this adapter support creating unique constraints?

#supports_validate_constraints?

Does this adapter support creating invalid constraints?

#supports_views?

Does this adapter support views?

#supports_virtual_columns?

Does this adapter support virtual columns?

#visitor, #reconnect_can_restore_state?, #advisory_locks_enabled?, #async_enabled?, #lock_thread=

DatabaseStatements - Included

SchemaStatements - Included

Instance Method Summary

PostgreSQL::DatabaseStatements - Included

#build_explain_clause, #explain, #high_precision_current_timestamp,
#set_constraints

Set when constraints will be checked for the current transaction.

#affected_rows, #build_truncate_statements, #cancel_any_running_query, #cast_result, #execute_batch, #handle_warnings,
#last_insert_id_result

Returns the current ID of a table’s sequence.

#perform_query, #returning_column_values, #suppress_composite_primary_key, #warning_ignored?,
#begin_db_transaction

Begins a transaction.

#begin_isolated_db_transaction,
#commit_db_transaction

Commits a transaction.

#exec_insert, #exec_restart_db_transaction,
#exec_rollback_db_transaction

Aborts a transaction.

#execute

Executes an SQL statement, returning a PG::Result object on success or raising a PG::Error exception otherwise.

#query

Queries the database and returns the results in an Array-like object.

#write_query?

PostgreSQL::SchemaStatements - Included

#add_exclusion_constraint

Adds a new exclusion constraint to the table.

#add_foreign_key,
#add_unique_constraint

Adds a new unique constraint to the table.

#collation

Returns the current database collation.

#create_database

Create a new PostgreSQL database.

#create_schema

Creates a schema for the given schema name.

#ctype

Returns the current database ctype.

#current_database

Returns the current database name.

#current_schema

Returns the current schema name.

#drop_schema

Drops the schema for the given schema name.

#encoding

Returns the current database encoding format.

#exclusion_constraints

Returns an array of exclusion constraints for the given table.

#foreign_keys, #foreign_table_exists?, #foreign_tables,
#index_name_exists?

Verifies existence of an index with a given name.

#remove_exclusion_constraint

Removes the given exclusion constraint from the table.

#remove_unique_constraint

Removes the given unique constraint from the table.

#rename_index

Renames an index of a table.

#rename_table

Renames a table.

#schema_exists?

Returns true if schema exists.

#schema_names

Returns an array of schema names.

#serial_sequence,
#unique_constraints

Returns an array of unique constraints for the given table.

#validate_check_constraint

Validates the given check constraint.

#validate_constraint

Validates the given constraint.

#validate_foreign_key

Validates the given foreign key.

#add_column_for_alter, #add_index_opclass, #add_options_for_index_columns, #assert_valid_deferrable, #change_column_for_alter, #change_column_null_for_alter, #column_names_from_column_numbers, #create_alter_table, #create_table_definition, #data_source_sql, #exclusion_constraint_for, #exclusion_constraint_for!, #exclusion_constraint_name, #extract_constraint_deferrable, #extract_foreign_key_action, #extract_schema_qualified_name, #fetch_type_metadata, #new_column_from_field, #quoted_scope, #reference_name_for_table, #sequence_name_from_parts, #unique_constraint_for, #unique_constraint_for!, #unique_constraint_name, #add_column, #add_index, #add_index_options, #build_change_column_default_definition,
#build_change_column_definition

Builds a ChangeColumnDefinition object.

#build_create_index_definition, #change_column,
#change_column_comment

Adds comment for given table column or drops it if comment is a nil

#change_column_default

Changes the default value of a table column.

#change_column_null,
#change_table_comment

Adds comment for given table or drops it if comment is a nil

#check_constraints,
#columns_for_distinct

PostgreSQL requires the ORDER BY columns in the select list for distinct queries, and requires that the ORDER BY include the distinct column.

#create_schema_dumper,
#default_sequence_name

Returns the sequence name for a table’s primary key or some other specified key.

#drop_database

Drops a PostgreSQL database.

#drop_table, #exclusion_constraint_options, #foreign_key_column_for, #index_name,
#indexes

Returns an array of indexes for the given table.

#inherited_table_names

Returns the inherited table name of a given table.

#pk_and_sequence_for

Returns a table’s primary key and belonging sequence.

#primary_keys, #quoted_include_columns_for_index,
#recreate_database

Drops the database specified on the name attribute and creates it again using the provided options.

#remove_index,
#rename_column

Renames a column in a table.

#reset_pk_sequence!

Resets the sequence of a table’s primary key to the maximum value.

#schema_creation,
#set_pk_sequence!

Sets the sequence of a table’s primary key to the specified value.

#table_comment

Returns a comment stored in database for given table.

#table_options,
#table_partition_definition

Returns the partition definition of a given table.

#type_to_sql

Maps logical ::Rails types to PostgreSQL-specific data types.

#unique_constraint_options, #update_table_definition

PostgreSQL::ReferentialIntegrity - Included

PostgreSQL::Quoting - Included

#check_int_in_range,
#escape_bytea

Escapes binary strings for bytea input to the database.

#quote_schema_name

Quotes schema names for use in SQL queries.

#quote_table_name_for_assignment,
#unescape_bytea

Unescapes bytea output from a database to the binary string it represents.

#determine_encoding_of_strings_in_array, #encode_array, #encode_range, #infinity?, #lookup_cast_type, #type_cast_array, #type_cast_range_value, #lookup_cast_type_from_column, #quote, #quote_default_expression,
#quote_string

Quotes strings for use in SQL input.

#quoted_binary,
#quoted_date

Quote date/time values for use in SQL input.

#type_cast

AbstractAdapter - Inherited

#adapter_name

Returns the human-readable name of the adapter.

#check_all_foreign_keys_valid!

Override to check all foreign key constraints in a database.

#clear_cache!

Clear any caching the database adapter may be doing.

#close

Check the connection back in to the connection pool.

#connect!, #connection_retries, #default_timezone,
#disable_extension

This is meant to be implemented by the adapters that support extensions.

#disable_referential_integrity

Override to turn off referential integrity while executing &block.

#discard!

Immediately forget this connection ever existed.

#disconnect!

Disconnects from the database if already connected.

#enable_extension

This is meant to be implemented by the adapters that support extensions.

#expire

this method must only be called while holding connection pool’s mutex.

#extensions

A list of extensions, to be filled in by adapters that support them.

#index_algorithms

A list of index algorithms, to be filled by adapters that support them.

#lease

this method must only be called while holding connection pool’s mutex.

#prefetch_primary_key?

Should primary key values be selected from their corresponding sequence before the insert statement? If true, next_sequence_value is called before each insert to set the record’s primary key.

#prepared_statements?,
#raw_connection

Provides access to the underlying database driver for this adapter.

#reconnect!

Disconnects from the database if already connected, and establishes a new connection with the database.

#reset!

Reset the state of this connection, directing the DBMS to clear transactions and other connection-related server-side state.

#retry_deadline,
#role

The role (e.g. :writing) for the current connection.

#schema_cache,
#schema_version

Returns the version identifier of the schema currently available in the database.

#shard

The shard (e.g. :default) for the current connection.

#throw_away!

Removes the connection from the pool and disconnect it.

#unprepared_statement,
#verify!

Checks whether the connection to the database is still active (i.e. not stale).

#any_raw_connection

Returns a raw connection for internal use with methods that are known to both be thread-safe and not rely upon actual server communication.

#arel_visitor, #backoff,
#build_result

Builds the result object.

#build_statement_pool, #can_perform_case_insensitive_comparison_for?, #collector, #column_for, #column_for_attribute,
#configure_connection

Perform any necessary initialization upon the newly-established connection settings, run queries to configure any application-global “session” variables, etc.

#default_prepared_statements, #extended_type_map_key, #invalidate_transaction, #log, #reconnect, #retryable_connection_error?, #retryable_query_error?, #translate_exception, #translate_exception_class, #type_map,
#valid_raw_connection

Similar to any_raw_connection, but ensures it is validated and connected.

#verified!

Mark the connection as verified.

#warning_ignored?,
#with_raw_connection

Lock the monitor, ensure we’re properly connected and transactions are materialized, and then yield the underlying raw connection object.

#add_enum_value

This is meant to be implemented by the adapters that support custom enum types.

#build_insert_sql

Called by ::ActiveRecord::InsertAll, Passed an instance of ::ActiveRecord::InsertAll::Builder, This method implements standard bulk inserts for all databases, but should be overridden by adapters to implement common features with non-standard syntax like handling duplicates or returning values.

#case_insensitive_comparison, #case_sensitive_comparison, #check_if_write_query, #check_version, #clean!, #connection_class,
#create_enum

This is meant to be implemented by the adapters that support custom enum types.

#create_virtual_table

This is meant to be implemented by the adapters that support virtual tables.

#database_version, #default_index_type?, #default_uniqueness_comparison,
#drop_enum

This is meant to be implemented by the adapters that support custom enum types.

#drop_virtual_table

This is meant to be implemented by the adapters that support virtual tables.

#get_advisory_lock

This is meant to be implemented by the adapters that support advisory locks.

#get_database_version, #inspect, #prepared_statements_disabled_cache,
#release_advisory_lock

This is meant to be implemented by the adapters that support advisory locks.

#rename_enum

This is meant to be implemented by the adapters that support custom enum types.

#rename_enum_value

This is meant to be implemented by the adapters that support custom enum types.

#return_value_after_insert?,
#seconds_idle

Seconds since this connection was returned to the pool.

#steal!

this method must only be called while holding connection pool’s mutex (and a desire for segfaults).

#valid_type?, #with_instrumenter

Savepoints - Included

DatabaseLimits - Included

#index_name_length

Returns the maximum length of an index name.

#table_alias_length

Returns the maximum length of a table alias.

#table_name_length

Returns the maximum length of a table name.

#bind_params_length, #max_identifier_length

Quoting - Included

#quote

Quotes the column value to help prevent SQL injection attacks.

#quote_column_name

Quotes the column name.

#quote_string

Quotes a string, escaping any ‘ (single quote) and \ (backslash) characters.

#quote_table_name

Quotes the table name.

#quote_table_name_for_assignment

Override to return the quoted table name for assignment.

#quoted_date

Quote date/time values for use in SQL input.

#quoted_false, #quoted_true,
#type_cast

Cast a value to a type that the database understands.

#unquoted_false, #unquoted_true, #lookup_cast_type, #type_casted_binds,
#cast_bound_value

Cast a value to be used as a bound parameter of unknown type.

#lookup_cast_type_from_column

If you are having to call this function, you are likely doing something wrong.

#quote_default_expression, #quoted_binary, #quoted_time, #sanitize_as_sql_comment

DatabaseStatements - Included

#add_transaction_record

Register a record with the current transaction so that its after_commit and after_rollback callbacks can be called.

#begin_db_transaction

Begins the transaction (and turns off auto-committing).

#begin_isolated_db_transaction

Begins the transaction with the isolation level set.

#commit_db_transaction

Commits the transaction (and turns on auto-committing).

#create
#default_sequence_name,
#delete

Executes the delete statement and returns the number of rows affected.

#disable_lazy_transactions!, #empty_insert_statement_value, #enable_lazy_transactions!,
#exec_delete

Executes delete sql statement in the context of this connection using binds as the bind substitutes.

#exec_insert

Executes insert sql statement in the context of this connection using binds as the bind substitutes.

#exec_query

Executes sql statement in the context of this connection using binds as the bind substitutes.

#exec_update

Executes update sql statement in the context of this connection using binds as the bind substitutes.

#execute

Executes the SQL statement in the context of this connection and returns the raw result from the connection adapter.

#high_precision_current_timestamp

Returns an ::Arel SQL literal for the CURRENT_TIMESTAMP for usage with arbitrary precision date/time columns.

#initialize,
#insert

Executes an INSERT query and returns the new record’s ID.

#insert_fixture

Inserts the given fixture into the table.

#insert_fixtures_set,
#reset_isolation_level

Hook point called after an isolated DB transaction is committed or rolled back.

#reset_sequence!

Set the sequence to the max value of the table’s column.

#restart_db_transaction,
#rollback_db_transaction

Rolls back the transaction (and turns on auto-committing).

#rollback_to_savepoint,
#sanitize_limit

Sanitizes the given LIMIT parameter in order to prevent SQL injection.

#select_all

Returns an ::ActiveRecord::Result instance.

#select_one

Returns a record hash with the column names as keys and column values as values.

#select_rows

Returns an array of arrays containing the field values.

#select_value

Returns a single value from a record.

#select_values

Returns an array of the values of the first column in a select:

#to_sql

Converts an arel AST to SQL.

#transaction

Runs the given block in a database transaction, and returns the result of the block.

#transaction_isolation_levels,
#truncate

Executes the truncate statement.

#update

Executes the update statement and returns the number of rows affected.

#write_query?

Determines whether the SQL statement is a write query.

#affected_rows, #arel_from_relation, #build_fixture_sql, #build_fixture_statements, #build_truncate_statement, #build_truncate_statements,
#cast_result

Receive a native adapter result object and returns an ::ActiveRecord::Result object.

#combine_multi_statements, #default_insert_value, #execute_batch, #extract_table_ref_from_insert_sql,
#internal_execute

Same as #internal_exec_query, but yields a native adapter result.

#last_inserted_id, #perform_query, #preprocess_query,
#raw_execute

Lowest level way to execute a query.

#returning_column_values,
#select

Returns an ::ActiveRecord::Result instance.

#single_value_from_rows, #begin_deferred_transaction,
#cacheable_query

This is used in the ::ActiveRecord::StatementCache object.

#exec_insert_all, #exec_restart_db_transaction, #exec_rollback_db_transaction, #explain,
#internal_exec_query

Execute a query and returns an ::ActiveRecord::Result

#mark_transaction_written_if_write, #query, #query_value, #query_values,
#raw_exec_query

Same as raw_execute but returns an ::ActiveRecord::Result object.

#reset_transaction, #truncate_tables,
#with_yaml_fallback

::ActiveRecord::Fixture value is quoted by ::Arel, however scalar values are not quotable.

#sql_for_insert, #to_sql_and_binds

SchemaStatements - Included

#add_belongs_to
#add_check_constraint

Adds a new check constraint to the table.

#add_column

Add a new type column named column_name to table_name.

#add_foreign_key

Adds a new foreign key.

#add_index

Adds a new index to the table.

#add_reference

Adds a reference.

#add_timestamps

Adds timestamps (created_at and updated_at) columns to table_name.

#assume_migrated_upto_version,
#build_create_table_definition

Returns a TableDefinition object containing information about the table that would be created if the same arguments were passed to #create_table.

#change_column

Changes the column’s definition according to the new options.

#change_column_comment

Changes the comment for a column or removes it if nil.

#change_column_default

Sets a new default value for a column:

#change_column_null

Sets or removes a NOT NULL constraint on a column.

#change_table

A block for changing columns in table.

#change_table_comment

Changes the comment for a table or removes it if nil.

#check_constraint_exists?

Checks to see if a check constraint exists on a table for a given check constraint definition.

#check_constraints

Returns an array of check constraints for the given table.

#column_exists?

Checks to see if a column exists in a given table.

#columns

Returns an array of Column objects for the table specified by table_name.

#create_join_table

Creates a new join table with the name created using the lexical order of the first two arguments.

#create_table

Creates a new table with the name table_name.

#data_source_exists?

Checks to see if the data source name exists on the database.

#data_sources

Returns the relation names usable to back Active Record models.

#drop_join_table

Drops the join table specified by the given arguments.

#drop_table

Drops a table or tables from the database.

#foreign_key_exists?

Checks to see if a foreign key exists on a table for a given foreign key definition.

#foreign_keys

Returns an array of foreign keys for the given table.

#index_exists?

Checks to see if an index exists on a table for a given index definition.

#index_name_exists?

Verifies the existence of an index with a given name.

#indexes

Returns an array of indexes for the given table.

#max_index_name_size

Returns the maximum length of an index name in bytes.

#native_database_types

Returns a hash of mappings from the abstract data types to the native database types.

#options_include_default?,
#primary_key

Returns just a table’s primary key.

#remove_belongs_to
#remove_check_constraint

Removes the given check constraint from the table.

#remove_column

Removes the column from the table definition.

#remove_columns

Removes the given columns from the table definition.

#remove_foreign_key

Removes the given foreign key from the table.

#remove_index

Removes the given index from the table.

#remove_reference

Removes the reference(s).

#remove_timestamps

Removes the timestamp columns (created_at and updated_at) from the table definition.

#rename_column

Renames a column.

#rename_index

Renames an index.

#rename_table

Renames a table.

#table_alias_for

Truncates a table alias according to the limits of the current adapter.

#table_comment

Returns the table comment that’s stored in database metadata.

#table_exists?

Checks to see if the table table_name exists on the database.

#table_options,
#tables

Returns an array of table names defined in the database.

#view_exists?

Checks to see if the view view_name exists on the database.

#views

Returns an array of view names defined in the database.

#add_column_for_alter, #add_index_sort_order,
#add_options_for_index_columns

Overridden by the MySQL adapter for supporting index lengths and by the PostgreSQL adapter for supporting operator classes.

#add_timestamps_for_alter, #can_remove_index_by_name?, #change_column_default_for_alter, #check_constraint_for, #check_constraint_for!, #check_constraint_name, #column_options_keys, #create_alter_table, #create_table_definition, #data_source_sql,
#expression_column_name?

Try to identify whether the given column name is an expression.

#extract_foreign_key_action,
#extract_new_comment_value
#extract_new_default_value, #fetch_type_metadata, #foreign_key_for, #foreign_key_for!, #foreign_key_name, #generate_index_name, #index_column_names, #index_name_for_remove, #index_name_options, #insert_versions_sql, #options_for_index_columns, #quoted_scope, #reference_name_for_table, #remove_column_for_alter, #remove_columns_for_alter, #remove_timestamps_for_alter, #rename_column_indexes, #rename_column_sql, #rename_table_indexes, #strip_table_name_prefix_and_suffix, #validate_change_column_null_argument!, #validate_create_table_options!, #validate_index_length!, #validate_table_length!, #add_columns, #add_index_options,
#build_add_column_definition

Builds an AlterTable object for adding a column to a table.

#build_change_column_default_definition
#build_create_index_definition

Builds a CreateIndexDefinition object.

#build_create_join_table_definition

Builds a TableDefinition object for a join table.

#bulk_change_table, #check_constraint_options,
#columns_for_distinct

Given a set of columns and an ORDER BY clause, returns the columns for a SELECT DISTINCT.

#create_schema_dumper, #distinct_relation_for_primary_key, #dump_schema_information, #foreign_key_column_for, #foreign_key_options, #index_algorithm, #index_name, #internal_string_options_for_primary_key, #quoted_columns_for_index, #remove_constraint,
#schema_creation

Returns an instance of SchemaCreation, which can be used to visit a schema definition object and return DDL.

#type_to_sql, #update_table_definition, #valid_column_definition_options, #valid_primary_key_options, #valid_table_definition_options

::ActiveRecord::Migration::JoinTable - Included

::ActiveSupport::Callbacks - Included

#run_callbacks

Runs the callbacks for the given event.

#halted_callback_hook

A hook invoked every time a before callback is halted.

Constructor Details

.newPostgreSQLAdapter

Initializes and connects a PostgreSQL adapter.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 320

def initialize(...)
  super

  conn_params = @config.compact

  # 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]

  # Forward only valid config params to PG::Connection.connect.
  valid_conn_param_keys = PG::Connection.conndefaults_hash.keys + [:requiressl]
  conn_params.slice!(*valid_conn_param_keys)

  @connection_parameters = conn_params

  @max_identifier_length = nil
  @type_map = nil
  @raw_connection = nil
  @notice_receiver_sql_warnings = []

  @use_insert_returning = @config.key?(:insert_returning) ? self.class.type_cast_config_to_boolean(@config[:insert_returning]) : true
end

Class Attribute Details

.create_unlogged_tables (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

.create_unlogged_tables?Boolean (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

.datetime_type (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

.datetime_type?Boolean (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

.decode_dates (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

.decode_dates?Boolean (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

Class Method Details

.dbconsole(config, options = {})

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 73

def dbconsole(config, options = {})
  pg_config = config.configuration_hash

  ENV["PGUSER"]         = pg_config[:username] if pg_config[:username]
  ENV["PGHOST"]         = pg_config[:host] if pg_config[:host]
  ENV["PGPORT"]         = pg_config[:port].to_s if pg_config[:port]
  ENV["PGPASSWORD"]     = pg_config[:password].to_s if pg_config[:password] && options[:include_password]
  ENV["PGSSLMODE"]      = pg_config[:sslmode].to_s if pg_config[:sslmode]
  ENV["PGSSLCERT"]      = pg_config[:sslcert].to_s if pg_config[:sslcert]
  ENV["PGSSLKEY"]       = pg_config[:sslkey].to_s if pg_config[:sslkey]
  ENV["PGSSLROOTCERT"]  = pg_config[:sslrootcert].to_s if pg_config[:sslrootcert]
  if pg_config[:variables]
    ENV["PGOPTIONS"] = pg_config[:variables].filter_map do |name, value|
      "-c #{name}=#{value.to_s.gsub(/[ \\]/, '\\\\\0')}" unless value == ":default" || value == :default
    end.join(" ")
  end
  find_cmd_and_exec(ActiveRecord.database_cli[:postgresql], config.database)
end

.initialize_type_map(m)

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 671

def initialize_type_map(m) # :nodoc:
  m.register_type "int2", Type::Integer.new(limit: 2)
  m.register_type "int4", Type::Integer.new(limit: 4)
  m.register_type "int8", Type::Integer.new(limit: 8)
  m.register_type "oid", OID::Oid.new
  m.register_type "float4", Type::Float.new(limit: 24)
  m.register_type "float8", Type::Float.new
  m.register_type "text", Type::Text.new
  register_class_with_limit m, "varchar", Type::String
  m.alias_type "char", "varchar"
  m.alias_type "name", "varchar"
  m.alias_type "bpchar", "varchar"
  m.register_type "bool", Type::Boolean.new
  register_class_with_limit m, "bit", OID::Bit
  register_class_with_limit m, "varbit", OID::BitVarying
  m.register_type "date", OID::Date.new

  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", Type::Json.new
  m.register_type "jsonb", OID::Jsonb.new
  m.register_type "cidr", OID::Cidr.new
  m.register_type "inet", OID::Inet.new
  m.register_type "uuid", OID::Uuid.new
  m.register_type "xml", OID::Xml.new
  m.register_type "tsvector", OID::SpecializedString.new(:tsvector)
  m.register_type "macaddr", OID::Macaddr.new
  m.register_type "citext", OID::SpecializedString.new(:citext)
  m.register_type "ltree", OID::SpecializedString.new(:ltree)
  m.register_type "line", OID::SpecializedString.new(:line)
  m.register_type "lseg", OID::SpecializedString.new(:lseg)
  m.register_type "box", OID::SpecializedString.new(:box)
  m.register_type "path", OID::SpecializedString.new(:path)
  m.register_type "polygon", OID::SpecializedString.new(:polygon)
  m.register_type "circle", OID::SpecializedString.new(:circle)

  m.register_type "numeric" do |_, fmod, sql_type|
    precision = extract_precision(sql_type)
    scale = extract_scale(sql_type)

    # 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?
      # FIXME: Remove this class, and the second argument to
      # lookups on PG
      Type::DecimalWithoutScale.new(precision: precision)
    else
      OID::Decimal.new(precision: precision, scale: scale)
    end
  end

  m.register_type "interval" do |*args, sql_type|
    precision = extract_precision(sql_type)
    OID::Interval.new(precision: precision)
  end
end

.native_database_types

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 403

def self.native_database_types # :nodoc:
  @native_database_types ||= begin
    types = NATIVE_DATABASE_TYPES.dup
    types[:datetime] = types[datetime_type]
    types
  end
end

.new_client(conn_params)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 57

def new_client(conn_params)
  PG.connect(**conn_params)
rescue ::PG::Error => error
  if conn_params && conn_params[:dbname] == "postgres"
    raise ActiveRecord::ConnectionNotEstablished, error.message
  elsif conn_params && conn_params[:dbname] && error.message.include?(conn_params[:dbname])
    raise ActiveRecord::NoDatabaseError.db_error(conn_params[:dbname])
  elsif conn_params && conn_params[:user] && error.message.include?(conn_params[:user])
    raise ActiveRecord::DatabaseConnectionError.username_error(conn_params[:user])
  elsif conn_params && conn_params[:host] && error.message.include?(conn_params[:host])
    raise ActiveRecord::DatabaseConnectionError.hostname_error(conn_params[:host])
  else
    raise ActiveRecord::ConnectionNotEstablished, error.message
  end
end

Instance Attribute Details

#active?Boolean (readonly)

Is this connection alive and ready for queries?

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 348

def active?
  @lock.synchronize do
    return false unless @raw_connection
    @raw_connection.query ";"
  end
  true
rescue PG::Error
  false
end

#connected?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 343

def connected?
  !(@raw_connection.nil? || @raw_connection.finished?)
end

#create_unlogged_tables (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

#create_unlogged_tables?Boolean (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 105

class_attribute :create_unlogged_tables, default: false

#datetime_type (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

#datetime_type?Boolean (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 123

class_attribute :datetime_type, default: :timestamp

#decode_dates (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

#decode_dates?Boolean (rw)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 132

class_attribute :decode_dates, default: false

#in_transaction?Boolean (readonly, private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 903

def in_transaction?
  open_transactions > 0
end

#session_auth=(user) (writeonly)

Set the authorized user for this session

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 624

def session_auth=(user)
  clear_cache!
  internal_execute("SET SESSION AUTHORIZATION #{user}", nil, materialize_transactions: true)
end

#supports_advisory_locks?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 419

def supports_advisory_locks?
  true
end

#supports_bulk_alter?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 188

def supports_bulk_alter?
  true
end

#supports_check_constraints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 220

def supports_check_constraints?
  true
end

#supports_comments?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 252

def supports_comments?
  true
end

#supports_common_table_expressions?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 450

def supports_common_table_expressions?
  true
end

#supports_datetime_with_precision?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 244

def supports_datetime_with_precision?
  true
end

#supports_ddl_transactions?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 415

def supports_ddl_transactions?
  true
end

#supports_deferrable_constraints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 236

def supports_deferrable_constraints?
  true
end

#supports_exclusion_constraints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 224

def supports_exclusion_constraints?
  true
end

#supports_explain?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 423

def supports_explain?
  true
end

#supports_expression_index?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 208

def supports_expression_index?
  true
end

#supports_extensions?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 427

def supports_extensions?
  true
end

#supports_foreign_keys?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 216

def supports_foreign_keys?
  true
end

#supports_foreign_tables?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 435

def supports_foreign_tables?
  true
end

#supports_identity_columns?Boolean (readonly)

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 279

def supports_identity_columns? # :nodoc:
  database_version >= 10_00_00 # >= 10.0
end

#supports_index_include?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 204

def supports_index_include?
  database_version >= 11_00_00 # >= 11.0
end

#supports_index_sort_order?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 192

def supports_index_sort_order?
  true
end

#supports_insert_conflict_target? (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 273

alias supports_insert_conflict_target? supports_insert_on_conflict?

#supports_insert_on_conflict?Boolean (readonly) Also known as: #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_conflict_target?

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 268

def supports_insert_on_conflict?
  database_version >= 9_05_00 # >= 9.5
end

#supports_insert_on_duplicate_skip? (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 271

alias supports_insert_on_duplicate_skip? supports_insert_on_conflict?

#supports_insert_on_duplicate_update? (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 272

alias supports_insert_on_duplicate_update? supports_insert_on_conflict?

#supports_insert_returning?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 264

def supports_insert_returning?
  true
end

#supports_json?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 248

def supports_json?
  true
end

#supports_lazy_transactions?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 454

def supports_lazy_transactions?
  true
end

#supports_materialized_views?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 431

def supports_materialized_views?
  true
end

#supports_native_partitioning?Boolean (readonly)

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 287

def supports_native_partitioning? # :nodoc:
  database_version >= 10_00_00 # >= 10.0
end

#supports_nulls_not_distinct?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 283

def supports_nulls_not_distinct?
  database_version >= 15_00_00 # >= 15.0
end

#supports_optimizer_hints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 443

def supports_optimizer_hints?
  unless defined?(@has_pg_hint_plan)
    @has_pg_hint_plan = extension_available?("pg_hint_plan")
  end
  @has_pg_hint_plan
end

#supports_partial_index?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 200

def supports_partial_index?
  true
end

#supports_partitioned_indexes?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 196

def supports_partitioned_indexes?
  database_version >= 11_00_00 # >= 11.0
end

#supports_pgcrypto_uuid?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 439

def supports_pgcrypto_uuid?
  database_version >= 9_04_00 # >= 9.4
end

#supports_restart_db_transaction?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 260

def supports_restart_db_transaction?
  database_version >= 12_00_00 # >= 12.0
end

#supports_savepoints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 256

def supports_savepoints?
  true
end

#supports_transaction_isolation?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 212

def supports_transaction_isolation?
  true
end

#supports_unique_constraints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 228

def supports_unique_constraints?
  true
end

#supports_validate_constraints?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 232

def supports_validate_constraints?
  true
end

#supports_views?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 240

def supports_views?
  true
end

#supports_virtual_columns?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 275

def supports_virtual_columns?
  database_version >= 12_00_00 # >= 12.0
end

#type_map (readonly, private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 737

attr_reader :type_map

#use_insert_returning?Boolean (readonly)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 629

def use_insert_returning?
  @use_insert_returning
end

Instance Method Details

#add_enum_value(type_name, value, **options)

Add enum value to an existing enum type.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 587

def add_enum_value(type_name, value, **options)
  before, after = options.values_at(:before, :after)
  sql = +"ALTER TYPE #{quote_table_name(type_name)} ADD VALUE"
  sql << " IF NOT EXISTS" if options[:if_not_exists]
  sql << " #{quote(value)}"

  if before && after
    raise ArgumentError, "Cannot have both :before and :after at the same time"
  elsif before
    sql << " BEFORE #{quote(before)}"
  elsif after
    sql << " AFTER #{quote(after)}"
  end

  execute(sql).tap { reload_type_map }
end

#add_pg_decoders (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1107

def add_pg_decoders
  @mapped_default_timezone = nil
  @timestamp_decoder = nil

  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,
    "numeric" => PG::TextDecoder::Numeric,
    "bool" => PG::TextDecoder::Boolean,
    "timestamp" => PG::TextDecoder::TimestampUtc,
    "timestamptz" => PG::TextDecoder::TimestampWithTimeZone,
  }
  coders_by_name["date"] = PG::TextDecoder::Date if decode_dates

  known_coder_types = coders_by_name.keys.map { |n| quote(n) }
  query = <<~SQL % known_coder_types.join(", ")
    SELECT t.oid, t.typname
    FROM pg_type as t
    WHERE t.typname IN (%s)
  SQL
  result = internal_execute(query, "SCHEMA", [], allow_retry: true, materialize_transactions: false)
  coders = result.filter_map { |row| construct_coder(row, coders_by_name[row["typname"]]) }

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

  @type_map_for_results = PG::TypeMapByOid.new
  @type_map_for_results.default_type_map = map
  @type_map_for_results.add_coder(PG::TextDecoder::Bytea.new(oid: 17, name: "bytea"))
  @type_map_for_results.add_coder(MoneyDecoder.new(oid: 790, name: "money"))

  # extract timestamp decoder for use in update_typemap_for_default_timezone
  @timestamp_decoder = coders.find { |coder| coder.name == "timestamp" }
  update_typemap_for_default_timezone
end

#add_pg_encoders (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1080

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
  @raw_connection.type_map_for_queries = map
end

#arel_visitor (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1046

def arel_visitor
  Arel::Visitors::PostgreSQL.new(self)
end

#build_insert_sql(insert)

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 645

def build_insert_sql(insert) # :nodoc:
  sql = +"INSERT #{insert.into} #{insert.values_list}"

  if insert.skip_duplicates?
    sql << " ON CONFLICT #{insert.conflict_target} DO NOTHING"
  elsif insert.update_duplicates?
    sql << " ON CONFLICT #{insert.conflict_target} DO UPDATE SET "
    if insert.raw_update_sql?
      sql << insert.raw_update_sql
    else
      sql << insert.touch_model_timestamps_unless { |column| "#{insert.model.quoted_table_name}.#{column} IS NOT DISTINCT FROM excluded.#{column}" }
      sql << insert.updatable_columns.map { |column| "#{column}=excluded.#{column}" }.join(",")
    end
  end

  sql << " RETURNING #{insert.returning}" if insert.returning
  sql
end

#build_statement_pool (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1050

def build_statement_pool
  StatementPool.new(self, self.class.type_cast_config_to_integer(@config[:statement_limit]))
end

#can_perform_case_insensitive_comparison_for?(column) ⇒ Boolean (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1054

def can_perform_case_insensitive_comparison_for?(column)
  # NOTE: citext is an exception. It is possible to perform a
  #       case-insensitive comparison using `LOWER()`, but it is
  #       unnecessary, as `citext` is case-insensitive by definition.
  @case_insensitive_cache ||= { "citext" => false }
  @case_insensitive_cache.fetch(column.sql_type) do
    @case_insensitive_cache[column.sql_type] = begin
      sql = <<~SQL
        SELECT exists(
          SELECT * FROM pg_proc
          WHERE proname = 'lower'
            AND proargtypes = ARRAY[#{quote column.sql_type}::regtype]::oidvector
        ) OR exists(
          SELECT * FROM pg_proc
          INNER JOIN pg_cast
            ON ARRAY[casttarget]::oidvector = proargtypes
          WHERE proname = 'lower'
            AND castsource = #{quote column.sql_type}::regtype
        )
      SQL
      result = internal_execute(sql, "SCHEMA", [], allow_retry: true, materialize_transactions: false)
      result.getvalue(0, 0)
    end
  end
end

#check_version

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 664

def check_version # :nodoc:
  if database_version < 9_03_00 # < 9.3
    raise "Your version of PostgreSQL (#{database_version}) is too old. Active Record supports PostgreSQL >= 9.3."
  end
end

#column_definitions(table_name) (private)

Returns the list of a table’s column names, data types, and default values.

The underlying query is roughly:

SELECT column.name, column.type, default.value, column.comment
  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
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1029

def column_definitions(table_name)
  query(<<~SQL, "SCHEMA")
      SELECT a.attname, format_type(a.atttypid, a.atttypmod),
             pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod,
             c.collname, col_description(a.attrelid, a.attnum) AS comment,
             #{supports_identity_columns? ? 'attidentity' : quote('')} AS identity,
             #{supports_virtual_columns? ? 'attgenerated' : quote('')} as attgenerated
        FROM pg_attribute a
        LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
        LEFT JOIN pg_type t ON a.atttypid = t.oid
        LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation
       WHERE a.attrelid = #{quote(quote_table_name(table_name))}::regclass
         AND a.attnum > 0 AND NOT a.attisdropped
       ORDER BY a.attnum
  SQL
end

#configure_connection (private)

Configures the encoding, verbosity, schema search path, and time zone of the connection. This is called by #connect and should not be called manually.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 951

def configure_connection
  super

  if @config[:encoding]
    @raw_connection.set_client_encoding(@config[:encoding])
  end
  self.client_min_messages = @config[:min_messages] || "warning"
  self.schema_search_path = @config[:schema_search_path] || @config[:schema_order]

  unless ActiveRecord.db_warnings_action.nil?
    @raw_connection.set_notice_receiver do |result|
      message = result.error_field(PG::Result::PG_DIAG_MESSAGE_PRIMARY)
      code = result.error_field(PG::Result::PG_DIAG_SQLSTATE)
      level = result.error_field(PG::Result::PG_DIAG_SEVERITY)
      @notice_receiver_sql_warnings << SQLWarning.new(message, code, level, nil, @pool)
    end
  end

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

  variables = @config.fetch(:variables, {}).stringify_keys

  # Set interval output format to ISO 8601 for ease of parsing by ActiveSupport::Duration.parse
  internal_execute("SET intervalstyle = iso_8601", "SCHEMA")

  # SET statements from :variables config hash
  # https://www.postgresql.org/docs/current/static/sql-set.html
  variables.map do |k, v|
    if v == ":default" || v == :default
      # Sets the value to the global or compile default
      internal_execute("SET SESSION #{k} TO DEFAULT", "SCHEMA")
    elsif !v.nil?
      internal_execute("SET SESSION #{k} TO #{quote(v)}", "SCHEMA")
    end
  end

  add_pg_encoders
  add_pg_decoders

  reload_type_map
end

#connect (private)

Connects to a PostgreSQL server and sets up the adapter depending on the connected server’s characteristics.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 933

def connect
  @raw_connection = self.class.new_client(@connection_parameters)
rescue ConnectionNotEstablished => ex
  raise ex.set_pool(@pool)
end

#construct_coder(row, coder_class) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1148

def construct_coder(row, coder_class)
  return unless coder_class
  coder_class.new(oid: row["oid"].to_i, name: row["typname"])
end

#create_enum(name, values, **options)

Given a name and an array of values, creates an enum type.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 540

def create_enum(name, values, **options)
  sql_values = values.map { |s| quote(s) }.join(", ")
  scope = quoted_scope(name)
  query = <<~SQL
    DO $$
    BEGIN
        IF NOT EXISTS (
          SELECT 1
          FROM pg_type t
          JOIN pg_namespace n ON t.typnamespace = n.oid
          WHERE t.typname = #{scope[:name]}
            AND n.nspname = #{scope[:schema]}
        ) THEN
            CREATE TYPE #{quote_table_name(name)} AS ENUM (#{sql_values});
        END IF;
    END
    $$;
  SQL
  internal_exec_query(query).tap { reload_type_map }
end

#default_index_type?(index) ⇒ Boolean

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 641

def default_index_type?(index) # :nodoc:
  index.using == :btree || super
end

#disable_extension(name, force: false)

Removes an extension from the database.

:force

Set to :cascade to drop dependent objects as well. Defaults to false.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 485

def disable_extension(name, force: false)
  _schema, name = name.to_s.split(".").values_at(-2, -1)
  internal_exec_query("DROP EXTENSION IF EXISTS \"#{name}\"#{' CASCADE' if force == :cascade}").tap {
    reload_type_map
  }
end

#discard!

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 393

def discard! # :nodoc:
  super
  @raw_connection&.socket_io&.reopen(IO::NULL) rescue nil
  @raw_connection = nil
end

#disconnect!

Disconnects from the database if already connected. Otherwise, this method does nothing.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 385

def disconnect!
  @lock.synchronize do
    super
    @raw_connection&.close rescue nil
    @raw_connection = nil
  end
end

#drop_enum(name, values = nil, **options)

Drops an enum type.

If the if_exists: true option is provided, the enum is dropped only if it exists. Otherwise, if the enum doesn’t exist, an error is raised.

The values parameter will be ignored if present. It can be helpful to provide this in a migration’s change method so it can be reverted. In that case, values will be used by #create_enum.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 570

def drop_enum(name, values = nil, **options)
  query = <<~SQL
    DROP TYPE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(name)};
  SQL
  internal_exec_query(query).tap { reload_type_map }
end

#enable_extension(name)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 472

def enable_extension(name, **)
  schema, name = name.to_s.split(".").values_at(-2, -1)
  sql = +"CREATE EXTENSION IF NOT EXISTS \"#{name}\""
  sql << " SCHEMA #{schema}" if schema

  internal_exec_query(sql).tap { reload_type_map }
end

#enum_types

Returns a list of defined enum types, and their values.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 517

def enum_types
  query = <<~SQL
    SELECT
      type.typname AS name,
      type.OID AS oid,
      n.nspname AS schema,
      string_agg(enum.enumlabel, ',' ORDER BY enum.enumsortorder) AS value
    FROM pg_enum AS enum
    JOIN pg_type AS type ON (type.oid = enum.enumtypid)
    JOIN pg_namespace n ON type.typnamespace = n.oid
    WHERE n.nspname = ANY (current_schemas(false))
    GROUP BY type.OID, n.nspname, type.typname;
  SQL

  internal_exec_query(query, "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values.each_with_object({}) do |row, memo|
    name, schema = row[0], row[2]
    schema = nil if schema == current_schema
    full_name = [schema, name].compact.join(".")
    memo[full_name] = row.last
  end.to_a
end

#extension_available?(name) ⇒ Boolean

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 492

def extension_available?(name)
  query_value("SELECT true FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA")
end

#extension_enabled?(name) ⇒ Boolean

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 496

def extension_enabled?(name)
  query_value("SELECT installed_version IS NOT NULL FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA")
end

#extensions

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 500

def extensions
  query = <<~SQL
    SELECT
      pg_extension.extname,
      n.nspname AS schema
    FROM pg_extension
    JOIN pg_namespace n ON pg_extension.extnamespace = n.oid
  SQL

  internal_exec_query(query, "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values.map do |row|
    name, schema = row[0], row[1]
    schema = nil if schema == current_schema
    [schema, name].compact.join(".")
  end
end

#extract_default_function(default_value, default) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 776

def extract_default_function(default_value, default)
  default if has_default_function?(default_value, default)
end

#extract_value_from_default(default) (private)

Extracts the value from a PostgreSQL column default definition.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 750

def extract_value_from_default(default)
  case default
    # Quoted types
  when /\A[(B]?'(.*)'.*::"?([\w. ]+)"?(?:\[\])?\z/m
    # The default 'now'::date is CURRENT_DATE
    if $1 == "now" && $2 == "date"
      nil
    else
      $1.gsub("''", "'")
    end
    # Boolean types
  when "true", "false"
    default
    # Numeric types
  when /\A\(?(-?\d+(\.\d*)?)\)?(::bigint)?\z/
    $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

#get_advisory_lock(lock_id)

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 458

def get_advisory_lock(lock_id) # :nodoc:
  unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63
    raise(ArgumentError, "PostgreSQL requires advisory lock ids to be a signed 64 bit integer")
  end
  query_value("SELECT pg_try_advisory_lock(#{lock_id})")
end

#get_database_version

This method is for internal use only.

Returns the version of the connected PostgreSQL server.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 634

def get_database_version # :nodoc:
  with_raw_connection do |conn|
    conn.server_version
  end
end

#get_oid_type(oid, fmod, column_name, sql_type = "") (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 849

def get_oid_type(oid, fmod, column_name, sql_type = "")
  if !type_map.key?(oid)
    load_additional_types([oid])
  end

  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.default_value.tap do |cast_type|
      type_map.register_type(oid, cast_type)
    end
  }
end

#has_default_function?(default_value, default) ⇒ Boolean (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 780

def has_default_function?(default_value, default)
  !default_value && %r{\w\(.*\)|\(.*\)::\w|CURRENT_DATE|CURRENT_TIMESTAMP}.match?(default)
end

#index_algorithms

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 291

def index_algorithms
  { concurrently: "CONCURRENTLY" }
end

#initialize_type_map(m = type_map) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 739

def initialize_type_map(m = type_map)
  self.class.initialize_type_map(m)

  self.class.register_class_with_precision m, "time", Type::Time, timezone: @default_timezone
  self.class.register_class_with_precision m, "timestamp", OID::Timestamp, timezone: @default_timezone
  self.class.register_class_with_precision m, "timestamptz", OID::TimestampWithTimeZone

  load_additional_types
end

#is_cached_plan_failure?(pgerror) ⇒ Boolean (private)

Annoyingly, the code for prepared statements whose return value may have changed is FEATURE_NOT_SUPPORTED.

This covers various different error types so we need to do additional work to classify the exception definitively as a ::ActiveRecord::PreparedStatementCacheExpired

Check here for more details: git.postgresql.org/gitweb/?p=postgresql.git;a=blob;f=src/backend/utils/cache/plancache.c#l573

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 896

def is_cached_plan_failure?(pgerror)
  pgerror.result.result_error_field(PG::PG_DIAG_SQLSTATE) == FEATURE_NOT_SUPPORTED &&
    pgerror.result.result_error_field(PG::PG_DIAG_SOURCE_FUNCTION) == "RevalidateCachedQuery"
rescue
  false
end

#load_additional_types(oids = nil) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 862

def load_additional_types(oids = nil)
  initializer = OID::TypeMapInitializer.new(type_map)
  load_types_queries(initializer, oids) do |query|
    records = internal_execute(query, "SCHEMA", [], allow_retry: true, materialize_transactions: false)
    initializer.run(records)
  end
end

#load_types_queries(initializer, oids) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 870

def load_types_queries(initializer, oids)
  query = <<~SQL
    SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, r.rngsubtype, t.typtype, t.typbasetype
    FROM pg_type as t
    LEFT JOIN pg_range as r ON oid = rngtypid
  SQL
  if oids
    yield query + "WHERE t.oid IN (%s)" % oids.join(", ")
  else
    yield query + initializer.query_conditions_for_known_type_names
    yield query + initializer.query_conditions_for_known_type_types
    yield query + initializer.query_conditions_for_array_types
  end
end

#max_identifier_length

Returns the configured supported identifier length supported by PostgreSQL

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 619

def max_identifier_length
  @max_identifier_length ||= query_value("SHOW max_identifier_length", "SCHEMA").to_i
end

#native_database_types

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 399

def native_database_types # :nodoc:
  self.class.native_database_types
end

#postgresql_version

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 639

alias :postgresql_version :database_version

#prepare_statement(sql, binds, conn) (private)

Prepare the statement if it hasn’t been prepared, return the statement key.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 915

def prepare_statement(sql, binds, conn)
  sql_key = sql_key(sql)
  unless @statements.key? sql_key
    nextkey = @statements.next_key
    begin
      conn.prepare nextkey, sql
    rescue => e
      raise translate_exception_class(e, sql, binds)
    end
    # Clear the queue
    conn.get_last_result
    @statements[sql_key] = nextkey
  end
  @statements[sql_key]
end

#reconfigure_connection_timezone (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 994

def reconfigure_connection_timezone
  variables = @config.fetch(:variables, {}).stringify_keys

  # If it's been directly configured as a connection variable, we don't
  # need to do anything here; it will be set up by configure_connection
  # and then never changed.
  return if variables["timezone"]

  # If using Active Record's time zone support configure the connection
  # to return TIMESTAMP WITH ZONE types in UTC.
  if default_timezone == :utc
    raw_execute("SET SESSION timezone TO 'UTC'", "SCHEMA")
  else
    raw_execute("SET SESSION timezone TO DEFAULT", "SCHEMA")
  end
end

#reconnect (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 939

def reconnect
  begin
    @raw_connection&.reset
  rescue PG::ConnectionBad
    @raw_connection = nil
  end

  connect unless @raw_connection
end

#release_advisory_lock(lock_id)

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 465

def release_advisory_lock(lock_id) # :nodoc:
  unless lock_id.is_a?(Integer) && lock_id.bit_length <= 63
    raise(ArgumentError, "PostgreSQL requires advisory lock ids to be a signed 64 bit integer")
  end
  query_value("SELECT pg_advisory_unlock(#{lock_id})")
end

#reload_type_map

This method is for internal use only.
[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 358

def reload_type_map # :nodoc:
  @lock.synchronize do
    if @type_map
      type_map.clear
    else
      @type_map = Type::HashLookupTypeMap.new
    end

    initialize_type_map
  end
end

#rename_enum(name, new_name = nil, **options)

Rename an existing enum type to something else.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 578

def rename_enum(name, new_name = nil, **options)
  new_name ||= options.fetch(:to) do
    raise ArgumentError, "rename_enum requires two from/to name positional arguments."
  end

  exec_query("ALTER TYPE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}").tap { reload_type_map }
end

#rename_enum_value(type_name, **options)

Rename enum value on an existing enum type.

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 605

def rename_enum_value(type_name, **options)
  unless database_version >= 10_00_00 # >= 10.0
    raise ArgumentError, "Renaming enum values is only supported in PostgreSQL 10 or later"
  end

  from = options.fetch(:from) { raise ArgumentError, ":from is required" }
  to = options.fetch(:to) { raise ArgumentError, ":to is required" }

  execute("ALTER TYPE #{quote_table_name(type_name)} RENAME VALUE #{quote(from)} TO #{quote(to)}").tap {
    reload_type_map
  }
end

#reset!

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 370

def reset!
  @lock.synchronize do
    return connect! unless @raw_connection

    unless @raw_connection.transaction_status == ::PG::PQTRANS_IDLE
      @raw_connection.query "ROLLBACK"
    end
    @raw_connection.query "DISCARD ALL"

    super
  end
end

#retryable_query_error?(exception) ⇒ Boolean (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 842

def retryable_query_error?(exception)
  # We cannot retry anything if we're inside a broken transaction; we need to at
  # least raise until the innermost savepoint is rolled back
  @raw_connection&.transaction_status != ::PG::PQTRANS_INERROR &&
    super
end

#set_standard_conforming_strings

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 411

def set_standard_conforming_strings
  internal_execute("SET standard_conforming_strings = on", "SCHEMA")
end

#sql_key(sql) (private)

Returns the statement identifier for the client side cache of statements

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 909

def sql_key(sql)
  "#{schema_search_path}-#{sql}"
end

#translate_exception(exception, message:, sql:, binds:) (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 796

def translate_exception(exception, message:, sql:, binds:)
  return exception unless exception.respond_to?(:result)

  case exception.result.try(:error_field, PG::PG_DIAG_SQLSTATE)
  when nil
    if exception.message.match?(/connection is closed/i) || exception.message.match?(/no connection to the server/i)
      ConnectionNotEstablished.new(exception, connection_pool: @pool)
    elsif exception.is_a?(PG::ConnectionBad)
      # libpq message style always ends with a newline; the pg gem's internal
      # errors do not. We separate these cases because a pg-internal
      # ConnectionBad means it failed before it managed to send the query,
      # whereas a libpq failure could have occurred at any time (meaning the
      # server may have already executed part or all of the query).
      if exception.message.end_with?("\n")
        ConnectionFailed.new(exception, connection_pool: @pool)
      else
        ConnectionNotEstablished.new(exception, connection_pool: @pool)
      end
    else
      super
    end
  when UNIQUE_VIOLATION
    RecordNotUnique.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when FOREIGN_KEY_VIOLATION
    InvalidForeignKey.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when VALUE_LIMIT_VIOLATION
    ValueTooLong.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when NUMERIC_VALUE_OUT_OF_RANGE
    RangeError.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when NOT_NULL_VIOLATION
    NotNullViolation.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when SERIALIZATION_FAILURE
    SerializationFailure.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when DEADLOCK_DETECTED
    Deadlocked.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when DUPLICATE_DATABASE
    DatabaseAlreadyExists.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when LOCK_NOT_AVAILABLE
    LockWaitTimeout.new(message, sql: sql, binds: binds, connection_pool: @pool)
  when QUERY_CANCELED
    QueryCanceled.new(message, sql: sql, binds: binds, connection_pool: @pool)
  else
    super
  end
end

#update_typemap_for_default_timezone (private)

[ GitHub ]

  
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 1088

def update_typemap_for_default_timezone
  if @raw_connection && @mapped_default_timezone != default_timezone && @timestamp_decoder
    decoder_class = default_timezone == :utc ?
      PG::TextDecoder::TimestampUtc :
      PG::TextDecoder::TimestampWithoutTimeZone

    @timestamp_decoder = decoder_class.new(**@timestamp_decoder.to_h)
    @raw_connection.type_map_for_results.add_coder(@timestamp_decoder)

    @mapped_default_timezone = default_timezone

    # if default timezone has changed, we need to reconfigure the connection
    # (specifically, the session time zone)
    reconfigure_connection_timezone

    true
  end
end