123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::MySQL::SchemaCreation

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveRecord::ConnectionAdapters::SchemaCreation
Instance Chain:
self, ::ActiveRecord::ConnectionAdapters::SchemaCreation
Inherits: ActiveRecord::ConnectionAdapters::SchemaCreation
Defined in: activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb

Class Method Summary

::ActiveRecord::ConnectionAdapters::SchemaCreation - Inherited

.new

Instance Attribute Summary

::ActiveRecord::ConnectionAdapters::SchemaCreation - Inherited

#quote_column_name, #quote_default_expression, #quote_table_name, #quoted_columns_for_index, #type_to_sql, #supports_index_using?

Instance Method Summary

::ActiveRecord::ConnectionAdapters::SchemaCreation - Inherited

#accept, #options_include_default?, #supports_check_constraints?, #supports_exclusion_constraints?, #supports_index_include?, #supports_indexes_in_create?, #supports_nulls_not_distinct?, #supports_partial_index?, #supports_unique_constraints?, #use_foreign_keys?, #action_sql, #add_column_options!, #add_table_options!, #column_options, #quoted_columns,
#table_modifier_in_create

Returns any SQL string to go between CREATE and TABLE.
#to_sql, #visit_AddCheckConstraint, #visit_AddColumnDefinition, #visit_AddForeignKey, #visit_AlterTable, #visit_CheckConstraintDefinition, #visit_ColumnDefinition, #visit_CreateIndexDefinition, #visit_DropCheckConstraint, #visit_DropForeignKey, #visit_ForeignKeyDefinition, #visit_PrimaryKeyDefinition, #visit_TableDefinition

Constructor Details

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

Instance Method Details

#add_column_options!(sql, options) (private)

[ GitHub ] 

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 62



def add_column_options!(sql, options)
  # By default, TIMESTAMP columns are NOT NULL, cannot contain NULL values,
  # and assigning NULL assigns the current timestamp. To permit a TIMESTAMP
  # column to contain NULL, explicitly declare it with the NULL attribute.
  # See https://dev.mysql.com/doc/refman/en/timestamp-initialization.html
  if /\Atimestamp\b/.match?(options[:column].sql_type) && !options[:primary_key]
    sql << " NULL" unless options[:null] == false || options_include_default?(options)
  end

  if charset = options[:charset]
    sql << " CHARACTER SET #{charset}"
  end

  if collation = options[:collation]
    sql << " COLLATE #{collation}"
  end

  if as = options[:as]
    sql << " AS (#{as})"
    if options[:stored]
      sql << (mariadb? ? " PERSISTENT" : " STORED")
    end
  end

  add_sql_comment!(super, options[:comment])
end


  








  

    #add_column_position!(sql, options)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 89



def add_column_position!(sql, options)
  if options[:first]
    sql << " FIRST"
  elsif options[:after]
    sql << " AFTER #{quote_column_name(options[:after])}"
  end

  sql
end


  








  

    #add_sql_comment!  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 7



delegate :add_sql_comment!, :mariadb?, to: :@conn, private: true


  








  

    #add_table_options!(create_sql, o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 56



def add_table_options!(create_sql, o)
  create_sql << " DEFAULT CHARSET=#{o.charset}" if o.charset
  create_sql << " COLLATE=#{o.collation}" if o.collation
  add_sql_comment!(super, o.comment)
end


  








  

    #index_in_create(table_name, column_name, options)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 99



def index_in_create(table_name, column_name, options)
  index, _ = @conn.add_index_options(table_name, column_name, **options)
  accept(index)
end


  








  

    #mariadb?  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 7



delegate :add_sql_comment!, :mariadb?, to: :@conn, private: true


  








  

    #visit_AddColumnDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 18



def visit_AddColumnDefinition(o)
  add_column_position!(super, column_options(o.column))
end


  








  

    #visit_ChangeColumnDefaultDefinition(o)   (private)
  

  [ GitHub ]


  

  


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



def visit_ChangeColumnDefaultDefinition(o)
  sql = +"ALTER COLUMN #{quote_column_name(o.column.name)} "
  if o.default.nil? && !o.column.null
    sql << "DROP DEFAULT"
  else
    sql << "SET DEFAULT #{quote_default_expression(o.default, o.column)}"
  end
end


  








  

    #visit_ChangeColumnDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 22



def visit_ChangeColumnDefinition(o)
  change_column_sql = +"CHANGE #{quote_column_name(o.name)} #{accept(o.column)}"
  add_column_position!(change_column_sql, column_options(o.column))
end


  








  

    #visit_CreateIndexDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 36



def visit_CreateIndexDefinition(o)
  sql = visit_IndexDefinition(o.index, true)
  sql << " #{o.algorithm}" if o.algorithm
  sql
end


  








  

    #visit_DropCheckConstraint(name)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 14



def visit_DropCheckConstraint(name)
  "DROP #{mariadb? ? 'CONSTRAINT' : 'CHECK'} #{name}"
end


  








  

    #visit_DropForeignKey(name)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 10



def visit_DropForeignKey(name)
  "DROP FOREIGN KEY #{name}"
end


  








  

    #visit_IndexDefinition(o, create = false)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/mysql/schema_creation.rb', line 42



def visit_IndexDefinition(o, create = false)
  index_type = o.type&.to_s&.upcase || o.unique && "UNIQUE"

  sql = create ? ["CREATE"] : []
  sql << index_type if index_type
  sql << "INDEX"
  sql << quote_column_name(o.name)
  sql << "USING #{o.using}" if o.using
  sql << "ON #{quote_table_name(o.table)}" if create
  sql << "(#{quoted_columns(o)})"

  add_sql_comment!(sql.join(" "), o.comment)
end