@intentius/chant-lexicon-sql 0.124.48 → 0.124.50

package/src/postgres/testing/roundtrip-schema.ts

@@ -6,7 +6,8 @@
  * domain over its type, a collation, composite and range types (and a
  * multirange column), plain and ordered-set aggregates, a cast and an event
  * trigger, an operator, extended statistics, a foreign data wrapper and server, and a
- * publication (#3911), a partitioned table and a partition, an ORM's
+ * publication (#3911), a foreign table, an operator class and family, a text
+ * search dictionary and configuration (#4406), a partitioned table and a partition, an ORM's
  * revision table that import leaves out, and an object carrying chant's
  * ownership trailer.
  */
@@ -72,5 +73,15 @@ CREATE SERVER app_replica TYPE 'pg' VERSION '16' FOREIGN DATA WRAPPER app_fdw OP
 COMMENT ON SERVER app_replica IS 'The read replica';
 CREATE PUBLICATION app_pub FOR TABLE app.orders, app.users WITH (publish = 'insert, update');
 COMMENT ON PUBLICATION app_pub IS 'Order changes';
+CREATE FOREIGN TABLE app.remote_orders (id integer OPTIONS (column_name 'order_id') NOT NULL, status text DEFAULT 'placed', CONSTRAINT status_known CHECK (status IS NOT NULL)) SERVER app_replica OPTIONS (table_name 'orders');
+COMMENT ON FOREIGN TABLE app.remote_orders IS 'Orders on the replica';
+CREATE OPERATOR CLASS app.int_hash_ops FOR TYPE integer USING hash AS OPERATOR 1 =, FUNCTION 1 hashint4(integer);
+COMMENT ON OPERATOR CLASS app.int_hash_ops USING hash IS 'Hash by value';
+CREATE OPERATOR FAMILY app.spare_ops USING btree;
+CREATE TEXT SEARCH DICTIONARY app.shop_stop (TEMPLATE = simple, StopWords = english);
+CREATE TEXT SEARCH CONFIGURATION app.shop (PARSER = pg_catalog."default");
+ALTER TEXT SEARCH CONFIGURATION app.shop ADD MAPPING FOR asciiword, word WITH app.shop_stop, english_stem;
+ALTER TEXT SEARCH CONFIGURATION app.shop ADD MAPPING FOR int, uint WITH simple;
+COMMENT ON TEXT SEARCH CONFIGURATION app.shop IS 'Shop search';
 CREATE TABLE public._prisma_migrations (id varchar(36) PRIMARY KEY, checksum varchar(64) NOT NULL);
 `;

package/src/postgres.ts

@@ -21,6 +21,11 @@ export {
   trigger,
   eventTrigger,
   operator,
+  operatorClass,
+  operatorFamily,
+  foreignTable,
+  textSearchConfiguration,
+  textSearchDictionary,
   statistics,
   foreignDataWrapper,
   foreignServer,
@@ -55,6 +60,11 @@ export {
   type PostgresCast,
   type PostgresEventTrigger,
   type PostgresOperator,
+  type PostgresOperatorClass,
+  type PostgresOperatorFamily,
+  type PostgresForeignTable,
+  type PostgresTextSearchConfiguration,
+  type PostgresTextSearchDictionary,
   type PostgresStatistics,
   type PostgresForeignDataWrapper,
   type PostgresForeignServer,
@@ -86,6 +96,13 @@ export {
   type CastProps,
   type EventTriggerProps,
   type OperatorProps,
+  type OperatorClassProps,
+  type OperatorClassItemDef,
+  type OperatorFamilyProps,
+  type ForeignTableProps,
+  type TextSearchConfigurationProps,
+  type TextSearchDictionaryProps,
+  type TextSearchMappingDef,
   type StatisticsProps,
   type ForeignDataWrapperProps,
   type ForeignServerProps,

package/src/skills/chant-sql-postgres-migration.md

@@ -121,6 +121,7 @@ The Plan phase refuses, naming each object and what to do, a table or column wit
 - a rename combined with a type change, unless the Op gives `reverse` (the old column's value from the new one); with a default, a serial or an identity as well, run the Op twice, the rename first;
 - a rename of a column with a default, an identity or a serial sequence, unless the Op gives `defaultAtContract: true` (the default lands on the new column at the contract; an explicit NULL into the new name gets the default until then);
 - a column a logical replication publication sends; a column list that leaves it out does not stop the Op (chant #3332);
+- a table that is the target of a logical replication subscription, named in the refusal (chant #4405);
 - a column that needs no migration, where the message says to use the applier.
 
 ## Checking it is done

package/src/skills/chant-sql-postgres.md

@@ -43,6 +43,11 @@ The export name (`users`) is the object's identity in chant. The name in the SQL
 | `trigger` | `CREATE TRIGGER` | `Postgres::Trigger` |
 | `eventTrigger` | `CREATE EVENT TRIGGER` | `Postgres::EventTrigger` |
 | `operator` | `CREATE OPERATOR` | `Postgres::Operator` |
+| `operatorClass` | `CREATE OPERATOR CLASS` | `Postgres::OperatorClass` |
+| `operatorFamily` | `CREATE OPERATOR FAMILY` | `Postgres::OperatorFamily` |
+| `foreignTable` | `CREATE FOREIGN TABLE` | `Postgres::ForeignTable` |
+| `textSearchConfiguration` | `CREATE TEXT SEARCH CONFIGURATION`, then `ALTER TEXT SEARCH CONFIGURATION ... ADD MAPPING` | `Postgres::TextSearchConfiguration` |
+| `textSearchDictionary` | `CREATE TEXT SEARCH DICTIONARY` | `Postgres::TextSearchDictionary` |
 | `statistics` | `CREATE STATISTICS` | `Postgres::Statistics` |
 | `foreignDataWrapper` | `CREATE FOREIGN DATA WRAPPER` | `Postgres::ForeignDataWrapper` |
 | `foreignServer` | `CREATE SERVER` | `Postgres::ForeignServer` |

package/src/sql-files.test.ts

@@ -42,6 +42,39 @@ describe("reading a file of Postgres DDL", () => {
     );
   });
 
+  test("a foreign table, an operator class and a text search configuration with its mappings and comments are each one object (#4406)", () => {
+    const ddl = [
+      "CREATE FOREIGN TABLE app.remote_orders (id int NOT NULL) SERVER replica OPTIONS (table_name 'orders');",
+      "COMMENT ON FOREIGN TABLE app.remote_orders IS 'Orders';",
+      "CREATE OPERATOR CLASS app.int_hash_ops FOR TYPE int USING hash AS OPERATOR 1 =, FUNCTION 1 hashint4(int);",
+      "CREATE OPERATOR FAMILY app.int_hash_ops USING btree;",
+      "COMMENT ON OPERATOR CLASS app.int_hash_ops USING hash IS 'Hash';",
+      "CREATE TEXT SEARCH DICTIONARY app.shop_stop (TEMPLATE = simple, StopWords = english);",
+      "CREATE TEXT SEARCH CONFIGURATION app.shop (PARSER = pg_catalog.default);",
+      "CREATE TEXT SEARCH CONFIGURATION app.shop2 (PARSER = pg_catalog.default);",
+      "ALTER TEXT SEARCH CONFIGURATION app.shop ADD MAPPING FOR word WITH app.shop_stop;",
+      "COMMENT ON TEXT SEARCH CONFIGURATION app.shop2 IS 'Second';",
+    ].join("\n");
+    const objects = readSqlFile("postgres", ddl, { origin: "schema.sql" });
+    expect(objects.map((o) => [o.export, o.type, o.name])).toEqual([
+      ["remoteOrders", "Postgres::ForeignTable", "app.remote_orders"],
+      ["appIntHashOps", "Postgres::OperatorClass", "app.int_hash_ops"],
+      ["appIntHashOps2", "Postgres::OperatorFamily", "app.int_hash_ops"],
+      ["shopStop", "Postgres::TextSearchDictionary", "app.shop_stop"],
+      ["shop", "Postgres::TextSearchConfiguration", "app.shop"],
+      ["shop2", "Postgres::TextSearchConfiguration", "app.shop2"],
+    ]);
+    expect(objects[0]!.ddl).toContain("COMMENT ON FOREIGN TABLE app.remote_orders IS 'Orders'");
+    // A class and a family of one name and two methods are two objects, and each takes only its own comment.
+    expect(objects[1]!.ddl).toContain("COMMENT ON OPERATOR CLASS app.int_hash_ops USING hash IS 'Hash'");
+    expect(objects[2]!.ddl).not.toContain("COMMENT");
+    expect(objects[4]!.ddl).toContain("ADD MAPPING FOR word WITH app.shop_stop");
+    expect(objects[5]!.ddl).toContain("COMMENT ON TEXT SEARCH CONFIGURATION app.shop2 IS 'Second'");
+    expect(objects[5]!.ddl).not.toContain("ADD MAPPING");
+    // A mapping for a configuration the file does not create is named.
+    expect(() => readSqlFile("postgres", "ALTER TEXT SEARCH CONFIGURATION app.x ADD MAPPING FOR word WITH simple;", { origin: "x.sql" })).toThrow(/ALTER TEXT SEARCH CONFIGURATION \.\.\. ADD MAPPING for an object the file does not create/);
+  });
+
   test("a statement that declares nothing or does not parse is an error naming it, and every one is named", () => {
     const read = () => readSqlFile("postgres", "CREATE TABLE a (id int);\nINSERT INTO a VALUES (1);\nCREATE TABLE b (id int,);\nCOMMENT ON TABLE c IS 'x';", { origin: "db/schema.sql" });
     expect(read).toThrow(SqlFileError);

package/src/validate.ts

@@ -48,6 +48,11 @@ const REQUIRED_ENTITIES = [
   "PostgresCast",
   "PostgresEventTrigger",
   "PostgresOperator",
+  "PostgresOperatorClass",
+  "PostgresOperatorFamily",
+  "PostgresForeignTable",
+  "PostgresTextSearchConfiguration",
+  "PostgresTextSearchDictionary",
   "PostgresStatistics",
   "PostgresForeignDataWrapper",
   "PostgresForeignServer",