Module: ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements

Included in:
ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
Defined in:
lib/active_record/connection_adapters/postgresql/database_statements.rb

Instance Method Summary collapse

Instance Method Details

#begin_db_transaction ⇒ Object

Begins a transaction.



64
65
66
 
# File '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) ⇒ Object

:nodoc:



68
69
70
 
# File '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 = []) ⇒ Object 



96
97
98
99
100
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 96

def build_explain_clause(options = [])
  return "EXPLAIN" if options.empty?

  "EXPLAIN (#{options.join(", ").upcase})"
end

#commit_db_transaction ⇒ Object

Commits a transaction.



73
74
75
 
# File '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) ⇒ Object

:nodoc:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File '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 ⇒ Object

:nodoc:



83
84
85
86
 
# File '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 ⇒ Object

Aborts a transaction.



78
79
80
81
 
# File '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 ⇒ Object

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.



39
40
41
42
43
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 39

def execute(...) # :nodoc:
  super
ensure
  @notice_receiver_sql_warnings = []
end

#explain(arel, binds = [], options = []) ⇒ Object 



7
8
9
10
11
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 7

def explain(arel, binds = [], options = [])
  sql    = build_explain_clause(options) + " " + to_sql(arel, binds)
  result = internal_exec_query(sql, "EXPLAIN", binds)
  PostgreSQL::ExplainPrettyPrinter.new.pp(result)
end

#high_precision_current_timestamp ⇒ Object 



92
93
94
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 92

def high_precision_current_timestamp
  HIGH_PRECISION_CURRENT_TIMESTAMP
end

#query(sql, name = nil) ⇒ Object

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



14
15
16
17
 
# File '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

#set_constraints(deferred, *constraints) ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
 
# File '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

#write_query?(sql) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


24
25
26
27
28
 
# File '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