Class: ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter

Inherits:
AbstractAdapter
  • Object
show all
Includes:
MySQL::ColumnDumper, MySQL::Quoting, MySQL::SchemaStatements
Defined in:
lib/active_record/connection_adapters/abstract_mysql_adapter.rb

Direct Known Subclasses

Mysql2Adapter

Defined Under Namespace

Classes: MysqlJson, MysqlString, StatementPool

Constant Summary collapse

NATIVE_DATABASE_TYPES =
{
  primary_key: "bigint auto_increment PRIMARY KEY",
  string:      { name: "varchar", limit: 255 },
  text:        { name: "text", limit: 65535 },
  integer:     { name: "int", limit: 4 },
  float:       { name: "float" },
  decimal:     { name: "decimal" },
  datetime:    { name: "datetime" },
  timestamp:   { name: "timestamp" },
  time:        { name: "time" },
  date:        { name: "date" },
  binary:      { name: "blob", limit: 65535 },
  boolean:     { name: "tinyint", limit: 1 },
  json:        { name: "json" },
}
INDEX_TYPES =
[:fulltext, :spatial]
INDEX_USINGS =
[:btree, :hash]

Constants inherited from AbstractAdapter

ActiveRecord::ConnectionAdapters::AbstractAdapter::ADAPTER_NAME, ActiveRecord::ConnectionAdapters::AbstractAdapter::SIMPLE_INT

Instance Attribute Summary

Attributes inherited from AbstractAdapter

#lock, #logger, #owner, #pool, #prepared_statements, #schema_cache, #visitor

Attributes included from QueryCache

#query_cache, #query_cache_enabled

Attributes included from DatabaseStatements

#transaction_manager

Instance Method Summary collapse

Methods included from MySQL::SchemaStatements

#internal_string_options_for_primary_key

Methods included from MySQL::ColumnDumper

#migration_keys, #prepare_column_options

Methods included from MySQL::Quoting

#quote_column_name, #quote_table_name, #quoted_binary, #quoted_date, #quoted_false, #quoted_true, #unquoted_false, #unquoted_true

Methods inherited from AbstractAdapter

#active?, #adapter_name, #case_insensitive_comparison, #close, #collector, #column_name_for_operation, #columns, #combine_bind_parameters, #disable_extension, #disconnect!, #enable_extension, #expire, #extensions, #lease, #lookup_cast_type, #prefetch_primary_key?, #raw_connection, #reconnect!, #requires_reloading?, #reset!, #steal!, #supports_comments?, #supports_comments_in_create?, #supports_ddl_transactions?, #supports_expression_index?, #supports_extensions?, #supports_json?, #supports_migrations?, #supports_multi_insert?, #supports_partial_index?, #supports_primary_key?, #supports_savepoints?, type_cast_config_to_boolean, type_cast_config_to_integer, #type_map, #unprepared_statement, #valid_type?, #verify!

Methods included from Savepoints

#create_savepoint, #current_savepoint_name, #exec_rollback_to_savepoint, #release_savepoint

Methods included from ColumnDumper

#column_spec, #column_spec_for_primary_key, #migration_keys, #prepare_column_options

Methods included from QueryCache

#cache, #clear_query_cache, dirties_query_cache, #disable_query_cache!, #enable_query_cache!, included, #select_all, #uncached

Methods included from DatabaseLimits

#allowed_index_name_length, #column_name_length, #columns_per_multicolumn_index, #columns_per_table, #in_clause_length, #index_name_length, #indexes_per_table, #joins_per_query, #sql_query_length, #table_alias_length, #table_name_length

Methods included from Quoting

#lookup_cast_type_from_column, #quote, #quote_column_name, #quote_default_expression, #quote_string, #quote_table_name, #quote_table_name_for_assignment, #quoted_binary, #quoted_date, #quoted_false, #quoted_time, #quoted_true, #type_cast, #type_cast_from_column, #type_casted_binds, #unquoted_false, #unquoted_true

Methods included from DatabaseStatements

#add_transaction_record, #cacheable_query, #default_sequence_name, #delete, #exec_delete, #exec_insert, #exec_query, #exec_update, #insert, #insert_fixture, #reset_sequence!, #reset_transaction, #rollback_db_transaction, #rollback_to_savepoint, #sanitize_limit, #select_all, #select_one, #select_rows, #select_value, #select_values, #to_sql, #transaction, #transaction_isolation_levels, #transaction_open?, #transaction_state, #update

