class ActiveRecord::ConnectionAdapters::MysqlAdapter
The MySQL adapter will work with both Ruby/MySQL, which is a Ruby-based MySQL adapter that comes bundled with Active Record, and with the faster C-based MySQL/Ruby adapter (available both as a gem and from www.tmtm.org/en/mysql/ruby/).
Options:
-
:host
- Defaults to “localhost”. -
:port
- Defaults to 3306. -
:socket
- Defaults to “/tmp/mysql.sock”. -
:username
- Defaults to “root” -
:password
- Defaults to nothing. -
:database
- The name of the database. No default, must be provided. -
:encoding
- (Optional) Sets the client encoding by executing “SET NAMES <encoding>” after connection. -
:reconnect
- Defaults to false (See MySQL documentation: dev.mysql.com/doc/refman/5.0/en/auto-reconnect.html). -
:strict
- Defaults to true. Enable STRICT_ALL_TABLES. (See MySQL documentation: dev.mysql.com/doc/refman/5.5/en/server-sql-mode.html) -
:sslca
- Necessary to use MySQL with an SSL connection. -
:sslkey
- Necessary to use MySQL with an SSL connection. -
:sslcert
- Necessary to use MySQL with an SSL connection. -
:sslcapath
- Necessary to use MySQL with an SSL connection. -
:sslcipher
- Necessary to use MySQL with an SSL connection.
Constants
- ADAPTER_NAME
- ENCODINGS
Taken from here:
https://github.com/tmtm/ruby-mysql/blob/master/lib/mysql/charset.rb
Author: TOMITA Masahiro <tommy@tmtm.org>
Public Class Methods
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 125 def initialize(connection, logger, connection_options, config) super @statements = StatementPool.new(@connection, config.fetch(:statement_limit) { 1000 }) @client_encoding = nil connect end
Public Instance Methods
CONNECTION MANAGEMENT ====================================
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 174 def active? if @connection.respond_to?(:stat) @connection.stat else @connection.query 'select 1' end # mysql-ruby doesn't raise an exception when stat fails. if @connection.respond_to?(:errno) @connection.errno.zero? else true end rescue Mysql::Error false end
Clears the prepared statements cache.
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 223 def clear_cache! @statements.clear end
Get the client encoding for this database
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 271 def client_encoding return @client_encoding if @client_encoding result = exec_query( "SHOW VARIABLES WHERE Variable_name = 'character_set_client'", 'SCHEMA') @client_encoding = ENCODINGS[result.rows.last.last] end
Disconnects from the database if already connected. Otherwise, this method does nothing.
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 199 def disconnect! super @connection.close rescue nil end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 455 def exec_delete(sql, name, binds) affected_rows = 0 exec_query(sql, name, binds) do |n| affected_rows = n end affected_rows end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 280 def exec_query(sql, name = 'SQL', binds = []) # If the configuration sets prepared_statements:false, binds will # always be empty, since the bind variables will have been already # substituted and removed from binds by BindVisitor, so this will # effectively disable prepared statement usage completely. if binds.empty? result_set, affected_rows = exec_without_stmt(sql, name) else result_set, affected_rows = exec_stmt(sql, name, binds) end yield affected_rows if block_given? result_set end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 442 def execute_and_free(sql, name = nil) result = execute(sql, name) ret = yield result result.free ret end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 296 def last_inserted_id(result) @connection.insert_id end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 191 def reconnect! super disconnect! connect end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 204 def reset! if @connection.respond_to?(:change_user) # See http://bugs.mysql.com/bug.php?id=33540 -- the workaround way to # reset the connection is to change the user to the same user. @connection.change_user(@config[:username], @config[:password], @config[:database]) configure_connection end end
DATABASE STATEMENTS ======================================
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 215 def select_rows(sql, name = nil) @connection.query_with_result = true rows = exec_query(sql, name).rows @connection.more_results && @connection.next_result # invoking stored procedures with CLIENT_MULTI_RESULTS requires this to tidy up else connection will be dropped rows end
Returns true, since this connection adapter supports prepared statement caching.
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 135 def supports_statement_cache? true end
QUOTING ==================================================
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 162 def type_cast(value, column) return super unless value == true || value == false value ? 1 : 0 end
Private Instance Methods
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 538 def configure_connection encoding = @config[:encoding] execute("SET NAMES '#{encoding}'", :skip_logging) if encoding # By default, MySQL 'where id is null' selects the last inserted id. # Turn this off. http://dev.rubyonrails.org/ticket/6778 execute("SET SQL_AUTO_IS_NULL=0", :skip_logging) # Make MySQL reject illegal values rather than truncating or # blanking them. See # http://dev.mysql.com/doc/refman/5.5/en/server-sql-mode.html#sqlmode_strict_all_tables execute("SET SQL_MODE='STRICT_ALL_TABLES'", :skip_logging) if strict_mode? end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 516 def connect encoding = @config[:encoding] if encoding @connection.options(Mysql::SET_CHARSET_NAME, encoding) rescue nil end if @config[:sslca] || @config[:sslkey] @connection.ssl_set(@config[:sslkey], @config[:sslcert], @config[:sslca], @config[:sslcapath], @config[:sslcipher]) end @connection.options(Mysql::OPT_CONNECT_TIMEOUT, @config[:connect_timeout]) if @config[:connect_timeout] @connection.options(Mysql::OPT_READ_TIMEOUT, @config[:read_timeout]) if @config[:read_timeout] @connection.options(Mysql::OPT_WRITE_TIMEOUT, @config[:write_timeout]) if @config[:write_timeout] @connection.real_connect(*@connection_options) # reconnect must be set after real_connect is called, because real_connect sets it to false internally @connection.reconnect = !!@config[:reconnect] if @connection.respond_to?(:reconnect=) configure_connection end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 474 def exec_stmt(sql, name, binds) cache = {} log(sql, name, binds) do if binds.empty? stmt = @connection.prepare(sql) else cache = @statements[sql] ||= { :stmt => @connection.prepare(sql) } stmt = cache[:stmt] end begin stmt.execute(*binds.map { |col, val| type_cast(val, col) }) rescue Mysql::Error => e # Older versions of MySQL leave the prepared statement in a bad # place when an error occurs. To support older mysql versions, we # need to close the statement and delete the statement from the # cache. stmt.close @statements.delete sql raise e end cols = nil if metadata = stmt.result_metadata cols = cache[:cols] ||= metadata.fetch_fields.map { |field| field.name } end result_set = ActiveRecord::Result.new(cols, stmt.to_a) if cols affected_rows = stmt.affected_rows stmt.result_metadata.free if cols stmt.free_result stmt.close if binds.empty? [result_set, affected_rows] end end
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 552 def select(sql, name = nil, binds = []) @connection.query_with_result = true rows = exec_query(sql, name, binds) @connection.more_results && @connection.next_result # invoking stored procedures with CLIENT_MULTI_RESULTS requires this to tidy up else connection will be dropped rows end
Returns the version of the connected MySQL server.
# File lib/active_record/connection_adapters/mysql_adapter.rb, line 560 def version @version ||= @connection.server_info.scan(/^(\d+)\.(\d+)\.(\d+)/).flatten.map { |v| v.to_i } end