Class: ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter

Inherits:
AbstractAdapter
  • Object
show all
Defined in:
lib/active_record/connection_adapters/oracle_enhanced_adapter.rb

Overview

Oracle enhanced adapter will work with both Ruby 1.8/1.9 ruby-oci8 gem (which provides interface to Oracle OCI client) or with JRuby and Oracle JDBC driver.

It should work with Oracle 9i, 10g and 11g databases. Limited set of functionality should work on Oracle 8i as well but several features rely on newer functionality in Oracle database.

Usage notes:

  • Key generation assumes a “$table_name_seq” sequence is available for all tables; the sequence name can be changed using ActiveRecord::Base.set_sequence_name. When using Migrations, these sequences are created automatically. Use set_sequence_name :autogenerated with legacy tables that have triggers that populate primary keys automatically.

  • Oracle uses DATE or TIMESTAMP datatypes for both dates and times. Consequently some hacks are employed to map data back to Date or Time in Ruby. Timezones and sub-second precision on timestamps are not supported.

  • Default values that are functions (such as “SYSDATE”) are not supported. This is a restriction of the way ActiveRecord supports default values.

Required parameters:

  • :username

  • :password

  • :database - either TNS alias or connection string for OCI client or database name in JDBC connection string

Optional parameters:

  • :host - host name for JDBC connection, defaults to “localhost”

  • :port - port number for JDBC connection, defaults to 1521

  • :privilege - set “SYSDBA” if you want to connect with this privilege

  • :allow_concurrency - set to “true” if non-blocking mode should be enabled (just for OCI client)

  • :prefetch_rows - how many rows should be fetched at one time to increase performance, defaults to 100

  • :cursor_sharing - cursor sharing mode to minimize amount of unique statements, defaults to “force”

  • :time_zone - database session time zone (it is recommended to set it using ENV which will be then also used for database session time zone)

Optionals NLS parameters:

  • :nls_calendar

  • :nls_characterset

  • :nls_comp

  • :nls_currency

  • :nls_date_format - format for :date columns, defaults to YYYY-MM-DD HH24:MI:SS

  • :nls_date_language

  • :nls_dual_currency

  • :nls_iso_currency

  • :nls_language

  • :nls_length_semantics - semantics of size of VARCHAR2 and CHAR columns, defaults to CHAR (meaning that size specifies number of characters and not bytes)

  • :nls_nchar_characterset

  • :nls_nchar_conv_excp

  • :nls_numeric_characters

  • :nls_sort

  • :nls_territory

  • :nls_timestamp_format - format for :timestamp columns, defaults to YYYY-MM-DD HH24:MI:SS:FF6

  • :nls_timestamp_tz_format

  • :nls_time_format

  • :nls_time_tz_format

Direct Known Subclasses

OracleAdapter

Defined Under Namespace

Classes: StatementPool

Constant Summary collapse

ADAPTER_NAME = 
'OracleEnhanced'.freeze
DEFAULT_NLS_PARAMETERS =

:stopdoc:

{
  :nls_calendar            => nil,
  :nls_characterset        => nil,
  :nls_comp                => nil,
  :nls_currency            => nil,
  :nls_date_format         => 'YYYY-MM-DD HH24:MI:SS',
  :nls_date_language       => nil,
  :nls_dual_currency       => nil,
  :nls_iso_currency        => nil,
  :nls_language            => nil,
  :nls_length_semantics    => 'CHAR',
  :nls_nchar_characterset  => nil,
  :nls_nchar_conv_excp     => nil,
  :nls_numeric_characters  => nil,
  :nls_sort                => nil,
  :nls_territory           => nil,
  :nls_timestamp_format    => 'YYYY-MM-DD HH24:MI:SS:FF6',
  :nls_timestamp_tz_format => nil,
  :nls_time_format         => nil,
  :nls_time_tz_format      => nil
}
NATIVE_DATABASE_TYPES =

:stopdoc:

{
  :primary_key => "NUMBER(38) NOT NULL PRIMARY KEY",
  :string      => { :name => "VARCHAR2", :limit => 255 },
  :text        => { :name => "CLOB" },
  :integer     => { :name => "NUMBER", :limit => 38 },
  :float       => { :name => "NUMBER" },
  :decimal     => { :name => "DECIMAL" },
  :datetime    => { :name => "DATE" },
  # changed to native TIMESTAMP type
  # :timestamp   => { :name => "DATE" },
  :timestamp   => { :name => "TIMESTAMP" },
  :time        => { :name => "DATE" },
  :date        => { :name => "DATE" },
  :binary      => { :name => "BLOB" },
  :boolean     => { :name => "NUMBER", :limit => 1 },
  :raw         => { :name => "RAW", :limit => 2000 }
}
NATIVE_DATABASE_TYPES_BOOLEAN_STRINGS =

if emulate_booleans_from_strings then store booleans in VARCHAR2

NATIVE_DATABASE_TYPES.dup.merge(
  :boolean     => { :name => "VARCHAR2", :limit => 1 }
)
IDENTIFIER_MAX_LENGTH =

maximum length of Oracle identifiers

30
NONQUOTED_OBJECT_NAME =

Names must be from 1 to 30 bytes long with these exceptions:

  • Names of databases are limited to 8 bytes.

  • Names of database links can be as long as 128 bytes.

Nonquoted identifiers cannot be Oracle Database reserved words

Nonquoted identifiers must begin with an alphabetic character from your database character set

