activerecord-virgodb-adapter 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19cfa01c6fa3ae36139e4412c022abfe3039c670fd4b29fbffdb399f47c8c36d
-  data.tar.gz: 5180372a507b33cd5a51670c3439894efafd72ca8d22538efc5b0a738eeb3937
+  metadata.gz: d70a70ab0e46de3acd4d283c69e7c385873c7bb9ec817423f62ff09dbc601350
+  data.tar.gz: 1f7b6259306a3d61f2e3d05fb345373a5d350b2742309804be1d91ac096886a1
 SHA512:
-  metadata.gz: 4ffee29b035fe6705dd22022056b35e281f4275c9e009075508d136e87b03e804e62db4052ac8d581a010a50036568a6a6299ee7aa03f33137a56c28532b9a81
-  data.tar.gz: 5303c2ceaf69703a4739614f76fd518741ea4555b18cc3bab4276d19c04189e03a9d192b8402dde926f235136bf87ac5e361a331f9e2efc7510f33d761fd19eb
+  metadata.gz: 64c5716aa1f9d1ea110aacd562ad131acb5d8d76bbd4e8d0ed459a2191530d7b27c6c1f924b59a70840defed6f285c668e6fc9a56f97b134719bd2033ed42b6f
+  data.tar.gz: 9f2de20a524c86e2bafc0a43b6f49b8d86bdf127a54b8a5276972f75b10e937c5c7fe3b89b88172eaca32b4aaee09aa0aa52a34f947c614dc3926c3d1878f82e

data/lib/active_record/tasks/virgodb_database_tasks.rb

@@ -72,7 +72,9 @@ module ActiveRecord
 
       def structure_dump(filename, extra_flags)
         super
+        strip_null_autoindex_blank_lines!(filename)
         reformat_create_table_statements!(filename)
+        separate_create_table_statements_with_blank_lines!(filename)
         annotate_physical_layout!(filename)
         dump_schema_versions!(filename)
       end
@@ -194,18 +196,48 @@ module ActiveRecord
         File.write(filename, content)
       end
 
-      # `SQLite3Adapter#structure_dump`'s raw `SELECT sql FROM sqlite_master`
-      # path (used whenever `ActiveRecord::SchemaDumper.ignore_tables` is
+      # `SQLiteDatabaseTasks#structure_dump`'s `ignore_tables`-triggered
+      # fallback (used whenever `ActiveRecord::SchemaDumper.ignore_tables` is
       # non-empty, e.g. excluding tables owned by a separate replication/
-      # backup mechanism) reproduces each CREATE TABLE exactly as SQLite
-      # stored it -- one long line, every column crammed together, for a
-      # table ActiveRecord generated. Fine for SQLite to load back
-      # (structure_load doesn't care about whitespace), useless to a human
-      # reading the dump next to `db/clickhouse_structure.sql` (ClickHouse's
-      # own `SHOW CREATE TABLE` is naturally one-column-per-line, for
-      # comparison). Purely cosmetic, safe to do unconditionally: only
-      # rewrites the exact same statement with different whitespace, no DDL
-      # semantics change.
+      # backup mechanism -- exactly hintpot's own litestream initializer)
+      # runs `SELECT sql || ';' FROM sqlite_master WHERE tbl_name NOT IN
+      # (...) ORDER BY tbl_name, type DESC, name` through the `sqlite3` CLI.
+      # Any table with a non-INTEGER (so non-rowid-alias) PRIMARY KEY --
+      # `maintenance_lease`, `flush_completions`, `ar_internal_metadata`,
+      # `schema_migrations`, all `TEXT PRIMARY KEY` -- gets a second,
+      # *hidden* row in `sqlite_master` for its `sqlite_autoindex_*`, whose
+      # `sql` column is NULL (an autoindex has no CREATE INDEX text of its
+      # own; SQLite generates it implicitly). `NULL || ';'` is NULL, and the
+      # `sqlite3` CLI's default `.nullvalue` prints a NULL result as nothing
+      # -- so each such table silently donates one stray blank line to the
+      # dump, unrelated to any table's real position or content (confirmed
+      # directly against a real `sqlite_master`; every non-blank-line-
+      # producing table here is either INTEGER PRIMARY KEY, a rowid alias
+      # needing no separate index, or has no primary key at all). The other
+      # `structure_dump` path (`.schema --nosys`, taken when
+      # `ignore_tables` is empty) already skips these rows itself --
+      # confirmed empirically too -- so this is purely a gap in the
+      # raw-SQL fallback, not something either path does on purpose.
+      # Stripping now, before `reformat_create_table_statements!` and
+      # `separate_create_table_statements_with_blank_lines!` (below) touch
+      # anything, gives those steps a clean slate -- every blank line in the
+      # dump from this point on is one THEY deliberately added, not this
+      # accidental one.
+      def strip_null_autoindex_blank_lines!(filename)
+        content = File.read(filename)
+        content.gsub!(/\n\n+/, "\n")
+        File.write(filename, content)
+      end
+
+      # Reformats one-line CREATE TABLE statements (both `structure_dump`
+      # paths -- see `strip_null_autoindex_blank_lines!` above for the two --
+      # produce these one column crammed after another) into one column per
+      # line. Fine for SQLite to load back either way (structure_load
+      # doesn't care about whitespace), useless to a human reading the dump
+      # next to `db/clickhouse_structure.sql` (ClickHouse's own `SHOW CREATE
+      # TABLE` is naturally one-column-per-line, for comparison). Purely
+      # cosmetic, safe to do unconditionally: only rewrites the exact same
+      # statement with different whitespace, no DDL semantics change.
       #
       # Must handle statements that ALREADY span multiple lines, not just
       # single-line ones: every virgodb-side manifest table (`crates/
@@ -237,6 +269,29 @@ module ActiveRecord
         File.write(filename, content)
       end
 
+      # Matches `db/clickhouse_structure.sql` and `db/schema.rb`'s own
+      # convention (both, unprompted, separate every top-level table
+      # definition with a blank line -- confirmed directly against
+      # hintpot's real dumps of each, not assumed) rather than inventing a
+      # new one here. Only CREATE TABLE gets a leading blank line, not
+      # CREATE INDEX/CREATE UNIQUE INDEX -- those stay glued directly under
+      # their own table, same as clickhouse_structure.sql has no equivalent
+      # to disagree with and virgodb's own tables (e.g. `inline_batches` +
+      # `idx_inline_batches_table_name`) already read naturally that way.
+      # Runs after `reformat_create_table_statements!` (so every `CREATE
+      # TABLE` is unambiguously alone at the start of its own line already,
+      # nothing left to normalize first) but before
+      # `annotate_physical_layout!` (so a table WITH a physical-layout
+      # comment gets the blank line ahead of the comment block, not
+      # wedged between the comment and its own `CREATE TABLE`).
+      # `(?<!\A)` skips the very first statement in the file, which should
+      # start right at the top with no leading blank line.
+      def separate_create_table_statements_with_blank_lines!(filename)
+        content = File.read(filename)
+        content.gsub!(/(?<!\A)^CREATE TABLE /) { |match| "\n#{match}" }
+        File.write(filename, content)
+      end
+
       # Splits a CREATE TABLE column list on commas that are NOT nested
       # inside a type's own parens (e.g. `Decimal(18,2)`) -- a plain
       # `String#split(",")` would wrongly cut `Decimal(18` and `2)` apart.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-virgodb-adapter
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - virgodb