Methods
A
B
C
D
E
I
L
N
P
Q
R
S
T
U
Constants
ADAPTER_NAME = 'Mysql2'
PRIMARY = "PRIMARY"
LOST_CONNECTION_ERROR_MESSAGES = [ "Server shutdown in progress", "Broken pipe", "Lost connection to MySQL server during query", "MySQL server has gone away" ]
QUOTED_FALSE = '1', '0'
NATIVE_DATABASE_TYPES = { :primary_key => "int(11) DEFAULT NULL auto_increment PRIMARY KEY", :string => { :name => "varchar", :limit => 255 }, :text => { :name => "text" }, :integer => { :name => "int", :limit => 4 }, :float => { :name => "float" }, :decimal => { :name => "decimal" }, :datetime => { :name => "datetime" }, :timestamp => { :name => "datetime" }, :time => { :name => "time" }, :date => { :name => "date" }, :binary => { :name => "blob" }, :boolean => { :name => "tinyint", :limit => 1 } }
Class Public methods
new(connection, logger, connection_options, config)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 124
def initialize(connection, logger, connection_options, config)
  super(connection, logger)
  @connection_options, @config = connection_options, config
  @quoted_column_names, @quoted_table_names = {}, {}
  configure_connection
end
Instance Public methods
active?()

CONNECTION MANAGEMENT ====================================

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 209
def active?
  return false unless @connection
  @connection.ping
end
adapter_name()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 135
def adapter_name
  ADAPTER_NAME
end
add_column(table_name, column_name, type, options = {})
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 491
def add_column(table_name, column_name, type, options = {})
  add_column_sql = "ALTER TABLE #{quote_table_name(table_name)} ADD #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
  add_column_options!(add_column_sql, options)
  add_column_position!(add_column_sql, options)
  execute(add_column_sql)
end
add_column_position!(sql, options)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 558
def add_column_position!(sql, options)
  if options[:first]
    sql << " FIRST"
  elsif options[:after]
    sql << " AFTER #{quote_column_name(options[:after])}"
  end
end
add_limit_offset!(sql, options)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 353
def add_limit_offset!(sql, options)
  limit, offset = options[:limit], options[:offset]
  if limit && offset
    sql << " LIMIT #{offset.to_i}, #{sanitize_limit(limit)}"
  elsif limit
    sql << " LIMIT #{sanitize_limit(limit)}"
  elsif offset
    sql << " OFFSET #{offset.to_i}"
  end
  sql
end
begin_db_transaction()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 323
def begin_db_transaction
  execute "BEGIN"
rescue Exception
  # Transactions aren't supported
end
case_sensitive_equality_operator()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 588
def case_sensitive_equality_operator
  "= BINARY"
end
case_sensitive_modifier(node)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 593
def case_sensitive_modifier(node)
  Arel::Nodes::Bin.new(node)
end
change_column(table_name, column_name, type, options = {})
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 513
def change_column(table_name, column_name, type, options = {})
  column = column_for(table_name, column_name)

  unless options_include_default?(options)
    options[:default] = column.default
  end

  unless options.has_key?(:null)
    options[:null] = column.null
  end

  change_column_sql = "ALTER TABLE #{quote_table_name(table_name)} CHANGE #{quote_column_name(column_name)} #{quote_column_name(column_name)} #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}"
  add_column_options!(change_column_sql, options)
  add_column_position!(change_column_sql, options)
  execute(change_column_sql)
end
change_column_default(table_name, column_name, default)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 498
def change_column_default(table_name, column_name, default)
  column = column_for(table_name, column_name)
  change_column table_name, column_name, column.sql_type, :default => default
end
change_column_null(table_name, column_name, null, default = nil)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 503
def change_column_null(table_name, column_name, null, default = nil)
  column = column_for(table_name, column_name)

  unless null || default.nil?
    execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
  end

  change_column table_name, column_name, column.sql_type, :null => null
end
charset()

Returns the database character set.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 416
def charset
  show_variable 'character_set_database'
end
collation()

Returns the database collation strategy.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 421
def collation
  show_variable 'collation_database'
end
columns(table_name, name = nil)

Returns an array of Mysql2Column objects for the table specified by table_name.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 469
def columns(table_name, name = nil)
  sql = "SHOW FIELDS FROM #{quote_table_name(table_name)}"
  columns = []
  result = execute(sql, 'SCHEMA')
  result.each(:symbolize_keys => true, :as => :hash) { |field|
    columns << Mysql2Column.new(field[:Field], field[:Default], field[:Type], field[:Null] == "YES")
  }
  columns
end
commit_db_transaction()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 329
def commit_db_transaction
  execute "COMMIT"
rescue Exception
  # Transactions aren't supported
