123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::PostgreSQL::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/postgresql/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

Alias for SchemaCreation#visit_DropConstraint.
#visit_DropConstraint,
#visit_DropForeignKey

Alias for SchemaCreation#visit_DropConstraint.
#visit_ForeignKeyDefinition, #visit_PrimaryKeyDefinition, #visit_TableDefinition

Constructor Details

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

Instance Attribute Details

#quoted_include_columns_for_index (readonly)

[ GitHub ] 

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 8



delegate :quoted_include_columns_for_index, to: :@conn


  







Instance Method Details



  

    #add_column_options!(sql, options)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 123



def add_column_options!(sql, options)
  if options[:collation]
    sql << " COLLATE \"#{options[:collation]}\""
  end

  if as = options[:as]
    sql << " GENERATED ALWAYS AS (#{as})"

    if options[:stored]
      sql << " STORED"
    else
      raise ArgumentError, <<~MSG
        PostgreSQL currently does not support VIRTUAL (not persisted) generated columns.
        Specify 'stored: true' option for '#{options[:column].name}'
      MSG
    end
  end
  super
end


  








  

    #quoted_include_columns(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 143



def quoted_include_columns(o)
  String === o ? o : quoted_include_columns_for_index(o)
end


  








  

    #table_modifier_in_create(o)   (private)
  



  

    

Returns any SQL string to go between CREATE and TABLE. May be nil.


  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 148



def table_modifier_in_create(o)
  # A table cannot be both TEMPORARY and UNLOGGED, since all TEMPORARY
  # tables are already UNLOGGED.
  if o.temporary
    " TEMPORARY"
  elsif o.unlogged
    " UNLOGGED"
  end
end


  








  

    #visit_AddExclusionConstraint(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 70



def visit_AddExclusionConstraint(o)
  "ADD #{accept(o)}"
end


  








  

    #visit_AddForeignKey(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 17



def visit_AddForeignKey(o)
  super.dup.tap do |sql|
    sql << " NOT VALID" unless o.validate?
  end
end


  








  

    #visit_AddUniqueConstraint(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 74



def visit_AddUniqueConstraint(o)
  "ADD #{accept(o)}"
end


  








  

    #visit_AlterTable(o)   (private)
  

  [ GitHub ]


  

  


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



def visit_AlterTable(o)
  sql = super
  sql << o.constraint_validations.map { |fk| visit_ValidateConstraint fk }.join(" ")
  sql << o.exclusion_constraint_adds.map { |con| visit_AddExclusionConstraint con }.join(" ")
  sql << o.unique_constraint_adds.map { |con| visit_AddUniqueConstraint con }.join(" ")
end


  








  

    #visit_ChangeColumnDefaultDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 114



def visit_ChangeColumnDefaultDefinition(o)
  sql = +"ALTER COLUMN #{quote_column_name(o.column.name)} "
  if o.default.nil?
    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/postgresql/schema_creation.rb', line 78



def visit_ChangeColumnDefinition(o)
  column = o.column
  column.sql_type = type_to_sql(column.type, **column.options)
  quoted_column_name = quote_column_name(o.name)

  change_column_sql = +"ALTER COLUMN #{quoted_column_name} TYPE #{column.sql_type}"

  options = column_options(column)

  if options[:collation]
    change_column_sql << " COLLATE \"#{options[:collation]}\""
  end

  if options[:using]
    change_column_sql << " USING #{options[:using]}"
  elsif options[:cast_as]
    cast_as_type = type_to_sql(options[:cast_as], **options)
    change_column_sql << " USING CAST(#{quoted_column_name} AS #{cast_as_type})"
  end

  if options.key?(:default)
    if options[:default].nil?
      change_column_sql << ", ALTER COLUMN #{quoted_column_name} DROP DEFAULT"
    else
      quoted_default = quote_default_expression(options[:default], column)
      change_column_sql << ", ALTER COLUMN #{quoted_column_name} SET DEFAULT #{quoted_default}"
    end
  end

  if options.key?(:null)
    change_column_sql << ", ALTER COLUMN #{quoted_column_name} #{options[:null] ? 'DROP' : 'SET'} NOT NULL"
  end

  change_column_sql
end


  








  

    #visit_CheckConstraintDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 29



def visit_CheckConstraintDefinition(o)
  super.dup.tap { |sql| sql << " NOT VALID" unless o.validate? }
end


  








  

    #visit_ExclusionConstraintDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 37



def visit_ExclusionConstraintDefinition(o)
  sql = ["CONSTRAINT"]
  sql << quote_column_name(o.name)
  sql << "EXCLUDE"
  sql << "USING #{o.using}" if o.using
  sql << "(#{o.expression})"
  sql << "WHERE (#{o.where})" if o.where
  sql << "DEFERRABLE INITIALLY #{o.deferrable.to_s.upcase}" if o.deferrable

  sql.join(" ")
end


  








  

    #visit_ForeignKeyDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 23



def visit_ForeignKeyDefinition(o)
  super.dup.tap do |sql|
    sql << " DEFERRABLE INITIALLY #{o.deferrable.to_s.upcase}" if o.deferrable
  end
end


  








  

    #visit_UniqueConstraintDefinition(o)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 49



def visit_UniqueConstraintDefinition(o)
  column_name = Array(o.column).map { |column| quote_column_name(column) }.join(", ")

  sql = ["CONSTRAINT"]
  sql << quote_column_name(o.name)
  sql << "UNIQUE"
  sql << "NULLS NOT DISTINCT" if supports_nulls_not_distinct? && o.nulls_not_distinct

  if o.using_index
    sql << "USING INDEX #{quote_column_name(o.using_index)}"
  else
    sql << "(#{column_name})"
  end

  if o.deferrable
    sql << "DEFERRABLE INITIALLY #{o.deferrable.to_s.upcase}"
  end

  sql.join(" ")
end


  








  

    #visit_ValidateConstraint(name)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/schema_creation.rb', line 33



def visit_ValidateConstraint(name)
  "VALIDATE CONSTRAINT #{quote_column_name(name)}"
end