Class: ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter

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

Defined Under Namespace

Classes: StatementPool

Constant Summary collapse

NATIVE_DATABASE_TYPES = 
{
  primary_key: "bigint auto_increment PRIMARY KEY",
  string:      { name: "varchar", limit: 255 },
  text:        { name: "text" },
  integer:     { name: "int", limit: 4 },
  bigint:      { name: "bigint" },
  float:       { name: "float", limit: 24 },
  decimal:     { name: "decimal" },
  datetime:    { name: "datetime" },
  timestamp:   { name: "timestamp" },
  time:        { name: "time" },
  date:        { name: "date" },
  binary:      { name: "blob" },
  blob:        { name: "blob" },
  boolean:     { name: "tinyint", limit: 1 },
  json:        { name: "json" },
}
TYPE_MAP = 
Type::TypeMap.new.tap { |m| initialize_type_map(m) }
EXTENDED_TYPE_MAPS = 
Concurrent::Map.new
EMULATE_BOOLEANS_TRUE = 
{ emulate_booleans: true }.freeze

Constants inherited from AbstractAdapter

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

Constants included from ActiveSupport::Callbacks

ActiveSupport::Callbacks::CALLBACK_FILTER_TYPES

Instance Attribute Summary

Attributes inherited from AbstractAdapter

#lock, #logger, #owner, #pool, #visitor

Attributes included from QueryCache

#query_cache, #query_cache_enabled

Attributes included from DatabaseStatements

#transaction_manager

Class Method Summary collapse

Instance Method Summary collapse

Methods included from MySQL::SchemaStatements

#create_schema_dumper, #create_table, #indexes, #internal_string_options_for_primary_key, #remove_column, #schema_creation, #table_alias_length, #type_to_sql, #update_table_definition

Methods included from MySQL::Quoting

#cast_bound_value, #column_name_matcher, #column_name_with_order_matcher, #quote_column_name, #quote_table_name, #quoted_binary, #quoted_date, #type_cast, #unquote_identifier, #unquoted_false, #unquoted_true

Methods inherited from AbstractAdapter

#active?, #adapter_name, #advisory_locks_enabled?, #all_foreign_keys_valid?, #async_enabled?, build_read_query_regexp, #case_insensitive_comparison, #check_if_write_query, #clean!, #clear_cache!, #close, #connect!, #connection_class, #connection_retries, #create_enum, #database_exists?, database_exists?, #database_version, #default_timezone, #default_uniqueness_comparison, #disable_extension, #discard!, #disconnect!, #drop_enum, #enable_extension, #expire, #extensions, find_cmd_and_exec, #initialize, #internal_metadata, #lease, #lock_thread=, #migration_context, #migrations_paths, #prefetch_primary_key?, #prepared_statements?, #prepared_statements_disabled_cache, #preventing_writes?, quoted_column_names, quoted_table_names, #raw_connection, #reconnect!, register_class_with_precision, #replica?, #requires_reloading?, #reset!, #retry_deadline, #role, #savepoint_errors_invalidate_transactions?, #schema_cache, #schema_cache=, #schema_migration, #schema_version, #seconds_idle, #shard, #steal!, #supports_comments?, #supports_comments_in_create?, #supports_concurrent_connections?, #supports_ddl_transactions?, #supports_deferrable_constraints?, #supports_exclusion_constraints?, #supports_extensions?, #supports_foreign_tables?, #supports_index_include?, #supports_insert_conflict_target?, #supports_insert_returning?, #supports_json?, #supports_lazy_transactions?, #supports_materialized_views?, #supports_partial_index?, #supports_partitioned_indexes?, #supports_savepoints?, #supports_unique_keys?, #supports_validate_constraints?, #throw_away!, type_cast_config_to_boolean, type_cast_config_to_integer, #unprepared_statement, #use_metadata_table?, #valid_type?, validate_default_timezone, #verify!, #with_instrumenter

Methods included from Savepoints

