API Guides

class PostgreSQLAdapter

Ruby on Rails 8.0.4

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

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 .

Inherits from

ActiveRecord::ConnectionAdapters::AbstractAdapter

Includes

Constants

Attributes

Methods (defined here)

Private methods

(25) Implementation detail — not part of the public API.

Methods (inherited)

From ActiveRecord::ConnectionAdapters::AbstractAdapter (82)
From ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements (4)
From ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting (5)
From ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements (31)
From ActiveRecord::ConnectionAdapters::DatabaseLimits (3)
From ActiveRecord::ConnectionAdapters::QueryCache (9)
From ActiveRecord::ConnectionAdapters::Savepoints (4)
From ActiveSupport::Callbacks (1)
From ActiveSupport::Concern (3)
From Object (17)
From ActiveSupport::DescendantsTracker (3)
From ActiveSupport::NumericWithFormat (2)

Type at least 2 characters to search.

↑↓ navigate · ↵ open · esc close