Class: ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
|
|
Instance Chain:
|
|
Inherits: |
ActiveRecord::ConnectionAdapters::AbstractAdapter
|
Defined in: | activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb |
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 aSET client_encoding TO <encoding>
call on the connection. -
:min_messages
- An optional client min messages that is used in aSET client_min_messages TO <min_messages>
call on the connection. -
:variables
- An optional hash of additional parameters that will be used inSET SESSION key = val
calls on the connection. -
:insert_returning
- An optional boolean to control the use ofRETURNING
forINSERT
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
-
ADAPTER_NAME =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 65"PostgreSQL"
-
DEADLOCK_DETECTED =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 770"40P01"
-
DUPLICATE_DATABASE =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 771"42P04"
-
FOREIGN_KEY_VIOLATION =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 767"23503"
-
LOCK_NOT_AVAILABLE =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 772"55P03"
-
NATIVE_DATABASE_TYPES =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 136{ primary_key: "bigserial primary key", string: { name: "character varying" }, text: { name: "text" }, integer: { name: "integer", limit: 4 }, bigint: { name: "bigint" }, float: { name: "float" }, decimal: { name: "decimal" }, datetime: {}, # set dynamically based on datetime_type timestamp: { name: "timestamp" }, timestamptz: { name: "timestamptz" }, time: { name: "time" }, date: { name: "date" }, daterange: { name: "daterange" }, numrange: { name: "numrange" }, tsrange: { name: "tsrange" }, tstzrange: { name: "tstzrange" }, int4range: { name: "int4range" }, int8range: { name: "int8range" }, binary: { name: "bytea" }, boolean: { name: "boolean" }, xml: { name: "xml" }, tsvector: { name: "tsvector" }, hstore: { name: "hstore" }, inet: { name: "inet" }, cidr: { name: "cidr" }, macaddr: { name: "macaddr" }, uuid: { name: "uuid" }, json: { name: "json" }, jsonb: { name: "jsonb" }, ltree: { name: "ltree" }, citext: { name: "citext" }, point: { name: "point" }, line: { name: "line" }, lseg: { name: "lseg" }, box: { name: "box" }, path: { name: "path" }, polygon: { name: "polygon" }, circle: { name: "circle" }, bit: { name: "bit" }, bit_varying: { name: "bit varying" }, money: { name: "money" }, interval: { name: "interval" }, oid: { name: "oid" }, enum: {} # special type https://www.postgresql.org/docs/current/datatype-enum.html }
-
NOT_NULL_VIOLATION =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 766"23502"
-
NUMERIC_VALUE_OUT_OF_RANGE =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 765"22003"
-
QUERY_CANCELED =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 773"57014"
-
SERIALIZATION_FAILURE =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 769"40001"
-
UNIQUE_VIOLATION =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 768"23505"
-
VALUE_LIMIT_VIOLATION =
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 764
"22001"
::ActiveSupport::Callbacks
- Included
DatabaseStatements
- Included
DEFAULT_INSERT_VALUE
Quoting
- Included
COLUMN_NAME, COLUMN_NAME_WITH_ORDER
AbstractAdapter
- Inherited
ADAPTER_NAME, COMMENT_REGEX, EXTENDED_TYPE_MAPS, FIBER_LOCK, SIMPLE_INT, THREAD_LOCK, TYPE_MAP
PostgreSQL::Quoting
- Included
COLUMN_NAME, COLUMN_NAME_WITH_ORDER
PostgreSQL::DatabaseStatements
- Included
IDLE_TRANSACTION_STATUSES
Class Attribute Summary
- .create_unlogged_tables rw
- .create_unlogged_tables? ⇒ Boolean rw
- .datetime_type rw
- .datetime_type? ⇒ Boolean rw
AbstractAdapter
- Inherited
Class Method Summary
- .dbconsole(config, options = {})
-
.new ⇒ PostgreSQLAdapter
constructor
Initializes and connects a
PostgreSQL
adapter. - .new_client(conn_params)
AbstractAdapter
- Inherited
.database_exists? | Does the database for this adapter exist? |
.dbconsole | Opens a database console session. |
.find_cmd_and_exec, .type_cast_config_to_boolean, .type_cast_config_to_integer, .validate_default_timezone |
::ActiveSupport::DescendantsTracker
- Inherited
descendants | See additional method definition at line 104. |
subclasses | See additional method definition at line 100. |
Instance Attribute Summary
-
#active? ⇒ Boolean
readonly
Is this connection alive and ready for queries?
- #create_unlogged_tables rw
- #create_unlogged_tables? ⇒ Boolean rw
- #datetime_type rw
- #datetime_type? ⇒ Boolean rw
-
#session_auth=(user)
writeonly
Set the authorized user for this session.
- #supports_advisory_locks? ⇒ Boolean readonly
- #supports_bulk_alter? ⇒ Boolean readonly
- #supports_check_constraints? ⇒ Boolean readonly
- #supports_comments? ⇒ Boolean readonly
- #supports_common_table_expressions? ⇒ Boolean readonly
- #supports_datetime_with_precision? ⇒ Boolean readonly
- #supports_ddl_transactions? ⇒ Boolean readonly
- #supports_deferrable_constraints? ⇒ Boolean readonly
- #supports_exclusion_constraints? ⇒ Boolean readonly
- #supports_explain? ⇒ Boolean readonly
- #supports_expression_index? ⇒ Boolean readonly
- #supports_extensions? ⇒ Boolean readonly
- #supports_foreign_keys? ⇒ Boolean readonly
- #supports_foreign_tables? ⇒ Boolean readonly
- #supports_index_include? ⇒ Boolean readonly
- #supports_index_sort_order? ⇒ Boolean readonly
-
#supports_insert_conflict_target?
readonly
Alias for #supports_insert_on_conflict?.
- #supports_insert_on_conflict? ⇒ Boolean (also: #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_conflict_target?) readonly
-
#supports_insert_on_duplicate_skip?
readonly
Alias for #supports_insert_on_conflict?.
-
#supports_insert_on_duplicate_update?
readonly
Alias for #supports_insert_on_conflict?.
- #supports_insert_returning? ⇒ Boolean readonly
- #supports_json? ⇒ Boolean readonly
- #supports_lazy_transactions? ⇒ Boolean readonly
- #supports_materialized_views? ⇒ Boolean readonly
- #supports_nulls_not_distinct? ⇒ Boolean readonly
- #supports_optimizer_hints? ⇒ Boolean readonly
- #supports_partial_index? ⇒ Boolean readonly
- #supports_partitioned_indexes? ⇒ Boolean readonly
- #supports_pgcrypto_uuid? ⇒ Boolean readonly
- #supports_restart_db_transaction? ⇒ Boolean readonly
- #supports_savepoints? ⇒ Boolean readonly
- #supports_transaction_isolation? ⇒ Boolean readonly
- #supports_unique_constraints? ⇒ Boolean readonly
- #supports_validate_constraints? ⇒ Boolean readonly
- #supports_views? ⇒ Boolean readonly
- #supports_virtual_columns? ⇒ Boolean readonly
- #use_insert_returning? ⇒ Boolean readonly
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, #__callbacks?, | |
#active? | Checks whether the connection to the database is still active. |
#all_foreign_keys_valid? | Override to check all foreign key constraints in a database. |
#database_exists?, | |
#in_use? | Alias for AbstractAdapter#owner. |
#lock, #logger, #owner, #pool, #pool=, | |
#prepared_statements | Alias for AbstractAdapter#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? |
#use_metadata_table?, #visitor |
DatabaseStatements
- Included
SchemaStatements
- Included
Instance Method Summary
-
#add_enum_value(type_name, value, options = {})
Add enum value to an existing enum type.
-
#create_enum(name, values, **options)
Given a name and an array of values, creates an enum type.
-
#disable_extension(name, force: false)
Removes an extension from the database.
-
#disconnect!
Disconnects from the database if already connected.
-
#drop_enum(name, values = nil, **options)
Drops an enum type.
- #enable_extension(name)
-
#enum_types
Returns a list of defined enum types, and their values.
- #extension_available?(name) ⇒ Boolean
- #extension_enabled?(name) ⇒ Boolean
- #extensions
- #index_algorithms
-
#max_identifier_length
Returns the configured supported identifier length supported by
PostgreSQL
. -
#postgresql_version
Alias for AbstractAdapter#database_version.
-
#rename_enum(name, options = {})
Rename an existing enum type to something else.
-
#rename_enum_value(type_name, options = {})
Rename enum value on an existing enum type.
- #reset!
- #set_standard_conforming_strings
PostgreSQL::DatabaseStatements
- Included
#build_explain_clause, | |
#exec_update | Alias for PostgreSQL::DatabaseStatements#exec_delete. |
#explain, #high_precision_current_timestamp, #raw_execute |
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 |
#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. |
PostgreSQL::Quoting
- Included
#check_int_in_range, #column_name_matcher, #column_name_with_order_matcher, | |
#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. |
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 |
#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. |
#schema_cache, | |
#schema_version | Returns the version identifier of the schema currently available in the database. |
#shard | The shard (e.g. |
#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). |
#log |
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. |
Quoting
- Included
#quote | Quotes the column value to help prevent SQL injection attacks. |
#quote_bound_value | Quote a value to be used as a bound parameter of unknown type. |
#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 |
#unquoted_false, #unquoted_true |
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 | Alias for DatabaseStatements#insert. |
#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 |
#exec_insert | Executes insert |
#exec_query | Executes |
#exec_update | Executes update |
#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 |
#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_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 |
#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. |
SchemaStatements
- Included
#add_belongs_to | Alias for SchemaStatements#add_reference. |
#add_check_constraint | Adds a new check constraint to the table. |
#add_column | Add a new |
#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 ( |
#assume_migrated_upto_version, | |
#build_create_table_definition | Returns a |
#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 |
#change_column_default | Sets a new default value for a column: |
#change_column_null | Sets or removes a |
#change_table | A block for changing columns in |
#change_table_comment | Changes the comment for a table or removes it if |
#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 |
#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 |
#data_source_exists? | Checks to see if the data source |
#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 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 | Alias for SchemaStatements#remove_reference. |
#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 ( |
#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_options, | |
#tables | Returns an array of table names defined in the database. |
#view_exists? | Checks to see if the view |
#views | Returns an array of view names defined in the database. |
::ActiveSupport::Callbacks
- Included
#run_callbacks | Runs the callbacks for the given event. |
Constructor Details
.new ⇒ PostgreSQLAdapter
Initializes and connects a PostgreSQL
adapter.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 322
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 116
class_attribute :create_unlogged_tables, default: false
.create_unlogged_tables? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 116
class_attribute :create_unlogged_tables, default: false
.datetime_type (rw)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 134
class_attribute :datetime_type, default: :
.datetime_type? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 134
class_attribute :datetime_type, default: :
Class Method Details
.dbconsole(config, options = {})
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 84
def dbconsole(config, = {}) 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] && [: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("psql", config.database) end
.new_client(conn_params)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 68
def new_client(conn_params) PG.connect(**conn_params) rescue ::PG::Error => error if conn_params && conn_params[:dbname] == "postgres" raise ActiveRecord::ConnectionNotEstablished, error. elsif conn_params && conn_params[:dbname] && error. .include?(conn_params[:dbname]) raise ActiveRecord::NoDatabaseError.db_error(conn_params[:dbname]) elsif conn_params && conn_params[:user] && error. .include?(conn_params[:user]) raise ActiveRecord::DatabaseConnectionError.username_error(conn_params[:user]) elsif conn_params && conn_params[:host] && error. .include?(conn_params[:host]) raise ActiveRecord::DatabaseConnectionError.hostname_error(conn_params[:host]) else raise ActiveRecord::ConnectionNotEstablished, error. end end
Instance Attribute Details
#active? ⇒ Boolean
(readonly)
Is this connection alive and ready for queries?
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 346
def active? @lock.synchronize do return false unless @raw_connection @raw_connection.query ";" end true rescue PG::Error false end
#create_unlogged_tables (rw)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 116
class_attribute :create_unlogged_tables, default: false
#create_unlogged_tables? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 116
class_attribute :create_unlogged_tables, default: false
#datetime_type (rw)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 134
class_attribute :datetime_type, default: :
#datetime_type? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 134
class_attribute :datetime_type, default: :
#session_auth=(user) (writeonly)
Set the authorized user for this session
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 605
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 417
def supports_advisory_locks? true end
#supports_bulk_alter? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 190
def supports_bulk_alter? true end
#supports_check_constraints? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 222
def supports_check_constraints? true end
#supports_comments? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 254
def supports_comments? true end
#supports_common_table_expressions? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 448
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 246
def supports_datetime_with_precision? true end
#supports_ddl_transactions? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 413
def supports_ddl_transactions? true end
#supports_deferrable_constraints? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 238
def supports_deferrable_constraints? true end
#supports_exclusion_constraints? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 226
def supports_exclusion_constraints? true end
#supports_explain? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 421
def supports_explain? true end
#supports_expression_index? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 210
def supports_expression_index? true end
#supports_extensions? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 425
def supports_extensions? true end
#supports_foreign_keys? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 218
def supports_foreign_keys? true end
#supports_foreign_tables? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 433
def supports_foreign_tables? true end
#supports_index_include? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 206
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 194
def supports_index_sort_order? true end
#supports_insert_conflict_target? (readonly)
Alias for #supports_insert_on_conflict?.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 275
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 270
def supports_insert_on_conflict? database_version >= 9_05_00 # >= 9.5 end
#supports_insert_on_duplicate_skip? (readonly)
Alias for #supports_insert_on_conflict?.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 273
alias supports_insert_on_duplicate_skip? supports_insert_on_conflict?
#supports_insert_on_duplicate_update? (readonly)
Alias for #supports_insert_on_conflict?.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 274
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 266
def supports_insert_returning? true end
#supports_json? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 250
def supports_json? true end
#supports_lazy_transactions? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 452
def supports_lazy_transactions? true end
#supports_materialized_views? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 429
def supports_materialized_views? true end
#supports_nulls_not_distinct? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 285
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 441
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 202
def supports_partial_index? true end
#supports_partitioned_indexes? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 198
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 437
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 262
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 258
def supports_savepoints? true end
#supports_transaction_isolation? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 214
def supports_transaction_isolation? true end
#supports_unique_constraints? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 230
def supports_unique_constraints? true end
#supports_validate_constraints? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 234
def supports_validate_constraints? true end
#supports_views? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 242
def supports_views? true end
#supports_virtual_columns? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 277
def supports_virtual_columns? database_version >= 12_00_00 # >= 12.0 end
#use_insert_returning? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 610
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.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 570
def add_enum_value(type_name, value, = {}) before, after = .values_at(:before, :after) sql = +"ALTER TYPE #{quote_table_name(type_name)} ADD VALUE '#{value}'" if before && after raise ArgumentError, "Cannot have both :before and :after at the same time" elsif before sql << " BEFORE '#{before}'" elsif after sql << " AFTER '#{after}'" end execute(sql).tap { reload_type_map } end
#create_enum(name, values, **options)
Given a name and an array of values, creates an enum type.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 525
def create_enum(name, values, ** ) 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
#disable_extension(name, force: false)
Removes an extension from the database.
:force
-
Set to
:cascade
to drop dependent objects as well. Defaults to false.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 483
def disable_extension(name, force: false) internal_exec_query("DROP EXTENSION IF EXISTS \"#{name}\"#{' CASCADE' if force == :cascade}").tap { reload_type_map } end
#disconnect!
Disconnects from the database if already connected. Otherwise, this method does nothing.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 383
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.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 555
def drop_enum(name, values = nil, ** ) query = <<~SQL DROP TYPE#{' IF EXISTS' if [: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 470
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.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 502
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
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 489
def extension_available?(name) query_value("SELECT true FROM pg_available_extensions WHERE name = #{quote(name)}", "SCHEMA") end
#extension_enabled?(name) ⇒ Boolean
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 493
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 497
def extensions internal_exec_query("SELECT extname FROM pg_extension", "SCHEMA", allow_retry: true, materialize_transactions: false).cast_values end
#index_algorithms
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 289
def index_algorithms { concurrently: "CONCURRENTLY" } end
#max_identifier_length
Returns the configured supported identifier length supported by PostgreSQL
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 600
def max_identifier_length @max_identifier_length ||= query_value("SHOW max_identifier_length", "SCHEMA").to_i end
#postgresql_version
Alias for AbstractAdapter#database_version.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 618
alias :postgresql_version :database_version
#rename_enum(name, options = {})
Rename an existing enum type to something else.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 563
def rename_enum(name, = {}) to = .fetch(:to) { raise ArgumentError, ":to is required" } exec_query("ALTER TYPE #{quote_table_name(name)} RENAME TO #{to}").tap { reload_type_map } end
#rename_enum_value(type_name, options = {})
Rename enum value on an existing enum type.
# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 586
def rename_enum_value(type_name, = {}) unless database_version >= 10_00_00 # >= 10.0 raise ArgumentError, "Renaming enum values is only supported in PostgreSQL 10 or later" end from = .fetch(:from) { raise ArgumentError, ":from is required" } to = .fetch(:to) { raise ArgumentError, ":to is required" } execute("ALTER TYPE #{quote_table_name(type_name)} RENAME VALUE '#{from}' TO '#{to}'").tap { reload_type_map } end
#reset!
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 368
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
#set_standard_conforming_strings
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb', line 409
def set_standard_conforming_strings internal_execute("SET standard_conforming_strings = on") end