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:



167
168
169
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 167

def begin_db_transaction #:nodoc:
  @connection.autocommit = false
end

#begin_isolated_db_transaction(isolation) ⇒ Object 



181
182
183
184
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 181

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

#clear_cache! ⇒ Object

:nodoc:



16
17
18
19
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 16

def clear_cache! # :nodoc:
  reload_type_map
  super
end

#commit_db_transaction ⇒ Object

:nodoc:



186
187
188
189
190
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 186

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

#create_savepoint(name = current_savepoint_name) ⇒ Object

:nodoc:



198
199
200
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 198

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



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

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) 


247
248
249
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 247

def empty_insert_statement_value
  raise NotImplementedError
end

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

New method in ActiveRecord 3.1



95
96
97
98
99
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
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 95

def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil)
  sql, binds = sql_for_insert(sql, pk, binds)
  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) ⇒ Object 



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
62
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 21

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

  log(sql, name, binds, type_casted_binds) 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:



192
193
194
195
196
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 192

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

#exec_rollback_to_savepoint(name = current_savepoint_name) ⇒ Object

:nodoc:



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

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 138

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) ⇒ Object

Executes a SQL statement



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

def execute(sql, name = nil)
  log(sql, name) { @connection.exec(sql) }
end

#explain(arel, binds = []) ⇒ 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 = [])
  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 = []) ⇒ Object 



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

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

#insert_fixture(fixture, table_name) ⇒ Object

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 217

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 



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 232

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:



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

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

#sql_for_insert(sql, pk, binds) ⇒ Object

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



81
82
83
84
85
86
87
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 81

def sql_for_insert(sql, pk, binds)
  unless pk == false || pk.nil? || pk.is_a?(Array)
    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 



171
172
173
174
175
176
177
178
179
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 171

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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/active_record/connection_adapters/oracle_enhanced/database_statements.rb', line 252

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
    if klass.attribute_types[col.name].is_a? Type::Serialized
      value = klass.attribute_types[col.name].serialize(value)
      # value can be nil after serialization because ActiveRecord serializes [] and {} as nil
      next unless value
    end
    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