instance method
rename_table
Ruby on Rails 8.0.4
Since v4.2.9Signature
rename_table(table_name, new_name, **options)
Renames a table. Also renames a table’s primary key sequence if the sequence name exists and matches the Active Record default.
Example:
rename_table('octopuses', 'octopi')
Parameters
-
table_namereq -
new_namereq -
optionskeyrest
Source
# File activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb, line 434
def rename_table(table_name, new_name, **options)
validate_table_length!(new_name) unless options[:_uses_legacy_table_name]
clear_cache!
schema_cache.clear_data_source_cache!(table_name.to_s)
schema_cache.clear_data_source_cache!(new_name.to_s)
execute "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}"
pk, seq = pk_and_sequence_for(new_name)
if pk
# PostgreSQL automatically creates an index for PRIMARY KEY with name consisting of
# truncated table name and "_pkey" suffix fitting into max_identifier_length number of characters.
max_pkey_prefix = max_identifier_length - "_pkey".size
idx = "#{table_name[0, max_pkey_prefix]}_pkey"
new_idx = "#{new_name[0, max_pkey_prefix]}_pkey"
execute "ALTER INDEX #{quote_table_name(idx)} RENAME TO #{quote_table_name(new_idx)}"
# PostgreSQL automatically creates a sequence for PRIMARY KEY with name consisting of
# truncated table name and "#{primary_key}_seq" suffix fitting into max_identifier_length number of characters.
max_seq_prefix = max_identifier_length - "_#{pk}_seq".size
if seq && seq.identifier == "#{table_name[0, max_seq_prefix]}_#{pk}_seq"
new_seq = "#{new_name[0, max_seq_prefix]}_#{pk}_seq"
execute "ALTER TABLE #{seq.quoted} RENAME TO #{quote_table_name(new_seq)}"
end
end
rename_table_indexes(table_name, new_name, **options)
end
Defined in activerecord/lib/active_record/connection_adapters/postgresql/schema_statements.rb line 434
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements