@override
# File lib/arjdbc/jdbc/adapter.rb, line 597 def primary_key(table) primary_keys(table).first end
AbstractAdapter
Built on top of `ActiveRecord::ConnectionAdapters::AbstractAdapter` which provides the abstract interface for database-specific functionality, this class serves 2 purposes in AR-JDBC :
as a base class for sub-classes
usable standalone (or with a mixed in adapter spec module)
Historically this class is mostly been used standalone and that’s still a valid use-case esp. since (with it’s `arjdbc.jdbc.RubyJdbcConnectionClass`) JDBC provides a unified interface for all databases in Java it tries to do it’s best implementing all `ActiveRecord` functionality on top of that. This might no be perfect that’s why it checks for a `config` module (or tries to resolve one from the JDBC driver’s meta-data) and if the database has “extended” AR-JDBC support mixes in the given module for each adapter instance. This is sufficient for most database specific specs we support, but for compatibility with native (MRI) adapters it’s perfectly fine to sub-class the adapter and override some of its API methods.
@deprecated re-implemented - no longer used @return [Hash] the AREL visitor to use If there’s a `self.arel2_visitors(config)` method on the adapter spec than it is preferred and will be used instead of this one.
# File lib/arjdbc/jdbc/adapter.rb, line 182 def self.arel2_visitors(config) { 'jdbc' => ::Arel::Visitors::ToSql } end
@deprecated re-implemented - no longer used @see arel2_visitors
# File lib/arjdbc/jdbc/adapter.rb, line 188 def self.configure_arel2_visitors(config) visitors = ::Arel::Visitors::VISITORS klass = config[:adapter_spec] klass = self unless klass.respond_to?(:arel2_visitors) visitor = nil klass.arel2_visitors(config).each do |name, arel| visitors[name] = ( visitor = arel ) end if visitor && config[:adapter] =~ /^(jdbc|jndi)$/ visitors[ config[:adapter] ] = visitor end visitor end
Initializes the (JDBC connection) adapter instance. The passed configuration Hash’s keys are symbolized, thus changes to the original `config` keys won’t be reflected in the adapter. If the adapter’s sub-class or the spec module that this instance will extend in responds to `configure_connection` than it will be called. @param connection an (optional) connection instance @param logger the `ActiveRecord::Base.logger` to use (or nil) @param config the database configuration @note `initialize(logger, config)` with 2 arguments is supported as well
# File lib/arjdbc/jdbc/adapter.rb, line 52 def initialize(connection, logger, config = nil) if config.nil? && logger.respond_to?(:key?) # (logger, config) config, logger, connection = logger, connection, nil end @config = config.respond_to?(:symbolize_keys) ? config.symbolize_keys : config # NOTE: JDBC 4.0 drivers support checking if connection isValid # thus no need to @config[:connection_alive_sql] ||= 'SELECT 1' # # NOTE: setup to retry 5-times previously - maybe do not set at all ? @config[:retry_count] ||= 1 @config[:adapter_spec] = adapter_spec(@config) unless @config.key?(:adapter_spec) spec = @config[:adapter_spec] # NOTE: adapter spec's init_connection only called if instantiated here : connection ||= jdbc_connection_class(spec).new(@config, self) super(connection, logger) # kind of like `extend ArJdbc::MyDB if self.class == JdbcAdapter` : klass = @config[:adapter_class] extend spec if spec && ( ! klass || klass == JdbcAdapter) # NOTE: should not be necessary for JNDI due reconnect! on checkout : configure_connection if respond_to?(:configure_connection) Jdbc::JndiConnectionPoolCallbacks.prepare(self, connection) @visitor = new_visitor # nil if no AREL (AR-2.3) end
@return whether the given SQL string is an ‘INSERT’ query
# File lib/arjdbc/jdbc/adapter.rb, line 818 def self.insert?(sql) JdbcConnection::insert?(sql) end
Allows changing the prepared statements setting for this connection. @see #prepared_statements?
def prepared_statements=(statements)
@prepared_statements = statements
end
# File lib/arjdbc/jdbc/adapter.rb, line 745 def self.prepared_statements?(config) config.key?(:prepared_statements) ? type_cast_config_to_boolean(config.fetch(:prepared_statements)) : false # off by default - NOTE: on AR 4.x it's on by default !? end
@return whether the given SQL string is a ‘SELECT’ like query (returning a result set)
# File lib/arjdbc/jdbc/adapter.rb, line 813 def self.select?(sql) JdbcConnection::select?(sql) end
# File lib/arjdbc/jdbc/adapter.rb, line 757 def self.suble_binds=(flag); @@suble_binds = flag; end
# File lib/arjdbc/jdbc/adapter.rb, line 756 def self.suble_binds?; @@suble_binds; end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 837 def self.type_cast_config_to_boolean(config) config == 'false' ? false : (config == 'true' ? true : config) end
@note Used by Java API to convert dates from (custom) SELECTs (might get refactored). @private
# File lib/arjdbc/jdbc/adapter.rb, line 845 def _string_to_date(value) jdbc_column_class.string_to_date(value) end
@note Used by Java API to convert times from (custom) SELECTs (might get refactored). @private
# File lib/arjdbc/jdbc/adapter.rb, line 851 def _string_to_time(value) jdbc_column_class.string_to_dummy_time(value) end
@note Used by Java API to convert times from (custom) SELECTs (might get refactored). @private
# File lib/arjdbc/jdbc/adapter.rb, line 857 def _string_to_timestamp(value) jdbc_column_class.string_to_time(value) end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 277 def active? @connection.active? end
@return [String] the ‘JDBC’ adapter name.
# File lib/arjdbc/jdbc/adapter.rb, line 157 def adapter_name ADAPTER_NAME end
Locate the specialized (database specific) adapter specification module if one exists based on provided configuration data. This module will than extend an instance of the adapter (unless an `:adapter_class` provided).
This method is called during {initialize} unless an explicit `config` is set. @param config the configuration to check for `:adapter_spec` @return [Module] the database specific module
# File lib/arjdbc/jdbc/adapter.rb, line 127 def adapter_spec(config) dialect = (config[:dialect] || config[:driver]).to_s ::ArJdbc.modules.each do |constant| # e.g. ArJdbc::MySQL if constant.respond_to?(:adapter_matcher) spec = constant.adapter_matcher(dialect, config) return spec if spec end end if (config[:jndi] || config[:data_source]) && ! config[:dialect] begin data_source = config[:data_source] || Java::JavaxNaming::InitialContext.new.lookup(config[:jndi]) connection = data_source.getConnection config[:dialect] = connection.getMetaData.getDatabaseProductName rescue Java::JavaSql::SQLException => e warn "failed to set database :dialect from connection meda-data (#{e})" else return adapter_spec(config) # re-try matching a spec with set config[:dialect] ensure connection.close if connection # return to the pool end end nil end
Starts a database transaction. @override
# File lib/arjdbc/jdbc/adapter.rb, line 327 def begin_db_transaction @connection.begin end
Starts a database transaction. @param isolation the transaction isolation to use @since 1.3.0 @override on *AR-4.0*
# File lib/arjdbc/jdbc/adapter.rb, line 347 def begin_isolated_db_transaction(isolation) @connection.begin(isolation) end
# File lib/arjdbc/jdbc/adapter.rb, line 321 def columns(table_name, name = nil) @connection.columns(table_name.to_s) end
Commits the current database transaction. @override
# File lib/arjdbc/jdbc/adapter.rb, line 333 def commit_db_transaction @connection.commit end
Creates a (transactional) save-point one can rollback to. Unlike ‘plain’ `ActiveRecord` it is allowed to pass a save-point name. @param name the save-point name @return save-point name (even if nil passed will be generated) @since 1.3.0 @extension added optional name parameter
# File lib/arjdbc/jdbc/adapter.rb, line 374 def create_savepoint(name = current_savepoint_name(true)) @connection.create_savepoint(name) end
Due tracking of save-points created in a LIFO manner, always returns the correct name if any (last) save-point has been marked and not released. Otherwise when creating a save-point same naming convention as `ActiveRecord` uses (“active_record_” prefix) will be returned. @return [String] the current save-point name @since 1.3.0 @override
# File lib/arjdbc/jdbc/adapter.rb, line 404 def current_savepoint_name(create = nil) open_tx = open_transactions return "active_record_#{open_tx}" if create sp_names = @connection.marked_savepoint_names unless sp_names.empty? sp_names[ -(sp_names.size - open_tx + 1) ] else "active_record_#{open_tx}" end end
Returns the underlying database name. @override
# File lib/arjdbc/jdbc/adapter.rb, line 236 def database_name @connection.database_name end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 288 def disconnect! @connection.disconnect! end
Executes a delete statement in the context of this connection. @param sql the query string (or AREL object) @param name logging marker for the executed SQL statement log entry @param binds the bind parameters @override available since *AR-3.1*
# File lib/arjdbc/jdbc/adapter.rb, line 457 def exec_delete(sql, name, binds) if sql.respond_to?(:to_sql) sql = to_sql(sql, binds); to_sql = true end if prepared_statements? log(sql, name || 'SQL', binds) { @connection.execute_delete(sql, binds) } else sql = suble_binds(sql, binds) unless to_sql # deprecated behavior log(sql, name || 'SQL') { @connection.execute_delete(sql) } end end
Executes an insert statement in the context of this connection. @param sql the query string (or AREL object) @param name logging marker for the executed SQL statement log entry @param binds the bind parameters @override available since *AR-3.1*
# File lib/arjdbc/jdbc/adapter.rb, line 440 def exec_insert(sql, name, binds, pk = nil, sequence_name = nil) if sql.respond_to?(:to_sql) sql = to_sql(sql, binds); to_sql = true end if prepared_statements? log(sql, name || 'SQL', binds) { @connection.execute_insert(sql, binds) } else sql = suble_binds(sql, binds) unless to_sql # deprecated behavior log(sql, name || 'SQL') { @connection.execute_insert(sql) } end end
Executes a SQL query in the context of this connection using the bind substitutes. @param sql the query string (or AREL object) @param name logging marker for the executed SQL statement log entry @param binds the bind parameters @return [ActiveRecord::Result] or [Array] on *AR-2.3* @override available since *AR-3.1*
# File lib/arjdbc/jdbc/adapter.rb, line 423 def exec_query(sql, name = 'SQL', binds = []) if sql.respond_to?(:to_sql) sql = to_sql(sql, binds); to_sql = true end if prepared_statements? log(sql, name, binds) { @connection.execute_query(sql, binds) } else sql = suble_binds(sql, binds) unless to_sql # deprecated behavior log(sql, name) { @connection.execute_query(sql) } end end
Similar to {exec_query} except it returns “raw” results in an array where each rows is a hash with keys as columns (just like Rails used to do up until 3.0) instead of wrapping them in a {#ActiveRecord::Result}. @param sql the query string (or AREL object) @param name logging marker for the executed SQL statement log entry @param binds the bind parameters @yield [v1, v2] depending on the row values returned from the query In case a block is given it will yield each row from the result set instead of returning mapped query results in an array. @return [Array] unless a block is given
# File lib/arjdbc/jdbc/adapter.rb, line 496 def exec_query_raw(sql, name = 'SQL', binds = [], &block) if sql.respond_to?(:to_sql) sql = to_sql(sql, binds); to_sql = true end if prepared_statements? log(sql, name, binds) { @connection.execute_query_raw(sql, binds, &block) } else sql = suble_binds(sql, binds) unless to_sql # deprecated behavior log(sql, name) { @connection.execute_query_raw(sql, &block) } end end
# Executes an update statement in the context of this connection. @param sql the query string (or AREL object) @param name logging marker for the executed SQL statement log entry @param binds the bind parameters @override available since *AR-3.1*
# File lib/arjdbc/jdbc/adapter.rb, line 474 def exec_update(sql, name, binds) if sql.respond_to?(:to_sql) sql = to_sql(sql, binds); to_sql = true end if prepared_statements? log(sql, name || 'SQL', binds) { @connection.execute_update(sql, binds) } else sql = suble_binds(sql, binds) unless to_sql # deprecated behavior log(sql, name || 'SQL') { @connection.execute_update(sql) } end end
Executes the SQL statement in the context of this connection. The return value from this method depends on the SQL type (whether it’s a SELECT, INSERT etc.). For INSERTs a generated id might get returned while for UPDATE statements the affected row count. Please note that this method returns “raw” results (in an array) for statements that return a result set, while {exec_query} is expected to return a `ActiveRecord::Result` (since AR 3.1). @note This method does not use prepared statements. @note The method does not emulate various “native” `execute` results on MRI. @see exec_query @see exec_insert @see exec_update
# File lib/arjdbc/jdbc/adapter.rb, line 542 def execute(sql, name = nil, binds = nil) sql = suble_binds to_sql(sql, binds), binds if binds if name == :skip_logging _execute(sql, name) else log(sql, name) { _execute(sql, name) } end end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 587 def indexes(table_name, name = nil, schema_name = nil) @connection.indexes(table_name, name, schema_name) end
@note Used on AR 2.3 and 3.0 @override
# File lib/arjdbc/jdbc/adapter.rb, line 316 def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) id = execute(sql, name) id_value || id end
@override Will return true even when native adapter classes passed in e.g. `jdbc_adapter.is_a? ConnectionAdapter::PostgresqlAdapter`
This is only necessary (for built-in adapters) when `config` is forced to `nil` and the `:adapter_spec` module is used to extend the `JdbcAdapter`, otherwise we replace the class constants for built-in adapters (MySQL, PostgreSQL and SQLite3).
# File lib/arjdbc/jdbc/adapter.rb, line 169 def is_a?(klass) # This is to fake out current_adapter? conditional logic in AR tests if klass.is_a?(Class) && klass.name =~ /#{adapter_name}Adapter$/ true else super end end
Returns the (JDBC) `ActiveRecord` column class for this adapter. This is used by (database specific) spec modules to override the class. @see ActiveRecord::ConnectionAdapters::JdbcColumn
# File lib/arjdbc/jdbc/adapter.rb, line 96 def jdbc_column_class ::ActiveRecord::ConnectionAdapters::JdbcColumn end
Retrieve the raw `java.sql.Connection` object. The unwrap parameter is useful if an attempt to unwrap a pooled (JNDI) connection should be made - to really return the ‘native’ JDBC object. @param unwrap [true, false] whether to unwrap the connection object @return [Java::JavaSql::Connection] the JDBC connection
# File lib/arjdbc/jdbc/adapter.rb, line 105 def jdbc_connection(unwrap = nil) java_connection = raw_connection.connection return java_connection unless unwrap connection_class = java.sql.Connection.java_class if java_connection.wrapper_for?(connection_class) java_connection.unwrap(connection_class) # java.sql.Wrapper.unwrap elsif java_connection.respond_to?(:connection) # e.g. org.apache.tomcat.jdbc.pool.PooledConnection java_connection.connection # getConnection else java_connection end end
Returns the (JDBC) connection class to be used for this adapter. This is used by (database specific) spec modules to override the class used assuming some of the available methods have been re-defined. @see ActiveRecord::ConnectionAdapters::JdbcConnection
# File lib/arjdbc/jdbc/adapter.rb, line 88 def jdbc_connection_class(spec) connection_class = spec.jdbc_connection_class if spec && spec.respond_to?(:jdbc_connection_class) connection_class ? connection_class : ::ActiveRecord::ConnectionAdapters::JdbcConnection end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 295 def jdbc_insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) insert_sql(sql, name, pk, id_value, sequence_name) end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 307 def jdbc_select_all(sql, name = nil, binds = []) select(sql, name, binds) end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 301 def jdbc_update(sql, name = nil, binds = []) execute(sql, name, binds) end
Allows for modification of the detected native types. @param types the resolved native database types @see native_database_types
# File lib/arjdbc/jdbc/adapter.rb, line 217 def modify_types(types) types end
DB specific types are detected but adapter specs (or extenders) are expected to hand tune these types for concrete databases. @return [Hash] the native database types @override
# File lib/arjdbc/jdbc/adapter.rb, line 206 def native_database_types @native_database_types ||= begin types = @connection.native_database_types modify_types(types) types end end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 241 def native_sql_to_type(type) if /^(.*?)\(([0-9]+)\)/ =~ type tname, limit = $1, $2.to_i ntypes = native_database_types if ntypes[:primary_key] == type return :primary_key, nil else ntypes.each do |name, val| if name == :primary_key next end if val[:name].downcase == tname.downcase && ( val[:limit].nil? || val[:limit].to_i == limit ) return name, limit end end end elsif /^(.*?)/ =~ type tname = $1 ntypes = native_database_types if ntypes[:primary_key] == type return :primary_key, nil else ntypes.each do |name, val| if val[:name].downcase == tname.downcase && val[:limit].nil? return name, nil end end end else return :string, 255 end return nil, nil end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 592 def pk_and_sequence_for(table) ( key = primary_key(table) ) ? [ key, nil ] : nil end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 597 def primary_key(table) primary_keys(table).first end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 602 def primary_keys(table) @connection.primary_keys(table) end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 282 def reconnect! @connection.reconnect! # handles adapter.configure_connection @connection end
Release a previously created save-point. @note Save-points are auto-released with the transaction they’re created in (on transaction commit or roll-back). @param name the save-point name @since 1.3.0 @extension added optional name parameter
# File lib/arjdbc/jdbc/adapter.rb, line 393 def release_savepoint(name = current_savepoint_name) @connection.release_savepoint(name) end
Rolls back the current database transaction. @override
# File lib/arjdbc/jdbc/adapter.rb, line 339 def rollback_db_transaction @connection.rollback end
Transaction rollback to a given (previously created) save-point. If no save-point name given rollback to the last created one. @param name the save-point name @since 1.3.0 @extension added optional name parameter
# File lib/arjdbc/jdbc/adapter.rb, line 383 def rollback_to_savepoint(name = current_savepoint_name) @connection.rollback_savepoint(name) end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 517 def select(sql, name = nil, binds = []) exec_query(to_sql(sql, binds), name, binds) end
@private @override
# File lib/arjdbc/jdbc/adapter.rb, line 510 def select_rows(sql, name = nil, binds = []) exec_query_raw(sql, name, binds).map!(&:values) end
Abstract adapter default implementation does nothing silently. @override
# File lib/arjdbc/jdbc/adapter.rb, line 223 def structure_dump raise NotImplementedError, "structure_dump not supported" end
JDBC adapters support migration. @return [true] @override
# File lib/arjdbc/jdbc/adapter.rb, line 230 def supports_migrations? true end
Does our database (+ its JDBC driver) support save-points? @since 1.3.0 @override
# File lib/arjdbc/jdbc/adapter.rb, line 364 def supports_savepoints? @connection.supports_savepoints? end
Does this adapter support setting the isolation level for a transaction? Unlike ‘plain’ `ActiveRecord` we allow checking for concrete transaction isolation level support by the database. @param level optional to check if we support a specific isolation level @since 1.3.0 @extension added optional level parameter
# File lib/arjdbc/jdbc/adapter.rb, line 357 def supports_transaction_isolation?(level = nil) @connection.supports_transaction_isolation?(level) end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 581 def table_exists?(name) return false unless name @connection.table_exists?(name) # schema_name = nil end
@override
# File lib/arjdbc/jdbc/adapter.rb, line 576 def tables(name = nil) @connection.tables end
@private
# File lib/arjdbc/jdbc/adapter.rb, line 623 def to_sql(arel, binds = nil) # NOTE: can not handle `visitor.accept(arel.ast)` right arel.respond_to?(:to_sql) ? arel.send(:to_sql) : arel end
@param record the record e.g. `User.find(1)` @param column the model’s column e.g. `User.columns_hash` @param value the lob value - string or (IO or Java) stream
# File lib/arjdbc/jdbc/adapter.rb, line 614 def update_lob_value(record, column, value) @connection.update_lob_value(record, column, value) end
@deprecated Rather use {update_lob_value} instead.
# File lib/arjdbc/jdbc/adapter.rb, line 607 def write_large_object(*args) @connection.write_large_object(*args) end
Provides backwards-compatibility on ActiveRecord 4.1 for DB adapters that override this and than call super expecting to work. @note This method is available in 4.0 but won’t be in 4.1 @private
# File lib/arjdbc/jdbc/adapter.rb, line 723 def add_column_options!(sql, options) sql << " DEFAULT #{quote(options[:default], options[:column])}" if options_include_default?(options) # must explicitly check for :null to allow change_column to work on migrations sql << " NOT NULL" if options[:null] == false sql << " AUTO_INCREMENT" if options[:auto_increment] == true end
`TableDefinition.new native_database_types, name, temporary, options` and ActiveRecord 4.1 supports optional `as` argument (which defaults to nil) to provide the SQL to use to generate the table: `TableDefinition.new native_database_types, name, temporary, options, as` @private
# File lib/arjdbc/jdbc/adapter.rb, line 706 def create_table_definition(*args) table_definition(*args) end
Take an id from the result of an INSERT query. @return [Integer, NilClass]
# File lib/arjdbc/jdbc/adapter.rb, line 666 def last_inserted_id(result) if result.is_a?(Hash) || result.is_a?(ActiveRecord::Result) result.first.first[1] # .first = { "id"=>1 } .first = [ "id", 1 ] else result end end
@override so that we do not have to care having 2 arguments on 3.0
# File lib/arjdbc/jdbc/adapter.rb, line 640 def log(sql, name = nil, binds = []) unless binds.blank? binds = binds.map do |column, value| column ? [column.name, value] : [nil, value] end sql = "#{sql} #{binds.inspect}" end super(sql, name || 'SQL') # `log(sql, name)` on AR <= 3.0 end
@return whether `:prepared_statements` are to be used
# File lib/arjdbc/jdbc/adapter.rb, line 734 def prepared_statements? return @prepared_statements unless (@prepared_statements ||= nil).nil? @prepared_statements = self.class.prepared_statements?(config) end
aliasing create_table_definition as table_definition :
# File lib/arjdbc/jdbc/adapter.rb, line 651 def translate_exception(e, message) # we shall not translate native "Java" exceptions as they might # swallow an ArJdbc / driver bug into a AR::StatementInvalid ... return e if e.is_a?(NativeException) # JRuby 1.6 return e if e.is_a?(Java::JavaLang::Throwable) case e when SystemExit, SignalException, NoMemoryError then e # NOTE: wraps AR::JDBCError into AR::StatementInvalid, desired ?! else super end end
Generated with the Darkfish Rdoc Generator 2.