Methods included from SchemaStatements

#add_column, #add_foreign_key, #add_index_options, #add_reference, #add_timestamps, #assume_migrated_upto_version, #change_column_comment, #change_table, #change_table_comment, #column_exists?, #columns, #create_join_table, #data_source_exists?, #data_sources, #drop_join_table, #dump_schema_information, #foreign_key_column_for, #foreign_key_exists?, #foreign_key_for, #foreign_key_for!, #foreign_key_options, #index_exists?, #index_name, #index_name_exists?, #initialize_internal_metadata_table, #initialize_schema_migrations_table, #insert_versions_sql, #internal_string_options_for_primary_key, #options_include_default?, #primary_key, #remove_column, #remove_columns, #remove_foreign_key, #remove_index, #remove_reference, #remove_timestamps, #table_alias_for, #table_exists?, #tables, #view_exists?, #views

Constructor Details

#initialize(connection, logger, connection_options, config) ⇒ AbstractMysqlAdapter

Returns a new instance of AbstractMysqlAdapter.


68
69
70
71
72
73
74
75
76
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 68

def initialize(connection, logger, connection_options, config)
  super(connection, logger, config)

  @statements = StatementPool.new(self.class.type_cast_config_to_integer(config[:statement_limit]))

  if version < "5.1.10"
    raise "Your version of MySQL (#{full_version.match(/^\d+\.\d+\.\d+/)[0]}) is too old. Active Record supports MySQL >= 5.1.10."
  end
end

Instance Method Details

#add_index(table_name, column_name, options = {}) ⇒ Object

:nodoc:


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

def add_index(table_name, column_name, options = {}) #:nodoc:
  index_name, index_type, index_columns, _, index_algorithm, index_using, comment = add_index_options(table_name, column_name, options)
  sql = "CREATE #{index_type} INDEX #{quote_column_name(index_name)} #{index_using} ON #{quote_table_name(table_name)} (#{index_columns}) #{index_algorithm}"
  execute add_sql_comment!(sql, comment)
end

#add_sql_comment!(sql, comment) ⇒ Object

:nodoc:


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

def add_sql_comment!(sql, comment) # :nodoc:
  sql << " COMMENT #{quote(comment)}" if comment.present?
  sql
end

#arel_visitorObject

:nodoc:


29
30
31
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 29

def arel_visitor # :nodoc:
  Arel::Visitors::MySQL.new(self)
end

#begin_db_transactionObject


226
227
228
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 226

def begin_db_transaction
  execute "BEGIN"
end

#begin_isolated_db_transaction(isolation) ⇒ Object


230
231
232
233
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 230

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

#bulk_change_table(table_name, operations) ⇒ Object

:nodoc:


366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 366

def bulk_change_table(table_name, operations) #:nodoc:
  sqls = operations.flat_map do |command, args|
    table, arguments = args.shift, args
    method = :"#{command}_sql"

    if respond_to?(method, true)
      send(method, table, *arguments)
    else
      raise "Unknown method called : #{method}(#{arguments.inspect})"
    end
  end.join(", ")

  execute("ALTER TABLE #{quote_table_name(table_name)} #{sqls}")
end

#case_sensitive_comparison(table, attribute, column, value) ⇒ Object

:nodoc:


557
558
559
560
561
562
563
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 557

def case_sensitive_comparison(table, attribute, column, value) # :nodoc:
  if column.collation && !column.case_sensitive?
    table[attribute].eq(Arel::Nodes::Bin.new(value))
  else
    super
  end
end

#change_column(table_name, column_name, type, options = {}) ⇒ Object

:nodoc:


435
436
437
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 435

def change_column(table_name, column_name, type, options = {}) #:nodoc:
  execute("ALTER TABLE #{quote_table_name(table_name)} #{change_column_sql(table_name, column_name, type, options)}")
end

#change_column_default(table_name, column_name, default_or_changes) ⇒ Object

:nodoc:


419
420
421
422
423
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 419

def change_column_default(table_name, column_name, default_or_changes) #:nodoc:
  default = extract_new_default_value(default_or_changes)
  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) ⇒ Object

:nodoc:


425
426
427
428
429
430
431
432
433
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 425

def change_column_null(table_name, column_name, null, default = nil) #:nodoc:
  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

#charsetObject

Returns the database character set.


298
299
300
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 298

def charset
  show_variable "character_set_database"
end