end
create(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
create_database(name, options = {})

Create a new MySQL database with optional :charset and :collation. Charset defaults to utf8.

Example:

create_database 'charset_test', :charset => 'latin1', :collation => 'latin1_bin'
create_database 'matt_development'
create_database 'matt_development', :charset => :big5
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 395
def create_database(name, options = {})
  if options[:collation]
    execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}` COLLATE `#{options[:collation]}`"
  else
    execute "CREATE DATABASE `#{name}` DEFAULT CHARACTER SET `#{options[:charset] || 'utf8'}`"
  end
end
create_savepoint()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 341
def create_savepoint
  execute("SAVEPOINT #{current_savepoint_name}")
end
create_table(table_name, options = {})
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 479
def create_table(table_name, options = {})
  super(table_name, options.reverse_merge(:options => "ENGINE=InnoDB"))
end
current_database()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 411
def current_database
  select_value 'SELECT DATABASE() as db'
end
disconnect!()

Disconnects from the database if already connected. Otherwise, this method does nothing.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 226
def disconnect!
  unless @connection.nil?
    @connection.close
    @connection = nil
  end
end
drop_table(table_name, options = {})
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 446
def drop_table(table_name, options = {})
  super(table_name, options)
end
exec_delete(sql, name, binds)
This method is also aliased as exec_update
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 305
def exec_delete(sql, name, binds)
  binds = binds.dup

  # Pretend to support bind parameters
  execute sql.gsub("\00"") { quote(*binds.shift.reverse) }, name
  @connection.affected_rows
end
exec_insert(sql, name, binds)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 298
def exec_insert(sql, name, binds)
  binds = binds.dup

  # Pretend to support bind parameters
  execute sql.gsub("\00"") { quote(*binds.shift.reverse) }, name
end
exec_update(sql, name, binds)
execute(sql, name = nil)

Executes the SQL statement in the context of this connection.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 275
def execute(sql, name = nil)
  # make sure we carry over any changes to ActiveRecord::Base.default_timezone that have been
  # made since we established the connection
  @connection.query_options[:database_timezone] = ActiveRecord::Base.default_timezone
  if name == :skip_logging
    @connection.query(sql)
  else
    log(sql, name) { @connection.query(sql) }
  end
rescue ActiveRecord::StatementInvalid => exception
  if exception.message.split(":").first =~ /Packets out of order/
    raise ActiveRecord::StatementInvalid, "'Packets out of order' error was received from the database. Please update your mysql bindings (gem install mysql) and read http://dev.mysql.com/doc/mysql/en/password-hashing.html for more information.  If you're on Windows, use the Instant Rails installer to get the updated mysql bindings."
  else
    raise
  end
end
indexes(table_name, name = nil)

Returns an array of indexes for the given table.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 451
def indexes(table_name, name = nil)
  indexes = []
  current_index = nil
  result = execute("SHOW KEYS FROM #{quote_table_name(table_name)}", 'SCHEMA')
  result.each(:symbolize_keys => true, :as => :hash) do |row|
    if current_index != row[:Key_name]
      next if row[:Key_name] == PRIMARY # skip the primary key
      current_index = row[:Key_name]
      indexes << Mysql2IndexDefinition.new(row[:Table], row[:Key_name], row[:Non_unique] == 0, [], [])
    end

    indexes.last.columns << row[:Column_name]
    indexes.last.lengths << row[:Sub_part]
  end
  indexes
end
insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
This method is also aliased as create
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 292
def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
  super
  id_value || @connection.last_id
end
last_inserted_id(result)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 314
def last_inserted_id(result)
  @connection.last_id
end
limited_update_conditions(where_sql, quoted_table_name, quoted_primary_key)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 597
def limited_update_conditions(where_sql, quoted_table_name, quoted_primary_key)
  where_sql
end
native_database_types()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 153
def native_database_types
  NATIVE_DATABASE_TYPES
end
pk_and_sequence_for(table)

Returns a table’s primary key and belonging sequence.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 573
def pk_and_sequence_for(table)
  keys = []
  result = execute("DESCRIBE #{quote_table_name(table)}", 'SCHEMA')
  result.each(:symbolize_keys => true, :as => :hash) do |row|
    keys << row[:Field] if row[:Key] == "PRI"
  end
  keys.length == 1 ? [keys.first, nil] : nil
end
primary_key(table)

Returns just a table’s primary key

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 583
def primary_key(table)
  pk_and_sequence = pk_and_sequence_for(table)
  pk_and_sequence && pk_and_sequence.first
end
quote(value, column = nil)

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

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 159
def quote(value, column = nil)
  if value.kind_of?(String) && column && column.type == :binary && column.class.respond_to?(:string_to_binary)
    s = column.class.string_to_binary(value).unpack("H*")[0]
    "x'#{s}'"
  elsif value.kind_of?(BigDecimal)
    value.to_s("F")
  else
    super
  end
end
quote_string(string)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 178
def quote_string(string)
  @connection.escape(string)
end
quoted_false()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 186
def quoted_false
  QUOTED_FALSE
end
quoted_true()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 182
def quoted_true
  QUOTED_TRUE
end
reconnect!()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 214
def reconnect!
  disconnect!
  connect
end
recreate_database(name, options = {})

Drops the database specified on the name attribute and creates it again using the provided options.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 383
def recreate_database(name, options = {})
  drop_database(name)
  create_database(name, options)
end
release_savepoint()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 349
def release_savepoint
  execute("RELEASE SAVEPOINT #{current_savepoint_name}")
end
rename_column(table_name, column_name, new_column_name)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 530
def rename_column(table_name, column_name, new_column_name)
  options = {}
  if column = columns(table_name).find { |c| c.name == column_name.to_s }
    options[:default] = column.default
    options[:null] = column.null
  else
    raise ActiveRecordError, "No such column: #{table_name}.#{column_name}"
  end
  current_type = select_one("SHOW COLUMNS FROM #{quote_table_name(table_name)} LIKE '#{column_name}'")["Type"]
  rename_column_sql = "ALTER TABLE #{quote_table_name(table_name)} CHANGE #{quote_column_name(column_name)} #{quote_column_name(new_column_name)} #{current_type}"
  add_column_options!(rename_column_sql, options)
  execute(rename_column_sql)
end
rename_table(table_name, new_name)

Renames a table.

Example:

rename_table('octopuses', 'octopi')
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 487
def rename_table(table_name, new_name)
  execute "RENAME TABLE #{quote_table_name(table_name)} TO #{quote_table_name(new_name)}"
end
requires_reloading?()

this is set to true in 2.3, but we don’t want it to be

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 220
def requires_reloading?
  false
end
reset!()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 233
def reset!
  disconnect!
  connect
end
rollback_db_transaction()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 335
def rollback_db_transaction
  execute "ROLLBACK"
rescue Exception
  # Transactions aren't supported
end
rollback_to_savepoint()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 345
def rollback_to_savepoint
  execute("ROLLBACK TO SAVEPOINT #{current_savepoint_name}")
end
select_rows(sql, name = nil)

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

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 270
def select_rows(sql, name = nil)
  execute(sql, name).to_a
end
show_variable(name)

SHOW VARIABLES LIKE ‘name’.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 567
def show_variable(name)
  variables = select_all("SHOW VARIABLES LIKE '#{name}'")
  variables.first['Value'] unless variables.empty?
end
structure_dump()

SCHEMA STATEMENTS ========================================

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 368
def structure_dump
  if supports_views?
    sql = "SHOW FULL TABLES WHERE Table_type = 'BASE TABLE'"
  else
    sql = "SHOW TABLES"
  end

  select_all(sql).inject("") do |structure, table|
    table.delete('Table_type')
    structure += select_one("SHOW CREATE TABLE #{quote_table_name(table.to_a.first.last)}")["Create Table"] + ";\n\n"
  end
end
substitute_at(column, index)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 190
def substitute_at(column, index)
  Arel.sql "\00""
end
supports_migrations?()

Returns true, since this connection adapter supports migrations.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 140
def supports_migrations?
  true
end
supports_primary_key?()
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 144
def supports_primary_key?
  true
end
supports_savepoints?()

Returns true, since this connection adapter supports savepoints.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 149
def supports_savepoints?
  true
end
table_exists?(name)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 432
def table_exists?(name)
  return true if super

  name          = name.to_s
  schema, table = name.split('.', 2)

  unless table # A table was provided without a schema
    table  = schema
    schema = nil
  end

  tables(nil, schema).include? table
end
type_to_sql(type, limit = nil, precision = nil, scale = nil)

Maps logical Rails types to MySQL-specific data types.

# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 545
def type_to_sql(type, limit = nil, precision = nil, scale = nil)
  return super unless type.to_s == 'integer'

  case limit
  when 1; 'tinyint'
  when 2; 'smallint'
  when 3; 'mediumint'
  when nil, 4, 11; 'int(11)'  # compatibility with MySQL default
  when 5..8; 'bigint'
  else raise(ActiveRecordError, "No integer type has byte size #{limit}")
  end
end
update_sql(sql, name = nil)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 318
def update_sql(sql, name = nil)
  super
  @connection.affected_rows
end
Instance Protected methods
quoted_columns_for_index(column_names, options = {})
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 623
def quoted_columns_for_index(column_names, options = {})
  length = options[:length] if options.is_a?(Hash)

  quoted_column_names = case length
  when Hash
    column_names.map {|name| length[name] ? "#{quote_column_name(name)}(#{length[name]})" : quote_column_name(name) }
  when Fixnum
    column_names.map {|name| "#{quote_column_name(name)}(#{length})"}
  else
    column_names.map {|name| quote_column_name(name) }
  end
end
translate_exception(exception, message)
# File activerecord/lib/active_record/connection_adapters/mysql2_adapter.rb, line 636
def translate_exception(exception, message)
  return super unless exception.respond_to?(:error_number)

  case exception.error_number
  when 1062
    RecordNotUnique.new(message, exception)
  when 1452
    InvalidForeignKey.new(message, exception)
  else
    super
  end
end