#create_savepoint, #current_savepoint_name, #exec_rollback_to_savepoint, #release_savepoint

Methods included from QueryCache

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

Methods included from DatabaseLimits

#index_name_length, #max_identifier_length, #table_alias_length, #table_name_length

Methods included from Quoting

#cast_bound_value, #column_name_matcher, #column_name_with_order_matcher, #lookup_cast_type_from_column, #quote, #quote_bound_value, #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, #sanitize_as_sql_comment, #type_cast, #unquoted_false, #unquoted_true

Methods included from DatabaseStatements

#add_transaction_record, #cacheable_query, #default_sequence_name, #delete, #exec_delete, #exec_insert, #exec_insert_all, #exec_query, #exec_update, #explain, #high_precision_current_timestamp, #initialize, #insert, #insert_fixture, #insert_fixtures_set, #mark_transaction_written_if_write, #query, #query_value, #query_values, #reset_sequence!, #reset_transaction, #restart_db_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?, #truncate, #truncate_tables, #update, #with_yaml_fallback, #write_query?

Methods included from SchemaStatements

#add_check_constraint, #add_column, #add_columns, #add_foreign_key, #add_index_options, #add_reference, #add_timestamps, #assume_migrated_upto_version, #build_add_column_definition, #build_create_join_table_definition, #build_create_table_definition, #bulk_change_table, #change_table, #check_constraint_exists?, #check_constraint_options, #column_exists?, #columns, #create_join_table, #create_schema_dumper, #create_table, #data_source_exists?, #data_sources, #distinct_relation_for_primary_key, #drop_join_table, #dump_schema_information, #foreign_key_column_for, #foreign_key_exists?, #foreign_key_options, #index_algorithm, #index_exists?, #index_name, #index_name_exists?, #indexes, #internal_string_options_for_primary_key, #max_index_name_size, #options_include_default?, #primary_key, #quoted_columns_for_index, #remove_check_constraint, #remove_column, #remove_columns, #remove_foreign_key, #remove_index, #remove_reference, #remove_timestamps, #schema_creation, #table_alias_for, #table_exists?, #tables, #type_to_sql, #update_table_definition, #use_foreign_keys?, #valid_column_definition_options, #valid_primary_key_options, #valid_table_definition_options, #view_exists?, #views

Methods included from ActiveSupport::Callbacks

#run_callbacks

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included, #prepend_features, #prepended

Constructor Details

This class inherits a constructor from ActiveRecord::ConnectionAdapters::AbstractAdapter

Class Method Details

.dbconsole(config, options = {}) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 55

def dbconsole(config, options = {})
  mysql_config = config.configuration_hash

  args = {
    host: "--host",
    port: "--port",
    socket: "--socket",
    username: "--user",
    encoding: "--default-character-set",
    sslca: "--ssl-ca",
    sslcert: "--ssl-cert",
    sslcapath: "--ssl-capath",
    sslcipher: "--ssl-cipher",
    sslkey: "--ssl-key",
    ssl_mode: "--ssl-mode"
  }.filter_map { |opt, arg| "#{arg}=#{mysql_config[opt]}" if mysql_config[opt] }

  if mysql_config[:password] && options[:include_password]
    args << "--password=#{mysql_config[:password]}"
  elsif mysql_config[:password] && !mysql_config[:password].to_s.empty?
    args << "-p"
  end

  args << config.database

  find_cmd_and_exec(["mysql", "mysql5"], *args)
end

.extended_type_map(default_timezone: nil, emulate_booleans:) ⇒ Object

:nodoc:



653
654
655
656
657
658
659
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 653

def extended_type_map(default_timezone: nil, emulate_booleans:) # :nodoc:
  super(default_timezone: default_timezone).tap do |m|
    if emulate_booleans
      m.register_type %r(^tinyint\(1\))i, Type::Boolean.new
    end
  end
end

Instance Method Details

#add_index(table_name, column_name, **options) ⇒ Object

:nodoc:



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

