Class: ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
- Inherits:
-
AbstractAdapter
- Object
- AbstractAdapter
- ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
- Includes:
- MySQL::Quoting, MySQL::SchemaStatements
- Defined in:
- lib/active_record/connection_adapters/abstract_mysql_adapter.rb
Direct Known Subclasses
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) }
- TYPE_MAP_WITH_BOOLEAN =
Type::TypeMap.new(TYPE_MAP).tap do |m| m.register_type %r(^tinyint\(1\))i, Type::Boolean.new end
Constants inherited from AbstractAdapter
ActiveRecord::ConnectionAdapters::AbstractAdapter::ADAPTER_NAME, ActiveRecord::ConnectionAdapters::AbstractAdapter::COMMENT_REGEX, ActiveRecord::ConnectionAdapters::AbstractAdapter::SIMPLE_INT
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
Instance Method Summary collapse
-
#add_index(table_name, column_name, **options) ⇒ Object
:nodoc:.
-
#add_sql_comment!(sql, comment) ⇒ Object
:nodoc:.
-
#begin_db_transaction ⇒ Object
:nodoc:.
-
#begin_isolated_db_transaction(isolation) ⇒ Object
:nodoc:.
-
#build_insert_sql(insert) ⇒ Object
:nodoc:.
-
#case_sensitive_comparison(attribute, value) ⇒ Object
:nodoc:.
-
#change_column(table_name, column_name, type, **options) ⇒ Object
:nodoc:.
-
#change_column_comment(table_name, column_name, comment_or_changes) ⇒ Object
:nodoc:.
-
#change_column_default(table_name, column_name, default_or_changes) ⇒ Object
:nodoc:.
-
#change_column_null(table_name, column_name, null, default = nil) ⇒ Object
:nodoc:.
-
#change_table_comment(table_name, comment_or_changes) ⇒ Object
:nodoc:.
-
#charset ⇒ Object
Returns the database character set.
- #check_constraints(table_name) ⇒ Object
-
#check_version ⇒ Object
:nodoc:.
-
#collation ⇒ Object
Returns the database collation strategy.
-
#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.
-
#commit_db_transaction ⇒ Object
:nodoc:.
-
#create_database(name, options = {}) ⇒ Object
Create a new MySQL database with optional
:charset
and:collation
. - #current_database ⇒ Object
-
#default_index_type?(index) ⇒ Boolean
:nodoc:.
-
#disable_referential_integrity ⇒ Object
REFERENTIAL INTEGRITY ====================================.
-
#drop_database(name) ⇒ Object
Drops a MySQL database.
-
#drop_table(table_name, **options) ⇒ Object
Drops a table from the database.
-
#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.
-
#empty_insert_statement_value(primary_key = nil) ⇒ Object
:nodoc:.
-
#emulate_booleans ⇒ Object
:singleton-method: By default, the Mysql2Adapter will consider all columns of type
tinyint(1)
as boolean. -
#error_number(exception) ⇒ Object
Must return the MySQL error number from the exception, if the exception has an error number.
-
#exec_rollback_db_transaction ⇒ Object
:nodoc:.
-
#execute(sql, name = nil, async: false) ⇒ Object
Executes the SQL statement in the context of this connection.
-
#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.
-
#field_ordered_value(column, values) ⇒ Object
:nodoc:.
- #foreign_keys(table_name) ⇒ Object
-
#get_advisory_lock(lock_name, timeout = 0) ⇒ Object
:nodoc:.
-
#get_database_version ⇒ Object
:nodoc:.
- #index_algorithms ⇒ Object
-
#initialize(connection, logger, connection_options, config) ⇒ AbstractMysqlAdapter
constructor
A new instance of AbstractMysqlAdapter.
-
#mariadb? ⇒ Boolean
:nodoc:.
- #native_database_types ⇒ Object
-
#primary_keys(table_name) ⇒ Object
:nodoc:.
-
#recreate_database(name, options = {}) ⇒ Object
Drops the database specified on the
name
attribute and creates it again using the providedoptions
. -
#release_advisory_lock(lock_name) ⇒ Object
:nodoc:.
-
#rename_column(table_name, column_name, new_column_name) ⇒ Object
:nodoc:.
- #rename_index(table_name, old_name, new_name) ⇒ Object
-
#rename_table(table_name, new_name) ⇒ Object
Renames a table.
-
#show_variable(name) ⇒ Object
SHOW VARIABLES LIKE ‘name’.
- #strict_mode? ⇒ Boolean
- #supports_advisory_locks? ⇒ Boolean
- #supports_bulk_alter? ⇒ Boolean
- #supports_check_constraints? ⇒ Boolean
- #supports_common_table_expressions? ⇒ Boolean
- #supports_datetime_with_precision? ⇒ Boolean
- #supports_explain? ⇒ Boolean
- #supports_expression_index? ⇒ Boolean
- #supports_foreign_keys? ⇒ Boolean
- #supports_index_sort_order? ⇒ Boolean
- #supports_indexes_in_create? ⇒ Boolean
- #supports_insert_on_duplicate_skip? ⇒ Boolean
- #supports_insert_on_duplicate_update? ⇒ Boolean
-
#supports_optimizer_hints? ⇒ Boolean
See dev.mysql.com/doc/refman/en/optimizer-hints.html for more details.
- #supports_transaction_isolation? ⇒ Boolean
- #supports_views? ⇒ Boolean
- #supports_virtual_columns? ⇒ Boolean
-
#table_comment(table_name) ⇒ Object
:nodoc:.
-
#table_options(table_name) ⇒ Object
:nodoc:.
Methods included from MySQL::SchemaStatements
#create_schema_dumper, #create_table, #indexes, #internal_string_options_for_primary_key, #remove_column, #table_alias_length, #type_to_sql, #update_table_definition
Methods included from MySQL::Quoting
#column_name_matcher, #column_name_with_order_matcher, #quote_bound_value, #quote_column_name, #quote_table_name, #quoted_binary, #quoted_date, #type_cast, #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, #clear_cache!, #close, #connection_class, #create_enum, database_exists?, #database_version, #default_uniqueness_comparison, #disable_extension, #discard!, #disconnect!, #enable_extension, #expire, #extensions, #lease, #migration_context, #migrations_paths, #prefetch_primary_key?, #prepared_statements?, #prepared_statements_disabled_cache, #preventing_writes?, quoted_column_names, quoted_table_names, #raw_connection, #reconnect!, #replica?, #requires_reloading?, #reset!, #role, #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_extensions?, #supports_foreign_tables?, #supports_insert_conflict_target?, #supports_insert_returning?, #supports_json?, #supports_lazy_transactions?, #supports_materialized_views?, #supports_partial_index?, #supports_partitioned_indexes?, #supports_savepoints?, #supports_validate_constraints?, #throw_away!, type_cast_config_to_boolean, type_cast_config_to_integer, #unprepared_statement, #use_metadata_table?, #valid_type?, #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, #select_all, #uncached
Methods included from DatabaseLimits
#index_name_length, #max_identifier_length, #table_alias_length
Methods included from Quoting
#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, #insert, #insert_fixture, #insert_fixtures_set, #mark_transaction_written_if_write, #query, #query_value, #query_values, #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?, #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, #change_table, #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, #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, #table_alias_for, #table_exists?, #tables, #type_to_sql, #update_table_definition, #view_exists?, #views
Constructor Details
#initialize(connection, logger, connection_options, config) ⇒ AbstractMysqlAdapter
Returns a new instance of AbstractMysqlAdapter.
54 55 56 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 54 def initialize(connection, logger, , config) super(connection, logger, config) end |
Instance Method Details
#add_index(table_name, column_name, **options) ⇒ Object
:nodoc:
368 369 370 371 372 373 374 375 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 368 def add_index(table_name, column_name, **) # :nodoc: index, algorithm, if_not_exists = (table_name, column_name, **) return if if_not_exists && index_exists?(table_name, column_name, name: index.name) create_index = CreateIndexDefinition.new(index, algorithm) execute schema_creation.accept(create_index) end |
#add_sql_comment!(sql, comment) ⇒ Object
:nodoc:
377 378 379 380 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 377 def add_sql_comment!(sql, comment) # :nodoc: sql << " COMMENT #{quote(comment)}" if comment.present? sql end |
#begin_db_transaction ⇒ Object
:nodoc:
210 211 212 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 210 def begin_db_transaction # :nodoc: execute("BEGIN", "TRANSACTION") end |
#begin_isolated_db_transaction(isolation) ⇒ Object
:nodoc:
214 215 216 217 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 214 def begin_isolated_db_transaction(isolation) # :nodoc: execute "SET TRANSACTION ISOLATION LEVEL #{transaction_isolation_levels.fetch(isolation)}" begin_db_transaction end |
#build_insert_sql(insert) ⇒ Object
:nodoc:
538 539 540 541 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 538 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. { |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:
500 501 502 503 504 505 506 507 508 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 500 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:
359 360 361 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 359 def change_column(table_name, column_name, type, **) # :nodoc: execute("ALTER TABLE #{quote_table_name(table_name)} #{change_column_for_alter(table_name, column_name, type, **)}") end |
#change_column_comment(table_name, column_name, comment_or_changes) ⇒ Object
:nodoc:
354 355 356 357 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 354 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:
341 342 343 344 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 341 def change_column_default(table_name, column_name, default_or_changes) # :nodoc: default = extract_new_default_value(default_or_changes) change_column table_name, column_name, nil, default: default end |
#change_column_null(table_name, column_name, null, default = nil) ⇒ Object
:nodoc:
346 347 348 349 350 351 352 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 346 def change_column_null(table_name, column_name, null, default = nil) # :nodoc: 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:
294 295 296 297 298 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 294 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.
274 275 276 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 274 def charset show_variable "character_set_database" end |
#check_constraints(table_name) ⇒ Object
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 444 445 446 447 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 418 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| = { name: row["name"] } expression = row["expression"] expression = expression[1..-2] unless mariadb? # remove parentheses added by mysql CheckConstraintDefinition.new(table_name, expression, ) end else raise NotImplementedError end end |
#check_version ⇒ Object
:nodoc:
557 558 559 560 561 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 557 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.
279 280 281 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 279 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
519 520 521 522 523 524 525 526 527 528 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 519 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:
219 220 221 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 219 def commit_db_transaction # :nodoc: execute("COMMIT", "TRANSACTION") 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
249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 249 def create_database(name, = {}) if [:collation] execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT COLLATE #{quote_table_name([:collation])}" elsif [:charset] execute "CREATE DATABASE #{quote_table_name(name)} DEFAULT CHARACTER SET #{quote_table_name([: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
269 270 271 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 269 def current_database query_value("SELECT database()", "SCHEMA") end |
#default_index_type?(index) ⇒ Boolean
:nodoc:
534 535 536 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 534 def default_index_type?(index) # :nodoc: index.using == :btree || super end |
#disable_referential_integrity ⇒ Object
REFERENTIAL INTEGRITY ====================================
183 184 185 186 187 188 189 190 191 192 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 183 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')
265 266 267 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 265 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.
326 327 328 329 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 326 def drop_table(table_name, **) schema_cache.clear_data_source_cache!(table_name.to_s) execute "DROP#{' TEMPORARY' if [:temporary]} TABLE#{' IF EXISTS' if [:if_exists]} #{quote_table_name(table_name)}#{' CASCADE' if [: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.
171 172 173 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 171 def each_hash(result) # :nodoc: raise NotImplementedError end |
#empty_insert_statement_value(primary_key = nil) ⇒ Object
:nodoc:
227 228 229 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 227 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 '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.
177 178 179 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 177 def error_number(exception) # :nodoc: raise NotImplementedError end |
#exec_rollback_db_transaction ⇒ Object
:nodoc:
223 224 225 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 223 def exec_rollback_db_transaction # :nodoc: execute("ROLLBACK", "TRANSACTION") end |
#execute(sql, name = nil, async: false) ⇒ Object
Executes the SQL statement in the context of this connection.
199 200 201 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 199 def execute(sql, name = nil, async: false) raw_execute(sql, name, async: async) 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.
206 207 208 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 206 def execute_and_free(sql, name = nil, async: false) # :nodoc: yield execute(sql, name, async: async) end |
#field_ordered_value(column, values) ⇒ Object
:nodoc:
141 142 143 144 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 141 def field_ordered_value(column, values) # :nodoc: field = Arel::Nodes::NamedFunction.new("FIELD", [column, values.reverse.map { |value| Arel::Nodes.build_quoted(value) }]) Arel::Nodes::Descending.new(field) end |
#foreign_keys(table_name) ⇒ Object
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 382 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| = { column: row["column"], name: row["name"], primary_key: row["primary_key"] } [:on_update] = extract_foreign_key_action(row["on_update"]) [:on_delete] = extract_foreign_key_action(row["on_delete"]) ForeignKeyDefinition.new(table_name, row["to_table"], ) end end |
#get_advisory_lock(lock_name, timeout = 0) ⇒ Object
:nodoc:
146 147 148 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 146 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:
58 59 60 61 62 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 58 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
158 159 160 161 162 163 164 165 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 158 def index_algorithms { default: "ALGORITHM = DEFAULT", copy: "ALGORITHM = COPY", inplace: "ALGORITHM = INPLACE", instant: "ALGORITHM = INSTANT", } end |
#mariadb? ⇒ Boolean
:nodoc:
64 65 66 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 64 def mariadb? # :nodoc: /mariadb/i.match?(full_version) end |
#native_database_types ⇒ Object
154 155 156 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 154 def native_database_types NATIVE_DATABASE_TYPES end |
#primary_keys(table_name) ⇒ Object
:nodoc:
485 486 487 488 489 490 491 492 493 494 495 496 497 498 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 485 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
.
235 236 237 238 239 240 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 235 def recreate_database(name, = {}) drop_database(name) sql = create_database(name, ) reconnect! sql end |
#release_advisory_lock(lock_name) ⇒ Object
:nodoc:
150 151 152 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 150 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:
363 364 365 366 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 363 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
331 332 333 334 335 336 337 338 339 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 331 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')
304 305 306 307 308 309 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 304 def rename_table(table_name, new_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’
479 480 481 482 483 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 479 def show_variable(name) query_value("SELECT @@#{name}", "SCHEMA") rescue ActiveRecord::StatementInvalid nil end |
#strict_mode? ⇒ Boolean
530 531 532 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 530 def strict_mode? self.class.type_cast_config_to_boolean(@config.fetch(:strict, true)) end |
#supports_advisory_locks? ⇒ Boolean
129 130 131 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 129 def supports_advisory_locks? true end |
#supports_bulk_alter? ⇒ Boolean
68 69 70 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 68 def supports_bulk_alter? true end |
#supports_check_constraints? ⇒ Boolean
96 97 98 99 100 101 102 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 96 def supports_check_constraints? if mariadb? database_version >= "10.2.1" else database_version >= "8.0.16" end end |
#supports_common_table_expressions? ⇒ Boolean
121 122 123 124 125 126 127 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 121 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
108 109 110 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 108 def supports_datetime_with_precision? mariadb? || database_version >= "5.6.4" end |
#supports_explain? ⇒ Boolean
84 85 86 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 84 def supports_explain? true end |
#supports_expression_index? ⇒ Boolean
76 77 78 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 76 def supports_expression_index? !mariadb? && database_version >= "8.0.13" end |
#supports_foreign_keys? ⇒ Boolean
92 93 94 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 92 def supports_foreign_keys? true end |
#supports_index_sort_order? ⇒ Boolean
72 73 74 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 72 def supports_index_sort_order? !mariadb? && database_version >= "8.0.1" end |
#supports_indexes_in_create? ⇒ Boolean
88 89 90 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 88 def supports_indexes_in_create? true end |
#supports_insert_on_duplicate_skip? ⇒ Boolean
133 134 135 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 133 def supports_insert_on_duplicate_skip? true end |
#supports_insert_on_duplicate_update? ⇒ Boolean
137 138 139 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 137 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.
117 118 119 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 117 def supports_optimizer_hints? !mariadb? && database_version >= "5.7.7" end |
#supports_transaction_isolation? ⇒ Boolean
80 81 82 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 80 def supports_transaction_isolation? true end |
#supports_views? ⇒ Boolean
104 105 106 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 104 def supports_views? true end |
#supports_virtual_columns? ⇒ Boolean
112 113 114 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 112 def supports_virtual_columns? mariadb? || database_version >= "5.7.5" end |
#table_comment(table_name) ⇒ Object
:nodoc:
283 284 285 286 287 288 289 290 291 292 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 283 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:
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
# File 'lib/active_record/connection_adapters/abstract_mysql_adapter.rb', line 449 def (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. = create_table_info.sub(/\A.*\n\) ?/m, "").sub(/\n\/\*!.*\*\/\n\z/m, "").strip return if .empty? = {} if / DEFAULT CHARSET=(?<charset>\w+)(?: COLLATE=(?<collation>\w+))?/ =~ = $` + $' # before part + after part [:charset] = charset [:collation] = collation if collation end # strip AUTO_INCREMENT .sub!(/(ENGINE=\w+)(?: AUTO_INCREMENT=\d+)/, '\1') # strip COMMENT if .sub!(/ COMMENT='.+'/, "") [:comment] = table_comment(table_name) end [:options] = unless == "ENGINE=InnoDB" end |