Module: ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb |
Constant Summary
-
HIGH_PRECISION_CURRENT_TIMESTAMP =
private
Internal use only
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 89
Arel.sql("CURRENT_TIMESTAMP", retryable: true).freeze
-
IDLE_TRANSACTION_STATUSES =
private
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 124[PG::PQTRANS_IDLE, PG::PQTRANS_INTRANS, PG::PQTRANS_INERROR]
-
READ_QUERY =
private
Internal use only
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 19ActiveRecord::ConnectionAdapters::AbstractAdapter.build_read_query_regexp( :close, :declare, :fetch, :move, :set, :show )
Instance Method Summary
- #build_explain_clause(options = [])
- #explain(arel, binds = [], options = [])
- #high_precision_current_timestamp
-
#set_constraints(deferred, *constraints)
Set when constraints will be checked for the current transaction.
- #affected_rows(result) private
- #build_truncate_statements(table_names) private
- #cancel_any_running_query private
- #cast_result(result) private
- #execute_batch(statements, name = nil, **kwargs) private
- #handle_warnings(sql) private
-
#last_insert_id_result(sequence_name)
private
Returns the current ID of a table’s sequence.
- #perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false) private
- #returning_column_values(result) private
- #suppress_composite_primary_key(pk) private
- #warning_ignored?(warning) ⇒ Boolean private
-
#begin_db_transaction
Internal use only
Begins a transaction.
- #begin_isolated_db_transaction(isolation) Internal use only
-
#commit_db_transaction
Internal use only
Commits a transaction.
- #exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil) Internal use only
- #exec_restart_db_transaction Internal use only
-
#exec_rollback_db_transaction
Internal use only
Aborts a transaction.
-
#execute
Internal use only
Executes an SQL statement, returning a
PG::Result
object on success or raising aPG::Error
exception otherwise. -
#query(sql, name = nil)
Internal use only
Queries the database and returns the results in an Array-like object.
- #write_query?(sql) ⇒ Boolean Internal use only
Instance Method Details
#affected_rows(result) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 189
def affected_rows(result) affected_rows = result.cmd_tuples result.clear affected_rows end
#begin_db_transaction
Begins a transaction.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 64
def begin_db_transaction # :nodoc: internal_execute("BEGIN", "TRANSACTION", allow_retry: true, materialize_transactions: false) end
#begin_isolated_db_transaction(isolation)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 68
def begin_isolated_db_transaction(isolation) # :nodoc: internal_execute("BEGIN ISOLATION LEVEL #{transaction_isolation_levels.fetch(isolation)}", "TRANSACTION", allow_retry: true, materialize_transactions: false) end
#build_explain_clause(options = [])
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 96
def build_explain_clause( = []) return "EXPLAIN" if .empty? "EXPLAIN (#{ .join(", ").upcase})" end
#build_truncate_statements(table_names) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 199
def build_truncate_statements(table_names) ["TRUNCATE TABLE #{table_names.map(&method(:quote_table_name)).join(", ")}"] end
#cancel_any_running_query (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 127
def cancel_any_running_query return if @raw_connection.nil? || IDLE_TRANSACTION_STATUSES.include?(@raw_connection.transaction_status) @raw_connection.cancel @raw_connection.block rescue PG::Error end
#cast_result(result) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 171
def cast_result(result) if result.fields.empty? result.clear return ActiveRecord::Result.empty end types = {} fields = result.fields fields.each_with_index do |fname, i| ftype = result.ftype i fmod = result.fmod i types[fname] = types[i] = get_oid_type(ftype, fmod, fname) end ar_result = ActiveRecord::Result.new(fields, result.values, types.freeze) result.clear ar_result end
#commit_db_transaction
Commits a transaction.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 73
def commit_db_transaction # :nodoc: internal_execute("COMMIT", "TRANSACTION", allow_retry: false, materialize_transactions: true) end
#exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 45
def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil) # :nodoc: if use_insert_returning? || pk == false super else result = internal_exec_query(sql, name, binds) unless sequence_name table_ref = extract_table_ref_from_insert_sql(sql) if table_ref pk = primary_key(table_ref) if pk.nil? pk = suppress_composite_primary_key(pk) sequence_name = default_sequence_name(table_ref, pk) end return result unless sequence_name end last_insert_id_result(sequence_name) end end
#exec_restart_db_transaction
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 83
def exec_restart_db_transaction # :nodoc: cancel_any_running_query internal_execute("ROLLBACK AND CHAIN", "TRANSACTION", allow_retry: false, materialize_transactions: true) end
#exec_rollback_db_transaction
Aborts a transaction.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 78
def exec_rollback_db_transaction # :nodoc: cancel_any_running_query internal_execute("ROLLBACK", "TRANSACTION", allow_retry: false, materialize_transactions: true) end
#execute
Executes an SQL statement, returning a PG::Result
object on success or raising a PG::Error
exception otherwise.
Setting allow_retry
to true causes the db to reconnect and retry executing the SQL statement in case of a connection-related exception. This option should only be enabled for known idempotent queries.
Note: the PG::Result
object is manually memory managed; if you don’t need it specifically, you may want consider the exec_query
wrapper.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 39
def execute(...) # :nodoc: super ensure @notice_receiver_sql_warnings = [] end
#execute_batch(statements, name = nil, **kwargs) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 195
def execute_batch(statements, name = nil, **kwargs) raw_execute(combine_multi_statements(statements), name, batch: true, **kwargs) end
#explain(arel, binds = [], options = [])
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 7
def explain(arel, binds = [], = []) sql = build_explain_clause( ) + " " + to_sql(arel, binds) result = internal_exec_query(sql, "EXPLAIN", binds) PostgreSQL::ExplainPrettyPrinter.new.pp(result) end
#handle_warnings(sql) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 216
def handle_warnings(sql) @notice_receiver_sql_warnings.each do |warning| next if warning_ignored?(warning) warning.sql = sql ActiveRecord.db_warnings_action.call(warning) end end
#high_precision_current_timestamp
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 92
def HIGH_PRECISION_CURRENT_TIMESTAMP end
#last_insert_id_result(sequence_name) (private)
Returns the current ID of a table’s sequence.
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 204
def last_insert_id_result(sequence_name) internal_exec_query("SELECT currval(#{quote(sequence_name)})", "SQL") end
#perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 135
def perform_query(raw_connection, sql, binds, type_casted_binds, prepare:, notification_payload:, batch: false) update_typemap_for_default_timezone result = if prepare begin stmt_key = prepare_statement(sql, binds, raw_connection) notification_payload[:statement_name] = stmt_key raw_connection.exec_prepared(stmt_key, type_casted_binds) rescue PG::FeatureNotSupported => error if is_cached_plan_failure?(error) # Nothing we can do if we are in a transaction because all commands # will raise InFailedSQLTransaction if in_transaction? raise PreparedStatementCacheExpired.new(error., connection_pool: @pool) else @lock.synchronize do # outside of transactions we can simply flush this query and retry @statements.delete sql_key(sql) end retry end end raise end elsif binds.nil? || binds.empty? raw_connection.async_exec(sql) else raw_connection.exec_params(sql, type_casted_binds) end verified! handle_warnings(result) notification_payload[:row_count] = result.count result end
#query(sql, name = nil)
Queries the database and returns the results in an Array-like object
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 14
def query(sql, name = nil) # :nodoc: result = internal_execute(sql, name) result.map_types!(@type_map_for_results).values end
#returning_column_values(result) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 208
def returning_column_values(result) result.rows.first end
#set_constraints(deferred, *constraints)
Set when constraints will be checked for the current transaction.
Not passing any specific constraint names will set the value for all deferrable constraints.
deferred
-
Valid values are
:deferred
or:immediate
.
See www.postgresql.org/docs/current/sql-set-constraints.html
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 110
def set_constraints(deferred, *constraints) unless %i[deferred immediate].include?(deferred) raise ArgumentError, "deferred must be :deferred or :immediate" end constraints = if constraints.empty? "ALL" else constraints.map { |c| quote_table_name(c) }.join(", ") end execute("SET CONSTRAINTS #{constraints} #{deferred.to_s.upcase}") end
#suppress_composite_primary_key(pk) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 212
def suppress_composite_primary_key(pk) pk unless pk.is_a?(Array) end
#warning_ignored?(warning) ⇒ Boolean
(private)
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 225
def warning_ignored?(warning) ["WARNING", "ERROR", "FATAL", "PANIC"].exclude?(warning.level) || super end
#write_query?(sql) ⇒ Boolean
# File 'activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb', line 24
def write_query?(sql) # :nodoc: !READ_QUERY.match?(sql) rescue ArgumentError # Invalid encoding !READ_QUERY.match?(sql.b) end