def add_index(table_name, column_name, **options) # :nodoc:
  create_index = build_create_index_definition(table_name, column_name, **options)
  return unless create_index

  execute schema_creation.accept(create_index)
end

#add_sql_comment!(sql, comment) ⇒ Object

:nodoc:



465
466
467
468
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 465

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

#begin_db_transaction ⇒ Object

:nodoc:



242
243
244
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 242

def begin_db_transaction # :nodoc:
  internal_execute("BEGIN", "TRANSACTION")
end

#begin_isolated_db_transaction(isolation) ⇒ Object

:nodoc:



246
247
248
249
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 246

def begin_isolated_db_transaction(isolation) # :nodoc:
  internal_execute "SET TRANSACTION ISOLATION LEVEL #{transaction_isolation_levels.fetch(isolation)}", "TRANSACTION"
  begin_db_transaction
end

#build_change_column_default_definition(table_name, column_name, default_or_changes) ⇒ Object

:nodoc:



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

def build_change_column_default_definition(table_name, column_name, default_or_changes) # :nodoc:
  column = column_for(table_name, column_name)
  return unless column

  default = extract_new_default_value(default_or_changes)
  ChangeColumnDefaultDefinition.new(column, default)
end

#build_change_column_definition(table_name, column_name, type, **options) ⇒ Object

Builds a ChangeColumnDefinition object.

This definition object contains information about the column change that would occur if the same arguments were passed to #change_column. See #change_column for information about passing a table_name, column_name, type and other options that can be passed.



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 414

def build_change_column_definition(table_name, column_name, type, **options) # :nodoc:
  column = column_for(table_name, column_name)
  type ||= column.sql_type

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

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

  unless options.key?(:comment)
    options[:comment] = column.comment
  end

  if options[:collation] == :no_collation
    options.delete(:collation)
  else
    options[:collation] ||= column.collation if text_type?(type)
  end

  unless options.key?(:auto_increment)
    options[:auto_increment] = column.auto_increment?
  end

  td = create_table_definition(table_name)
  cd = td.new_column_definition(column.name, type, **options)
  ChangeColumnDefinition.new(cd, column.name)
end

#build_create_index_definition(table_name, column_name, **options) ⇒ Object

:nodoc:



457
458
459
460
461
462
463
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 457

def build_create_index_definition(table_name, column_name, **options) # :nodoc:
  index, algorithm, if_not_exists = add_index_options(table_name, column_name, **options)

  return if if_not_exists && index_exists?(table_name, column_name, name: index.name)

  CreateIndexDefinition.new(index, algorithm)
end

#build_insert_sql(insert) ⇒ Object

:nodoc:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 627

def build_insert_sql(insert) # :nodoc:
  sql = +"INSERT #{insert.into} #{insert.values_list}"

  if insert.skip_duplicates?
    no_op_column = quote_column_name(insert.keys.first)
    sql << " ON DUPLICATE KEY UPDATE #{no_op_column}=#{no_op_column}"
  elsif insert.update_duplicates?
    sql << " ON DUPLICATE KEY UPDATE "
    if insert.raw_update_sql?
      sql << insert.raw_update_sql
    else
      sql << insert.touch_model_timestamps_unless { |column| "#{column}<=>VALUES(#{column})" }
      sql << insert.updatable_columns.map { |column| "#{column}=VALUES(#{column})" }.join(",")
    end
  end

  sql
end

#case_sensitive_comparison(attribute, value) ⇒ Object

:nodoc:



589
590
591
592
593
594
595
596
597
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 589

def case_sensitive_comparison(attribute, value) # :nodoc:
  column = column_for_attribute(attribute)

  if column.collation && !column.case_sensitive?
    attribute.eq(Arel::Nodes::Bin.new(value))
  else
    super
  end
end

#change_column(table_name, column_name, type, **options) ⇒ Object

:nodoc:



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

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

#change_column_comment(table_name, column_name, comment_or_changes) ⇒ Object

:nodoc:



400
401
402
403
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 400