Nonquoted identifiers can contain only alphanumeric characters from your database character set and the underscore (_), dollar sign ($), and pound sign (#). Database links can also contain periods (.) and “at” signs (@). Oracle strongly discourages you from using $ and # in nonquoted identifiers.

/[A-Za-z][A-z0-9$#]{0,29}/
/[A-Za-z][A-z0-9$#\.@]{0,127}/
VALID_TABLE_NAME = 
/\A(?:#{NONQUOTED_OBJECT_NAME}\.)?#{NONQUOTED_OBJECT_NAME}(?:@#{NONQUOTED_DATABASE_LINK})?\Z/
EXEC_INSERT_RESULT_COLUMNS =

:nodoc:

%w(returning_id)
AUTOGENERATED_SEQUENCE_NAME =

use in set_sequence_name to avoid fetching primary key value from sequence

'autogenerated'.freeze
DBMS_OUTPUT_BUFFER_SIZE =

Maximum DBMS_OUTPUT buffer size

10000
VERSION = 
File.read(File.dirname(__FILE__)+'/../../../VERSION').chomp
@@do_not_prefetch_primary_key = 
{}
@@ignore_table_columns =

:nodoc:

nil
@@table_column_type =

:nodoc:

nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection, logger, config) ⇒ OracleEnhancedAdapter

:nodoc:



268
269
270
271
272
273
274
275
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 268

def initialize(connection, logger, config) #:nodoc:
  super(connection, logger)
  @quoted_column_names, @quoted_table_names = {}, {}
  @config = config
  @statements = StatementPool.new(connection, config.fetch(:statement_limit) { 250 })
  @enable_dbms_output = false
  @visitor = Arel::Visitors::Oracle.new self if defined?(Arel::Visitors::Oracle)
end

Instance Attribute Details

#auto_retry ⇒ Object

If SQL statement fails due to lost connection then reconnect and retry SQL statement if autocommit mode is enabled. By default this functionality is disabled.



546
547
548
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 546

def auto_retry
  @auto_retry
end

Class Method Details

.boolean_to_string(bool) ⇒ Object

How boolean value should be quoted to String. Used if emulate_booleans_from_strings option is set to true.



218
219
220
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 218

def self.boolean_to_string(bool)
  bool ? "Y" : "N"
end

.encode_raw(value) ⇒ Object

Encode a string or byte array as string of hex codes



502
503
504
505
506
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 502

def self.encode_raw(value)
  # When given a string, convert to a byte array.
  value = value.unpack('C*') if value.is_a?(String)
  value.map { |x| "%02X" % x }.join
end

.is_boolean_column?(name, field_type, table_name = nil) ⇒ Boolean

Check column name to identify if it is boolean (and not String) column. Is used if emulate_booleans_from_strings option is set to true. Override this method definition in initializer file if different boolean column recognition is needed.

Returns:

  • (Boolean) 


211
212
213
214
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 211

def self.is_boolean_column?(name, field_type, table_name = nil)
  return true if ["CHAR(1)","VARCHAR2(1)"].include?(field_type)
  field_type =~ /^VARCHAR2/ && (name =~ /_flag$/i || name =~ /_yn$/i)
end

.is_date_column?(name, table_name = nil) ⇒ Boolean

Check column name to identify if it is Date (and not Time) column. Is used if emulate_dates_by_column_name option is set to true. Override this method definition in initializer file if different Date column recognition is needed.

Returns:

  • (Boolean) 


165
166
167
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 165

def self.is_date_column?(name, table_name = nil)
  name =~ /(^|_)date(_|$)/i
end

.is_integer_column?(name, table_name = nil) ⇒ Boolean

Check column name to identify if it is Integer (and not Float or BigDecimal) column. Is used if emulate_integers_by_column_name option is set to true. Override this method definition in initializer file if different Integer column recognition is needed.

Returns:

  • (Boolean) 


195
196
197
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 195

def self.is_integer_column?(name, table_name = nil)
  name =~ /(^|_)id$/i
end

.valid_table_name?(name) ⇒ Boolean

unescaped table name should start with letter and contain letters, digits, _, $ or # can be prefixed with schema name CamelCase table names should be quoted

Returns:

  • (Boolean) 


440
441
442
443
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 440

def self.valid_table_name?(name) #:nodoc:
  name = name.to_s 
  name =~ VALID_TABLE_NAME && !(name =~ /[A-Z]/ && name =~ /[a-z]/) ? true : false
end

.visitor_for(pool) ⇒ Object

:nodoc:



277
278
279
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 277

def self.visitor_for(pool) # :nodoc:
  Arel::Visitors::Oracle.new(pool)
end

Instance Method Details

#active? ⇒ Boolean

Returns true if the connection is active.

Returns:

  • (Boolean) 


560
561
562
563
564
565
566
567
568
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 560

def active? #:nodoc:
  # Pings the connection to check if it's still good. Note that an
  # #active? method is also available, but that simply returns the
  # last known state, which isn't good enough if the connection has
  # gone stale since the last use.
  @connection.ping
rescue OracleEnhancedConnectionException
  false
end

#adapter_name ⇒ Object

:nodoc:



283
284
285
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 283

def adapter_name #:nodoc:
  ADAPTER_NAME
end

#add_limit_offset!(sql, options) ⇒ Object

:nodoc:



802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 802

def add_limit_offset!(sql, options) #:nodoc:
  # added to_i for limit and offset to protect from SQL injection
  offset = (options[:offset] || 0).to_i
  limit = options[:limit]
  limit = limit.is_a?(String) && limit.blank? ? nil : limit && limit.to_i
  if limit && offset > 0
    sql.replace "SELECT * FROM (SELECT raw_sql_.*, ROWNUM raw_rnum_ FROM (#{sql}) raw_sql_ WHERE ROWNUM <= #{offset+limit}) WHERE raw_rnum_ > #{offset}"
  elsif limit
    sql.replace "SELECT * FROM (#{sql}) WHERE ROWNUM <= #{limit}"
  elsif offset > 0
    sql.replace "SELECT * FROM (SELECT raw_sql_.*, ROWNUM raw_rnum_ FROM (#{sql}) raw_sql_) WHERE raw_rnum_ > #{offset}"
  end
end

#add_order_by_for_association_limiting!(sql, options) ⇒ Object

ORDER BY clause for the passed order option.

Uses column aliases as defined by #distinct.

In Rails 3.x this method is moved to Arel



1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1221

def add_order_by_for_association_limiting!(sql, options) #:nodoc:
  return sql if options[:order].blank?

  order = options[:order].split(',').collect { |s| s.strip }.reject(&:blank?)
  order.map! {|s| $1 if s =~ / (.*)/}
  order = order.zip((0...order.size).to_a).map { |s,i| "alias_#{i}__ #{s}" }.join(', ')

  sql << " ORDER BY #{order}"
end

#begin_db_transaction ⇒ Object

:nodoc:



774
775
776
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 774

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

#cache_columns ⇒ Object

:singleton-method: Cache column description between requests. Could be used in development environment to avoid selecting table columns from data dictionary tables for each request. This can speed up request processing in development mode if development database is not on local computer.

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.cache_columns = true



1050
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1050

cattr_accessor :cache_columns

#clear_cache! ⇒ Object 



602
603
604
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 602

def clear_cache!
  @statements.clear
end

#clear_columns_cache ⇒ Object

used just in tests to clear column cache



1119
1120
1121
1122
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1119

def clear_columns_cache #:nodoc:
  @@columns_cache = nil
  @@pk_and_sequence_for_cache = nil
end

#clear_ignored_table_columns ⇒ Object

used just in tests to clear ignored table columns



1002
1003
1004
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1002

def clear_ignored_table_columns #:nodoc:
  @@ignore_table_columns = nil
end

#clear_prefetch_primary_key ⇒ Object

used just in tests to clear prefetch primary key flag for all tables



834
835
836
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 834

def clear_prefetch_primary_key #:nodoc:
  @@do_not_prefetch_primary_key = {}
end

#clear_table_columns_cache(table_name) ⇒ Object

used in migrations to clear column cache for specified table



1125
1126
1127
1128
1129
1130
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1125

def clear_table_columns_cache(table_name)
  if @@cache_columns
    @@columns_cache ||= {}
    @@columns_cache[table_name.to_s] = nil
  end
end

#clear_types_for_columns ⇒ Object

used just in tests to clear column data type definitions



1022
1023
1024
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1022

def clear_types_for_columns #:nodoc:
  @@table_column_type = nil
end

#column_name_length ⇒ Object

the maximum length of a column name



363
364
365
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 363

def column_name_length
  IDENTIFIER_MAX_LENGTH
end

#columns(table_name, name = nil) ⇒ Object

:nodoc:



1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1053

def columns(table_name, name = nil) #:nodoc:
  if @@cache_columns
    @@columns_cache ||= {}
    @@columns_cache[table_name] ||= columns_without_cache(table_name, name)
  else
    columns_without_cache(table_name, name)
  end
end

#columns_without_cache(table_name, name = nil) ⇒ Object

:nodoc:



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1062

def columns_without_cache(table_name, name = nil) #:nodoc:
  table_name = table_name.to_s
  # get ignored_columns by original table name
  ignored_columns = ignored_table_columns(table_name)

  (owner, desc_table_name, db_link) = @connection.describe(table_name)

  # reset do_not_prefetch_primary_key cache for this table
  @@do_not_prefetch_primary_key[table_name] = nil

  table_cols = <<-SQL.strip.gsub(/\s+/, ' ')
    SELECT column_name AS name, data_type AS sql_type, data_default, nullable, virtual_column, hidden_column,
           DECODE(data_type, 'NUMBER', data_precision,
                             'FLOAT', data_precision,
                             'VARCHAR2', DECODE(char_used, 'C', char_length, data_length),
                             'RAW', DECODE(char_used, 'C', char_length, data_length),
                             'CHAR', DECODE(char_used, 'C', char_length, data_length),
                              NULL) AS limit,
           DECODE(data_type, 'NUMBER', data_scale, NULL) AS scale
      FROM all_tab_cols#{db_link}
     WHERE owner      = '#{owner}'
       AND table_name = '#{desc_table_name}'
       AND hidden_column = 'NO'
     ORDER BY column_id
  SQL

  # added deletion of ignored columns
  select_all(table_cols, name).delete_if do |row|
    ignored_columns && ignored_columns.include?(row['name'].downcase)
  end.map do |row|
    limit, scale = row['limit'], row['scale']
    if limit || scale
      row['sql_type'] += "(#{(limit || 38).to_i}" + ((scale = scale.to_i) > 0 ? ",#{scale})" : ")")
    end

    # clean up odd default spacing from Oracle
    if row['data_default']
      row['data_default'].sub!(/^(.*?)\s*$/, '\1')

      # If a default contains a newline these cleanup regexes need to 
      # match newlines.
      row['data_default'].sub!(/^'(.*)'$/m, '\1')
      row['data_default'] = nil if row['data_default'] =~ /^(null|empty_[bc]lob\(\))$/i
    end

    OracleEnhancedColumn.new(oracle_downcase(row['name']),
                     row['data_default'],
                     row['sql_type'],
                     row['nullable'] == 'Y',
                     # pass table name for table specific column definitions
                     table_name,
                     # pass column type if specified in class definition
                     get_type_for_column(table_name, oracle_downcase(row['name'])), row['virtual_column']=='YES')
  end
end

#commit_db_transaction ⇒ Object

:nodoc:



778
779
780
781
782
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 778

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

#create_savepoint ⇒ Object

:nodoc:



790
791
792
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 790

def create_savepoint #:nodoc:
  execute("SAVEPOINT #{current_savepoint_name}")
end

#current_database ⇒ Object

Current database name



889
890
891
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 889

def current_database
  select_value("SELECT SYS_CONTEXT('userenv', 'db_name') FROM dual")
end

#current_schema ⇒ Object

Current database session schema



899
900
901
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 899

def current_schema
  select_value("SELECT SYS_CONTEXT('userenv', 'current_schema') FROM dual")
end

#current_user ⇒ Object

Current database session user



894
895
896
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 894

def current_user
  select_value("SELECT SYS_CONTEXT('userenv', 'session_user') FROM dual")
end

#dbms_output_enabled? ⇒ Boolean

Is DBMS_Output logging enabled?

Returns:

  • (Boolean) 


1304
1305
1306
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1304

def dbms_output_enabled?
  @enable_dbms_output
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



840
841
842
843
844
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 840

def default_sequence_name(table_name, primary_key = nil)
  # TODO: remove schema prefix if present before truncating
  # truncate table name if necessary to fit in max length of identifier
  "#{table_name.to_s[0,IDENTIFIER_MAX_LENGTH-4]}_seq"
end

#default_sequence_start_value ⇒ Object

:singleton-method: Specify default sequence start with value (by default 10000 if not explicitly set), e.g.:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.default_sequence_start_value = 1



1137
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1137

cattr_accessor :default_sequence_start_value

#default_tablespace ⇒ Object

Default tablespace name of current user



904
905
906
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 904

def default_tablespace
  select_value("SELECT LOWER(default_tablespace) FROM user_users WHERE username = SYS_CONTEXT('userenv', 'current_schema')")
end

#disable_dbms_output ⇒ Object

Turn DBMS_Output logging off



1298
1299
1300
1301
1302
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1298

def disable_dbms_output
  set_dbms_output_plsql_connection
  @enable_dbms_output = false
  plsql(:dbms_output).sys.dbms_output.disable
end

#disconnect! ⇒ Object

Disconnects from the database.



584
585
586
587
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 584

def disconnect! #:nodoc:
  clear_cache!
  @connection.logoff rescue nil
end

#distinct(columns, order_by) ⇒ Object

SELECT DISTINCT clause for a given set of columns and a given ORDER BY clause.

Oracle requires the ORDER BY columns to be in the SELECT list for DISTINCT queries. However, with those columns included in the SELECT DISTINCT list, you won’t actually get a distinct list of the column you want (presuming the column has duplicates with multiple values for the ordered-by columns. So we use the FIRST_VALUE function to get a single (first) value for each column, effectively making every row the same.

distinct("posts.id", "posts.created_at desc")



1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1193

def distinct(columns, order_by) #:nodoc:
  return "DISTINCT #{columns}" if order_by.blank?

  # construct a valid DISTINCT clause, ie. one that includes the ORDER BY columns, using
  # FIRST_VALUE such that the inclusion of these columns doesn't invalidate the DISTINCT
  order_columns = if order_by.is_a?(String)
    order_by.split(',').map { |s| s.strip }.reject(&:blank?)
  else # in latest ActiveRecord versions order_by is already Array
    order_by
  end
  order_columns = order_columns.zip((0...order_columns.size).to_a).map do |c, i|
    # remove any ASC/DESC modifiers
    value = c =~ /^(.+)\s+(ASC|DESC)\s*$/i ? $1 : c
    "FIRST_VALUE(#{value}) OVER (PARTITION BY #{columns} ORDER BY #{c}) AS alias_#{i}__"
  end
  sql = "DISTINCT #{columns}, "
  sql << order_columns * ", "
end

#emulate_booleans ⇒ Object

:singleton-method: By default, the OracleEnhancedAdapter will consider all columns of type NUMBER(1) as boolean. If you wish to disable this emulation you can add the following line to your initializer file:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_booleans = false



118
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 118

cattr_accessor :emulate_booleans

#emulate_booleans_from_strings ⇒ Object

:singleton-method: If you wish that CHAR(1), VARCHAR2(1) columns or VARCHAR2 columns with FLAG or YN at the end of their name are typecasted to booleans then you can add the following line to your initializer file:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_booleans_from_strings = true



205
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 205

cattr_accessor :emulate_booleans_from_strings

#emulate_dates ⇒ Object

:singleton-method: By default, the OracleEnhancedAdapter will typecast all columns of type DATE to Time or DateTime (if value is out of Time value range) value. If you wish that DATE values with hour, minutes and seconds equal to 0 are typecasted to Date then you can add the following line to your initializer file:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates = true

As this option can have side effects when unnecessary typecasting is done it is recommended that Date columns are explicily defined with set_date_columns method.



132
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 132

cattr_accessor :emulate_dates

#emulate_dates_by_column_name ⇒ Object

:singleton-method: By default, the OracleEnhancedAdapter will typecast all columns of type DATE to Time or DateTime (if value is out of Time value range) value. If you wish that DATE columns with “date” in their name (e.g. “creation_date”) are typecasted to Date then you can add the following line to your initializer file:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_dates_by_column_name = true

As this option can have side effects when unnecessary typecasting is done it is recommended that Date columns are explicily defined with set_date_columns method.



159
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 159

cattr_accessor :emulate_dates_by_column_name

#emulate_integers_by_column_name ⇒ Object

:singleton-method: By default, the OracleEnhancedAdapter will typecast all columns of type NUMBER (without precision or scale) to Float or BigDecimal value. If you wish that NUMBER columns with name “id” or that end with “_id” are typecasted to Integer then you can add the following line to your initializer file:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.emulate_integers_by_column_name = true



189
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 189

cattr_accessor :emulate_integers_by_column_name

#enable_dbms_output ⇒ Object

Turn DBMS_Output logging on



1292
1293
1294
1295
1296
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1292

def enable_dbms_output
  set_dbms_output_plsql_connection
  @enable_dbms_output = true
  plsql(:dbms_output).sys.dbms_output.enable(DBMS_OUTPUT_BUFFER_SIZE)
end

#exec_insert(sql, name, binds) ⇒ Object

New method in ActiveRecord 3.1



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 703

def exec_insert(sql, name, binds)
  log(sql, name, binds) do
    returning_id_index = nil
    cursor = if @statements.key?(sql)
      @statements[sql]
    else
      @statements[sql] = @connection.prepare(sql)
    end

    binds.each_with_index do |bind, i|
      col, val = bind
      if col == :returning_id
        returning_id_index = i + 1
        cursor.bind_returning_param(returning_id_index, Integer)
      else
        cursor.bind_param(i + 1, type_cast(val, col), col && col.type)
      end
    end

    cursor.exec_update

    rows = []
    if returning_id_index
      returning_id = cursor.get_returning_param(returning_id_index, Integer)
      rows << [returning_id]
    end
    ActiveRecord::Result.new(EXEC_INSERT_RESULT_COLUMNS, rows)
  end
end

#exec_query(sql, name = 'SQL', binds = []) ⇒ Object 



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 606

def exec_query(sql, name = 'SQL', binds = [])
  log(sql, name, binds) do
    cursor = nil
    cached = false
    if binds.empty?
      cursor = @connection.prepare(sql)
    else
      unless @statements.key? sql
        @statements[sql] = @connection.prepare(sql)
      end

      cursor = @statements[sql]

      binds.each_with_index do |bind, i|
        col, val = bind
        cursor.bind_param(i + 1, type_cast(val, col), col && col.type)
      end

      cached = true
    end

    cursor.exec

    if name == 'EXPLAIN'
      res = true
    else
      columns = cursor.get_col_names.map do |col_name|
        @connection.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 = ActiveRecord::Result.new(columns, rows)
    end

    cursor.close unless cached
    res
  end
end

#exec_update(sql, name, binds) ⇒ Object Also known as: exec_delete

New method in ActiveRecord 3.1



734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 734

def exec_update(sql, name, binds)
  log(sql, name, binds) do
    cached = false
    if binds.empty?
      cursor = @connection.prepare(sql)
    else
      cursor = if @statements.key?(sql)
        @statements[sql]
      else
        @statements[sql] = @connection.prepare(sql)
      end

      binds.each_with_index do |bind, i|
        col, val = bind
        cursor.bind_param(i + 1, type_cast(val, col), col && col.type)
      end
      cached = true
    end

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

#execute(sql, name = nil) ⇒ Object

Executes a SQL statement



594
595
596
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 594

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

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



656
657
658
659
660
661
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 656

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

#get_type_for_column(table_name, column_name) ⇒ Object

:nodoc:



1017
1018
1019
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1017

def get_type_for_column(table_name, column_name) #:nodoc:
  @@table_column_type && @@table_column_type[table_name] && @@table_column_type[table_name][column_name.to_s.downcase]
end

#has_primary_key?(table_name, owner = nil, desc_table_name = nil, db_link = nil) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


1179
1180
1181
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1179

def has_primary_key?(table_name, owner=nil, desc_table_name=nil, db_link=nil) #:nodoc:
  !pk_and_sequence_for(table_name, owner, desc_table_name, db_link).nil?
end

#has_primary_key_trigger?(table_name, owner = nil, desc_table_name = nil, db_link = nil) ⇒ Boolean

check if table has primary key trigger with _pkt suffix

Returns:

  • (Boolean) 


1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1027

def has_primary_key_trigger?(table_name, owner = nil, desc_table_name = nil, db_link = nil)
  (owner, desc_table_name, db_link) = @connection.describe(table_name) unless owner

  trigger_name = default_trigger_name(table_name).upcase
  pkt_sql = <<-SQL
    SELECT trigger_name
    FROM all_triggers#{db_link}
    WHERE owner = '#{owner}'
      AND trigger_name = '#{trigger_name}'
      AND table_owner = '#{owner}'
      AND table_name = '#{desc_table_name}'
      AND status = 'ENABLED'
  SQL
  select_value(pkt_sql, 'Primary Key Trigger') ? true : false
end

#ignore_table_columns(table_name, *args) ⇒ Object

set ignored columns for table



989
990
991
992
993
994
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 989

def ignore_table_columns(table_name, *args) #:nodoc:
  @@ignore_table_columns ||= {}
  @@ignore_table_columns[table_name] ||= []
  @@ignore_table_columns[table_name] += args.map{|a| a.to_s.downcase}
  @@ignore_table_columns[table_name].uniq!
end

#ignored_table_columns(table_name) ⇒ Object

:nodoc:



996
997
998
999
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 996

def ignored_table_columns(table_name) #:nodoc:
  @@ignore_table_columns ||= {}
  @@ignore_table_columns[table_name]
end

#in_clause_length ⇒ Object Also known as: ids_in_list_limit

To avoid ORA-01795: maximum number of expressions in a list is 1000 tell ActiveRecord to limit us to 1000 ids at a time



379
380
381
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 379

def in_clause_length
  1000
end

#index_name_length ⇒ Object

the maximum length of an index name



368
369
370
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 368

def index_name_length
  IDENTIFIER_MAX_LENGTH
end

#indexes(table_name, name = nil) ⇒ Object

This method selects all indexes at once, and caches them in a class variable. Subsequent index calls get them from the variable, without going to the DB.



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 930

def indexes(table_name, name = nil) #:nodoc:
  (owner, table_name, db_link) = @connection.describe(table_name)
  unless all_schema_indexes
    default_tablespace_name = default_tablespace
    result = select_all(<<-SQL.strip.gsub(/\s+/, ' '))
      SELECT LOWER(i.table_name) AS table_name, LOWER(i.index_name) AS index_name, i.uniqueness,
        i.index_type, i.ityp_owner, i.ityp_name, i.parameters,
        LOWER(i.tablespace_name) AS tablespace_name,
        LOWER(c.column_name) AS column_name, e.column_expression
      FROM all_indexes#{db_link} i
        JOIN all_ind_columns#{db_link} c ON c.index_name = i.index_name AND c.index_owner = i.owner
        LEFT OUTER JOIN all_ind_expressions#{db_link} e ON e.index_name = i.index_name AND
          e.index_owner = i.owner AND e.column_position = c.column_position
      WHERE i.owner = '#{owner}'
         AND i.table_owner = '#{owner}'
         AND NOT EXISTS (SELECT uc.index_name FROM all_constraints uc
          WHERE uc.index_name = i.index_name AND uc.owner = i.owner AND uc.constraint_type = 'P')
      ORDER BY i.index_name, c.column_position
    SQL

    current_index = nil
    self.all_schema_indexes = []

    result.each do |row|
      # have to keep track of indexes because above query returns dups
      # there is probably a better query we could figure out
      if current_index != row['index_name']
        statement_parameters = nil
        if row['index_type'] == 'DOMAIN' && row['ityp_owner'] == 'CTXSYS' && row['ityp_name'] == 'CONTEXT'
          procedure_name = default_datastore_procedure(row['index_name'])
          source = select_values(<<-SQL).join
            SELECT text
            FROM all_source#{db_link}
            WHERE owner = '#{owner}'
              AND name = '#{procedure_name.upcase}'
            ORDER BY line
          SQL
          if source =~ /-- add_context_index_parameters (.+)\n/
            statement_parameters = $1
          end
        end
        all_schema_indexes << OracleEnhancedIndexDefinition.new(row['table_name'], row['index_name'],
          row['uniqueness'] == "UNIQUE", row['index_type'] == 'DOMAIN' ? "#{row['ityp_owner']}.#{row['ityp_name']}" : nil,
          row['parameters'], statement_parameters,
          row['tablespace_name'] == default_tablespace_name ? nil : row['tablespace_name'], [])
        current_index = row['index_name']
      end
      all_schema_indexes.last.columns << (row['column_expression'] || row['column_name'].downcase)
    end
  end

  # Return the indexes just for the requested table, since AR is structured that way
  table_name = table_name.downcase
  all_schema_indexes.select{|i| i.table == table_name}
end

#insert_fixture(fixture, table_name) ⇒ Object

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



847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 847

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

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

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

#is_date_column?(name, table_name = nil) ⇒ Boolean

instance method uses at first check if column type defined at class level

Returns:

  • (Boolean) 


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

def is_date_column?(name, table_name = nil) #:nodoc:
  case get_type_for_column(table_name, name)
  when nil
    self.class.is_date_column?(name, table_name)
  when :date
    true
  else
    false
  end
end

#join_to_update(update, select) ⇒ Object

construct additional wrapper subquery if select.offset is used to avoid generation of invalid subquery … IN ( SELECT * FROM ( SELECT raw_sql_.*, rownum raw_rnum_ FROM ( … ) raw_sql_ ) WHERE raw_rnum_ > … )



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1233

def join_to_update(update, select) #:nodoc:
  if select.offset
    subsubselect = select.clone
    subsubselect.projections = [update.key]

    subselect = Arel::SelectManager.new(select.engine)
    subselect.project Arel.sql(quote_column_name update.key.name)
    subselect.from subsubselect.as('alias_join_to_update')

    update.where update.key.in(subselect)
  else
    super
  end
end

#materialized_views ⇒ Object

:nodoc:



922
923
924
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 922

def materialized_views #:nodoc:
  select_values("SELECT LOWER(mview_name) FROM all_mviews WHERE owner = SYS_CONTEXT('userenv', 'current_schema')")
end

#native_database_types ⇒ Object

:startdoc:



346
347
348
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 346

def native_database_types #:nodoc:
  emulate_booleans_from_strings ? NATIVE_DATABASE_TYPES_BOOLEAN_STRINGS : NATIVE_DATABASE_TYPES
end

#next_sequence_value(sequence_name) ⇒ Object

Returns the next sequence value from a sequence generator. Not generally called directly; used by ActiveRecord to get the next primary key value when inserting a new database record (see #prefetch_primary_key?).



767
768
769
770
771
772
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 767

def next_sequence_value(sequence_name)
  # if sequence_name is set to :autogenerated then it means that primary key will be populated by trigger
  return nil if sequence_name == AUTOGENERATED_SEQUENCE_NAME
  # call directly connection method to avoid prepared statement which causes fetching of next sequence value twice
  @connection.select_value("SELECT #{quote_table_name(sequence_name)}.NEXTVAL FROM dual")
end

#pk_and_sequence_for(table_name, owner = nil, desc_table_name = nil, db_link = nil) ⇒ Object

Find a table’s primary key and sequence. Note: Only primary key is implemented - sequence will be nil.



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1142

def pk_and_sequence_for(table_name, owner=nil, desc_table_name=nil, db_link=nil) #:nodoc:
  if @@cache_columns
    @@pk_and_sequence_for_cache ||= {}
    if @@pk_and_sequence_for_cache.key?(table_name)
      @@pk_and_sequence_for_cache[table_name]
    else
      @@pk_and_sequence_for_cache[table_name] = pk_and_sequence_for_without_cache(table_name, owner, desc_table_name, db_link)
    end
  else
    pk_and_sequence_for_without_cache(table_name, owner, desc_table_name, db_link)
  end
end

#pk_and_sequence_for_without_cache(table_name, owner = nil, desc_table_name = nil, db_link = nil) ⇒ Object

:nodoc:



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1155

def pk_and_sequence_for_without_cache(table_name, owner=nil, desc_table_name=nil, db_link=nil) #:nodoc:
  (owner, desc_table_name, db_link) = @connection.describe(table_name) unless owner

  # changed back from user_constraints to all_constraints for consistency
  pks = select_values(<<-SQL.strip.gsub(/\s+/, ' '), 'Primary Key')
    SELECT cc.column_name
      FROM all_constraints#{db_link} c, all_cons_columns#{db_link} cc
     WHERE c.owner = '#{owner}'
       AND c.table_name = '#{desc_table_name}'
       AND c.constraint_type = 'P'
       AND cc.owner = c.owner
       AND cc.constraint_name = c.constraint_name
  SQL

  # only support single column keys
  pks.size == 1 ? [oracle_downcase(pks.first), nil] : nil
end

#prefetch_primary_key?(table_name = nil) ⇒ Boolean

Returns true for Oracle adapter (since Oracle requires primary key values to be pre-fetched before insert). See also #next_sequence_value.

Returns:

  • (Boolean) 


820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 820

def prefetch_primary_key?(table_name = nil)
  return true if table_name.nil?
  table_name = table_name.to_s
  do_not_prefetch = @@do_not_prefetch_primary_key[table_name]
  if do_not_prefetch.nil?
    owner, desc_table_name, db_link = @connection.describe(table_name)
    @@do_not_prefetch_primary_key[table_name] = do_not_prefetch =
      !has_primary_key?(table_name, owner, desc_table_name, db_link) ||
      has_primary_key_trigger?(table_name, owner, desc_table_name, db_link)
  end
  !do_not_prefetch
end

#primary_key(table_name) ⇒ Object

Returns just a table’s primary key



1174
1175
1176
1177
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1174

def primary_key(table_name)
  pk_and_sequence = pk_and_sequence_for(table_name)
  pk_and_sequence && pk_and_sequence.first
end

#quote(value, column = nil) ⇒ Object

:nodoc:



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 454

def quote(value, column = nil) #:nodoc:
  if value && column
    case column.type
    when :text, :binary
      %Q{empty_#{ column.sql_type.downcase rescue 'blob' }()}
    # NLS_DATE_FORMAT independent TIMESTAMP support
    when :timestamp
      quote_timestamp_with_to_timestamp(value)
    # NLS_DATE_FORMAT independent DATE support
    when :date, :time, :datetime
      quote_date_with_to_date(value)
    when :raw
      quote_raw(value)
    when :string
      # NCHAR and NVARCHAR2 literals should be quoted with N'...'.
      # Read directly instance variable as otherwise migrations with table column default values are failing
      # as migrations pass ColumnDefinition object to this method.
      # Check if instance variable is defined to avoid warnings about accessing undefined instance variable.
      column.instance_variable_defined?('@nchar') && column.instance_variable_get('@nchar') ? 'N' << super : super
    else
      super
    end
  elsif value.acts_like?(:date)
    quote_date_with_to_date(value)
  elsif value.acts_like?(:time)
    value.to_i == value.to_f ? quote_date_with_to_date(value) : quote_timestamp_with_to_timestamp(value)
  else
    super
  end
end

#quote_column_name(name) ⇒ Object

QUOTING ==================================================

see: abstract/quoting.rb



388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 388

def quote_column_name(name) #:nodoc:
  name = name.to_s
  @quoted_column_names[name] ||= begin
    # if only valid lowercase column characters in name
    if name =~ /\A[a-z][a-z_0-9\$#]*\Z/
      "\"#{name.upcase}\""
    else
      # remove double quotes which cannot be used inside quoted identifier
      "\"#{name.gsub('"', '')}\""
    end
  end
end

#quote_column_name_or_expression(name) ⇒ Object

This method is used in add_index to identify either column name (which is quoted) or function based index (in which case function expression is not quoted)



403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 403

def quote_column_name_or_expression(name) #:nodoc:
  name = name.to_s
  case name
  # if only valid lowercase column characters in name
  when /^[a-z][a-z_0-9\$#]*$/
    "\"#{name.upcase}\""
  when /^[a-z][a-z_0-9\$#\-]*$/i
    "\"#{name}\""
  # if other characters present then assume that it is expression
  # which should not be quoted
  else
    name
  end
end

#quote_date_with_to_date(value) ⇒ Object

:nodoc:



495
496
497
498
499
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 495

def quote_date_with_to_date(value) #:nodoc:
  # should support that composite_primary_keys gem will pass date as string
  value = quoted_date(value) if value.acts_like?(:date) || value.acts_like?(:time)
  "TO_DATE('#{value}','YYYY-MM-DD HH24:MI:SS')"
end

#quote_raw(value) ⇒ Object

quote encoded raw value



509
510
511
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 509

def quote_raw(value) #:nodoc:
  "'#{self.class.encode_raw(value)}'"
end

#quote_string(s) ⇒ Object

:nodoc:



450
451
452
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 450

def quote_string(s) #:nodoc:
  s.gsub(/'/, "''")
end

#quote_table_name(name) ⇒ Object

:nodoc:



445
446
447
448
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 445

def quote_table_name(name) #:nodoc:
  name = name.to_s
  @quoted_table_names[name] ||= name.split('.').map{|n| n.split('@').map{|m| quote_column_name(m)}.join('@')}.join('.')
end

#quote_timestamp_with_to_timestamp(value) ⇒ Object

:nodoc:



513
514
515
516
517
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 513

def quote_timestamp_with_to_timestamp(value) #:nodoc:
  # add up to 9 digits of fractional seconds to inserted time
  value = "#{quoted_date(value)}:#{("%.6f"%value.to_f).split('.')[1]}" if value.acts_like?(:time)
  "TO_TIMESTAMP('#{value}','YYYY-MM-DD HH24:MI:SS:FF6')"
end

#quoted_false ⇒ Object

:nodoc:



490
491
492
493
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 490

def quoted_false #:nodoc:
  return "'#{self.class.boolean_to_string(false)}'" if emulate_booleans_from_strings
  "0"
end

#quoted_true ⇒ Object

:nodoc:



485
486
487
488
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 485

def quoted_true #:nodoc:
  return "'#{self.class.boolean_to_string(true)}'" if emulate_booleans_from_strings
  "1"
end

#raw_connection ⇒ Object

return raw OCI8 or JDBC connection



555
556
557
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 555

def raw_connection
  @connection.raw_connection
end

#reconnect! ⇒ Object

Reconnects to the database.



571
572
573
574
575
576
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 571

def reconnect! #:nodoc:
  clear_cache!
  @connection.reset!
rescue OracleEnhancedConnectionException => e
  @logger.warn "#{adapter_name} automatic reconnection failed: #{e.message}" if @logger
end

#release_savepoint ⇒ Object

:nodoc:



798
799
800
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 798

def release_savepoint #:nodoc:
  # there is no RELEASE SAVEPOINT statement in Oracle
end

#reset! ⇒ Object 



578
579
580
581
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 578

def reset!
  clear_cache!
  super
end

#rollback_db_transaction ⇒ Object

:nodoc:



784
785
786
787
788
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 784

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

#rollback_to_savepoint ⇒ Object

:nodoc:



794
795
796
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 794

def rollback_to_savepoint #:nodoc:
  execute("ROLLBACK TO #{current_savepoint_name}")
end

#select_rows(sql, name = nil) ⇒ Object

Returns an array of arrays containing the field values. Order is the same as that returned by #columns.



665
666
667
668
669
670
671
672
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 665

def select_rows(sql, name = nil)
  # last parameter indicates to return also column list
  result = columns = nil
  log(sql, name) do
    result, columns = @connection.select(sql, name, true)
  end
  result.map{ |v| columns.map{|c| v[c]} }
end

#sequence_name_length ⇒ Object

the maximum length of a sequence name



373
374
375
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 373

def sequence_name_length
  IDENTIFIER_MAX_LENGTH
end

#set_type_for_columns(table_name, column_type, *args) ⇒ Object

set explicit type for specified table columns



1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1009

def set_type_for_columns(table_name, column_type, *args) #:nodoc:
  @@table_column_type ||= {}
  @@table_column_type[table_name] ||= {}
  args.each do |col|
    @@table_column_type[table_name][col.to_s.downcase] = column_type
  end
end

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

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



692
693
694
695
696
697
698
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 692

def sql_for_insert(sql, pk, id_value, sequence_name, binds)
  unless id_value || pk.nil? || (defined?(CompositePrimaryKeys) && pk.kind_of?(CompositePrimaryKeys::CompositeKeys))
    sql = "#{sql} RETURNING #{quote_column_name(pk)} INTO :returning_id"
    (binds = binds.dup) << [:returning_id, nil]
  end
  [sql, binds]
end

#string_to_date_format ⇒ Object

:singleton-method: Specify non-default date format that should be used when assigning string values to :date columns, e.g.:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.string_to_date_format = “%d.%m.%Y”



227
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 227

cattr_accessor :string_to_date_format

#string_to_time_format ⇒ Object

:singleton-method: Specify non-default time format that should be used when assigning string values to :datetime columns, e.g.:

ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.string_to_time_format = “%d.%m.%Y %H:%M:%S”



235
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 235

cattr_accessor :string_to_time_format

#substitute_at(column, index) ⇒ Object 



598
599
600
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 598

def substitute_at(column, index)
  Arel.sql(":a#{index + 1}")
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


652
653
654
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 652

def supports_explain?
  true
end

#supports_migrations? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 287

def supports_migrations? #:nodoc:
  true
end

#supports_primary_key? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


291
292
293
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 291

def supports_primary_key? #:nodoc:
  true
end

#supports_savepoints? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


295
296
297
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 295

def supports_savepoints? #:nodoc:
  true
end

#supports_statement_cache? ⇒ Boolean

Returns:

  • (Boolean) 


648
649
650
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 648

def supports_statement_cache?
  true
end

#table_alias_length ⇒ Object

:nodoc:



353
354
355
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 353

def table_alias_length #:nodoc:
  IDENTIFIER_MAX_LENGTH
end

#table_exists?(table_name) ⇒ Boolean

Will return true if database object exists (to be able to use also views and synonyms for ActiveRecord models)

Returns:

  • (Boolean) 


915
916
917
918
919
920
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 915

def table_exists?(table_name)
  (owner, table_name, db_link) = @connection.describe(table_name)
  true
rescue
  false
end

#table_name_length ⇒ Object

the maximum length of a table name



358
359
360
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 358

def table_name_length
  IDENTIFIER_MAX_LENGTH
end

#tables(name = nil) ⇒ Object

:nodoc:



908
909
910
911
912
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 908

def tables(name = nil) #:nodoc:
  select_values(
  "SELECT DECODE(table_name, UPPER(table_name), LOWER(table_name), table_name) FROM all_tables WHERE owner = SYS_CONTEXT('userenv', 'current_schema') AND secondary = 'N'",
  name)
end

#temporary_table?(table_name) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


1212
1213
1214
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 1212

def temporary_table?(table_name) #:nodoc:
  select_value("SELECT temporary FROM user_tables WHERE table_name = '#{table_name.upcase}'") == 'Y'
end

#type_cast(value, column) ⇒ Object

Cast a value to a type that the database understands.



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 520

def type_cast(value, column)
  case value
  when true, false
    if emulate_booleans_from_strings || column && column.type == :string
      self.class.boolean_to_string(value)
    else
      value ? 1 : 0
    end
  when Date, Time
    if value.acts_like?(:time)
      zone_conversion_method = ActiveRecord::Base.default_timezone == :utc ? :getutc : :getlocal
      value.respond_to?(zone_conversion_method) ? value.send(zone_conversion_method) : value
    else
      value
    end
  else
    super
  end
end

#write_lobs(table_name, klass, attributes) ⇒ Object

Writes LOB values from attributes, as indicated by the LOB columns of klass.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/active_record/connection_adapters/oracle_enhanced_adapter.rb', line 863

def write_lobs(table_name, klass, attributes) #:nodoc:
  # is class with composite primary key>
  is_with_cpk = klass.respond_to?(:composite?) && klass.composite?
  if is_with_cpk
    id = klass.primary_key.map {|pk| attributes[pk.to_s] }
  else
    id = quote(attributes[klass.primary_key])
  end
  klass.columns.select { |col| col.sql_type =~ /LOB$/i }.each do |col|
    value = attributes[col.name]
    # changed sequence of next two lines - should check if value is nil before converting to yaml
    next if value.nil?  || (value == '')
    value = value.to_yaml if col.text? && klass.serialized_attributes[col.name]
    uncached do
      sql = is_with_cpk ? "SELECT #{quote_column_name(col.name)} FROM #{quote_table_name(table_name)} WHERE #{klass.composite_where_clause(id)} FOR UPDATE" :
        "SELECT #{quote_column_name(col.name)} FROM #{quote_table_name(table_name)} WHERE #{quote_column_name(klass.primary_key)} = #{id} FOR UPDATE"
      unless lob_record = select_one(sql, 'Writable Large Object')
        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