Module: ActiveRecord::ConnectionAdapters::Redshift::DatabaseStatements

Included in:
ActiveRecord::ConnectionAdapters::RedshiftAdapter
Defined in:
lib/active_record/connection_adapters/redshift_7_0/database_statements.rb,
lib/active_record/connection_adapters/redshift_7_1/database_statements.rb

Defined Under Namespace

Classes: ExplainPrettyPrinter

Constant Summary collapse

MONEY_COLUMN_TYPE_OID =

The internal PostgreSQL identifier of the money data type.

790
BYTEA_COLUMN_TYPE_OID =

The internal PostgreSQL identifier of the BYTEA data type.

17

Instance Method Summary collapse

Instance Method Details

#begin_db_transaction ⇒ Object

Begins a transaction.



211
212
213
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 211

def begin_db_transaction
  execute 'BEGIN'
end

#begin_isolated_db_transaction(isolation) ⇒ Object 



215
216
217
218
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 215

def begin_isolated_db_transaction(isolation)
  begin_db_transaction
  execute "SET TRANSACTION ISOLATION LEVEL #{transaction_isolation_levels.fetch(isolation)}"
end

#build_explain_clause(options = []) ⇒ Object 



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

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

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

#commit_db_transaction ⇒ Object

Commits a transaction.



221
222
223
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 221

def commit_db_transaction
  execute 'COMMIT'
end

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

:nodoc:



76
77
78
 
# File 'lib/active_record/connection_adapters/redshift_7_1/database_statements.rb', line 76

def exec_delete(sql, name = 'SQL', binds = [])
  execute_and_clear(sql, name, binds, &:cmd_tuples)
end

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

:nodoc:



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/active_record/connection_adapters/redshift_7_1/database_statements.rb', line 81

def exec_insert(sql, name, binds, pk = nil, sequence_name = nil)
  val = exec_query(sql, name, binds)
  if !use_insert_returning? && pk
    unless sequence_name
      table_ref = extract_table_ref_from_insert_sql(sql)
      sequence_name = default_sequence_name(table_ref, pk)
      return val unless sequence_name
    end
    last_insert_id_result(sequence_name)
  else
    val
  end
end

#exec_query(sql, name = 'SQL', binds = [], prepare: false) ⇒ Object Also known as: internal_exec_query 



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 165

def exec_query(sql, name = 'SQL', binds = [], prepare: false)
  execute_and_clear(sql, name, binds, prepare: prepare) do |result|
    types = {}
    fields = result.fields
    fields.each_with_index do |fname, i|
      ftype = result.ftype i
      fmod  = result.fmod i
      types[fname] = get_oid_type(ftype, fmod, fname)
    end
    ActiveRecord::Result.new(fields, result.values, types)
  end
end

#exec_restart_db_transaction ⇒ Object

:nodoc:



119
120
121
122
123
 
# File 'lib/active_record/connection_adapters/redshift_7_1/database_statements.rb', line 119

def exec_restart_db_transaction # :nodoc:
  cancel_any_running_query
  exec_rollback_db_transaction
  begin_db_transaction
end

#exec_rollback_db_transaction ⇒ Object

Aborts a transaction.



226
227
228
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 226

def exec_rollback_db_transaction
  execute 'ROLLBACK'
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.



159
160
161
162
163
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 159

def execute(sql, name = nil)
  log(sql, name) do
    @connection.async_exec(sql)
  end
end

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



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

def explain(arel, binds = [])
  sql = "EXPLAIN #{to_sql(arel, binds)}"
  ExplainPrettyPrinter.new.pp(exec_query(sql, 'EXPLAIN', binds))
end

#high_precision_current_timestamp ⇒ Object 



129
130
131
 
# File 'lib/active_record/connection_adapters/redshift_7_1/database_statements.rb', line 129

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



151
152
153
154
155
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 151

def query(sql, name = nil) # :nodoc:
  log(sql, name) do
    result_as_array @connection.async_exec(sql)
  end
end

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



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

def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
  log(sql, name, async: async) do
    with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
      result = conn.async_exec(sql)
      verified!
      handle_warnings(result)
      result
    end
  end
end