#clear_cache!Object

Clears the prepared statements cache.


192
193
194
195
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 192

def clear_cache!
  reload_type_map
  @statements.clear
end

#collationObject

Returns the database collation strategy.


303
304
305
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 303

def collation
  show_variable "collation_database"
end

#columns_for_distinct(columns, orders) ⇒ Object

In MySQL 5.7.5 and up, ONLY_FULL_GROUP_BY affects handling of queries that use DISTINCT and ORDER BY. It requires the ORDER BY columns in the select list for distinct queries, and requires that the ORDER BY include the distinct column. See dev.mysql.com/doc/refman/5.7/en/group-by-handling.html


574
575
576
577
578
579
580
581
582
583
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 574

def columns_for_distinct(columns, orders) # :nodoc:
  order_columns = orders.reject(&:blank?).map { |s|
    # Convert Arel node to string
    s = s.to_sql unless s.is_a?(String)
    # Remove any ASC/DESC modifiers
    s.gsub(/\s+(?:ASC|DESC)\b/i, "")
  }.reject(&:blank?).map.with_index { |column, i| "#{column} AS alias_#{i}" }

  [super, *order_columns].join(", ")
end

#commit_db_transactionObject

:nodoc:


235
236
237
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 235

def commit_db_transaction #:nodoc:
  execute "COMMIT"
end

#create_database(name, options = {}) ⇒ Object

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

277
278
279
280
281
282
283
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 277

def create_database(name, options = {})
  if options[:collation]
    execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT CHARACTER SET #{quote_table_name(options[:charset] || 'utf8')} COLLATE #{quote_table_name(options[:collation])}"
  else
    execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT CHARACTER SET #{quote_table_name(options[:charset] || 'utf8')}"
  end
end

#create_table(table_name, **options) ⇒ Object

:nodoc:


362
363
364
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 362

def create_table(table_name, **options) #:nodoc:
  super(table_name, options: "ENGINE=InnoDB", **options)
end

#current_databaseObject


293
294
295
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 293

def current_database
  select_value "SELECT DATABASE() as db"
end

#default_index_type?(index) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

589
590
591
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 589

def default_index_type?(index) # :nodoc:
  index.using == :btree || super
end

#disable_referential_integrityObject

REFERENTIAL INTEGRITY ====================================


178
179
180
181
182
183
184
185
186
187
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 178

def disable_referential_integrity #:nodoc:
  old = select_value("SELECT @@FOREIGN_KEY_CHECKS")

  begin
    update("SET FOREIGN_KEY_CHECKS = 0")
    yield
  ensure
    update("SET FOREIGN_KEY_CHECKS = #{old}")
  end
end

#drop_database(name) ⇒ Object

Drops a MySQL database.

Example:

drop_database('sebastian_development')

289
290
291
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 289

def drop_database(name) #:nodoc:
  execute "DROP DATABASE IF EXISTS #{quote_table_name(name)}"
end

#drop_table(table_name, options = {}) ⇒ Object

Drops a table from the database.

:force

Set to :cascade to drop dependent objects as well. Defaults to false.

:if_exists

Set to true to only drop the table if it exists. Defaults to false.

:temporary

Set to true to drop temporary table. Defaults to false.

Although this command ignores most options and the block if one is given, it can be helpful to provide these in a migration's change method so it can be reverted. In that case, options and the block will be used by create_table.


405
406
407
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 405

def drop_table(table_name, options = {})
  execute "DROP#{' TEMPORARY' if options[:temporary]} TABLE#{' IF EXISTS' if options[:if_exists]} #{quote_table_name(table_name)}#{' CASCADE' if options[:force] == :cascade}"
end

#each_hash(result) ⇒ Object

The two drivers have slightly different ways of yielding hashes of results, so this method must be implemented to provide a uniform interface.

Raises:

  • (NotImplementedError)

162
163
164
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 162

def each_hash(result) # :nodoc:
  raise NotImplementedError
end

#empty_insert_statement_valueObject


255
256
257
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 255

def empty_insert_statement_value
  "VALUES ()"
end

#emulate_booleansObject

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

ActiveRecord::ConnectionAdapters::Mysql2Adapter.emulate_booleans = false

40
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 40

class_attribute :emulate_booleans

#error_number(exception) ⇒ Object

Must return the MySQL error number from the exception, if the exception has an error number.

Raises:

  • (NotImplementedError)

172
173
174
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 172

