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.



102
103
104
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 102

def begin_db_transaction # :nodoc:
  internal_execute("BEGIN", "TRANSACTION", allow_retry: true, materialize_transactions: false)
end

#begin_isolated_db_transaction(isolation) ⇒ Object

:nodoc:



106
107
108
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 106

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 



134
135
136
137
138
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 134

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

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

#commit_db_transaction ⇒ Object

Commits a transaction.



111
112
113
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 111

def commit_db_transaction # :nodoc:
  internal_execute("COMMIT", "TRANSACTION", allow_retry: false, materialize_transactions: true)
end

#exec_delete(sql, name = nil, binds = []) ⇒ Object Also known as: exec_update

:nodoc:



78
79
80
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 78

def exec_delete(sql, name = nil, binds = []) # :nodoc:
  execute_and_clear(sql, name, binds) { |result| result.cmd_tuples }
end

#exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil) ⇒ Object

:nodoc:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 83

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:



121
122
123
124
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 121

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.



116
117
118
119
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 116

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.



47
48
49
50
51
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 47

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 



130
131
132
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 130

def high_precision_current_timestamp
  HIGH_PRECISION_CURRENT_TIMESTAMP
end

#internal_exec_query(sql, name = "SQL", binds = [], prepare: false, async: false, allow_retry: false, materialize_transactions: true) ⇒ Object

:nodoc:



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 65

def internal_exec_query(sql, name = "SQL", binds = [], prepare: false, async: false, allow_retry: false, materialize_transactions: true) # :nodoc:
  execute_and_clear(sql, name, binds, prepare: prepare, async: async, allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |result|
    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
    build_result(columns: fields, rows: result.values, column_types: types.freeze)
  end
end

#query(sql, name = nil) ⇒ Object

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



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 14

def query(sql, name = nil) # :nodoc:
  mark_transaction_written_if_write(sql)

  log(sql, name) do |notification_payload|
    with_raw_connection do |conn|
      result = conn.async_exec(sql).map_types!(@type_map_for_results).values
      verified!
      notification_payload[:row_count] = result.count
      result
    end
  end
end

#raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 53

def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
  log(sql, name, async: async) do |notification_payload|
    with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
      result = conn.async_exec(sql)
      verified!
      handle_warnings(result)
      notification_payload[:row_count] = result.count
      result
    end
  end
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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 148

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) 


32
33
34
35
36
 
# File 'lib/active_record/connection_adapters/postgresql/database_statements.rb', line 32

def write_query?(sql) # :nodoc:
  !READ_QUERY.match?(sql)
rescue ArgumentError # Invalid encoding
  !READ_QUERY.match?(sql.b)
end