skyward-orm 0.2.0 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +182 -75
- data/lib/skyward/orm/adapters/postgresql/connection.rb +52 -0
- data/lib/skyward/orm/adapters/postgresql.rb +283 -0
- data/lib/skyward/orm/adapters/sqlite/constraints.rb +172 -0
- data/lib/skyward/orm/adapters/sqlite.rb +317 -0
- data/lib/skyward/orm/adapters.rb +38 -0
- data/lib/skyward/orm/catalog/column.rb +12 -0
- data/lib/skyward/orm/catalog/constraint.rb +13 -0
- data/lib/skyward/orm/catalog/index.rb +11 -0
- data/lib/skyward/orm/catalog/table.rb +10 -0
- data/lib/skyward/orm/catalog.rb +6 -0
- data/lib/skyward/orm/cli/boot_file.rb +43 -0
- data/lib/skyward/orm/cli/migrate.rb +30 -0
- data/lib/skyward/orm/cli/migration.rb +111 -0
- data/lib/skyward/orm/cli/rollback.rb +18 -0
- data/lib/skyward/orm/cli/status.rb +36 -0
- data/lib/skyward/orm/cli.rb +4 -0
- data/lib/skyward/orm/commands.rb +64 -0
- data/lib/skyward/orm/connection/database/schema_check.rb +67 -0
- data/lib/skyward/orm/connection/database.rb +357 -0
- data/lib/skyward/orm/connection/pool.rb +102 -0
- data/lib/skyward/orm/connection/session.rb +38 -0
- data/lib/skyward/orm/connection.rb +7 -0
- data/lib/skyward/orm/members.rb +16 -0
- data/lib/skyward/orm/migration_error.rb +4 -0
- data/lib/skyward/orm/migrations/add_column.rb +7 -0
- data/lib/skyward/orm/migrations/add_constraint.rb +7 -0
- data/lib/skyward/orm/migrations/add_index.rb +7 -0
- data/lib/skyward/orm/migrations/alter_table.rb +12 -0
- data/lib/skyward/orm/migrations/change_default.rb +9 -0
- data/lib/skyward/orm/migrations/change_nullable.rb +8 -0
- data/lib/skyward/orm/migrations/change_type.rb +9 -0
- data/lib/skyward/orm/migrations/create_table.rb +8 -0
- data/lib/skyward/orm/migrations/definitions.rb +176 -0
- data/lib/skyward/orm/migrations/diff.rb +213 -0
- data/lib/skyward/orm/migrations/directory.rb +48 -0
- data/lib/skyward/orm/migrations/discovery.rb +14 -0
- data/lib/skyward/orm/migrations/drop_column.rb +7 -0
- data/lib/skyward/orm/migrations/drop_constraint.rb +7 -0
- data/lib/skyward/orm/migrations/drop_index.rb +7 -0
- data/lib/skyward/orm/migrations/rename_column.rb +8 -0
- data/lib/skyward/orm/migrations/runner/edited.rb +7 -0
- data/lib/skyward/orm/migrations/runner/failed.rb +8 -0
- data/lib/skyward/orm/migrations/runner/irreversible.rb +7 -0
- data/lib/skyward/orm/migrations/runner/locked.rb +8 -0
- data/lib/skyward/orm/migrations/runner/migration.rb +11 -0
- data/lib/skyward/orm/migrations/runner/missing.rb +7 -0
- data/lib/skyward/orm/migrations/runner/raced.rb +7 -0
- data/lib/skyward/orm/migrations/runner.rb +227 -0
- data/lib/skyward/orm/migrations/script.rb +350 -0
- data/lib/skyward/orm/migrations/status.rb +93 -0
- data/lib/skyward/orm/migrations/summary.rb +110 -0
- data/lib/skyward/orm/migrations/versions.rb +19 -0
- data/lib/skyward/orm/migrations.rb +8 -0
- data/lib/skyward/orm/placeholders.rb +37 -0
- data/lib/skyward/orm/pool_timeout.rb +4 -0
- data/lib/skyward/orm/projection.rb +67 -0
- data/lib/skyward/orm/queries/clauses.rb +588 -0
- data/lib/skyward/orm/queries.rb +4 -0
- data/lib/skyward/orm/query.rb +26 -0
- data/lib/skyward/orm/record.rb +96 -0
- data/lib/skyward/orm/schema_mismatch.rb +4 -0
- data/lib/skyward/orm/statements.rb +97 -0
- data/lib/skyward/orm/tables/check.rb +8 -0
- data/lib/skyward/orm/tables/column.rb +10 -0
- data/lib/skyward/orm/tables/column_types.rb +74 -0
- data/lib/skyward/orm/tables/declarations.rb +172 -0
- data/lib/skyward/orm/tables/length.rb +8 -0
- data/lib/skyward/orm/tables/loaded.rb +21 -0
- data/lib/skyward/orm/tables/reference.rb +9 -0
- data/lib/skyward/orm/tables/rows.rb +52 -0
- data/lib/skyward/orm/tables/schema.rb +14 -0
- data/lib/skyward/orm/tables/sql.rb +7 -0
- data/lib/skyward/orm/tables/validation.rb +29 -0
- data/lib/skyward/orm/tables/values.rb +102 -0
- data/lib/skyward/orm/tables.rb +7 -0
- data/lib/skyward/orm/transactional.rb +18 -0
- data/lib/skyward/orm/version.rb +1 -1
- data/lib/skyward/orm/violation.rb +13 -0
- data/lib/skyward/orm/violation_error.rb +13 -0
- data/lib/skyward/orm.rb +72 -1
- data/sig/generated/skyward/orm/adapters/postgresql/connection.rbs +41 -0
- data/sig/generated/skyward/orm/adapters/postgresql.rbs +138 -0
- data/sig/generated/skyward/orm/adapters/sqlite/constraints.rbs +87 -0
- data/sig/generated/skyward/orm/adapters/sqlite.rbs +166 -0
- data/sig/generated/skyward/orm/adapters.rbs +15 -0
- data/sig/generated/skyward/orm/catalog/column.rbs +20 -0
- data/sig/generated/skyward/orm/catalog/constraint.rbs +22 -0
- data/sig/generated/skyward/orm/catalog/index.rbs +20 -0
- data/sig/generated/skyward/orm/catalog/table.rbs +20 -0
- data/sig/generated/skyward/orm/catalog.rbs +5 -0
- data/sig/generated/skyward/orm/cli/boot_file.rbs +21 -0
- data/sig/generated/skyward/orm/cli/migrate.rbs +15 -0
- data/sig/generated/skyward/orm/cli/migration.rbs +45 -0
- data/sig/generated/skyward/orm/cli/rollback.rbs +7 -0
- data/sig/generated/skyward/orm/cli/status.rbs +17 -0
- data/sig/generated/skyward/orm/cli.rbs +4 -0
- data/sig/generated/skyward/orm/commands.rbs +2 -0
- data/sig/generated/skyward/orm/connection/database/schema_check.rbs +31 -0
- data/sig/generated/skyward/orm/connection/database.rbs +226 -0
- data/sig/generated/skyward/orm/connection/pool.rbs +54 -0
- data/sig/generated/skyward/orm/connection/session.rbs +25 -0
- data/sig/generated/skyward/orm/connection.rbs +7 -0
- data/sig/generated/skyward/orm/members.rbs +9 -0
- data/sig/generated/skyward/orm/migration_error.rbs +4 -0
- data/sig/generated/skyward/orm/migrations/add_column.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/add_constraint.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/add_index.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/alter_table.rbs +22 -0
- data/sig/generated/skyward/orm/migrations/change_default.rbs +18 -0
- data/sig/generated/skyward/orm/migrations/change_nullable.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/change_type.rbs +18 -0
- data/sig/generated/skyward/orm/migrations/create_table.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/definitions.rbs +81 -0
- data/sig/generated/skyward/orm/migrations/diff.rbs +99 -0
- data/sig/generated/skyward/orm/migrations/directory.rbs +37 -0
- data/sig/generated/skyward/orm/migrations/discovery.rbs +9 -0
- data/sig/generated/skyward/orm/migrations/drop_column.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/drop_constraint.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/drop_index.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/rename_column.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/runner/edited.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner/failed.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/runner/irreversible.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner/locked.rbs +16 -0
- data/sig/generated/skyward/orm/migrations/runner/migration.rbs +22 -0
- data/sig/generated/skyward/orm/migrations/runner/missing.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner/raced.rbs +14 -0
- data/sig/generated/skyward/orm/migrations/runner.rbs +73 -0
- data/sig/generated/skyward/orm/migrations/script.rbs +161 -0
- data/sig/generated/skyward/orm/migrations/status.rbs +49 -0
- data/sig/generated/skyward/orm/migrations/summary.rbs +50 -0
- data/sig/generated/skyward/orm/migrations/versions.rbs +11 -0
- data/sig/generated/skyward/orm/migrations.rbs +7 -0
- data/sig/generated/skyward/orm/placeholders.rbs +21 -0
- data/sig/generated/skyward/orm/pool_timeout.rbs +4 -0
- data/sig/generated/skyward/orm/projection.rbs +42 -0
- data/sig/generated/skyward/orm/queries/clauses.rbs +367 -0
- data/sig/generated/skyward/orm/queries.rbs +4 -0
- data/sig/generated/skyward/orm/query.rbs +20 -0
- data/sig/generated/skyward/orm/record.rbs +80 -0
- data/sig/generated/skyward/orm/schema_mismatch.rbs +4 -0
- data/sig/generated/skyward/orm/statements.rbs +53 -0
- data/sig/generated/skyward/orm/tables/check.rbs +16 -0
- data/sig/generated/skyward/orm/tables/column.rbs +20 -0
- data/sig/generated/skyward/orm/tables/column_types.rbs +39 -0
- data/sig/generated/skyward/orm/tables/declarations.rbs +87 -0
- data/sig/generated/skyward/orm/tables/length.rbs +16 -0
- data/sig/generated/skyward/orm/tables/loaded.rbs +14 -0
- data/sig/generated/skyward/orm/tables/reference.rbs +18 -0
- data/sig/generated/skyward/orm/tables/rows.rbs +24 -0
- data/sig/generated/skyward/orm/tables/schema.rbs +28 -0
- data/sig/generated/skyward/orm/tables/sql.rbs +14 -0
- data/sig/generated/skyward/orm/tables/validation.rbs +9 -0
- data/sig/generated/skyward/orm/tables/values.rbs +49 -0
- data/sig/generated/skyward/orm/tables.rbs +7 -0
- data/sig/generated/skyward/orm/transactional.rbs +11 -0
- data/sig/generated/skyward/orm/violation.rbs +22 -0
- data/sig/generated/skyward/orm/violation_error.rbs +10 -0
- data/sig/generated/skyward/orm.rbs +29 -0
- data/sig/manual/pg.rbs +31 -0
- data/sig/manual/skyward/orm/adapters/postgresql.rbs +3 -0
- data/sig/manual/skyward/orm/adapters/sqlite/constraints.rbs +3 -0
- data/sig/manual/skyward/orm/adapters/sqlite.rbs +3 -0
- data/sig/manual/skyward/orm/adapters.rbs +3 -0
- data/sig/manual/skyward/orm/cli/boot_file.rbs +3 -0
- data/sig/manual/skyward/orm/cli/migrate.rbs +3 -0
- data/sig/manual/skyward/orm/cli/migration.rbs +3 -0
- data/sig/manual/skyward/orm/cli/rollback.rbs +3 -0
- data/sig/manual/skyward/orm/cli/status.rbs +3 -0
- data/sig/manual/skyward/orm/connection/database/schema_check.rbs +3 -0
- data/sig/manual/skyward/orm/members.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/definitions.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/diff.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/directory.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/discovery.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/runner.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/script.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/status.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/summary.rbs +3 -0
- data/sig/manual/skyward/orm/migrations/versions.rbs +3 -0
- data/sig/manual/skyward/orm/placeholders.rbs +3 -0
- data/sig/manual/skyward/orm/statements.rbs +3 -0
- data/sig/manual/skyward/orm/tables/loaded.rbs +3 -0
- data/sig/manual/skyward/orm/tables/rows.rbs +3 -0
- data/sig/manual/skyward/orm/tables/validation.rbs +3 -0
- data/sig/manual/skyward/orm/tables/values.rbs +3 -0
- data/sig/manual/skyward/orm.rbs +45 -0
- data/sig/manual/sqlite3.rbs +23 -0
- metadata +188 -3
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "digest"
|
|
4
|
+
|
|
5
|
+
module Skyward::ORM::Migrations::Runner
|
|
6
|
+
extend self
|
|
7
|
+
|
|
8
|
+
# @rbs!
|
|
9
|
+
# type outcome = Array[String] | Edited | Locked | Failed
|
|
10
|
+
# type unrolled = :nothing | Missing | Irreversible | Raced | Locked | Failed
|
|
11
|
+
# type rolled_back = String | unrolled
|
|
12
|
+
|
|
13
|
+
TABLE = Skyward::ORM::Migrations::Versions::TABLE #: Symbol
|
|
14
|
+
|
|
15
|
+
DOWN = /^[ \t]*-- down[ \t]*$/ #: Regexp
|
|
16
|
+
|
|
17
|
+
# @rbs path: String
|
|
18
|
+
# @rbs return: Array[Migration]
|
|
19
|
+
def read(path)
|
|
20
|
+
Skyward::ORM::Migrations::Directory.sql_files(path).map do |file|
|
|
21
|
+
parse(file, File.read(File.join(path, file)))
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# Line endings are normalised first, so a checkout that converts them
|
|
26
|
+
# doesn't read as an edit.
|
|
27
|
+
# @rbs file: String
|
|
28
|
+
# @rbs source: String
|
|
29
|
+
# @rbs return: Migration
|
|
30
|
+
def parse(file, source)
|
|
31
|
+
up, _, down = source.gsub("\r\n", "\n").partition(DOWN)
|
|
32
|
+
Migration.new(
|
|
33
|
+
file:,
|
|
34
|
+
version: Skyward::ORM::Migrations::Directory.version(file),
|
|
35
|
+
up:,
|
|
36
|
+
down:,
|
|
37
|
+
checksum: Digest::SHA256.hexdigest(up)
|
|
38
|
+
)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
# @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::_Connection connection, Array[Migration] migrations) -> outcome
|
|
42
|
+
def run(adapter, connection, migrations)
|
|
43
|
+
# Only when it's missing: on SQLite, even committing nothing under the
|
|
44
|
+
# migration lock fails while another connection reads.
|
|
45
|
+
refused = create_table(adapter, connection) unless adapter.tables(connection).any? { |table| table.name == TABLE }
|
|
46
|
+
if refused
|
|
47
|
+
return migrations.empty? ? [] : Locked.new(file: migrations.fetch(0).file, message: refused)
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
ran = connection.execute("SELECT version, checksum FROM #{TABLE}").to_h
|
|
51
|
+
# A migration that ran but whose file is gone doesn't stop the rest, so old
|
|
52
|
+
# migrations can be squashed.
|
|
53
|
+
changed = migrations.reject { |migration| ran.fetch(migration.version, migration.checksum) == migration.checksum }
|
|
54
|
+
return Edited.new(files: changed.map(&:file)) unless changed.empty?
|
|
55
|
+
|
|
56
|
+
none = [] #: Array[String]
|
|
57
|
+
migrations.reject { |migration| ran.key?(migration.version) }.reduce(none) do |versions, migration|
|
|
58
|
+
applied = apply(adapter, connection, migration) do
|
|
59
|
+
# Another migrator can run it between reading what has run and taking
|
|
60
|
+
# the lock, so it's checked again now the lock is held.
|
|
61
|
+
pending?(adapter, connection, migration) && change(adapter, connection, migration, migration.up) do
|
|
62
|
+
connection.execute(
|
|
63
|
+
"INSERT INTO #{TABLE} (version, checksum) VALUES (#{adapter.placeholder(1)}, #{adapter.placeholder(2)})",
|
|
64
|
+
[migration.version, migration.checksum]
|
|
65
|
+
)
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
case applied
|
|
69
|
+
when Locked, Failed then return applied
|
|
70
|
+
when true then [*versions, migration.version]
|
|
71
|
+
else versions
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::_Connection connection, Array[Migration] migrations)
|
|
77
|
+
# -> rolled_back
|
|
78
|
+
def rollback(adapter, connection, migrations)
|
|
79
|
+
version = latest(connection) if adapter.tables(connection).any? { |table| table.name == TABLE }
|
|
80
|
+
return :nothing unless version
|
|
81
|
+
|
|
82
|
+
migration = migrations.find { |candidate| candidate.version == version }
|
|
83
|
+
return Missing.new(version:) unless migration
|
|
84
|
+
return Irreversible.new(file: migration.file) if migration.down.strip.empty?
|
|
85
|
+
|
|
86
|
+
undone = apply(adapter, connection, migration) do
|
|
87
|
+
# Another migrator can run or roll back one between reading the latest
|
|
88
|
+
# and taking the lock, so it's read again now the lock is held.
|
|
89
|
+
latest(connection) == version && change(adapter, connection, migration, migration.down) do
|
|
90
|
+
connection.execute("DELETE FROM #{TABLE} WHERE version = #{adapter.placeholder(1)}", [version])
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
case undone
|
|
94
|
+
when Locked, Failed then undone
|
|
95
|
+
when true then version
|
|
96
|
+
else Raced.new(file: migration.file)
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# @rbs failure: Edited | Locked | Failed
|
|
101
|
+
# @rbs return: String
|
|
102
|
+
def message(failure)
|
|
103
|
+
case failure
|
|
104
|
+
when Edited
|
|
105
|
+
files = failure.files.map { |file| " #{file}\n" }.join
|
|
106
|
+
"These migrations changed after they ran, so none ran:\n#{files}" \
|
|
107
|
+
"Put each back as it was, and make the change in a new migration. Only a -- down section can change."
|
|
108
|
+
when Locked
|
|
109
|
+
"#{failure.file} couldn't take the migration lock, which another migrator may hold, so neither it nor any " \
|
|
110
|
+
"later migration ran: #{failure.message}"
|
|
111
|
+
else "#{failure.file} failed, so it was rolled back and no later migration ran: #{failure.message}"
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# @rbs failure: unrolled
|
|
116
|
+
# @rbs return: String
|
|
117
|
+
def rollback_message(failure)
|
|
118
|
+
case failure
|
|
119
|
+
when :nothing then "No migration has run, so there's nothing to roll back."
|
|
120
|
+
when Missing
|
|
121
|
+
"#{failure.version} is the latest migration to have run, but its file is gone, so it can't be rolled back. " \
|
|
122
|
+
"Put its file back to roll it back."
|
|
123
|
+
when Irreversible
|
|
124
|
+
"#{failure.file} has nothing in its -- down section, so it wasn't rolled back. " \
|
|
125
|
+
"Write the SQL that undoes it there."
|
|
126
|
+
when Raced
|
|
127
|
+
"#{failure.file} isn't the latest migration anymore, since another migrator ran or rolled back one while " \
|
|
128
|
+
"this one waited for the lock, so it wasn't rolled back."
|
|
129
|
+
when Locked
|
|
130
|
+
"#{failure.file} couldn't take the migration lock, which another migrator may hold, so it wasn't rolled back: " \
|
|
131
|
+
"#{failure.message}"
|
|
132
|
+
else "Rolling back #{failure.file} failed, so its -- down section was undone and it still counts as run: " \
|
|
133
|
+
"#{failure.message}"
|
|
134
|
+
end
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
private
|
|
138
|
+
|
|
139
|
+
# Made under the migration lock, since two migrators making it at once on
|
|
140
|
+
# PostgreSQL can collide in its catalog, and IF NOT EXISTS doesn't stop that.
|
|
141
|
+
# Returns the database's message when the lock can't be taken.
|
|
142
|
+
# @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::_Connection connection) -> String?
|
|
143
|
+
def create_table(adapter, connection)
|
|
144
|
+
connection.execute_batch(adapter.begin_migration)
|
|
145
|
+
rescue StandardError => e
|
|
146
|
+
cancel(connection)
|
|
147
|
+
e.message
|
|
148
|
+
else
|
|
149
|
+
settled = false
|
|
150
|
+
begin
|
|
151
|
+
connection.execute(
|
|
152
|
+
"CREATE TABLE IF NOT EXISTS #{TABLE} (version TEXT PRIMARY KEY, checksum TEXT NOT NULL, " \
|
|
153
|
+
"ran_at #{adapter.sql_type(:time)} NOT NULL DEFAULT CURRENT_TIMESTAMP)"
|
|
154
|
+
)
|
|
155
|
+
connection.execute("COMMIT")
|
|
156
|
+
settled = true
|
|
157
|
+
ensure
|
|
158
|
+
cancel(connection) unless settled
|
|
159
|
+
end
|
|
160
|
+
nil
|
|
161
|
+
ensure
|
|
162
|
+
connection.execute_batch(adapter.end_migration)
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::_Connection connection, Migration migration)
|
|
166
|
+
# { () -> (bool | Failed) } -> (bool | Locked | Failed)
|
|
167
|
+
def apply(adapter, connection, migration, &)
|
|
168
|
+
connection.execute_batch(adapter.begin_migration)
|
|
169
|
+
rescue StandardError => e
|
|
170
|
+
# PostgreSQL leaves the transaction open when the lock is what failed.
|
|
171
|
+
cancel(connection)
|
|
172
|
+
Locked.new(file: migration.file, message: e.message)
|
|
173
|
+
else
|
|
174
|
+
run_locked(connection, migration, &)
|
|
175
|
+
ensure
|
|
176
|
+
connection.execute_batch(adapter.end_migration)
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# Rolled back in ensure rather than rescue, so a migration left by throw or a
|
|
180
|
+
# killed thread rolls back too, before foreign keys go back on.
|
|
181
|
+
# @rbs (Skyward::ORM::_Connection connection, Migration migration) { () -> (bool | Failed) } -> (bool | Failed)
|
|
182
|
+
def run_locked(connection, migration)
|
|
183
|
+
settled = false
|
|
184
|
+
begin
|
|
185
|
+
applied = yield
|
|
186
|
+
connection.execute(applied.is_a?(Failed) ? "ROLLBACK" : "COMMIT")
|
|
187
|
+
settled = true
|
|
188
|
+
applied
|
|
189
|
+
rescue StandardError => e
|
|
190
|
+
Failed.new(file: migration.file, message: e.message)
|
|
191
|
+
ensure
|
|
192
|
+
cancel(connection) unless settled
|
|
193
|
+
end
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
# SQLite ends the transaction itself on some failures, such as ON CONFLICT
|
|
197
|
+
# ROLLBACK, and then ROLLBACK raises, though the outcome is already decided.
|
|
198
|
+
# @rbs (Skyward::ORM::_Connection connection) -> void
|
|
199
|
+
def cancel(connection)
|
|
200
|
+
connection.execute("ROLLBACK")
|
|
201
|
+
rescue StandardError
|
|
202
|
+
nil
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
# @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::_Connection connection, Migration migration) -> bool
|
|
206
|
+
def pending?(adapter, connection, migration)
|
|
207
|
+
connection.execute("SELECT 1 FROM #{TABLE} WHERE version = #{adapter.placeholder(1)}", [migration.version]).empty?
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Versions sort in filename order, which is the order they ran in, so the
|
|
211
|
+
# greatest is the latest.
|
|
212
|
+
# @rbs (Skyward::ORM::_Connection connection) -> String?
|
|
213
|
+
def latest(connection) = connection.execute("SELECT max(version) FROM #{TABLE}").dig(0, 0)
|
|
214
|
+
|
|
215
|
+
# @rbs (Skyward::ORM::_Adapter adapter, Skyward::ORM::_Connection connection, Migration migration, String section)
|
|
216
|
+
# { () -> void } -> (true | Failed)
|
|
217
|
+
def change(adapter, connection, migration, section)
|
|
218
|
+
connection.execute_batch(section)
|
|
219
|
+
violations = adapter.foreign_key_violations(connection)
|
|
220
|
+
if violations.any?
|
|
221
|
+
return Failed.new(file: migration.file, message: "foreign key check failed: #{violations.join(", ")}")
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
yield
|
|
225
|
+
true
|
|
226
|
+
end
|
|
227
|
+
end
|
|
@@ -0,0 +1,350 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Migrations::Script
|
|
4
|
+
extend self
|
|
5
|
+
|
|
6
|
+
# @rbs changes: Array[Skyward::ORM::Migrations::change]
|
|
7
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
8
|
+
# @rbs return: String
|
|
9
|
+
def write(changes, adapter)
|
|
10
|
+
up = changes.map { |change| up(change, adapter) }.join("\n")
|
|
11
|
+
down = changes.reverse.map { |change| down(change, adapter) }.join
|
|
12
|
+
"#{up}\n-- down\n#{down}"
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
private
|
|
16
|
+
|
|
17
|
+
# @rbs change: Skyward::ORM::Migrations::change
|
|
18
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
19
|
+
# @rbs return: String
|
|
20
|
+
def up(change, adapter)
|
|
21
|
+
case change
|
|
22
|
+
when Skyward::ORM::Migrations::CreateTable
|
|
23
|
+
klass = change.klass
|
|
24
|
+
"#{create_table(klass, change.columns, adapter, klass.table_name, {})}#{indexes(klass)}"
|
|
25
|
+
else
|
|
26
|
+
return rebuild(change, adapter) unless in_place?(change, adapter)
|
|
27
|
+
|
|
28
|
+
change.edits.map { |edit| forward(change, edit, adapter) }.join
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# @rbs change: Skyward::ORM::Migrations::change
|
|
33
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
34
|
+
# @rbs return: String
|
|
35
|
+
def down(change, adapter)
|
|
36
|
+
case change
|
|
37
|
+
when Skyward::ORM::Migrations::CreateTable then "DROP TABLE #{change.klass.table_name};\n"
|
|
38
|
+
else
|
|
39
|
+
return unbuild(change) unless in_place?(change, adapter)
|
|
40
|
+
|
|
41
|
+
change.edits.reverse.map { |edit| backward(change, edit) }.join
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# SQLite can't alter a column or a constraint, so only what ALTER TABLE does
|
|
46
|
+
# on every database is done in place: adding, dropping and renaming a
|
|
47
|
+
# column, and indexes. It can't add a key column, or one whose default is an
|
|
48
|
+
# expression, either.
|
|
49
|
+
# @rbs change: Skyward::ORM::Migrations::AlterTable
|
|
50
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
51
|
+
# @rbs return: bool
|
|
52
|
+
def in_place?(change, adapter)
|
|
53
|
+
schema = change.klass.schema
|
|
54
|
+
adapter.alters_in_place? || change.edits.all? do |edit|
|
|
55
|
+
case edit
|
|
56
|
+
when Skyward::ORM::Migrations::AddColumn
|
|
57
|
+
name = edit.column.name
|
|
58
|
+
!(schema.primary_key == name || schema.uniques.include?([name]) ||
|
|
59
|
+
schema.defaults[name].is_a?(Skyward::ORM::Tables::SQL))
|
|
60
|
+
when Skyward::ORM::Migrations::DropColumn, Skyward::ORM::Migrations::RenameColumn,
|
|
61
|
+
Skyward::ORM::Migrations::AddIndex, Skyward::ORM::Migrations::DropIndex then true
|
|
62
|
+
else false
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# PostgreSQL changes a column's type with USING, which casts each value it has.
|
|
68
|
+
# @rbs change: Skyward::ORM::Migrations::AlterTable
|
|
69
|
+
# @rbs edit: Skyward::ORM::Migrations::edit
|
|
70
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
71
|
+
# @rbs return: String
|
|
72
|
+
def forward(change, edit, adapter)
|
|
73
|
+
klass = change.klass
|
|
74
|
+
table = klass.table_name
|
|
75
|
+
case edit
|
|
76
|
+
when Skyward::ORM::Migrations::AddColumn then add_column(klass, change.columns, edit.column, adapter)
|
|
77
|
+
when Skyward::ORM::Migrations::DropColumn then "ALTER TABLE #{table} DROP COLUMN #{edit.column.name};\n"
|
|
78
|
+
when Skyward::ORM::Migrations::RenameColumn then rename(table, edit.from, edit.to)
|
|
79
|
+
when Skyward::ORM::Migrations::ChangeType then retype(table, edit.column, edit.to)
|
|
80
|
+
when Skyward::ORM::Migrations::ChangeNullable then nullable(table, edit.column, edit.nullable)
|
|
81
|
+
when Skyward::ORM::Migrations::ChangeDefault then default(table, edit.column, edit.to)
|
|
82
|
+
when Skyward::ORM::Migrations::AddConstraint then add_constraint(table, edit.constraint)
|
|
83
|
+
when Skyward::ORM::Migrations::DropConstraint then drop_constraint(table, edit.constraint)
|
|
84
|
+
when Skyward::ORM::Migrations::AddIndex then "#{edit.index.definition};\n"
|
|
85
|
+
else "DROP INDEX #{edit.index.name};\n"
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# @rbs change: Skyward::ORM::Migrations::AlterTable
|
|
90
|
+
# @rbs edit: Skyward::ORM::Migrations::edit
|
|
91
|
+
# @rbs return: String
|
|
92
|
+
def backward(change, edit)
|
|
93
|
+
table = change.klass.table_name
|
|
94
|
+
case edit
|
|
95
|
+
when Skyward::ORM::Migrations::AddColumn then "ALTER TABLE #{table} DROP COLUMN #{edit.column.name};\n"
|
|
96
|
+
when Skyward::ORM::Migrations::DropColumn
|
|
97
|
+
"#{restored(table, edit.column)}ALTER TABLE #{table} ADD COLUMN #{column(edit.column)};\n"
|
|
98
|
+
when Skyward::ORM::Migrations::RenameColumn then rename(table, edit.to, edit.from)
|
|
99
|
+
when Skyward::ORM::Migrations::ChangeType then retype(table, edit.column, edit.from)
|
|
100
|
+
when Skyward::ORM::Migrations::ChangeNullable then nullable(table, edit.column, !edit.nullable)
|
|
101
|
+
when Skyward::ORM::Migrations::ChangeDefault then default(table, edit.column, edit.from)
|
|
102
|
+
when Skyward::ORM::Migrations::AddConstraint then drop_constraint(table, edit.constraint)
|
|
103
|
+
when Skyward::ORM::Migrations::DropConstraint then add_constraint(table, edit.constraint)
|
|
104
|
+
when Skyward::ORM::Migrations::AddIndex then "DROP INDEX #{edit.index.name};\n"
|
|
105
|
+
else "#{edit.index.definition};\n"
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# SQLite rebuilds the table as its class has it: create the new one, copy
|
|
110
|
+
# the rows of each column it keeps, drop the old one, rename the new one and
|
|
111
|
+
# recreate its indexes. Dropping a table another one references would run
|
|
112
|
+
# that one's ON DELETE, so `skyward migrate` turns SQLite's foreign keys off
|
|
113
|
+
# around each migration, and checks them before it commits.
|
|
114
|
+
# @rbs change: Skyward::ORM::Migrations::AlterTable
|
|
115
|
+
# @rbs adapter: Skyward::ORM::_Adapter
|
|
116
|
+
# @rbs return: String
|
|
117
|
+
def rebuild(change, adapter)
|
|
118
|
+
klass = change.klass
|
|
119
|
+
table = klass.table_name
|
|
120
|
+
moved = renames(change)
|
|
121
|
+
kept = change.table.columns.to_h { |column| [moved.fetch(column.name, column.name), column] }
|
|
122
|
+
copied = change.columns.select { |column| kept.key?(column.name) }
|
|
123
|
+
todos = change.edits.filter_map do |edit|
|
|
124
|
+
case edit
|
|
125
|
+
when Skyward::ORM::Migrations::AddColumn then needs_default(klass, edit.column)
|
|
126
|
+
when Skyward::ORM::Migrations::ChangeNullable then backfill(table, edit.column) unless edit.nullable
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
[
|
|
130
|
+
*todos,
|
|
131
|
+
create_table(klass, change.columns, adapter, :"#{table}_new", kept),
|
|
132
|
+
copy(table, copied.map(&:name), copied.map { |column| kept.fetch(column.name).name }),
|
|
133
|
+
indexes(klass)
|
|
134
|
+
].join
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# The table goes back as the database had it, from what was read of it.
|
|
138
|
+
# @rbs change: Skyward::ORM::Migrations::AlterTable
|
|
139
|
+
# @rbs return: String
|
|
140
|
+
def unbuild(change)
|
|
141
|
+
had = change.table
|
|
142
|
+
table = had.name
|
|
143
|
+
moved = renames(change)
|
|
144
|
+
current = change.columns.map(&:name)
|
|
145
|
+
copied = had.columns.select { |column| current.include?(moved.fetch(column.name, column.name)) }
|
|
146
|
+
restored = change.edits.filter_map do |edit|
|
|
147
|
+
restored(table, edit.column) if edit.is_a?(Skyward::ORM::Migrations::DropColumn)
|
|
148
|
+
end
|
|
149
|
+
name_width = had.columns.map { |column| column.name.length }.max || 0
|
|
150
|
+
type_width = had.columns.map { |column| column.type.length }.max || 0
|
|
151
|
+
lines = [
|
|
152
|
+
*had.columns.map do |column|
|
|
153
|
+
"#{column.name.name.ljust(name_width)} #{column.type.ljust(type_width)} #{clauses(column)}".rstrip
|
|
154
|
+
end,
|
|
155
|
+
*had.constraints.map do |constraint|
|
|
156
|
+
"#{"CONSTRAINT #{constraint.name} " if constraint.name}#{constraint.definition}"
|
|
157
|
+
end
|
|
158
|
+
]
|
|
159
|
+
[
|
|
160
|
+
*restored,
|
|
161
|
+
"CREATE TABLE #{table}_new (\n#{lines.map { |line| " #{line}" }.join(",\n")}\n);\n",
|
|
162
|
+
copy(table, copied.map(&:name), copied.map { |column| moved.fetch(column.name, column.name) }),
|
|
163
|
+
*had.indexes.map { |index| "#{index.definition};\n" }
|
|
164
|
+
].join
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
# @rbs change: Skyward::ORM::Migrations::AlterTable
|
|
168
|
+
# @rbs return: Hash[Symbol, Symbol]
|
|
169
|
+
def renames(change)
|
|
170
|
+
pairs = change.edits.filter_map do |edit|
|
|
171
|
+
case edit
|
|
172
|
+
when Skyward::ORM::Migrations::RenameColumn then [edit.from, edit.to]
|
|
173
|
+
end
|
|
174
|
+
end #: Array[[Symbol, Symbol]]
|
|
175
|
+
pairs.to_h
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
# @rbs table: Symbol
|
|
179
|
+
# @rbs into: Array[Symbol]
|
|
180
|
+
# @rbs from: Array[Symbol]
|
|
181
|
+
# @rbs return: String
|
|
182
|
+
def copy(table, into, from)
|
|
183
|
+
"INSERT INTO #{table}_new (#{into.join(", ")}) SELECT #{from.join(", ")} FROM #{table};\n" \
|
|
184
|
+
"DROP TABLE #{table};\n" \
|
|
185
|
+
"ALTER TABLE #{table}_new RENAME TO #{table};\n"
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# Columns line up as a person would write them. A generated key's type runs
|
|
189
|
+
# on into its identity clause, so it doesn't set the width. A rebuild keeps
|
|
190
|
+
# the type an untyped column has.
|
|
191
|
+
# @rbs (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns,
|
|
192
|
+
# Skyward::ORM::_Adapter adapter, Symbol name, Hash[Symbol, Skyward::ORM::Catalog::Column] kept) -> String
|
|
193
|
+
def create_table(klass, columns, adapter, name, kept)
|
|
194
|
+
schema = klass.schema
|
|
195
|
+
constraints = Skyward::ORM::Migrations::Definitions.constraints(klass, columns)
|
|
196
|
+
name_width = columns.map { |column| column.name.length }.max || 0
|
|
197
|
+
identity = adapter.identity
|
|
198
|
+
type_width = columns.reject { |column| identity && generated?(schema, column) }
|
|
199
|
+
.filter_map { |column| (adapter.sql_type(column.type) || kept[column.name]&.type)&.length }
|
|
200
|
+
.max || 0
|
|
201
|
+
lines = columns.map do |column|
|
|
202
|
+
found = definition(klass, column, adapter, constraints, kept[column.name])
|
|
203
|
+
next [false, todo_type(klass.table_name, column)] unless found
|
|
204
|
+
|
|
205
|
+
spec, clauses = found
|
|
206
|
+
[true, "#{column.name.name.ljust(name_width)} #{spec.ljust(type_width)} #{clauses}".rstrip]
|
|
207
|
+
end #: Array[[bool, String]]
|
|
208
|
+
table_constraints = constraints.reject { |constraint| constraint.columns.one? }.map do |constraint|
|
|
209
|
+
[true, "CONSTRAINT #{constraint.name} #{constraint.definition}"]
|
|
210
|
+
end #: Array[[bool, String]]
|
|
211
|
+
entries = [*lines, *table_constraints]
|
|
212
|
+
last = entries.rindex { |definition, _| definition }
|
|
213
|
+
body = entries.each_with_index.map do |(definition, text), index|
|
|
214
|
+
" #{text}#{"," if definition && index != last}\n"
|
|
215
|
+
end
|
|
216
|
+
["CREATE TABLE #{name} (\n", *body, ");\n"].join
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
# @rbs klass: singleton(Skyward::ORM::Record)
|
|
220
|
+
# @rbs return: String
|
|
221
|
+
def indexes(klass)
|
|
222
|
+
Skyward::ORM::Migrations::Definitions.indexes(klass).map { |index| "#{index.definition};\n" }.join
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# @rbs (singleton(Skyward::ORM::Record) klass, Array[Skyward::ORM::Tables::Column] columns,
|
|
226
|
+
# Skyward::ORM::Tables::Column column, Skyward::ORM::_Adapter adapter) -> String
|
|
227
|
+
def add_column(klass, columns, column, adapter)
|
|
228
|
+
table = klass.table_name
|
|
229
|
+
constraints = Skyward::ORM::Migrations::Definitions.constraints(klass, columns)
|
|
230
|
+
found = definition(klass, column, adapter, constraints, nil)
|
|
231
|
+
return "#{todo_type(table, column)}\n" unless found
|
|
232
|
+
|
|
233
|
+
spec, clauses = found
|
|
234
|
+
"#{needs_default(klass, column)}ALTER TABLE #{table} ADD COLUMN #{"#{column.name} #{spec} #{clauses}".rstrip};\n"
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# A column's type, and the clauses that follow it, or nil when it has no
|
|
238
|
+
# type. One with no type keeps the one the table has, if it has one.
|
|
239
|
+
# @rbs (singleton(Skyward::ORM::Record) klass, Skyward::ORM::Tables::Column column, Skyward::ORM::_Adapter adapter,
|
|
240
|
+
# Array[Skyward::ORM::Catalog::Constraint] constraints, Skyward::ORM::Catalog::Column? kept) -> [String, String]?
|
|
241
|
+
def definition(klass, column, adapter, constraints, kept)
|
|
242
|
+
typed = adapter.sql_type(column.type)
|
|
243
|
+
sql_type = typed || kept&.type
|
|
244
|
+
return unless sql_type
|
|
245
|
+
|
|
246
|
+
name = column.name
|
|
247
|
+
generated = generated?(klass.schema, column)
|
|
248
|
+
default = Skyward::ORM::Migrations::Definitions.default(klass, name, adapter)
|
|
249
|
+
clauses = [
|
|
250
|
+
("NOT NULL" unless (typed ? column.nullable : kept&.nullable) || generated),
|
|
251
|
+
("DEFAULT #{default}" if default),
|
|
252
|
+
*constraints.select { |constraint| constraint.columns == [name] }
|
|
253
|
+
.map { |constraint| Skyward::ORM::Migrations::Definitions.inline(constraint) }
|
|
254
|
+
].compact
|
|
255
|
+
[[sql_type, (adapter.identity if generated)].compact.join(" "), clauses.join(" ")]
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
# @rbs schema: Skyward::ORM::Tables::Schema
|
|
259
|
+
# @rbs column: Skyward::ORM::Tables::Column
|
|
260
|
+
# @rbs return: bool
|
|
261
|
+
def generated?(schema, column) = schema.primary_key == column.name && column.type == :integer
|
|
262
|
+
|
|
263
|
+
# A column as the database has it.
|
|
264
|
+
# @rbs column: Skyward::ORM::Catalog::Column
|
|
265
|
+
# @rbs return: String
|
|
266
|
+
def column(column) = [column.name, (column.type unless column.type.empty?), clauses(column)].compact.join(" ").rstrip
|
|
267
|
+
|
|
268
|
+
# @rbs column: Skyward::ORM::Catalog::Column
|
|
269
|
+
# @rbs return: String
|
|
270
|
+
def clauses(column)
|
|
271
|
+
[("NOT NULL" unless column.nullable), ("DEFAULT #{column.default}" if column.default)].compact.join(" ")
|
|
272
|
+
end
|
|
273
|
+
|
|
274
|
+
# @rbs table: Symbol
|
|
275
|
+
# @rbs from: Symbol
|
|
276
|
+
# @rbs to: Symbol
|
|
277
|
+
# @rbs return: String
|
|
278
|
+
def rename(table, from, to) = "ALTER TABLE #{table} RENAME COLUMN #{from} TO #{to};\n"
|
|
279
|
+
|
|
280
|
+
# @rbs table: Symbol
|
|
281
|
+
# @rbs column: Symbol
|
|
282
|
+
# @rbs type: String
|
|
283
|
+
# @rbs return: String
|
|
284
|
+
def retype(table, column, type)
|
|
285
|
+
"ALTER TABLE #{table} ALTER COLUMN #{column} TYPE #{type} USING #{column}::#{type};\n"
|
|
286
|
+
end
|
|
287
|
+
|
|
288
|
+
# @rbs table: Symbol
|
|
289
|
+
# @rbs column: Symbol
|
|
290
|
+
# @rbs nullable: bool
|
|
291
|
+
# @rbs return: String
|
|
292
|
+
def nullable(table, column, nullable)
|
|
293
|
+
return "ALTER TABLE #{table} ALTER COLUMN #{column} DROP NOT NULL;\n" if nullable
|
|
294
|
+
|
|
295
|
+
"#{backfill(table, column)}ALTER TABLE #{table} ALTER COLUMN #{column} SET NOT NULL;\n"
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# @rbs table: Symbol
|
|
299
|
+
# @rbs column: Symbol
|
|
300
|
+
# @rbs value: String?
|
|
301
|
+
# @rbs return: String
|
|
302
|
+
def default(table, column, value)
|
|
303
|
+
"ALTER TABLE #{table} ALTER COLUMN #{column} #{value ? "SET DEFAULT #{value}" : "DROP DEFAULT"};\n"
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# @rbs table: Symbol
|
|
307
|
+
# @rbs constraint: Skyward::ORM::Catalog::Constraint
|
|
308
|
+
# @rbs return: String
|
|
309
|
+
def add_constraint(table, constraint)
|
|
310
|
+
"ALTER TABLE #{table} ADD #{"CONSTRAINT #{constraint.name} " if constraint.name}#{constraint.definition};\n"
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# @rbs table: Symbol
|
|
314
|
+
# @rbs constraint: Skyward::ORM::Catalog::Constraint
|
|
315
|
+
# @rbs return: String
|
|
316
|
+
def drop_constraint(table, constraint) = "ALTER TABLE #{table} DROP CONSTRAINT #{constraint.name};\n"
|
|
317
|
+
|
|
318
|
+
# The rows a table already has need a value for a new required column.
|
|
319
|
+
# @rbs klass: singleton(Skyward::ORM::Record)
|
|
320
|
+
# @rbs column: Skyward::ORM::Tables::Column
|
|
321
|
+
# @rbs return: String?
|
|
322
|
+
def needs_default(klass, column)
|
|
323
|
+
return if column.nullable || klass.schema.defaults.key?(column.name)
|
|
324
|
+
|
|
325
|
+
todo_default(klass.table_name, column.name)
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
# @rbs table: Symbol
|
|
329
|
+
# @rbs column: Skyward::ORM::Catalog::Column
|
|
330
|
+
# @rbs return: String
|
|
331
|
+
def restored(table, column)
|
|
332
|
+
"-- #{table}.#{column.name} comes back empty: dropping it lost its data\n" \
|
|
333
|
+
"#{todo_default(table, column.name) unless column.nullable || column.default}"
|
|
334
|
+
end
|
|
335
|
+
|
|
336
|
+
# @rbs table: Symbol
|
|
337
|
+
# @rbs column: Symbol
|
|
338
|
+
# @rbs return: String
|
|
339
|
+
def todo_default(table, column) = "-- TODO: #{table}.#{column} needs a DEFAULT for the rows #{table} already has\n"
|
|
340
|
+
|
|
341
|
+
# @rbs table: Symbol
|
|
342
|
+
# @rbs column: Symbol
|
|
343
|
+
# @rbs return: String
|
|
344
|
+
def backfill(table, column) = "-- TODO: backfill the NULLs in #{table}.#{column} before it becomes NOT NULL\n"
|
|
345
|
+
|
|
346
|
+
# @rbs table: Symbol
|
|
347
|
+
# @rbs column: Skyward::ORM::Tables::Column
|
|
348
|
+
# @rbs return: String
|
|
349
|
+
def todo_type(table, column) = "-- TODO: #{table}.#{column.name} needs a type"
|
|
350
|
+
end
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Skyward::ORM::Migrations::Status
|
|
4
|
+
extend self
|
|
5
|
+
|
|
6
|
+
# @rbs!
|
|
7
|
+
# type state = :ran | :pending | :edited | :gone
|
|
8
|
+
|
|
9
|
+
STATES = {
|
|
10
|
+
ran: "ran",
|
|
11
|
+
pending: "pending",
|
|
12
|
+
edited: "edited after it ran",
|
|
13
|
+
gone: "ran, but its file is gone"
|
|
14
|
+
}.freeze #: Hash[state, String]
|
|
15
|
+
|
|
16
|
+
NONE = "No migrations yet.\n" #: String
|
|
17
|
+
|
|
18
|
+
CLEAN = "Nothing is pending, and every table matches its class.\n" #: String
|
|
19
|
+
|
|
20
|
+
# A migration whose file is gone is named by its version, which is all the
|
|
21
|
+
# database keeps of its name, and sorts among the files as it did.
|
|
22
|
+
# @rbs migrations: Array[Skyward::ORM::Migrations::Runner::Migration]
|
|
23
|
+
# @rbs ran: Hash[String, String]
|
|
24
|
+
# @rbs return: Array[[String, state]]
|
|
25
|
+
def migrations(migrations, ran)
|
|
26
|
+
files = migrations.map do |migration|
|
|
27
|
+
[migration.file, state(migration, ran[migration.version])] #: [String, state]
|
|
28
|
+
end
|
|
29
|
+
gone = (ran.keys - migrations.map(&:version)).map do |version|
|
|
30
|
+
[version, :gone] #: [String, state]
|
|
31
|
+
end
|
|
32
|
+
[*files, *gone].sort_by(&:first)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# schema_migrations is Skyward ORM's own, so it never needs a class.
|
|
36
|
+
# @rbs tables: Array[Skyward::ORM::Catalog::Table]
|
|
37
|
+
# @rbs classes: Array[singleton(Skyward::ORM::Record)]
|
|
38
|
+
# @rbs return: Array[Symbol]
|
|
39
|
+
def unowned(tables, classes)
|
|
40
|
+
owned = [Skyward::ORM::Migrations::Versions::TABLE, *classes.map(&:table_name)]
|
|
41
|
+
tables.map(&:name).reject { |name| owned.include?(name) }
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# @rbs migrations: Array[[String, state]]
|
|
45
|
+
# @rbs changes: Array[Skyward::ORM::Migrations::change]
|
|
46
|
+
# @rbs unowned: Array[Symbol]
|
|
47
|
+
# @rbs return: bool
|
|
48
|
+
def clean?(migrations, changes, unowned)
|
|
49
|
+
migrations.all? { |_, state| state == :ran } && changes.empty? && unowned.empty?
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# @rbs (Array[[String, state]] migrations, Array[Skyward::ORM::Migrations::change] changes, Array[Symbol] unowned,
|
|
53
|
+
# Skyward::ORM::_Adapter adapter) -> String
|
|
54
|
+
def text(migrations, changes, unowned, adapter)
|
|
55
|
+
[
|
|
56
|
+
listing(migrations),
|
|
57
|
+
Skyward::ORM::Migrations::Summary.text(changes, adapter),
|
|
58
|
+
unowned_text(unowned),
|
|
59
|
+
clean?(migrations, changes, unowned) ? CLEAN : ""
|
|
60
|
+
].join
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
private
|
|
64
|
+
|
|
65
|
+
# @rbs migration: Skyward::ORM::Migrations::Runner::Migration
|
|
66
|
+
# @rbs checksum: String?
|
|
67
|
+
# @rbs return: state
|
|
68
|
+
def state(migration, checksum)
|
|
69
|
+
case checksum
|
|
70
|
+
when nil then :pending
|
|
71
|
+
when migration.checksum then :ran
|
|
72
|
+
else :edited
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# @rbs migrations: Array[[String, state]]
|
|
77
|
+
# @rbs return: String
|
|
78
|
+
def listing(migrations)
|
|
79
|
+
return NONE if migrations.empty?
|
|
80
|
+
|
|
81
|
+
width = migrations.map { |name, _| name.length }.max.to_i
|
|
82
|
+
["Migrations:\n", *migrations.map { |name, state| " #{name.ljust(width)} #{STATES.fetch(state)}\n" }].join
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# @rbs unowned: Array[Symbol]
|
|
86
|
+
# @rbs return: String
|
|
87
|
+
def unowned_text(unowned)
|
|
88
|
+
return "" if unowned.empty?
|
|
89
|
+
|
|
90
|
+
["These tables have no class, so `skyward migration` leaves them alone:\n",
|
|
91
|
+
*unowned.map { |table| " #{table}\n" }].join
|
|
92
|
+
end
|
|
93
|
+
end
|