#result_as_array(res) ⇒ Object

create a 2D array representing the result set



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 109

def result_as_array(res) # :nodoc:
  # check if we have any binary column and if they need escaping
  ftypes = Array.new(res.nfields) do |i|
    [i, res.ftype(i)]
  end

  rows = res.values
  return rows unless ftypes.any? do |_, x|
    [BYTEA_COLUMN_TYPE_OID, MONEY_COLUMN_TYPE_OID].include?(x)
  end

  typehash = ftypes.group_by { |_, type| type }
  binaries = typehash[BYTEA_COLUMN_TYPE_OID] || []
  monies   = typehash[MONEY_COLUMN_TYPE_OID] || []

  rows.each do |row|
    # unescape string passed BYTEA field (OID == 17)
    binaries.each do |index, _|
      row[index] = unescape_bytea(row[index])
    end

    # If this is a money type column and there are any currency symbols,
    # then strip them off. Indeed it would be prettier to do this in
    # PostgreSQLColumn.string_to_decimal but would break form input
    # fields that call value_before_type_cast.
    monies.each do |index, _|
      data = row[index]
      # Because money output is formatted according to the locale, there are two
      # cases to consider (note the decimal separators):
      #  (1) $12,345,678.12
      #  (2) $12.345.678,12
      case data
      when /^-?\D+[\d,]+\.\d{2}$/ # (1)
        data.gsub!(/[^-\d.]/, '')
      when /^-?\D+[\d.]+,\d{2}$/ # (2)
        data.gsub!(/[^-\d,]/, '').sub!(/,/, '.')
      end
    end
  end
end

#select_rows(arel, name = nil, binds = []) ⇒ Object

Executes a SELECT query and returns an array of rows. Each row is an array of field values.



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 92

def select_rows(arel, name = nil, binds = [])
  if respond_to?(:arel_from_relation, true)
    arel = arel_from_relation(arel)
    sql, binds = to_sql_and_binds(arel, [])
  else
    arel, binds = binds_from_relation arel, []
    sql = to_sql(arel, binds)
  end
  execute_and_clear(sql, name, binds, &:values)
end

#select_value(arel, name = nil, binds = []) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 49

def select_value(arel, name = nil, binds = [])
  # In Rails 5.2, arel_from_relation replaced binds_from_relation,
  # so we see which method exists to get the variables
  #
  # In Rails 6.0 to_sql_and_binds began only returning sql, with
  # to_sql_and_binds serving as a replacement
  if respond_to?(:arel_from_relation, true)
    arel = arel_from_relation(arel)
    sql, binds = to_sql_and_binds(arel, binds)
  else
    arel, binds = binds_from_relation arel, binds
    sql = to_sql(arel, binds)
  end
  execute_and_clear(sql, name, binds) do |result|
    result.getvalue(0, 0) if result.ntuples > 0 && result.nfields > 0
  end
end

#select_values(arel, name = nil) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 67

def select_values(arel, name = nil)
  # In Rails 5.2, arel_from_relation replaced binds_from_relation,
  # so we see which method exists to get the variables
  #
  # In Rails 6.0 to_sql_and_binds began only returning sql, with
  # to_sql_and_binds serving as a replacement
  if respond_to?(:arel_from_relation, true)
    arel = arel_from_relation(arel)
    sql, binds = to_sql_and_binds(arel, [])
  else
    arel, binds = binds_from_relation arel, []
    sql = to_sql(arel, binds)
  end

  execute_and_clear(sql, name, binds) do |result|
    if result.nfields > 0
      result.column_values(0)
    else
      []
    end
  end
end

#sql_for_insert(sql, pk, id_value, sequence_name, binds) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/active_record/connection_adapters/redshift_7_0/database_statements.rb', line 184

def sql_for_insert(sql, pk, id_value, sequence_name, binds)
  if pk.nil?
    # Extract the table from the insert sql. Yuck.
    table_ref = extract_table_ref_from_insert_sql(sql)
    pk = primary_key(table_ref) if table_ref
  end

  sql = "#{sql} RETURNING #{quote_column_name(pk)}" if pk && use_insert_returning?

  super
end

#write_query?(sql) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

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