discourse/migrations/lib/database/schema/table_writer.rb
Gerhard Schlager 5b3dbb2c6f DEV: Add ability to generate enums for IntermediateDB
This also adds the ability to generate YARD documentation for IntermediateDB models.
2025-10-01 15:25:28 +02:00

111 lines
3.2 KiB
Ruby

# frozen_string_literal: true
module Migrations::Database::Schema
class TableWriter
def initialize(output_stream)
@output = output_stream
end
def output_file_header(header)
@output.puts header.gsub(/^/, "-- ")
@output.puts
end
def output_table(table)
output_create_table_statement(table) { output_table_definitions(table) }
output_indexes(table)
@output.puts ""
end
private
def output_create_table_statement(table)
@output.puts "CREATE TABLE #{escape_identifier(table.name)}"
@output.puts "("
yield
@output.puts ");"
end
def output_table_definitions(table)
definitions = create_column_definitions(table)
if table.primary_key_column_names.size > 1
primary_key_column_names =
table.primary_key_column_names.map { |name| escape_identifier(name) }.join(", ")
definitions << " PRIMARY KEY (#{primary_key_column_names})"
end
if table.constraints&.any?
definitions.concat(
table.constraints.map do |constraint|
" CONSTRAINT #{escape_identifier(constraint.name)} CHECK (#{constraint.condition})"
end,
)
end
@output.puts definitions.join(",\n")
end
def create_column_definitions(table)
columns = table.sorted_columns
has_composite_primary_key = table.primary_key_column_names.size > 1
max_column_name_length = columns.map { |c| escape_identifier(c.name).length }.max
max_datatype_length = columns.map { |c| convert_datatype(c.datatype, c.enum).length }.max
columns.map do |c|
definition = [
escape_identifier(c.name).ljust(max_column_name_length),
convert_datatype(c.datatype, c.enum).ljust(max_datatype_length),
]
if c.is_primary_key && !has_composite_primary_key
definition << "NOT NULL" if c.datatype != :integer
definition << "PRIMARY KEY"
else
definition << "NOT NULL" unless c.nullable
end
definition = definition.join(" ")
definition.strip!
" #{definition}"
end
end
def convert_datatype(type, enum)
case type
when :blob, :boolean, :date, :datetime, :float, :integer, :numeric, :text
datatype = type.to_s.upcase
enum ? "ENUM_#{datatype}" : datatype
when :inet
"INET_TEXT"
when :json
"JSON_TEXT"
else
raise "Unknown datatype: #{type}"
end
end
def escape_identifier(identifier)
::Migrations::Database::Schema.escape_identifier(identifier)
end
def output_indexes(table)
return unless table.indexes
@output.puts ""
table.indexes.each do |index|
index_name = escape_identifier(index.name)
table_name = escape_identifier(table.name)
column_names = index.column_names.map { |name| escape_identifier(name) }
@output.print "CREATE "
@output.print "UNIQUE " if index.unique
@output.print "INDEX #{index_name} ON #{table_name} (#{column_names.join(", ")})"
@output.print " #{index.condition}" if index.condition.present?
@output.puts ";"
end
end
end
end