Module: ActiveRecord::ConnectionAdapters::MySQL::SchemaStatements
Do not use. This module is for internal use only.
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb |
Constant Summary
-
CHARSETS_OF_4BYTES_MAXLEN =
# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 137["utf8mb4", "utf16", "utf16le", "utf32"]
Instance Attribute Summary
- #row_format_dynamic_by_default? ⇒ Boolean readonly private
Instance Method Summary
- #create_schema_dumper(options)
- #create_table(table_name, options: default_row_format)
-
#indexes(table_name)
Returns an array of indexes for the given table.
- #internal_string_options_for_primary_key
- #remove_column(table_name, column_name, type = nil, **options)
- #schema_creation
- #table_alias_length
-
#type_to_sql(type, limit: nil, precision: nil, scale: nil, size: limit_to_size(limit, type), unsigned: nil)
Maps logical
::Rails
types to MySQL-specific data types. - #update_table_definition(table_name, base)
- #add_index_length(quoted_columns, **options) private
- #add_options_for_index_columns(quoted_columns, **options) private
- #create_table_definition(name, **options) private
- #data_source_sql(name = nil, type: nil) private
- #default_row_format private
- #default_type(table_name, field_name) private
- #extract_foreign_key_action(specifier) private
- #extract_schema_qualified_name(string) private
- #fetch_type_metadata(sql_type, extra = "") private
- #integer_to_sql(limit) private
- #limit_to_size(limit, type) private
- #new_column_from_field(table_name, field, _definitions) private
- #quoted_scope(name = nil, type: nil) private
- #type_with_size_to_sql(type, size) private
- #valid_primary_key_options private
Instance Attribute Details
#row_format_dynamic_by_default? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 139
def row_format_dynamic_by_default? if mariadb? database_version >= "10.2.2" else database_version >= "5.7.9" end end
Instance Method Details
#add_index_length(quoted_columns, **options) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 222
def add_index_length(quoted_columns, ** ) lengths = ( [:length]) quoted_columns.each do |name, column| column << "(#{lengths[name]})" if lengths[name].present? end end
#add_options_for_index_columns(quoted_columns, **options) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 229
def (quoted_columns, ** ) quoted_columns = add_index_length(quoted_columns, ** ) super end
#create_schema_dumper(options)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 100
def create_schema_dumper( ) MySQL::SchemaDumper.create(self, ) end
#create_table(table_name, options: default_row_format)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 84
def create_table(table_name, options: default_row_format, **) super end
#create_table_definition(name, **options) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 165
def create_table_definition(name, ** ) MySQL::TableDefinition.new(self, name, ** ) end
#data_source_sql(name = nil, type: nil) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 234
def data_source_sql(name = nil, type: nil) scope = quoted_scope(name, type: type) sql = +"SELECT table_name FROM information_schema.tables" sql << " WHERE table_schema = #{scope[:schema]}" if scope[:name] sql << " AND table_name = #{scope[:name]}" sql << " AND table_name IN (SELECT table_name FROM information_schema.tables WHERE table_schema = #{scope[:schema]})" end sql << " AND table_type = #{scope[:type]}" if scope[:type] sql end
#default_row_format (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 147
def default_row_format return if row_format_dynamic_by_default? unless defined?(@default_row_format) if query_value("SELECT @@innodb_file_per_table = 1 AND @@innodb_file_format = 'Barracuda'") == 1 @default_row_format = "ROW_FORMAT=DYNAMIC" else @default_row_format = nil end end @default_row_format end
#default_type(table_name, field_name) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 169
def default_type(table_name, field_name) match = create_table_info(table_name)&.match(/`#{field_name}` (.+) DEFAULT ('|\d|[A-z])/) default_pre = match[2] if match if default_pre == "'" :string elsif default_pre&.match?(/^\d+$/) :integer elsif default_pre&.match?(/^[A-z]+$/) :function end end
#extract_foreign_key_action(specifier) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 218
def extract_foreign_key_action(specifier) super unless specifier == "RESTRICT" end
#extract_schema_qualified_name(string) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 258
def extract_schema_qualified_name(string) schema, name = string.to_s.scan(/[^`.\s]+|`[^`]*`/) schema, name = nil, schema unless name [schema, name] end
#fetch_type_metadata(sql_type, extra = "") (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 214
def (sql_type, extra = "") MySQL::TypeMetadata.new(super(sql_type), extra: extra) end
#indexes(table_name)
Returns an array of indexes for the given table.
# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 8
def indexes(table_name) indexes = [] current_index = nil internal_exec_query("SHOW KEYS FROM #{quote_table_name(table_name)}", "SCHEMA").each do |row| if current_index != row["Key_name"] next if row["Key_name"] == "PRIMARY" # skip the primary key current_index = row["Key_name"] mysql_index_type = row["Index_type"].downcase.to_sym case mysql_index_type when :fulltext, :spatial index_type = mysql_index_type when :btree, :hash index_using = mysql_index_type end indexes << [ row["Table"], row["Key_name"], row["Non_unique"].to_i == 0, [], lengths: {}, orders: {}, type: index_type, using: index_using, comment: row["Index_comment"].presence ] end if expression = row["Expression"] expression = expression.gsub("\\'", "'") expression = +"(#{expression})" unless expression.start_with?("(") indexes.last[-2] << expression indexes.last[-1][:expressions] ||= {} indexes.last[-1][:expressions][expression] = expression indexes.last[-1][:orders][expression] = :desc if row["Collation"] == "D" else indexes.last[-2] << row["Column_name"] indexes.last[-1][:lengths][row["Column_name"]] = row["Sub_part"].to_i if row["Sub_part"] indexes.last[-1][:orders][row["Column_name"]] = :desc if row["Collation"] == "D" end end indexes.map do |index| = index.pop if expressions = .delete(:expressions) orders = .delete(:orders) lengths = .delete(:lengths) columns = index[-1].to_h { |name| [ name.to_sym, expressions[name] || +quote_column_name(name) ] } index[-1] = ( columns, order: orders, length: lengths ).values.join(", ") end IndexDefinition.new(*index, ** ) end rescue StatementInvalid => e if e. .match?(/Table '.+' doesn't exist/) [] else raise end end
#integer_to_sql(limit) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 287
def integer_to_sql(limit) case limit when 1; "tinyint" when 2; "smallint" when 3; "mediumint" when nil, 4; "int" when 5..8; "bigint" else raise ArgumentError, "No integer type has byte size #{limit}. Use a decimal with scale 0 instead." end end
#internal_string_options_for_primary_key
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 88
def super.tap do || if !row_format_dynamic_by_default? && CHARSETS_OF_4BYTES_MAXLEN.include?(charset) [:collation] = collation.sub(/\A[^_]+/, "utf8") end end end
#limit_to_size(limit, type) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 274
def limit_to_size(limit, type) case type.to_s when "text", "blob", "binary" case limit when 0..0xff; "tiny" when nil, 0x100..0xffff; nil when 0x10000..0xffffff; "medium" when 0x1000000..0xffffffff; "long" else raise ArgumentError, "No #{type} type has byte size #{limit}" end end end
#new_column_from_field(table_name, field, _definitions) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 182
def new_column_from_field(table_name, field, _definitions) field_name = field.fetch("Field") = (field["Type"], field["Extra"]) default, default_function = field["Default"], nil if .type == :datetime && /\ACURRENT_TIMESTAMP(?:\([0-6]?\))?\z/i.match?(default) default = "#{default} ON UPDATE #{default}" if /on update CURRENT_TIMESTAMP/i.match?(field["Extra"]) default, default_function = nil, default elsif .extra == "DEFAULT_GENERATED" default = +"(#{default})" unless default.start_with?("(") default = default.gsub("\\'", "'") default, default_function = nil, default elsif .type == :text && default&.start_with?("'") # strip and unescape quotes default = default[1...-1].gsub("\\'", "'") elsif default&.match?(/\A\d/) # Its a number so we can skip the query to check if it is a function elsif default && default_type(table_name, field_name) == :function default, default_function = nil, default end MySQL::Column.new( field["Field"], default, , field["Null"] == "YES", default_function, collation: field["Collation"], comment: field["Comment"].presence ) end
#quoted_scope(name = nil, type: nil) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 249
def quoted_scope(name = nil, type: nil) schema, name = extract_schema_qualified_name(name) scope = {} scope[:schema] = schema ? quote(schema) : "database()" scope[:name] = quote(name) if name scope[:type] = quote(type) if type scope end
#remove_column(table_name, column_name, type = nil, **options)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 77
def remove_column(table_name, column_name, type = nil, ** ) if foreign_key_exists?(table_name, column: column_name) remove_foreign_key(table_name, column: column_name) end super end
#schema_creation
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 132
def schema_creation # :nodoc: MySQL::SchemaCreation.new(self) end
#table_alias_length
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 128
def table_alias_length 256 # https://dev.mysql.com/doc/refman/en/identifiers.html end
#type_to_sql(type, limit: nil, precision: nil, scale: nil, size: limit_to_size(limit, type), unsigned: nil)
Maps logical ::Rails
types to MySQL-specific data types.
# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 105
def type_to_sql(type, limit: nil, precision: nil, scale: nil, size: limit_to_size(limit, type), unsigned: nil, **) sql = case type.to_s when "integer" integer_to_sql(limit) when "text" type_with_size_to_sql("text", size) when "blob" type_with_size_to_sql("blob", size) when "binary" if (0..0xfff) === limit "varbinary(#{limit})" else type_with_size_to_sql("blob", size) end else super end sql = "#{sql} unsigned" if unsigned && type != :primary_key sql end
#type_with_size_to_sql(type, size) (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 264
def type_with_size_to_sql(type, size) case size&.to_s when nil, "tiny", "medium", "long" "#{size}#{type}" else raise ArgumentError, "#{size.inspect} is invalid :size value. Only :tiny, :medium, and :long are allowed." end end
#update_table_definition(table_name, base)
[ GitHub ]#valid_primary_key_options (private)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_statements.rb', line 161
def super + [:unsigned, :auto_increment] end