def change_column_comment(table_name, column_name, comment_or_changes) # :nodoc:
  comment = extract_new_comment_value(comment_or_changes)
  change_column table_name, column_name, nil, comment: comment
end

#change_column_default(table_name, column_name, default_or_changes) ⇒ Object

:nodoc:



378
379
380
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 378

def change_column_default(table_name, column_name, default_or_changes) # :nodoc:
  execute "ALTER TABLE #{quote_table_name(table_name)} #{change_column_default_for_alter(table_name, column_name, default_or_changes)}"
end

#change_column_null(table_name, column_name, null, default = nil) ⇒ Object

:nodoc:



390
391
392
393
394
395
396
397
398
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 390

def change_column_null(table_name, column_name, null, default = nil) # :nodoc:
  validate_change_column_null_argument!(null)

  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, nil, null: null
end

#change_table_comment(table_name, comment_or_changes) ⇒ Object

:nodoc:



330
331
332
333
334
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 330

def change_table_comment(table_name, comment_or_changes) # :nodoc:
  comment = extract_new_comment_value(comment_or_changes)
  comment = "" if comment.nil?
  execute("ALTER TABLE #{quote_table_name(table_name)} COMMENT #{quote(comment)}")
end

#charset ⇒ Object

Returns the database character set.



310
311
312
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 310

def charset
  show_variable "character_set_database"
end

#check_constraints(table_name) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 506

def check_constraints(table_name)
  if supports_check_constraints?
    scope = quoted_scope(table_name)

    sql = <<~SQL
      SELECT cc.constraint_name AS 'name',
            cc.check_clause AS 'expression'
      FROM information_schema.check_constraints cc
      JOIN information_schema.table_constraints tc
      USING (constraint_schema, constraint_name)
      WHERE tc.table_schema = #{scope[:schema]}
        AND tc.table_name = #{scope[:name]}
        AND cc.constraint_schema = #{scope[:schema]}
    SQL
    sql += " AND cc.table_name = #{scope[:name]}" if mariadb?

    chk_info = exec_query(sql, "SCHEMA")

    chk_info.map do |row|
      options = {
        name: row["name"]
      }
      expression = row["expression"]
      expression = expression[1..-2] if expression.start_with?("(") && expression.end_with?(")")
      expression = strip_whitespace_characters(expression)
      CheckConstraintDefinition.new(table_name, expression, options)
    end
  else
    raise NotImplementedError
  end
end

#check_version ⇒ Object

:nodoc:



646
647
648
649
650
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 646

def check_version # :nodoc:
  if database_version < "5.5.8"
    raise "Your version of MySQL (#{database_version}) is too old. Active Record supports MySQL >= 5.5.8."
  end
end

#collation ⇒ Object

Returns the database collation strategy.



315
316
317
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 315

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/en/group-by-handling.html



608
609
610
611
612
613
614
615
616
617
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 608

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

  (order_columns << super).join(", ")
end

#commit_db_transaction ⇒ Object

:nodoc:



251
252
253
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 251

def commit_db_transaction # :nodoc:
  internal_execute("COMMIT", "TRANSACTION", allow_retry: false, uses_transaction: true)
end

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

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

Example:

create_database 'charset_test', charset: 'latin1', collation: 'latin1_bin'
create_database 'matt_development'
create_database 'matt_development', charset: :big5



285
286
287
288
289
290
291
292
293
294
295
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 285

def create_database(name, options = {})
  if options[:collation]
    execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT COLLATE #{quote_table_name(options[:collation])}"
  elsif options[:charset]
    execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT CHARACTER SET #{quote_table_name(options[:charset])}"
  elsif row_format_dynamic_by_default?
    execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT CHARACTER SET `utf8mb4`"
  else
    raise "Configure a supported :charset and ensure innodb_large_prefix is enabled to support indexes on varchar(255) string columns."
  end
end

#current_database ⇒ Object 



305
306
307
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 305

def current_database
  query_value("SELECT database()", "SCHEMA")