def error_number(exception) # :nodoc:
  raise NotImplementedError
end

#exec_rollback_db_transactionObject

:nodoc:


239
240
241
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 239

def exec_rollback_db_transaction #:nodoc:
  execute "ROLLBACK"
end

#execute(sql, name = nil) ⇒ Object

Executes the SQL statement in the context of this connection.


211
212
213
214
215
216
217
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 211

def execute(sql, name = nil)
  log(sql, name) do
    ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
      @connection.query(sql)
    end
  end
end

#execute_and_free(sql, name = nil) {|execute(sql, name)| ... } ⇒ Object

Mysql2Adapter doesn't have to free a result after using it, but we use this method to write stuff in an abstract way without concerning ourselves about whether it needs to be explicitly freed or not.

Yields:


222
223
224
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 222

def execute_and_free(sql, name = nil) # :nodoc:
  yield execute(sql, name)
end

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

– DATABASE STATEMENTS ====================================== ++


201
202
203
204
205
206
207
208
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 201

def explain(arel, binds = [])
  sql     = "EXPLAIN #{to_sql(arel, binds)}"
  start   = Time.now
  result  = exec_query(sql, "EXPLAIN", binds)
  elapsed = Time.now - start

  MySQL::ExplainPrettyPrinter.new.pp(result, elapsed)
end

#foreign_keys(table_name) ⇒ Object

Raises:

  • (ArgumentError)

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
484
485
486
487
488
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 455

