class ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
Constants
- ER_CANNOT_ADD_FOREIGN
- ER_CANNOT_CREATE_TABLE
- ER_DATA_TOO_LONG
- ER_DB_CREATE_EXISTS
See dev.mysql.com/doc/mysql-errors/en/server-error-reference.html
- ER_DO_NOT_HAVE_DEFAULT
- ER_DUP_ENTRY
- ER_FILSORT_ABORT
- ER_FK_INCOMPATIBLE_COLUMNS
- ER_LOCK_DEADLOCK
- ER_LOCK_WAIT_TIMEOUT
- ER_NOT_NULL_VIOLATION
- ER_NO_REFERENCED_ROW
- ER_NO_REFERENCED_ROW_2
- ER_OUT_OF_RANGE
- ER_QUERY_INTERRUPTED
- ER_QUERY_TIMEOUT
- ER_ROW_IS_REFERENCED
- ER_ROW_IS_REFERENCED_2
- NATIVE_DATABASE_TYPES
- TYPE_MAP
- TYPE_MAP_WITH_BOOLEAN
Public Class Methods
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
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 27 class_attribute :emulate_booleans, default: true
ActiveRecord::ConnectionAdapters::QueryCache::new
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 54 def initialize(connection, logger, connection_options, config) super(connection, logger, config) end
Private Class Methods
ActiveRecord::ConnectionAdapters::AbstractAdapter::extract_precision
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 603 def extract_precision(sql_type) if /\A(?:date)?time(?:stamp)?\b/.match?(sql_type) super || 0 else super end end
ActiveRecord::ConnectionAdapters::AbstractAdapter::initialize_type_map
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 561 def initialize_type_map(m) super m.register_type(%r(char)i) do |sql_type| limit = extract_limit(sql_type) Type.lookup(:string, adapter: :mysql2, limit: limit) end m.register_type %r(tinytext)i, Type::Text.new(limit: 2**8 - 1) m.register_type %r(tinyblob)i, Type::Binary.new(limit: 2**8 - 1) m.register_type %r(text)i, Type::Text.new(limit: 2**16 - 1) m.register_type %r(blob)i, Type::Binary.new(limit: 2**16 - 1) m.register_type %r(mediumtext)i, Type::Text.new(limit: 2**24 - 1) m.register_type %r(mediumblob)i, Type::Binary.new(limit: 2**24 - 1) m.register_type %r(longtext)i, Type::Text.new(limit: 2**32 - 1) m.register_type %r(longblob)i, Type::Binary.new(limit: 2**32 - 1) m.register_type %r(^float)i, Type::Float.new(limit: 24) m.register_type %r(^double)i, Type::Float.new(limit: 53) register_integer_type m, %r(^bigint)i, limit: 8 register_integer_type m, %r(^int)i, limit: 4 register_integer_type m, %r(^mediumint)i, limit: 3 register_integer_type m, %r(^smallint)i, limit: 2 register_integer_type m, %r(^tinyint)i, limit: 1 m.alias_type %r(year)i, "integer" m.alias_type %r(bit)i, "binary" m.register_type %r(^enum)i, Type.lookup(:string, adapter: :mysql2) m.register_type %r(^set)i, Type.lookup(:string, adapter: :mysql2) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 593 def register_integer_type(mapping, key, **options) mapping.register_type(key) do |sql_type| if /\bunsigned\b/.match?(sql_type) Type::UnsignedInteger.new(**options) else Type::Integer.new(**options) end end end
Public Instance Methods
Returns the database character set.
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 269 def charset show_variable "character_set_database" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 413 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
Returns the database collation strategy.
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 274 def collation show_variable "collation_database" end
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
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 244 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
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 264 def current_database query_value("SELECT database()", "SCHEMA") end
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.
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 321 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
Executes the SQL statement in the context of this connection.
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 194 def execute(sql, name = nil, async: false) raw_execute(sql, name, async: async) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 377 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
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 153 def index_algorithms { default: "ALGORITHM = DEFAULT", copy: "ALGORITHM = COPY", inplace: "ALGORITHM = INPLACE", instant: "ALGORITHM = INSTANT", } end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 149 def native_database_types NATIVE_DATABASE_TYPES end
Drops the database specified on the name
attribute and creates it again using the provided options
.
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 230 def recreate_database(name, options = {}) drop_database(name) sql = create_database(name, options) reconnect! sql end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 326 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
Renames a table.
Example:
rename_table('octopuses', 'octopi')
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 299 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 VARIABLES LIKE 'name'
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 475 def show_variable(name) query_value("SELECT @@#{name}", "SCHEMA") rescue ActiveRecord::StatementInvalid nil end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 526 def strict_mode? self.class.type_cast_config_to_boolean(@config.fetch(:strict, true)) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 129 def supports_advisory_locks? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 68 def supports_bulk_alter? true end
# 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
# 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
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 108 def supports_datetime_with_precision? mariadb? || database_version >= "5.6.4" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 84 def supports_explain? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 76 def supports_expression_index? !mariadb? && database_version >= "8.0.13" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 92 def supports_foreign_keys? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 72 def supports_index_sort_order? !mariadb? && database_version >= "8.0.1" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 88 def supports_indexes_in_create? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 133 def supports_insert_on_duplicate_skip? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 137 def supports_insert_on_duplicate_update? true end
See dev.mysql.com/doc/refman/en/optimizer-hints.html for more details.
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 117 def supports_optimizer_hints? !mariadb? && database_version >= "5.7.7" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 80 def supports_transaction_isolation? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 104 def supports_views? true end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 112 def supports_virtual_columns? mariadb? || database_version >= "5.7.5" end
Private Instance Methods
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 750 def add_index_for_alter(table_name, column_name, **options) index, algorithm, _ = add_index_options(table_name, column_name, **options) algorithm = ", #{algorithm}" if algorithm "ADD #{schema_creation.accept(index)}#{algorithm}" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 840 def arel_visitor Arel::Visitors::MySQL.new(self) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 844 def build_statement_pool StatementPool.new(self.class.type_cast_config_to_integer(@config[:statement_limit])) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 506 def can_perform_case_insensitive_comparison_for?(column) column.case_sensitive? end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 704 def change_column_for_alter(table_name, column_name, type, **options) 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 unless options.key?(:collation) 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) schema_creation.accept(ChangeColumnDefinition.new(cd, column.name)) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 778 def configure_connection variables = @config.fetch(:variables, {}).stringify_keys # By default, MySQL 'where id is null' selects the last inserted id; Turn this off. variables["sql_auto_is_null"] = 0 # Increase timeout so the server doesn't disconnect us. wait_timeout = self.class.type_cast_config_to_integer(@config[:wait_timeout]) wait_timeout = 2147483 unless wait_timeout.is_a?(Integer) variables["wait_timeout"] = wait_timeout defaults = [":default", :default].to_set # Make MySQL reject illegal values rather than truncating or blanking them, see # https://dev.mysql.com/doc/refman/en/sql-mode.html#sqlmode_strict_all_tables # If the user has provided another value for sql_mode, don't replace it. if sql_mode = variables.delete("sql_mode") sql_mode = quote(sql_mode) elsif !defaults.include?(strict_mode?) if strict_mode? sql_mode = "CONCAT(@@sql_mode, ',STRICT_ALL_TABLES')" else sql_mode = "REPLACE(@@sql_mode, 'STRICT_TRANS_TABLES', '')" sql_mode = "REPLACE(#{sql_mode}, 'STRICT_ALL_TABLES', '')" sql_mode = "REPLACE(#{sql_mode}, 'TRADITIONAL', '')" end sql_mode = "CONCAT(#{sql_mode}, ',NO_AUTO_VALUE_ON_ZERO')" end sql_mode_assignment = "@@SESSION.sql_mode = #{sql_mode}, " if sql_mode # NAMES does not have an equals sign, see # https://dev.mysql.com/doc/refman/en/set-names.html # (trailing comma because variable_assignments will always have content) if @config[:encoding] encoding = +"NAMES #{@config[:encoding]}" encoding << " COLLATE #{@config[:collation]}" if @config[:collation] encoding << ", " end # Gather up all of the SET variables... variable_assignments = variables.filter_map do |k, v| if defaults.include?(v) "@@SESSION.#{k} = DEFAULT" # Sets the value to the global or compile default elsif !v.nil? "@@SESSION.#{k} = #{quote(v)}" end end.join(", ") # ...and send them all in one query execute("SET #{encoding} #{sql_mode_assignment} #{variable_assignments}", "SCHEMA") end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 848 def mismatched_foreign_key(message, sql:, binds:) match = %r/ (?:CREATE|ALTER)\s+TABLE\s*(?:`?\w+`?\.)?`?(?<table>\w+)`?.+? FOREIGN\s+KEY\s*\(`?(?<foreign_key>\w+)`?\)\s* REFERENCES\s*(`?(?<target_table>\w+)`?)\s*\(`?(?<primary_key>\w+)`?\) /xmi.match(sql) options = { message: message, sql: sql, binds: binds, } if match options[:table] = match[:table] options[:foreign_key] = match[:foreign_key] options[:target_table] = match[:target_table] options[:primary_key] = match[:primary_key] options[:primary_key_column] = column_for(match[:target_table], match[:primary_key]) end MismatchedForeignKey.new(**options) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 632 def raw_execute(sql, name, async: false) materialize_transactions mark_transaction_written_if_write(sql) log(sql, name, async: async) do ActiveSupport::Dependencies.interlock.permit_concurrent_loads do @connection.query(sql) end end end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 757 def remove_index_for_alter(table_name, column_name = nil, **options) index_name = index_name_for_remove(table_name, column_name, options) "DROP INDEX #{quote_column_name(index_name)}" end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 733 def rename_column_for_alter(table_name, column_name, new_column_name) return rename_column_sql(table_name, column_name, new_column_name) if supports_rename_column? column = column_for(table_name, column_name) options = { default: column.default, null: column.null, auto_increment: column.auto_increment?, comment: column.comment } current_type = exec_query("SHOW COLUMNS FROM #{quote_table_name(table_name)} LIKE #{quote(column_name)}", "SCHEMA").first["Type"] td = create_table_definition(table_name) cd = td.new_column_definition(new_column_name, current_type, **options) schema_creation.accept(ChangeColumnDefinition.new(cd, column.name)) end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 618 def strip_whitespace_characters(expression) expression = expression.gsub(/\\n|\\\\/, "") expression = expression.gsub(/\s{2,}/, " ") expression end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 770 def supports_rename_column? if mariadb? database_version >= "10.5.2" else database_version >= "8.0.3" end end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 762 def supports_rename_index? if mariadb? database_version >= "10.5.2" else database_version >= "5.7.6" end end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 624 def text_type?(type) TYPE_MAP.lookup(type).is_a?(Type::String) || TYPE_MAP.lookup(type).is_a?(Type::Text) end
ActiveRecord::ConnectionAdapters::AbstractAdapter#translate_exception
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 663 def translate_exception(exception, message:, sql:, binds:) case error_number(exception) when nil if exception.message.match?(/MySQL client is not connected/i) ConnectionNotEstablished.new(exception) else super end when ER_DB_CREATE_EXISTS DatabaseAlreadyExists.new(message, sql: sql, binds: binds) when ER_DUP_ENTRY RecordNotUnique.new(message, sql: sql, binds: binds) when ER_NO_REFERENCED_ROW, ER_ROW_IS_REFERENCED, ER_ROW_IS_REFERENCED_2, ER_NO_REFERENCED_ROW_2 InvalidForeignKey.new(message, sql: sql, binds: binds) when ER_CANNOT_ADD_FOREIGN, ER_FK_INCOMPATIBLE_COLUMNS mismatched_foreign_key(message, sql: sql, binds: binds) when ER_CANNOT_CREATE_TABLE if message.include?("errno: 150") mismatched_foreign_key(message, sql: sql, binds: binds) else super end when ER_DATA_TOO_LONG ValueTooLong.new(message, sql: sql, binds: binds) when ER_OUT_OF_RANGE RangeError.new(message, sql: sql, binds: binds) when ER_NOT_NULL_VIOLATION, ER_DO_NOT_HAVE_DEFAULT NotNullViolation.new(message, sql: sql, binds: binds) when ER_LOCK_DEADLOCK Deadlocked.new(message, sql: sql, binds: binds) when ER_LOCK_WAIT_TIMEOUT LockWaitTimeout.new(message, sql: sql, binds: binds) when ER_QUERY_TIMEOUT, ER_FILSORT_ABORT StatementTimeout.new(message, sql: sql, binds: binds) when ER_QUERY_INTERRUPTED QueryCanceled.new(message, sql: sql, binds: binds) else super end end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 628 def type_map emulate_booleans ? TYPE_MAP_WITH_BOOLEAN : TYPE_MAP end
# File lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 872 def version_string(full_version_string) full_version_string.match(/^(?:5\.5\.5-)?(\d+\.\d+\.\d+)/)[1] end