end

#default_index_type?(index) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


623
624
625
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 623

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

#disable_referential_integrity ⇒ Object

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



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

def disable_referential_integrity # :nodoc:
  old = query_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')



301
302
303
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 301

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.



363
364
365
366
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 363

def drop_table(table_name, **options)
  schema_cache.clear_data_source_cache!(table_name.to_s)
  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) 


196
197
198
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 196

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

#empty_insert_statement_value(primary_key = nil) ⇒ Object

:nodoc:



263
264
265
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 263

def empty_insert_statement_value(primary_key = nil) # :nodoc:
  "VALUES ()"
end

#emulate_booleans ⇒ Object

: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



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

class_attribute :emulate_booleans, default: true

#error_number(exception) ⇒ Object

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

Raises:

  • (NotImplementedError) 


202
203
204
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 202

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

#exec_restart_db_transaction ⇒ Object

:nodoc:



259
260
261
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 259

def exec_restart_db_transaction # :nodoc:
  internal_execute("ROLLBACK AND CHAIN", "TRANSACTION", allow_retry: false, uses_transaction: true)
end

#exec_rollback_db_transaction ⇒ Object

:nodoc:



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

def exec_rollback_db_transaction # :nodoc:
  internal_execute("ROLLBACK", "TRANSACTION", allow_retry: false, uses_transaction: true)
end

#execute(sql, name = nil, async: false, allow_retry: false) ⇒ Object

Executes the SQL statement in the context of this connection.

Setting allow_retry to true causes the db to reconnect and retry executing the SQL statement in case of a connection-related exception. This option should only be enabled for known idempotent queries.



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

def execute(sql, name = nil, async: false, allow_retry: false)
  sql = transform_query(sql)
  check_if_write_query(sql)

  raw_execute(sql, name, async: async, allow_retry: allow_retry)
end

#execute_and_free(sql, name = nil, async: false) {|execute(sql, name, async: async)| ... } ⇒ 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:

  • (execute(sql, name, async: async)) 


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

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

#foreign_keys(table_name) ⇒ Object

Raises:

  • (ArgumentError) 