def foreign_keys(table_name)
  raise ArgumentError unless table_name.present?

  scope = quoted_scope(table_name)

  fk_info = select_all(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT fk.referenced_table_name AS 'to_table',
           fk.referenced_column_name AS 'primary_key',
           fk.column_name AS 'column',
           fk.constraint_name AS 'name',
           rc.update_rule AS 'on_update',
           rc.delete_rule AS 'on_delete'
    FROM information_schema.key_column_usage fk
    JOIN information_schema.referential_constraints rc
    USING (constraint_schema, constraint_name)
    WHERE fk.referenced_column_name IS NOT NULL
      AND fk.table_schema = #{scope[:schema]}
      AND fk.table_name = #{scope[:name]}
      AND rc.table_name = #{scope[:name]}
  SQL

  fk_info.map do |row|
    options = {
      column: row["column"],
      name: row["name"],
      primary_key: row["primary_key"]
    }

    options[:on_update] = extract_foreign_key_action(row["on_update"])
    options[:on_delete] = extract_foreign_key_action(row["on_delete"])

    ForeignKeyDefinition.new(table_name, row["to_table"], options)
  end
end

#get_advisory_lock(lock_name, timeout = 0) ⇒ Object

:nodoc:


142
143
144
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 142

def get_advisory_lock(lock_name, timeout = 0) # :nodoc:
  select_value("SELECT GET_LOCK(#{quote(lock_name)}, #{timeout})") == 1
end

#index_algorithmsObject


154
155
156
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 154

def index_algorithms
  { default: "ALGORITHM = DEFAULT", copy: "ALGORITHM = COPY", inplace: "ALGORITHM = INPLACE" }
end

#indexes(table_name, name = nil) ⇒ Object

Returns an array of indexes for the given table.


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 312

def indexes(table_name, name = nil) #:nodoc:
  if name
    ActiveSupport::Deprecation.warn(<<-MSG.squish)
      Passing name to #indexes is deprecated without replacement.
    MSG
  end

  indexes = []
  current_index = nil
  execute_and_free("SHOW KEYS FROM #{quote_table_name(table_name)}", "SCHEMA") do |result|
    each_hash(result) do |row|
      if current_index != row[:Key_name]
        next if row[:Key_name] == "PRIMARY" # skip the primary key
        current_index = row[:Key_name]

        mysql_index_type = row[:Index_type].downcase.to_sym
        index_type  = INDEX_TYPES.include?(mysql_index_type)  ? mysql_index_type : nil
        index_using = INDEX_USINGS.include?(mysql_index_type) ? mysql_index_type : nil
        indexes << IndexDefinition.new(row[:Table], row[:Key_name], row[:Non_unique].to_i == 0, [], {}, nil, nil, index_type, index_using, row[:Index_comment].presence)
      end

      indexes.last.columns << row[:Column_name]
      indexes.last.lengths.merge!(row[:Column_name] => row[:Sub_part].to_i) if row[:Sub_part]
    end
  end

  indexes
end

#join_to_update(update, select, key) ⇒ Object

In the simple case, MySQL allows us to place JOINs directly into the UPDATE query. However, this does not allow for LIMIT, OFFSET and ORDER. To support these, we must use a subquery.


246
247
248
249
250
251
252
253
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 246

def join_to_update(update, select, key) # :nodoc:
  if select.limit || select.offset || select.orders.any?
    super
  else
    update.table select.source
    update.wheres = select.constraints
  end
end

#mariadb?Boolean

:nodoc:

Returns:

  • (Boolean)

82
83
84
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 82

def mariadb? # :nodoc:
  /mariadb/i.match?(full_version)
end

#native_database_typesObject


150
151
152
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 150

def native_database_types
  NATIVE_DATABASE_TYPES
end

#new_column(*args) ⇒ Object

:nodoc:


166
167
168
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 166

def new_column(*args) #:nodoc:
  MySQL::Column.new(*args)
end

#new_column_from_field(table_name, field) ⇒ Object

:nodoc:


341
342
343
344
345
346
347
348
349
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 341

def new_column_from_field(table_name, field) # :nodoc:
   = (field[:Type], field[:Extra])
  if .type == :datetime && field[:Default] == "CURRENT_TIMESTAMP"
    default, default_function = nil, field[:Default]
  else
    default, default_function = field[:Default], nil
  end
  new_column(field[:Field], default, , field[:Null] == "YES", table_name, default_function, field[:Collation], comment: field[:Comment].presence)
end

#primary_keys(table_name) ⇒ Object

:nodoc:

Raises:

  • (ArgumentError)

542
543
544
545
546
547
548
549
550
551
552
553
554
555
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 542

def primary_keys(table_name) # :nodoc:
  raise ArgumentError unless table_name.present?

  scope = quoted_scope(table_name)

  select_values(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT column_name
    FROM information_schema.key_column_usage
    WHERE constraint_name = 'PRIMARY'
      AND table_schema = #{scope[:schema]}
      AND table_name = #{scope[:name]}
    ORDER BY ordinal_position
  SQL
end

#recreate_database(name, options = {}) ⇒ Object

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


263
264
265
266
267
268
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 263

def recreate_database(name, options = {})
  drop_database(name)
  sql = create_database(name, options)
  reconnect!
  sql
end

#release_advisory_lock(lock_name) ⇒ Object

:nodoc:


146
147
148
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 146

def release_advisory_lock(lock_name) # :nodoc:
  select_value("SELECT RELEASE_LOCK(#{quote(lock_name)})") == 1
end

#rename_column(table_name, column_name, new_column_name) ⇒ Object

:nodoc:


439
440
441
442
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 439

def rename_column(table_name, column_name, new_column_name) #:nodoc:
  execute("ALTER TABLE #{quote_table_name(table_name)} #{rename_column_sql(table_name, column_name, new_column_name)}")
  rename_column_indexes(table_name, column_name, new_column_name)
end

#rename_index(table_name, old_name, new_name) ⇒ Object


409
410
411
412
413
414
415
416
417
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 409

def rename_index(table_name, old_name, new_name)
  if supports_rename_index?
    validate_index_length!(table_name, new_name)

    execute "ALTER TABLE #{quote_table_name(table_name)} RENAME INDEX #{quote_table_name(old_name)} TO #{quote_table_name(new_name)}"
  else
    super
  end
end

#rename_table(table_name, new_name) ⇒ Object

Renames a table.

Example:

rename_table('octopuses', 'octopi')

385
386
387
388
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 385

def rename_table(table_name, new_name)
  execute "RENAME TABLE #{quote_table_name(table_name)} TO #{quote_table_name(new_name)}"
  rename_table_indexes(table_name, new_name)
end

#schema_creationObject

:nodoc:


25
26
27
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 25

def schema_creation # :nodoc:
  MySQL::SchemaCreation.new(self)
end

#show_variable(name) ⇒ Object

SHOW VARIABLES LIKE 'name'


536
537
538
539
540
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 536

def show_variable(name)
  select_value("SELECT @@#{name}", "SCHEMA")
rescue ActiveRecord::StatementInvalid
  nil
end

#strict_mode?Boolean

Returns:

  • (Boolean)

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

def strict_mode?
  self.class.type_cast_config_to_boolean(@config.fetch(:strict, true))
end

#supports_advisory_locks?Boolean

Returns:

  • (Boolean)

138
139
140
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 138

def supports_advisory_locks?
  true
end

#supports_bulk_alter?Boolean

:nodoc:

Returns:

  • (Boolean)

86
87
88
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 86

def supports_bulk_alter? #:nodoc:
  true
end

#supports_datetime_with_precision?Boolean

Returns:

  • (Boolean)

122
123
124
125
126
127
128
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 122

def supports_datetime_with_precision?
  if mariadb?
    version >= "5.3.0"
  else
    version >= "5.6.4"
  end
end

#supports_explain?Boolean

Returns:

  • (Boolean)

106
107
108
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 106

def supports_explain?
  true
end

#supports_foreign_keys?Boolean

Returns:

  • (Boolean)

114
115
116
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 114

def supports_foreign_keys?
  true
end

#supports_index_sort_order?Boolean

Technically MySQL allows to create indexes with the sort order syntax but at the moment (5.5) it doesn't yet implement them

Returns:

  • (Boolean)

98
99
100
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 98

def supports_index_sort_order?
  true
end

#supports_indexes_in_create?Boolean

Returns:

  • (Boolean)

110
111
112
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 110

def supports_indexes_in_create?
  true
end

#supports_statement_cache?Boolean

Returns true, since this connection adapter supports prepared statement caching.

Returns:

  • (Boolean)

92
93
94
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 92

def supports_statement_cache?
  true
end

#supports_transaction_isolation?Boolean

Returns:

  • (Boolean)

102
103
104
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 102

def supports_transaction_isolation?
  true
end

#supports_views?Boolean

Returns:

  • (Boolean)

118
119
120
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 118

def supports_views?
  true
end

#supports_virtual_columns?Boolean

Returns:

  • (Boolean)

130
131
132
133
134
135
136
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 130

def supports_virtual_columns?
  if mariadb?
    version >= "5.2.0"
  else
    version >= "5.7.5"
  end
end

#table_comment(table_name) ⇒ Object

:nodoc:


351
352
353
354
355
356
357
358
359
360
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 351

def table_comment(table_name) # :nodoc:
  scope = quoted_scope(table_name)

  select_value(<<-SQL.strip_heredoc, "SCHEMA")
    SELECT table_comment
    FROM information_schema.tables
    WHERE table_schema = #{scope[:schema]}
      AND table_name = #{scope[:name]}
  SQL
end

#table_options(table_name) ⇒ Object

:nodoc:


490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 490

def table_options(table_name) # :nodoc:
  table_options = {}

  create_table_info = create_table_info(table_name)

  # strip create_definitions and partition_options
  raw_table_options = create_table_info.sub(/\A.*\n\) /m, "").sub(/\n\/\*!.*\*\/\n\z/m, "").strip

  # strip AUTO_INCREMENT
  raw_table_options.sub!(/(ENGINE=\w+)(?: AUTO_INCREMENT=\d+)/, '\1')

  table_options[:options] = raw_table_options

  # strip COMMENT
  if raw_table_options.sub!(/ COMMENT='.+'/, "")
    table_options[:comment] = table_comment(table_name)
  end

  table_options
end

#truncate(table_name, name = nil) ⇒ Object


307
308
309
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 307

def truncate(table_name, name = nil)
  execute "TRUNCATE TABLE #{quote_table_name(table_name)}", name
end

#type_to_sql(type, limit: nil, precision: nil, scale: nil, unsigned: nil) ⇒ Object

Maps logical Rails types to MySQL-specific data types.


512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 512

def type_to_sql(type, limit: nil, precision: nil, scale: nil, unsigned: nil, **) # :nodoc:
  sql = \
    case type.to_s
    when "integer"
      integer_to_sql(limit)
    when "text"
      text_to_sql(limit)
    when "blob"
      binary_to_sql(limit)
    when "binary"
      if (0..0xfff) === limit
        "varbinary(#{limit})"
      else
        binary_to_sql(limit)
      end
    else
      super
    end

  sql << " unsigned" if unsigned && type != :primary_key
  sql
end

#update_table_definition(table_name, base) ⇒ Object

:nodoc:


21
22
23
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 21

def update_table_definition(table_name, base) # :nodoc:
  MySQL::Table.new(table_name, base)
end

#versionObject

:nodoc:


78
79
80
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 78

def version #:nodoc:
  @version ||= Version.new(full_version.match(/^\d+\.\d+\.\d+/)[0])
end