- MODULE ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter::Type
- CLASS ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter::StatementPool
- A
- B
- C
- D
- E
- F
- I
- N
- R
- S
-
- show_variable,
- strict_mode?,
- supports_advisory_locks?,
- supports_datetime_with_precision?,
- supports_explain?,
- supports_foreign_keys?,
- supports_index_sort_order?,
- supports_indexes_in_create?,
- supports_migrations?,
- supports_primary_key?,
- supports_statement_cache?,
- supports_transaction_isolation?,
- supports_views?
- T
- V
NATIVE_DATABASE_TYPES | = | { primary_key: "int auto_increment PRIMARY KEY", string: { name: "varchar", limit: 255 }, text: { name: "text" }, integer: { name: "int", limit: 4 }, float: { name: "float" }, decimal: { name: "decimal" }, datetime: { name: "datetime" }, time: { name: "time" }, date: { name: "date" }, binary: { name: "blob" }, boolean: { name: "tinyint", limit: 1 }, json: { name: "json" }, } |
INDEX_TYPES | = | [:fulltext, :spatial] |
INDEX_USINGS | = | [:btree, :hash] |
CHARSETS_OF_4BYTES_MAXLEN | = | ['utf8mb4', 'utf16', 'utf16le', 'utf32'] |
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 activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 65 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.0.0' raise "Your version of MySQL (#{version_string}) is too old. Active Record supports MySQL >= 5.0." end end
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 616 def case_sensitive_comparison(table, attribute, column, value) if !value.nil? && column.collation && !column.case_sensitive? table[attribute].eq(Arel::Nodes::Bin.new(Arel::Nodes::BindParam.new)) else super end end
Returns the database character set.
Clears the prepared statements cache.
Returns the database collation strategy.
Create a new MySQL database with optional
:charset
and :collation
. Charset defaults to
utf8.
Example:
create_database 'charset_test', charset: 'latin1', collation: 'latin1_bin'
create_database 'matt_development'
create_database 'matt_development', charset: :big5
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 279 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
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 347 def data_source_exists?(table_name) return false unless table_name.present? schema, name = extract_schema_qualified_name(table_name) sql = "SELECT table_name FROM information_schema.tables " sql << "WHERE table_schema = #{schema} AND table_name = #{name}" select_values(sql, 'SCHEMA').any? 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 activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 465 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
Executes the SQL statement in the context of this connection.
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 207 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
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 515 def foreign_keys(table_name) raise ArgumentError unless table_name.present? schema, name = extract_schema_qualified_name(table_name) fk_info = select_all(" 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 = #{schema} AND fk.table_name = #{name} AND rc.table_name = #{name} ".strip_heredoc, 'SCHEMA') 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
Drops the database specified on the name
attribute and creates
it again using the provided options
.
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 469 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')
SHOW VARIABLES LIKE 'name'
Technically MySQL allows to create indexes with the sort order syntax but at the moment (5.5) it doesn't yet implement them
Returns true, since this connection adapter supports migrations.
Returns true, since this connection adapter supports prepared statement caching.
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 336 def table_exists?(table_name) # Update lib/active_record/internal_metadata.rb when this gets removed ActiveSupport::Deprecation.warn(" #table_exists? currently checks both tables and views. This behavior is deprecated and will be changed with Rails 5.1 to only check tables. Use #data_source_exists? instead. ".squish) data_source_exists?(table_name) end
Maps logical Rails types to MySQL-specific data types.
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 572 def type_to_sql(type, limit = nil, precision = nil, scale = nil, unsigned = nil) 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(type, limit, precision, scale) end sql << ' unsigned' if unsigned && type != :primary_key sql end
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 748 def add_column_sql(table_name, column_name, type, options = {}) td = create_table_definition(table_name) cd = td.new_column_definition(column_name, type, options) schema_creation.accept(AddColumnDefinition.new(cd)) end
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 716 def add_index_length(quoted_columns, **options) if length = options[:length] case length when Hash length = length.symbolize_keys quoted_columns.each { |name, column| column << "(#{length[name]})" if length[name].present? } when Integer quoted_columns.each { |name, column| column << "(#{length})" } end end quoted_columns end
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 792 def add_index_sql(table_name, column_name, options = {}) index_name, index_type, index_columns, _, index_algorithm, index_using = add_index_options(table_name, column_name, options) index_algorithm[0, 0] = ", " if index_algorithm.present? "ADD #{index_type} INDEX #{quote_column_name(index_name)} #{index_using} (#{index_columns})#{index_algorithm}" end
# File activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 754 def change_column_sql(table_name, column_name, type, options = {}) column = column_for(table_name, column_name) unless options_include_default?(options) options[:default] = column.default end unless options.has_key?(:null) options[:null] = column.null end 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 activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 770 def rename_column_sql(table_name, column_name, new_column_name) column = column_for(table_name, column_name) options = { default: column.default, null: column.null, auto_increment: column.auto_increment? } current_type = select_one("SHOW COLUMNS FROM #{quote_table_name(table_name)} LIKE '#{column_name}'", 'SCHEMA')["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 activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb, line 735 def translate_exception(exception, message) case error_number(exception) when 1062 RecordNotUnique.new(message) when 1452 InvalidForeignKey.new(message) when 1406 ValueTooLong.new(message) else super end end