470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 470

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

  scope = quoted_scope(table_name)

  fk_info = exec_query(<<~SQL, "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.referential_constraints rc
    JOIN information_schema.key_column_usage fk
    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.constraint_schema = #{scope[:schema]}
      AND rc.table_name = #{scope[:name]}
  SQL

  fk_info.map do |row|
    options = {
      column: unquote_identifier(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, unquote_identifier(row["to_table"]), options)
  end
end

#get_advisory_lock(lock_name, timeout = 0) ⇒ Object

:nodoc:



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

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

#get_database_version ⇒ Object

:nodoc:



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

def get_database_version # :nodoc:
  full_version_string = get_full_version
  version_string = version_string(full_version_string)
  Version.new(version_string, full_version_string)
end

#index_algorithms ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 183

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

#mariadb? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


90
91
92
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 90

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

#native_database_types ⇒ Object 



179
180
181
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 179

def native_database_types
  NATIVE_DATABASE_TYPES
end

#primary_keys(table_name) ⇒ Object

:nodoc:

Raises:

  • (ArgumentError) 


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

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

  scope = quoted_scope(table_name)

  query_values(<<~SQL, "SCHEMA")
    SELECT column_name
    FROM information_schema.statistics
    WHERE index_name = 'PRIMARY'
      AND table_schema = #{scope[:schema]}
      AND table_name = #{scope[:name]}
    ORDER BY seq_in_index
  SQL
end

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

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



271
272
273
274
275
276
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 271

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

#release_advisory_lock(lock_name) ⇒ Object

:nodoc:



175
176
177
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 175

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

#rename_column(table_name, column_name, new_column_name) ⇒ Object

:nodoc:



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

def rename_column(table_name, column_name, new_column_name) # :nodoc:
  execute("ALTER TABLE #{quote_table_name(table_name)} #{rename_column_for_alter(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 



368
369
370
371
372
373
374
375
376
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 368

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, **options) ⇒ Object

Renames a table.

Example:

rename_table('octopuses', 'octopi')



340
341
342
343
344
345
346
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 340

def rename_table(table_name, new_name, **options)
  validate_table_length!(new_name) unless options[:_uses_legacy_table_name]
  schema_cache.clear_data_source_cache!(table_name.to_s)
  schema_cache.clear_data_source_cache!(new_name.to_s)
  execute "RENAME TABLE #{quote_table_name(table_name)} TO #{quote_table_name(new_name)}"
  rename_table_indexes(table_name, new_name)
end

#show_variable(name) ⇒ Object

SHOW VARIABLES LIKE ‘name’



568
569
570
571
572
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 568

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

#strict_mode? ⇒ Boolean

Returns:

  • (Boolean) 


619
620
621
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 619

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

#supports_advisory_locks? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 159

def supports_advisory_locks?
  true
end

#supports_bulk_alter? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 94

def supports_bulk_alter?
  true
end

#supports_check_constraints? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
129
130
131
132
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 126

def supports_check_constraints?
  if mariadb?
    database_version >= "10.3.10" || (database_version < "10.3" && database_version >= "10.2.22")
  else
    database_version >= "8.0.16"
  end
end

#supports_common_table_expressions? ⇒ Boolean

Returns:

  • (Boolean) 


151
152
153
154
155
156
157
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 151

def supports_common_table_expressions?
  if mariadb?
    database_version >= "10.2.1"
  else
    database_version >= "8.0.1"
  end
end

#supports_datetime_with_precision? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_datetime_with_precision?
  mariadb? || database_version >= "5.6.4"
end

#supports_explain? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_explain?
  true
end

#supports_expression_index? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_expression_index?
  !mariadb? && database_version >= "8.0.13"
end

#supports_foreign_keys? ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 122

def supports_foreign_keys?
  true
end

#supports_index_sort_order? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_index_sort_order?
  !mariadb? && database_version >= "8.0.1"
end

#supports_indexes_in_create? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_indexes_in_create?
  true
end

#supports_insert_on_duplicate_skip? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_insert_on_duplicate_skip?
  true
end

#supports_insert_on_duplicate_update? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_insert_on_duplicate_update?
  true
end

#supports_optimizer_hints? ⇒ Boolean

See dev.mysql.com/doc/refman/en/optimizer-hints.html for more details.

Returns:

  • (Boolean) 


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

def supports_optimizer_hints?
  !mariadb? && database_version >= "5.7.7"
end

#supports_restart_db_transaction? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_restart_db_transaction?
  true
end

#supports_transaction_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_transaction_isolation?
  true
end

#supports_views? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 134

def supports_views?
  true
end

#supports_virtual_columns? ⇒ Boolean

Returns:

  • (Boolean) 


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

def supports_virtual_columns?
  mariadb? || database_version >= "5.7.5"
end

#table_comment(table_name) ⇒ Object

:nodoc:



319
320
321
322
323
324
325
326
327
328
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 319

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

  query_value(<<~SQL, "SCHEMA").presence
    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:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 538

def table_options(table_name) # :nodoc:
  create_table_info = create_table_info(table_name)

  # strip create_definitions and partition_options
  # Be aware that `create_table_info` might not include any table options due to `NO_TABLE_OPTIONS` sql mode.
  raw_table_options = create_table_info.sub(/\A.*\n\) ?/m, "").sub(/\n\/\*!.*\*\/\n\z/m, "").strip

  return if raw_table_options.empty?

  table_options = {}

  if / DEFAULT CHARSET=(?<charset>\w+)(?: COLLATE=(?<collation>\w+))?/ =~ raw_table_options
    raw_table_options = $` + $' # before part + after part
    table_options[:charset] = charset
    table_options[:collation] = collation if collation
  end

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

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

  table_options[:options] = raw_table_options unless raw_table_options == "ENGINE=InnoDB"
  table_options
end