Module: ActiveRecord::ConnectionAdapters::OracleEnhanced::DatabaseStatements

Included in:
ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter
Defined in:
lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb

Instance Method Summary collapse

Instance Method Details

#begin_db_transaction ⇒ Object

:nodoc:



176
177
178
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 176

def begin_db_transaction # :nodoc:
  _connection.autocommit = false
end

#begin_isolated_db_transaction(isolation) ⇒ Object 



190
191
192
193
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 190

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 



79
80
81
82
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 79

def build_explain_clause(options = [])
  # Oracle does not have anything similar to "EXPLAIN ANALYZE"
  # https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/EXPLAIN-PLAN.html#GUID-FD540872-4ED3-4936-96A2-362539931BA0
end

#commit_db_transaction ⇒ Object

:nodoc:



195
196
197
198
199
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 195

def commit_db_transaction # :nodoc:
  _connection.commit
ensure
  _connection.autocommit = true
end

#create_savepoint(name = current_savepoint_name) ⇒ Object

:nodoc:



207
208
209
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 207

def create_savepoint(name = current_savepoint_name) # :nodoc:
  execute("SAVEPOINT #{name}", "TRANSACTION")
end

#default_sequence_name(table_name, primary_key = nil) ⇒ Object

Returns default sequence name for table. Will take all or first 26 characters of table name and append _seq suffix



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

def default_sequence_name(table_name, primary_key = nil)
  table_name.to_s.gsub((/(^|\.)([\w$-]{1,#{sequence_name_length - 4}})([\w$-]*)$/), '\1\2_seq')
end

#empty_insert_statement_value ⇒ Object

Oracle Database does not support this feature Refer community.oracle.com/ideas/13845 and consider to vote if you need this feature.

Raises:

  • (NotImplementedError) 


256
257
258
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 256

def empty_insert_statement_value
  raise NotImplementedError
end

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

New method in ActiveRecord 3.1



100
101
102
103
104
105
106
107
108
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
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 100

def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil)
  sql, binds = sql_for_insert(sql, pk, binds, returning)
  type_casted_binds = type_casted_binds(binds)

  log(sql, name, binds, type_casted_binds) do
    cached = false
    cursor = nil
    returning_id_col = returning_id_index = nil
    with_retry do
      if without_prepared_statement?(binds)
        cursor = _connection.prepare(sql)
      else
        unless @statements.key?(sql)
          @statements[sql] = _connection.prepare(sql)
        end

        cursor = @statements[sql]

        cursor.bind_params(type_casted_binds)

        if /:returning_id/.match?(sql)
          # it currently expects that returning_id comes last part of binds
          returning_id_index = binds.size
          cursor.bind_returning_param(returning_id_index, Integer)
        end

        cached = true
      end

      cursor.exec_update
    end

    rows = []
    if returning_id_index
      returning_id = cursor.get_returning_param(returning_id_index, Integer).to_i
      rows << [returning_id]
    end
    cursor.close unless cached
    build_result(columns: returning_id_col || [], rows: rows)
  end
end

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



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 18

def exec_query(sql, name = "SQL", binds = [], prepare: false, async: false, allow_retry: false)
  sql = transform_query(sql)

  type_casted_binds = type_casted_binds(binds)

  log(sql, name, binds, type_casted_binds, async: async) do
    cursor = nil
    cached = false
    with_retry do
      if without_prepared_statement?(binds)
        cursor = _connection.prepare(sql)
      else
        unless @statements.key? sql
          @statements[sql] = _connection.prepare(sql)
        end

        cursor = @statements[sql]

        cursor.bind_params(type_casted_binds)

        cached = true
      end

      cursor.exec
    end

    if (name == "EXPLAIN") && sql.start_with?("EXPLAIN")
      res = true
    else
      columns = cursor.get_col_names.map do |col_name|
        oracle_downcase(col_name)
      end
      rows = []
      fetch_options = { get_lob_value: (name != "Writable Large Object") }
      while row = cursor.fetch(fetch_options)
        rows << row
      end
      res = build_result(columns: columns, rows: rows)
    end

    cursor.close unless cached
    res
  end
end

#exec_rollback_db_transaction ⇒ Object

:nodoc:



201
202
203
204
205
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 201

def exec_rollback_db_transaction # :nodoc:
  _connection.rollback
ensure
  _connection.autocommit = true
end

#exec_rollback_to_savepoint(name = current_savepoint_name) ⇒ Object

:nodoc:



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

def exec_rollback_to_savepoint(name = current_savepoint_name) # :nodoc:
  execute("ROLLBACK TO #{name}", "TRANSACTION")
end

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

New method in ActiveRecord 3.1



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 143

def exec_update(sql, name = nil, binds = [])
  type_casted_binds = type_casted_binds(binds)

  log(sql, name, binds, type_casted_binds) do
    with_retry do
      cached = false
      if without_prepared_statement?(binds)
        cursor = _connection.prepare(sql)
      else
        if @statements.key?(sql)
          cursor = @statements[sql]
        else
          cursor = @statements[sql] = _connection.prepare(sql)
        end

        cursor.bind_params(type_casted_binds)

        cached = true
      end

      res = cursor.exec_update
      cursor.close unless cached
      res
    end
  end
end

#execute(sql, name = nil, async: false, allow_retry: false) ⇒ Object

Executes a SQL statement



12
13
14
15
16
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 12

def execute(sql, name = nil, async: false, allow_retry: false)
  sql = transform_query(sql)

  log(sql, name, async: async) { _connection.exec(sql, allow_retry: allow_retry) }
end

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



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 68

def explain(arel, binds = [], options = [])
  sql = "EXPLAIN PLAN FOR #{to_sql(arel, binds)}"
  return if /FROM all_/.match?(sql)
  if ORACLE_ENHANCED_CONNECTION == :jdbc
    exec_query(sql, "EXPLAIN", binds)
  else
    exec_query(sql, "EXPLAIN")
  end
  select_values("SELECT * FROM TABLE(DBMS_XPLAN.DISPLAY)", "EXPLAIN").join("\n")
end

#insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [], returning: nil) ⇒ Object 



94
95
96
97
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 94

def insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [], returning: nil)
  pk = nil if id_value
  Array(super || id_value)
end

#insert_fixture(fixture, table_name) ⇒ Object

Inserts the given fixture into the table. Overridden to properly handle lobs.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 226

def insert_fixture(fixture, table_name) # :nodoc:
  super

  if ActiveRecord::Base.pluralize_table_names
    klass = table_name.to_s.singularize.camelize
  else
    klass = table_name.to_s.camelize
  end

  klass = klass.constantize rescue nil
  if klass.respond_to?(:ancestors) && klass.ancestors.include?(ActiveRecord::Base)
    write_lobs(table_name, klass, fixture, klass.lob_columns)
  end
end

#insert_fixtures_set(fixture_set, tables_to_delete = []) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 241

def insert_fixtures_set(fixture_set, tables_to_delete = [])
  disable_referential_integrity do
    transaction(requires_new: true) do
      tables_to_delete.each { |table| delete "DELETE FROM #{quote_table_name(table)}", "Fixture Delete" }

      fixture_set.each do |table_name, rows|
        rows.each { |row| insert_fixture(row, table_name) }
      end
    end
  end
end

#release_savepoint(name = current_savepoint_name) ⇒ Object

:nodoc:



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

def release_savepoint(name = current_savepoint_name) # :nodoc:
  # there is no RELEASE SAVEPOINT statement in Oracle
end

#returning_column_values(result) ⇒ Object 



172
173
174
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 172

def returning_column_values(result)
  result.rows.first
end

#sql_for_insert(sql, pk, binds, _returning) ⇒ Object

New method in ActiveRecord 3.1 Will add RETURNING clause in case of trigger generated primary keys



86
87
88
89
90
91
92
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 86

def sql_for_insert(sql, pk, binds, _returning)
  unless pk == false || pk.nil? || pk.is_a?(Array) || pk.is_a?(String)
    sql = "#{sql} RETURNING #{quote_column_name(pk)} INTO :returning_id"
    (binds = binds.dup) << ActiveRecord::Relation::QueryAttribute.new("returning_id", nil, Type::OracleEnhanced::Integer.new)
  end
  super
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 64

def supports_explain?
  true
end

#transaction_isolation_levels ⇒ Object 



180
181
182
183
184
185
186
187
188
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 180

def transaction_isolation_levels
  # Oracle database supports `READ COMMITTED` and `SERIALIZABLE`
  # No read uncommitted nor repeatable read supppoted
  # http://docs.oracle.com/cd/E11882_01/server.112/e26088/statements_10005.htm#SQLRF55422
  {
    read_committed:   "READ COMMITTED",
    serializable:     "SERIALIZABLE"
  }
end

#write_lobs(table_name, klass, attributes, columns) ⇒ Object

Writes LOB values from attributes for specified columns



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 261

def write_lobs(table_name, klass, attributes, columns) # :nodoc:
  id = quote(attributes[klass.primary_key])
  columns.each do |col|
    value = attributes[col.name]
    # changed sequence of next two lines - should check if value is nil before converting to yaml
    next unless value
    value = klass.attribute_types[col.name].serialize(value)
    # value can be nil after serialization because ActiveRecord serializes [] and {} as nil
    next unless value
    uncached do
      unless lob_record = select_one(sql = <<~SQL.squish, "Writable Large Object")
        SELECT #{quote_column_name(col.name)} FROM #{quote_table_name(table_name)}
        WHERE #{quote_column_name(klass.primary_key)} = #{id} FOR UPDATE
      SQL
        raise ActiveRecord::RecordNotFound, "statement #{sql} returned no rows"
      end
      lob = lob_record[col.name]
      _connection.write_lob(lob, value.to_s, col.type == :binary)
    end
  end
end