From 2b646ac710450789fd4828ecd1173522dd84e1ab Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Fri, 13 Nov 2026 22:01:05 +0000 Subject: [PATCH 1/6] fix(deparser): preserve multi-line string literals in pretty mode and parenthesize indirection targets --- __fixtures__/generated/generated.json | 225 +++++++++ .../kitchen-sink/misc/indirection-parens.sql | 115 +++++ .../misc/multiline-string-literals.sql | 447 ++++++++++++++++++ __fixtures__/plpgsql-generated/generated.json | 2 + .../plpgsql/plpgsql_deparser_fixes.sql | 56 +++ packages/deparser/DEPARSER_USAGE.md | 9 +- .../misc-indirection-parens.test.ts | 103 ++++ .../misc-multiline-string-literals.test.ts | 138 ++++++ .../__snapshots__/misc-pretty.test.ts.snap | 197 ++++---- .../triggers-pretty.test.ts.snap | 20 +- packages/deparser/src/deparser.ts | 72 +-- packages/deparser/src/index.ts | 1 + packages/deparser/src/utils/sql-formatter.ts | 98 +++- .../__snapshots__/roundtrip.test.ts.snap | 2 +- packages/pgsql-types/src/field-metadata.json | 37 +- .../__snapshots__/hydrate-demo.test.ts.snap | 2 +- .../plpgsql-deparser/src/plpgsql-deparser.ts | 10 +- .../__snapshots__/roundtrip.test.ts.snap | 2 +- .../__fixtures__/output/kitchen-sink.sql | 4 +- 19 files changed, 1370 insertions(+), 170 deletions(-) create mode 100644 __fixtures__/kitchen-sink/misc/indirection-parens.sql create mode 100644 __fixtures__/kitchen-sink/misc/multiline-string-literals.sql create mode 100644 packages/deparser/__tests__/kitchen-sink/misc-indirection-parens.test.ts create mode 100644 packages/deparser/__tests__/kitchen-sink/misc-multiline-string-literals.test.ts diff --git a/__fixtures__/generated/generated.json b/__fixtures__/generated/generated.json index 4fc2f187a..9192ee89e 100644 --- a/__fixtures__/generated/generated.json +++ b/__fixtures__/generated/generated.json @@ -21543,6 +21543,136 @@ "misc/pg18-copy-18.sql": "COPY t FROM 'it''s.csv'", "misc/pg18-copy-19.sql": "COPY t FROM STDIN WHERE a > 0", "misc/pg18-copy-20.sql": "COPY t FROM STDIN WITH NULL AS 'I''m null'", + "misc/multiline-string-literals-1.sql": "CREATE TABLE t (memo text DEFAULT 'line one\nline two')", + "misc/multiline-string-literals-2.sql": "CREATE TABLE t (id int PRIMARY KEY, memo text NOT NULL DEFAULT 'line one\n line two\n line three', n int)", + "misc/multiline-string-literals-3.sql": "CREATE TABLE t (memo text DEFAULT E'tab\\there\nback\\\\slash\nquote''s')", + "misc/multiline-string-literals-4.sql": "CREATE TABLE t (memo text DEFAULT 'it''s\n''quoted''\n')", + "misc/multiline-string-literals-5.sql": "CREATE TABLE t (memo text DEFAULT '\n')", + "misc/multiline-string-literals-6.sql": "CREATE TABLE t (memo text DEFAULT '\n\nleading and trailing blank lines\n\n')", + "misc/multiline-string-literals-7.sql": "CREATE TABLE t (a text DEFAULT 'first\nliteral', b text DEFAULT 'second\nliteral', c text DEFAULT 'one line')", + "misc/multiline-string-literals-8.sql": "CREATE TABLE t (memo text DEFAULT $body$dollar 'quoted'\n body $$ with\na tag$body$)", + "misc/multiline-string-literals-9.sql": "CREATE TABLE t (memo text DEFAULT 'a\nb' || 'c\nd')", + "misc/multiline-string-literals-10.sql": "CREATE TABLE t (memo text DEFAULT concat('a\nb', upper('c\nd')))", + "misc/multiline-string-literals-11.sql": "CREATE TABLE t (memo text GENERATED ALWAYS AS (other || '\nsuffix') STORED, other text)", + "misc/multiline-string-literals-12.sql": "CREATE TABLE t (memo text CHECK (memo <> 'line one\nline two'))", + "misc/multiline-string-literals-13.sql": "CREATE TABLE t (memo text, CHECK (memo <> 'line one\nline two'))", + "misc/multiline-string-literals-14.sql": "CREATE TABLE t (memo text, kind text, CONSTRAINT memo_ok CHECK (memo <> 'line one\nline two' AND kind IN ('a\nb', 'c') OR memo IS NULL))", + "misc/multiline-string-literals-15.sql": "CREATE TABLE t (memo text, CONSTRAINT memo_ok CHECK (memo <> 'line one\nline two') NOT VALID, CONSTRAINT memo_len CHECK (length(memo) < 10))", + "misc/multiline-string-literals-16.sql": "CREATE TABLE s.t (\n id uuid PRIMARY KEY DEFAULT gen_random_uuid(),\n memo text NOT NULL DEFAULT 'line one\nline two',\n kind text NOT NULL DEFAULT 'plain',\n owner_id uuid REFERENCES s.owners (id) ON DELETE CASCADE,\n CONSTRAINT memo_ok CHECK (memo <> 'x\ny'),\n UNIQUE (owner_id, kind)\n)", + "misc/multiline-string-literals-17.sql": "CREATE DOMAIN d AS text DEFAULT 'a\nb' CHECK (VALUE <> 'c\nd')", + "misc/multiline-string-literals-18.sql": "ALTER TABLE t ALTER COLUMN memo SET DEFAULT 'line one\nline two'", + "misc/multiline-string-literals-19.sql": "ALTER TABLE t ADD COLUMN memo text DEFAULT 'line one\nline two'", + "misc/multiline-string-literals-20.sql": "ALTER TABLE t ADD COLUMN memo text NOT NULL DEFAULT 'line one\nline two' CHECK (memo <> 'x\ny')", + "misc/multiline-string-literals-21.sql": "ALTER TABLE t ADD CONSTRAINT memo_ok CHECK (memo <> 'line one\nline two')", + "misc/multiline-string-literals-22.sql": "ALTER TABLE t ADD CONSTRAINT memo_ok CHECK (memo <> 'line one\nline two' AND memo <> 'x\ny') NOT VALID", + "misc/multiline-string-literals-23.sql": "ALTER TABLE t ALTER COLUMN memo TYPE text USING coalesce(memo, 'line one\nline two')", + "misc/multiline-string-literals-24.sql": "ALTER TABLE t ADD COLUMN a text DEFAULT 'a\nb', ALTER COLUMN c SET DEFAULT 'c\nd', ADD CONSTRAINT e CHECK (c <> 'e\nf')", + "misc/multiline-string-literals-25.sql": "ALTER DOMAIN d SET DEFAULT 'a\nb'", + "misc/multiline-string-literals-26.sql": "ALTER DOMAIN d ADD CONSTRAINT c CHECK (VALUE <> 'a\nb')", + "misc/multiline-string-literals-27.sql": "CREATE POLICY p ON t USING (memo = 'line one\nline two')", + "misc/multiline-string-literals-28.sql": "CREATE POLICY p ON t FOR INSERT WITH CHECK (memo = 'line one\nline two')", + "misc/multiline-string-literals-29.sql": "CREATE POLICY p ON s.t AS RESTRICTIVE FOR UPDATE TO authenticated USING (memo = 'line one\nline two' AND owner_id = current_user_id()) WITH CHECK (memo <> 'x\ny' OR kind = 'k\nl')", + "misc/multiline-string-literals-30.sql": "CREATE POLICY p ON t FOR SELECT USING (EXISTS (SELECT 1 FROM u WHERE u.memo = 'line one\nline two' AND u.id = t.id))", + "misc/multiline-string-literals-31.sql": "ALTER POLICY p ON t USING (memo = 'line one\nline two') WITH CHECK (memo = 'x\ny')", + "misc/multiline-string-literals-32.sql": "CREATE TRIGGER trg BEFORE UPDATE ON t FOR EACH ROW WHEN (new.memo = 'line one\nline two') EXECUTE FUNCTION f()", + "misc/multiline-string-literals-33.sql": "CREATE TRIGGER trg AFTER INSERT OR UPDATE OF memo ON s.t FOR EACH ROW WHEN (new.memo IS DISTINCT FROM 'line one\nline two' AND old.memo <> 'x\ny') EXECUTE FUNCTION s.f('arg one\narg two', 'b')", + "misc/multiline-string-literals-34.sql": "CREATE TRIGGER trg BEFORE INSERT ON t FOR EACH ROW EXECUTE FUNCTION f('arg one\narg two')", + "misc/multiline-string-literals-35.sql": "CREATE CONSTRAINT TRIGGER trg AFTER INSERT ON t DEFERRABLE INITIALLY DEFERRED FOR EACH ROW WHEN (new.memo = 'a\nb') EXECUTE FUNCTION f()", + "misc/multiline-string-literals-36.sql": "CREATE RULE r AS ON INSERT TO t WHERE new.memo = 'a\nb' DO INSTEAD INSERT INTO u (memo) VALUES ('c\nd')", + "misc/multiline-string-literals-37.sql": "CREATE RULE r AS ON UPDATE TO t DO ALSO (INSERT INTO u (memo) VALUES ('c\nd'); UPDATE v SET memo = 'e\nf' WHERE id = new.id)", + "misc/multiline-string-literals-38.sql": "INSERT INTO t (id, memo) VALUES (1, 'line one\nline two')", + "misc/multiline-string-literals-39.sql": "INSERT INTO t (id, memo) VALUES (1, 'a\nb'), (2, 'c\nd'), (3, 'e')", + "misc/multiline-string-literals-40.sql": "INSERT INTO t (id, memo) VALUES (1, 'a') ON CONFLICT (id) DO UPDATE SET memo = 'line one\nline two'", + "misc/multiline-string-literals-41.sql": "INSERT INTO t (id, memo, kind) VALUES (1, 'a\nb', 'k') ON CONFLICT (id) WHERE kind = 'k\nl' DO UPDATE SET memo = excluded.memo || '\nappended', kind = 'x\ny' WHERE t.memo <> 'p\nq' RETURNING memo, 'r\ns' AS tag", + "misc/multiline-string-literals-42.sql": "INSERT INTO t (id, memo) SELECT id, 'line one\nline two' FROM u WHERE memo = 'x\ny'", + "misc/multiline-string-literals-43.sql": "INSERT INTO t (memo) VALUES ('a\nb') ON CONFLICT ON CONSTRAINT t_pkey DO NOTHING RETURNING 'c\nd'", + "misc/multiline-string-literals-44.sql": "WITH src AS (SELECT 'a\nb' AS memo) INSERT INTO t (memo) SELECT memo FROM src ON CONFLICT (memo) DO UPDATE SET memo = 'c\nd'", + "misc/multiline-string-literals-45.sql": "UPDATE t SET memo = 'line one\nline two' WHERE id = 1", + "misc/multiline-string-literals-46.sql": "UPDATE t SET memo = 'a\nb', kind = 'c\nd' FROM u WHERE u.id = t.id AND u.memo = 'e\nf' RETURNING t.memo, 'g\nh'", + "misc/multiline-string-literals-47.sql": "UPDATE t SET (memo, kind) = ('a\nb', 'c\nd') WHERE id = 1", + "misc/multiline-string-literals-48.sql": "UPDATE t SET memo = (SELECT 'a\nb' FROM u WHERE u.memo = 'c\nd' LIMIT 1) WHERE id IN (SELECT id FROM v WHERE memo = 'e\nf')", + "misc/multiline-string-literals-49.sql": "DELETE FROM t WHERE memo = 'line one\nline two'", + "misc/multiline-string-literals-50.sql": "DELETE FROM t USING u WHERE t.id = u.id AND u.memo = 'a\nb' AND t.memo = 'c\nd' RETURNING 'e\nf'", + "misc/multiline-string-literals-51.sql": "MERGE INTO t USING u ON t.id = u.id AND u.memo = 'a\nb' WHEN MATCHED AND t.memo = 'c\nd' THEN UPDATE SET memo = 'e\nf' WHEN NOT MATCHED THEN INSERT (id, memo) VALUES (u.id, 'g\nh')", + "misc/multiline-string-literals-52.sql": "SELECT 'line one\nline two'", + "misc/multiline-string-literals-53.sql": "SELECT 'a\nb' AS x, 'c\nd' AS y, id FROM t", + "misc/multiline-string-literals-54.sql": "SELECT id FROM t WHERE memo = 'line one\nline two'", + "misc/multiline-string-literals-55.sql": "SELECT id FROM t WHERE memo = 'a\nb' AND kind = 'c\nd' OR (memo <> 'e\nf' AND kind IS NULL)", + "misc/multiline-string-literals-56.sql": "SELECT id FROM t WHERE memo IN ('a\nb', 'c\nd') AND kind LIKE 'e\n%' AND memo BETWEEN 'f\ng' AND 'h\ni'", + "misc/multiline-string-literals-57.sql": "SELECT t.id FROM t JOIN u ON u.id = t.id AND u.memo = 'a\nb' LEFT JOIN v ON v.id = t.id AND v.memo = 'c\nd' AND v.kind = 'a long enough condition to be wrapped onto its own line'", + "misc/multiline-string-literals-58.sql": "SELECT kind, count(*) FROM t GROUP BY kind, memo || 'a\nb' HAVING max(memo) = 'c\nd' ORDER BY kind || 'e\nf', 2 LIMIT 5", + "misc/multiline-string-literals-59.sql": "SELECT DISTINCT ON (memo || 'a\nb') memo FROM t", + "misc/multiline-string-literals-60.sql": "SELECT * FROM (SELECT 'a\nb' AS memo, id FROM t WHERE kind = 'c\nd') sub WHERE sub.memo = 'e\nf'", + "misc/multiline-string-literals-61.sql": "SELECT * FROM t WHERE EXISTS (SELECT 1 FROM u WHERE u.memo = 'a\nb' AND u.id = t.id) AND id = ANY (SELECT id FROM v WHERE memo = 'c\nd')", + "misc/multiline-string-literals-62.sql": "SELECT 'a\nb' UNION ALL SELECT 'c\nd' UNION ALL SELECT memo FROM t WHERE memo = 'e\nf'", + "misc/multiline-string-literals-63.sql": "SELECT * FROM (VALUES (1, 'a\nb'), (2, 'c\nd')) AS v (id, memo)", + "misc/multiline-string-literals-64.sql": "VALUES (1, 'a\nb'), (2, 'c\nd')", + "misc/multiline-string-literals-65.sql": "SELECT * FROM f('a\nb', 'c') AS x, LATERAL g(x.id, 'd\ne') AS y", + "misc/multiline-string-literals-66.sql": "SELECT 'a\nb'::text, CAST('c\nd' AS varchar(20)), text 'e\nf'", + "misc/multiline-string-literals-67.sql": "SELECT E'a\\nb\nc', U&'d\\0061\ne', B'101', X'1F', N'f\ng'", + "misc/multiline-string-literals-68.sql": "SELECT $$dollar\nquoted$$, $tag$with 'quotes'\nand $$ inside$tag$", + "misc/multiline-string-literals-69.sql": "SELECT 'trailing space \nand\ttab\n', ' leading spaces\n kept'", + "misc/multiline-string-literals-70.sql": "SELECT \"quoted\nidentifier\" FROM \"quoted\ntable\" AS \"alias\nname\" WHERE \"quoted\nidentifier\" = 'a\nb'", + "misc/multiline-string-literals-71.sql": "SELECT CASE WHEN memo = 'a\nb' THEN 'c\nd' WHEN kind = 'k' THEN 'one line' ELSE 'e\nf' END FROM t", + "misc/multiline-string-literals-72.sql": "SELECT CASE memo WHEN 'a\nb' THEN 1 ELSE 2 END, CASE WHEN id > 1 THEN CASE WHEN memo = 'c\nd' THEN 'e\nf' ELSE 'g' END END FROM t", + "misc/multiline-string-literals-73.sql": "SELECT concat('a\nb', memo, 'c\nd'), coalesce(memo, 'e\nf'), nullif(memo, 'g\nh'), greatest('i\nj', memo) FROM t", + "misc/multiline-string-literals-74.sql": "SELECT string_agg(memo, ',\n' ORDER BY memo || 'a\nb') FILTER (WHERE memo <> 'c\nd') FROM t", + "misc/multiline-string-literals-75.sql": "SELECT count(*) FILTER (WHERE memo = 'a\nb') OVER (PARTITION BY kind || 'c\nd' ORDER BY memo || 'e\nf' ROWS BETWEEN 1 PRECEDING AND CURRENT ROW) FROM t", + "misc/multiline-string-literals-76.sql": "SELECT lag(memo, 1, 'a\nb') OVER w FROM t WINDOW w AS (PARTITION BY memo = 'c\nd' ORDER BY id)", + "misc/multiline-string-literals-77.sql": "SELECT format('%s\n%s', 'a', 'b'), regexp_replace(memo, '\\s\n', 'x\ny', 'g') FROM t", + "misc/multiline-string-literals-78.sql": "SELECT f(a => 'a\nb', b := 'c\nd')", + "misc/multiline-string-literals-79.sql": "SELECT ARRAY['a\nb', 'c\nd'], ARRAY[ARRAY['e\nf'], ARRAY['g']], ROW('h\ni', 2), ('j\nk', 'l')", + "misc/multiline-string-literals-80.sql": "SELECT * FROM t WHERE (memo, kind) = ('a\nb', 'c\nd') AND memo = ANY (ARRAY['e\nf', 'g'])", + "misc/multiline-string-literals-81.sql": "SELECT '{\"a\nb\",\"c\"}'::text[], '{\"k\": \"v\nw\"}'::jsonb -> 'k', jsonb_build_object('a\nb', 'c\nd')", + "misc/multiline-string-literals-82.sql": "WITH a AS (SELECT 'a\nb' AS memo) SELECT memo FROM a WHERE memo = 'c\nd'", + "misc/multiline-string-literals-83.sql": "WITH a AS (SELECT 'a\nb' AS memo), b AS (SELECT memo FROM a WHERE memo <> 'c\nd'), c AS MATERIALIZED (SELECT 'one line' AS memo) SELECT * FROM b UNION ALL SELECT 'e\nf' FROM c", + "misc/multiline-string-literals-84.sql": "WITH RECURSIVE r (n, memo) AS (SELECT 1, 'a\nb' UNION ALL SELECT n + 1, memo || 'c\nd' FROM r WHERE n < 3) SELECT * FROM r", + "misc/multiline-string-literals-85.sql": "WITH upd AS (UPDATE t SET memo = 'a\nb' WHERE memo = 'c\nd' RETURNING id), del AS (DELETE FROM u WHERE memo = 'e\nf' RETURNING id) SELECT * FROM upd, del", + "misc/multiline-string-literals-86.sql": "CREATE VIEW v AS SELECT id, 'line one\nline two' AS memo FROM t WHERE kind = 'a\nb'", + "misc/multiline-string-literals-87.sql": "CREATE OR REPLACE VIEW s.v (id, memo) WITH (security_barrier = true) AS SELECT id, CASE WHEN memo = 'a\nb' THEN 'c\nd' ELSE memo END FROM t WHERE memo <> 'e\nf' WITH CHECK OPTION", + "misc/multiline-string-literals-88.sql": "CREATE MATERIALIZED VIEW mv AS SELECT 'a\nb' AS memo FROM t WHERE memo = 'c\nd' WITH NO DATA", + "misc/multiline-string-literals-89.sql": "CREATE TABLE t2 AS SELECT 'a\nb' AS memo FROM t WHERE memo = 'c\nd'", + "misc/multiline-string-literals-90.sql": "SELECT 'a\nb' AS memo INTO t3 FROM t WHERE memo = 'c\nd'", + "misc/multiline-string-literals-91.sql": "CREATE INDEX i ON t (lower(memo)) WHERE memo <> 'line one\nline two'", + "misc/multiline-string-literals-92.sql": "CREATE UNIQUE INDEX i ON s.t USING btree ((memo || 'a\nb'), kind) WHERE memo <> 'c\nd' AND kind = 'e\nf'", + "misc/multiline-string-literals-93.sql": "ALTER TABLE t ADD CONSTRAINT ex EXCLUDE USING gist (memo WITH =) WHERE (memo <> 'a\nb')", + "misc/multiline-string-literals-94.sql": "COMMENT ON TABLE t IS 'line one\nline two'", + "misc/multiline-string-literals-95.sql": "COMMENT ON COLUMN s.t.memo IS 'line one\n indented line two\n\nline four'", + "misc/multiline-string-literals-96.sql": "COMMENT ON FUNCTION f(int, text) IS E'tab\\there\nsecond line'", + "misc/multiline-string-literals-97.sql": "COMMENT ON CONSTRAINT memo_ok ON t IS 'a\nb'", + "misc/multiline-string-literals-98.sql": "COMMENT ON POLICY p ON t IS 'a\nb'", + "misc/multiline-string-literals-99.sql": "COMMENT ON TRIGGER trg ON t IS 'a\nb'", + "misc/multiline-string-literals-100.sql": "SECURITY LABEL FOR p ON TABLE t IS 'a\nb'", + "misc/multiline-string-literals-101.sql": "CREATE FUNCTION f() RETURNS text LANGUAGE sql AS $$SELECT 'line one\nline two'$$", + "misc/multiline-string-literals-102.sql": "CREATE FUNCTION f(a text DEFAULT 'a\nb', b text DEFAULT 'c') RETURNS text LANGUAGE sql IMMUTABLE AS $$\n SELECT a || 'c\nd';\n$$", + "misc/multiline-string-literals-103.sql": "CREATE FUNCTION f(a text DEFAULT 'a\nb') RETURNS text LANGUAGE sql RETURN a || 'c\nd'", + "misc/multiline-string-literals-104.sql": "CREATE FUNCTION f() RETURNS SETOF text LANGUAGE sql BEGIN ATOMIC SELECT 'a\nb'; SELECT memo FROM t WHERE memo = 'c\nd'; END", + "misc/multiline-string-literals-105.sql": "CREATE FUNCTION f() RETURNS trigger LANGUAGE plpgsql SET search_path = 'a\nb' AS $fn$\nBEGIN\n IF new.memo = 'line one\nline two' THEN\n RAISE EXCEPTION 'bad\nmemo';\n END IF;\n RETURN new;\nEND;\n$fn$", + "misc/multiline-string-literals-106.sql": "CREATE PROCEDURE p(a text DEFAULT 'a\nb') LANGUAGE sql AS $$INSERT INTO t (memo) VALUES ('c\nd')$$", + "misc/multiline-string-literals-107.sql": "DO $$\nBEGIN\n RAISE NOTICE 'line one\nline two';\nEND\n$$", + "misc/multiline-string-literals-108.sql": "CALL p('a\nb', x => 'c\nd')", + "misc/multiline-string-literals-109.sql": "CREATE TYPE e AS ENUM ('a\nb', 'c')", + "misc/multiline-string-literals-110.sql": "ALTER TYPE e ADD VALUE 'd\ne' BEFORE 'a\nb'", + "misc/multiline-string-literals-111.sql": "ALTER TYPE e RENAME VALUE 'a\nb' TO 'f\ng'", + "misc/multiline-string-literals-112.sql": "CREATE TABLE p1 PARTITION OF p FOR VALUES IN ('a\nb', 'c\nd')", + "misc/multiline-string-literals-113.sql": "CREATE TABLE p2 PARTITION OF p (memo DEFAULT 'a\nb') FOR VALUES FROM ('c\nd') TO ('e\nf')", + "misc/multiline-string-literals-114.sql": "CREATE AGGREGATE agg (text) (SFUNC = f, STYPE = text, INITCOND = 'a\nb')", + "misc/multiline-string-literals-115.sql": "CREATE FOREIGN TABLE ft (memo text OPTIONS (column_name 'c\nd') DEFAULT 'a\nb') SERVER srv OPTIONS (table_name 'e\nf')", + "misc/multiline-string-literals-116.sql": "CREATE SERVER srv FOREIGN DATA WRAPPER w OPTIONS (host 'a\nb')", + "misc/multiline-string-literals-117.sql": "ALTER ROLE r SET search_path = 'a\nb'", + "misc/multiline-string-literals-118.sql": "SET application_name = 'a\nb'", + "misc/multiline-string-literals-119.sql": "CREATE EXTENSION x WITH SCHEMA s VERSION 'a\nb'", + "misc/multiline-string-literals-120.sql": "COPY t (memo) FROM STDIN WITH (FORMAT csv, NULL 'a\nb', DELIMITER ',') WHERE memo <> 'c\nd'", + "misc/multiline-string-literals-121.sql": "COPY (SELECT 'a\nb' FROM t WHERE memo = 'c\nd') TO STDOUT", + "misc/multiline-string-literals-122.sql": "PREPARE q (text) AS SELECT $1 || 'a\nb' FROM t WHERE memo = 'c\nd'", + "misc/multiline-string-literals-123.sql": "EXECUTE q ('a\nb')", + "misc/multiline-string-literals-124.sql": "EXPLAIN (ANALYZE) SELECT 'a\nb' FROM t WHERE memo = 'c\nd'", + "misc/multiline-string-literals-125.sql": "DECLARE c CURSOR FOR SELECT 'a\nb' FROM t WHERE memo = 'c\nd'", + "misc/multiline-string-literals-126.sql": "NOTIFY ch, 'a\nb'", + "misc/multiline-string-literals-127.sql": "GRANT SELECT ON t TO r", + "misc/multiline-string-literals-128.sql": "CREATE PUBLICATION pub FOR TABLE t WHERE (memo <> 'a\nb')", + "misc/multiline-string-literals-129.sql": "CREATE STATISTICS st ON (memo || 'a\nb'), kind FROM t", + "misc/multiline-string-literals-130.sql": "CREATE SCHEMA s CREATE TABLE t (memo text DEFAULT 'a\nb') CREATE VIEW v AS SELECT 'c\nd' AS memo", "misc/missing-types-1.sql": "ALTER PUBLICATION \"my_publication\" OWNER TO \"postgres\"", "misc/missing-types-2.sql": "ALTER OPERATOR FAMILY my_opfamily USING btree OWNER TO new_owner", "misc/missing-types-3.sql": "ALTER OPERATOR CLASS my_opclass USING btree OWNER TO new_owner", @@ -21703,6 +21833,101 @@ "misc/inflection-24.sql": "CREATE FUNCTION inflection.slugify ( text ) RETURNS text AS $EOFCODE$SELECT inflection.slugify($1, false)$EOFCODE$ LANGUAGE sql IMMUTABLE", "misc/inflection-25.sql": "INSERT INTO inflection.inflection_rules ( type, test, replacement ) VALUES ('plural', '^(m|wom)en$', NULL), ('plural', '(pe)ople$', NULL), ('plural', '(child)ren$', NULL), ('plural', '([ti])a$', NULL), ('plural', '((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$', NULL), ('plural', '(hi|ti)ves$', NULL), ('plural', '(curve)s$', NULL), ('plural', '([lr])ves$', NULL), ('plural', '([^fo])ves$', NULL), ('plural', '([^aeiouy]|qu)ies$', NULL), ('plural', '(s)eries$', NULL), ('plural', '(m)ovies$', NULL), ('plural', '(x|ch|ss|sh)es$', NULL), ('plural', '([m|l])ice$', NULL), ('plural', '(bus)es$', NULL), ('plural', '(o)es$', NULL), ('plural', '(shoe)s$', NULL), ('plural', '(cris|ax|test)es$', NULL), ('plural', '(octop|vir)i$', NULL), ('plural', '(alias|canvas|status|campus)es$', NULL), ('plural', '^(summons)es$', NULL), ('plural', '^(ox)en', NULL), ('plural', '(matr)ices$', NULL), ('plural', '^feet$', NULL), ('plural', '^teeth$', NULL), ('plural', '^geese$', NULL), ('plural', '(quiz)zes$', NULL), ('plural', '^(whereas)es$', NULL), ('plural', '^(criteri)a$', NULL), ('plural', '^genera$', NULL), ('plural', '^(m|wom)an$', '\\1en'), ('plural', '(pe)rson$', '\\1ople'), ('plural', '(child)$', '\\1ren'), ('plural', '^(ox)$', '\\1en'), ('plural', '(ax|test)is$', '\\1es'), ('plural', '(octop|vir)us$', '\\1i'), ('plural', '(alias|status|canvas|campus)$', '\\1es'), ('plural', '^(summons)$', '\\1es'), ('plural', '(bu)s$', '\\1ses'), ('plural', '(buffal|tomat|potat)o$', '\\1oes'), ('plural', '([ti])um$', '\\1a'), ('plural', 'sis$', 'ses'), ('plural', '(?:([^f])fe|([lr])f)$', '\\1\\2ves'), ('plural', '(hi|ti)ve$', '\\1ves'), ('plural', '([^aeiouy]|qu)y$', '\\1ies'), ('plural', '(matr)ix$', '\\1ices'), ('plural', '(vert|ind)ex$', '\\1ices'), ('plural', '(x|ch|ss|sh)$', '\\1es'), ('plural', '([m|l])ouse$', '\\1ice'), ('plural', '^foot$', 'feet'), ('plural', '^tooth$', 'teeth'), ('plural', '^goose$', 'geese'), ('plural', '(quiz)$', '\\1zes'), ('plural', '^(whereas)$', '\\1es'), ('plural', '^(criteri)on$', '\\1a'), ('plural', '^genus$', 'genera'), ('plural', 's$', 's'), ('plural', '$', 's'), ('singular', '^(m|wom)an$', NULL), ('singular', '(pe)rson$', NULL), ('singular', '(child)$', NULL), ('singular', '^(ox)$', NULL), ('singular', '(ax|test)is$', NULL), ('singular', '(octop|vir)us$', NULL), ('singular', '(alias|status|canvas|campus)$', NULL), ('singular', '^(summons)$', NULL), ('singular', '(bu)s$', NULL), ('singular', '(buffal|tomat|potat)o$', NULL), ('singular', '([ti])um$', NULL), ('singular', 'sis$', NULL), ('singular', '(?:([^f])fe|([lr])f)$', NULL), ('singular', '(hi|ti)ve$', NULL), ('singular', '([^aeiouy]|qu)y$', NULL), ('singular', '(x|ch|ss|sh)$', NULL), ('singular', '(matr)ix$', NULL), ('singular', '([m|l])ouse$', NULL), ('singular', '^foot$', NULL), ('singular', '^tooth$', NULL), ('singular', '^goose$', NULL), ('singular', '(quiz)$', NULL), ('singular', '^(whereas)$', NULL), ('singular', '^(criteri)on$', NULL), ('singular', '^genus$', NULL), ('singular', '^(m|wom)en$', '\\1an'), ('singular', '(pe)ople$', '\\1rson'), ('singular', '(child)ren$', '\\1'), ('singular', '^genera$', 'genus'), ('singular', '^(criteri)a$', '\\1on'), ('singular', '([ti])a$', '\\1um'), ('singular', '((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$', '\\1\\2sis'), ('singular', '(hi|ti)ves$', '\\1ve'), ('singular', '(curve)s$', '\\1'), ('singular', '([lr])ves$', '\\1f'), ('singular', '([a])ves$', '\\1ve'), ('singular', '([^fo])ves$', '\\1fe'), ('singular', '(m)ovies$', '\\1ovie'), ('singular', '([^aeiouy]|qu)ies$', '\\1y'), ('singular', '(s)eries$', '\\1eries'), ('singular', '(x|ch|ss|sh)es$', '\\1'), ('singular', '([m|l])ice$', '\\1ouse'), ('singular', '(bus)es$', '\\1'), ('singular', '(o)es$', '\\1'), ('singular', '(shoe)s$', '\\1'), ('singular', '(cris|ax|test)es$', '\\1is'), ('singular', '(octop|vir)i$', '\\1us'), ('singular', '(alias|canvas|status|campus)es$', '\\1'), ('singular', '^(summons)es$', '\\1'), ('singular', '^(ox)en', '\\1'), ('singular', '(matr)ices$', '\\1ix'), ('singular', '(vert|ind)ices$', '\\1ex'), ('singular', '^feet$', 'foot'), ('singular', '^teeth$', 'tooth'), ('singular', '^geese$', 'goose'), ('singular', '(quiz)zes$', '\\1'), ('singular', '^(whereas)es$', '\\1'), ('singular', 'ss$', 'ss'), ('singular', 's$', '')", "misc/inflection-26.sql": "CREATE INDEX inflection_rules_type_idx ON inflection.inflection_rules ( type )", + "misc/indirection-parens-1.sql": "SELECT (ARRAY[1, 2, 3])[2]", + "misc/indirection-parens-2.sql": "SELECT (ARRAY[1, 2, 3])[2:3]", + "misc/indirection-parens-3.sql": "SELECT (ARRAY[1, 2, 3])[:2], (ARRAY[1, 2, 3])[2:], (ARRAY[1, 2, 3])[:]", + "misc/indirection-parens-4.sql": "SELECT (ARRAY[ARRAY[1, 2], ARRAY[3, 4]])[1][2]", + "misc/indirection-parens-5.sql": "SELECT (ARRAY[ARRAY[1, 2], ARRAY[3, 4]])[1:2][2:2]", + "misc/indirection-parens-6.sql": "SELECT (ARRAY[[1, 2], [3, 4]])[2][1]", + "misc/indirection-parens-7.sql": "SELECT (ARRAY['a', 'b'])[i] FROM t", + "misc/indirection-parens-8.sql": "SELECT (ARRAY(SELECT id FROM t ORDER BY id))[1]", + "misc/indirection-parens-9.sql": "SELECT (ARRAY[]::int[])[1]", + "misc/indirection-parens-10.sql": "SELECT (ARRAY[ROW(1, 'a')::rt, ROW(2, 'b')::rt])[1].f1", + "misc/indirection-parens-11.sql": "SELECT (ROW(1, 2)).f1", + "misc/indirection-parens-12.sql": "SELECT (ROW(1, 2)::rt).*", + "misc/indirection-parens-13.sql": "SELECT (ROW(1, ROW(2, 3)::inner_t)::outer_t).f2.f1", + "misc/indirection-parens-14.sql": "SELECT ((1, 2)::rt).f1", + "misc/indirection-parens-15.sql": "SELECT (t.c).f1, (t.c).*, (c).f1, (s.t.c).f1 FROM s.t", + "misc/indirection-parens-16.sql": "SELECT (t.c).f1.f2, ((t.c).f1).f2, (t.arr[1]).f1, (t.c).arr[1] FROM t", + "misc/indirection-parens-17.sql": "SELECT (t).*, (t.*).f1 FROM t", + "misc/indirection-parens-18.sql": "SELECT (c).f1[1], (c).f1[1:2].g FROM t", + "misc/indirection-parens-19.sql": "SELECT ('{1,2,3}'::int[])[1]", + "misc/indirection-parens-20.sql": "SELECT ('{1,2,3}'::int[])[1:2]", + "misc/indirection-parens-21.sql": "SELECT (CAST('{1,2,3}' AS int[]))[1]", + "misc/indirection-parens-22.sql": "SELECT ('(1,2)'::rt).f1, ('(1,2)'::rt).*", + "misc/indirection-parens-23.sql": "SELECT (c::int[])[1], (c::text[])[i + 1][j] FROM t", + "misc/indirection-parens-24.sql": "SELECT ('{\"a\": [1, 2]}'::jsonb)['a'][0]", + "misc/indirection-parens-25.sql": "SELECT (int4range(1, 5)::text)[1]", + "misc/indirection-parens-26.sql": "SELECT (TIMESTAMP '2001-02-16 20:38:40')[1]", + "misc/indirection-parens-27.sql": "SELECT (f(x)).*", + "misc/indirection-parens-28.sql": "SELECT (f(x)).a, (s.f(x, y)).a.b, (f()).*", + "misc/indirection-parens-29.sql": "SELECT (f(x))[1], (f(x))[1:2], (f(x))[1].a", + "misc/indirection-parens-30.sql": "SELECT (string_to_array('a,b', ','))[1]", + "misc/indirection-parens-31.sql": "SELECT (regexp_match(memo, '(a)(b)'))[2] FROM t", + "misc/indirection-parens-32.sql": "SELECT (array_agg(id ORDER BY id))[1] FROM t", + "misc/indirection-parens-33.sql": "SELECT (array_agg(id) FILTER (WHERE id > 1))[1:2] FROM t", + "misc/indirection-parens-34.sql": "SELECT (array_agg(id) OVER (PARTITION BY kind))[1] FROM t", + "misc/indirection-parens-35.sql": "SELECT (coalesce(a, b))[1], (nullif(a, b))[1], (greatest(a, b)).f1 FROM t", + "misc/indirection-parens-36.sql": "SELECT (current_schemas(true))[1], (CURRENT_USER)[1]", + "misc/indirection-parens-37.sql": "SELECT (each(h)).key, (each(h)).value FROM t", + "misc/indirection-parens-38.sql": "SELECT (jsonb_populate_record(NULL::rt, j)).* FROM t", + "misc/indirection-parens-39.sql": "SELECT (unnest(ARRAY[ROW(1, 2)::rt])).f1", + "misc/indirection-parens-40.sql": "SELECT (SELECT arr FROM t LIMIT 1)[1]", + "misc/indirection-parens-41.sql": "SELECT (SELECT arr FROM t LIMIT 1)[1:2]", + "misc/indirection-parens-42.sql": "SELECT (SELECT c FROM t LIMIT 1).f1", + "misc/indirection-parens-43.sql": "SELECT (SELECT c FROM t LIMIT 1).*", + "misc/indirection-parens-44.sql": "SELECT (SELECT array_agg(id) FROM t)[1], ((SELECT array_agg(id) FROM t))[2]", + "misc/indirection-parens-45.sql": "SELECT (ARRAY(SELECT id FROM t))[1:2]", + "misc/indirection-parens-46.sql": "SELECT (a || b)[1] FROM t", + "misc/indirection-parens-47.sql": "SELECT (a || b)[1:2], (a || ARRAY[1])[1], (ARRAY[1] || a)[2] FROM t", + "misc/indirection-parens-48.sql": "SELECT (a -> 'k')[0], (a #> '{x,y}')[1], (- a)[1] FROM t", + "misc/indirection-parens-49.sql": "SELECT (a + b).f1, (a OPERATOR(pg_catalog.||) b)[1] FROM t", + "misc/indirection-parens-50.sql": "SELECT (a AND b)[1], (NOT a)[1], (a IS NULL)[1], (a IN (1, 2))[1] FROM t", + "misc/indirection-parens-51.sql": "SELECT (a BETWEEN 1 AND 2)[1], (a LIKE 'x')[1], (a IS DISTINCT FROM b)[1] FROM t", + "misc/indirection-parens-52.sql": "SELECT (a = ANY (b))[1], (a AT TIME ZONE 'UTC')[1], (a COLLATE \"C\")[1] FROM t", + "misc/indirection-parens-53.sql": "SELECT (EXISTS (SELECT 1))[1], (a IS TRUE)[1], (a IS NOT DOCUMENT)[1] FROM t", + "misc/indirection-parens-54.sql": "SELECT (CASE WHEN x THEN a ELSE b END)[1] FROM t", + "misc/indirection-parens-55.sql": "SELECT (CASE WHEN x THEN a ELSE b END)[1:2], (CASE x WHEN 1 THEN c END).f1 FROM t", + "misc/indirection-parens-56.sql": "SELECT (COALESCE(a, b))[1], (NULLIF(a, b))[1], (GREATEST(a, b))[1], (LEAST(a, b)).f1 FROM t", + "misc/indirection-parens-57.sql": "SELECT ($1)[1], $1[1], ($1).f1, ($1::int[])[1], $2[1:2]", + "misc/indirection-parens-58.sql": "SELECT ('{1,2}')[1], (NULL)[1], (1)[1], (TRUE)[1]", + "misc/indirection-parens-59.sql": "SELECT (a[1])[2], a[1][2], ((a)[1])[2], (a[1:2])[1] FROM t", + "misc/indirection-parens-60.sql": "SELECT (GROUPING(a))[1] FROM t GROUP BY a", + "misc/indirection-parens-61.sql": "SELECT (XMLELEMENT(NAME x))[1], (JSON_OBJECT('a': 1))[1], (JSON_ARRAY(1, 2))[1]", + "misc/indirection-parens-62.sql": "SELECT (EXTRACT(year FROM d))[1], (SUBSTRING(s FROM 1 FOR 2))[1], (TRIM(s))[1], (POSITION('a' IN s))[1], (OVERLAY(s PLACING 'x' FROM 1))[1] FROM t", + "misc/indirection-parens-63.sql": "SELECT (CURRENT_TIMESTAMP)[1], (CURRENT_DATE)[1], (LOCALTIME)[1], (SESSION_USER)[1], (CURRENT_CATALOG)[1]", + "misc/indirection-parens-64.sql": "SELECT (DEFAULT)[1] FROM t", + "misc/indirection-parens-65.sql": "SELECT ((ARRAY[1, 2, 3])[2:3])[1]", + "misc/indirection-parens-66.sql": "SELECT ((f(x)).arr)[1], ((f(x)).arr[1]).g, (((f(x)).a).b).c", + "misc/indirection-parens-67.sql": "SELECT ((ARRAY[ROW(1, ARRAY[2, 3])::rt])[1]).f2[1]", + "misc/indirection-parens-68.sql": "SELECT ((a || b)[1:2] || c)[1], (((a)))[1] FROM t", + "misc/indirection-parens-69.sql": "SELECT (ARRAY[(ARRAY[1, 2])[1], (f(x))[2]])[1]", + "misc/indirection-parens-70.sql": "SELECT (ARRAY[1, 2, 3])[(SELECT 1)], (ARRAY[1, 2, 3])[(ARRAY[1, 2])[1]], (ARRAY[1, 2, 3])[(f(x))[1]] FROM t", + "misc/indirection-parens-71.sql": "SELECT (ARRAY[1, 2, 3])[1]::text, - (ARRAY[1, 2, 3])[1], (ARRAY[1, 2, 3])[1] + (f(x)).a, NOT (ARRAY[TRUE])[1]", + "misc/indirection-parens-72.sql": "SELECT f((ARRAY[1, 2, 3])[1], (g(x)).a), count((f(x)).a) FROM t", + "misc/indirection-parens-73.sql": "SELECT * FROM t WHERE (ARRAY[1, 2, 3])[t.i] = 2 AND (f(t.x)).ok ORDER BY (string_to_array(t.s, ','))[1], (t.c).f1", + "misc/indirection-parens-74.sql": "SELECT * FROM t JOIN u ON (t.c).id = (u.c).id AND (ARRAY[t.a, t.b])[1] = u.a GROUP BY (t.c).f1 HAVING (array_agg(u.a))[1] > 0", + "misc/indirection-parens-75.sql": "SELECT * FROM generate_series(1, (ARRAY[3, 4])[1]) AS g, LATERAL (SELECT (ARRAY[1, 2])[g]) s", + "misc/indirection-parens-76.sql": "SELECT (x).* FROM (SELECT f(y) AS x FROM t) sub", + "misc/indirection-parens-77.sql": "INSERT INTO t (a, b) VALUES ((ARRAY[1, 2, 3])[2], (ROW(1, 2)::rt).f1)", + "misc/indirection-parens-78.sql": "INSERT INTO t (a) SELECT (f(x)).a FROM u ON CONFLICT (a) DO UPDATE SET a = (ARRAY[excluded.a, t.a])[1] RETURNING (t.c).f1", + "misc/indirection-parens-79.sql": "UPDATE t SET a = (ARRAY[1, 2, 3])[2], b = (f(x)).b, arr[1] = (ARRAY[5])[1], c.f1 = (c).f1 + 1 WHERE (c).f1 = (string_to_array(s, ','))[1]::int", + "misc/indirection-parens-80.sql": "UPDATE t SET (a, b) = (SELECT (f(x)).a, (ARRAY[1, 2])[1])", + "misc/indirection-parens-81.sql": "DELETE FROM t WHERE (ARRAY['a', 'b'])[i] = s RETURNING (c).*", + "misc/indirection-parens-82.sql": "CREATE TABLE t (a int DEFAULT (ARRAY[1, 2, 3])[2], b int CHECK (b > (ARRAY[1, 2, 3])[1]), c rt, CHECK ((c).f1 > 0))", + "misc/indirection-parens-83.sql": "CREATE TABLE t (a int GENERATED ALWAYS AS ((string_to_array(s, ','))[1]::int) STORED, s text)", + "misc/indirection-parens-84.sql": "ALTER TABLE t ALTER COLUMN a SET DEFAULT (ARRAY[1, 2, 3])[2], ADD CONSTRAINT k CHECK ((c).f1 > (f(a)).lo)", + "misc/indirection-parens-85.sql": "ALTER TABLE t ALTER COLUMN a TYPE int USING (string_to_array(a, ','))[1]::int", + "misc/indirection-parens-86.sql": "CREATE INDEX i ON t (((c).f1), ((string_to_array(s, ','))[1])) WHERE (c).f2 IS NOT NULL", + "misc/indirection-parens-87.sql": "CREATE VIEW v AS SELECT (ARRAY[1, 2, 3])[2] AS a, (f(x)).* FROM t", + "misc/indirection-parens-88.sql": "CREATE POLICY p ON t USING ((string_to_array(current_setting('x'), ','))[1] = owner) WITH CHECK ((c).f1 > 0)", + "misc/indirection-parens-89.sql": "CREATE TRIGGER trg BEFORE UPDATE ON t FOR EACH ROW WHEN ((new.c).f1 IS DISTINCT FROM (old.c).f1 AND (ARRAY[1, 2])[1] = 1) EXECUTE FUNCTION f()", + "misc/indirection-parens-90.sql": "CREATE FUNCTION f(a int[] DEFAULT ARRAY[1], b int DEFAULT (ARRAY[1, 2, 3])[2]) RETURNS int LANGUAGE sql RETURN (ARRAY[a[1], b])[1]", + "misc/indirection-parens-91.sql": "CREATE DOMAIN d AS int[] CHECK ((VALUE)[1] > 0 AND (array_remove(VALUE, NULL))[1] IS NOT NULL)", + "misc/indirection-parens-92.sql": "WITH x AS (SELECT (ARRAY[1, 2, 3])[2:3] AS a) SELECT (a)[1], (x.a)[1], (SELECT (a)[2]) FROM x", + "misc/indirection-parens-93.sql": "SELECT CASE WHEN (ARRAY[1, 2])[1] = 1 THEN (f(x)).a ELSE (ROW(1, 2)::rt).f1 END FROM t", + "misc/indirection-parens-94.sql": "SELECT sum((c).f1) OVER (PARTITION BY (ARRAY[a, b])[1] ORDER BY (f(x)).a) FROM t", + "misc/indirection-parens-95.sql": "PREPARE q (int[], rt) AS SELECT $1[1], ($2).f1, ($1)[1:2], ($1 || $1)[1]", "misc/indexes-1.sql": "CREATE INDEX CONCURRENTLY IF NOT EXISTS index_email_logs_on_created_at ON public.email_logs USING btree (created_at DESC)", "misc/indexes-2.sql": "DROP INDEX my_index", "misc/indexes-3.sql": "DROP INDEX CONCURRENTLY my_index", diff --git a/__fixtures__/kitchen-sink/misc/indirection-parens.sql b/__fixtures__/kitchen-sink/misc/indirection-parens.sql new file mode 100644 index 000000000..bc0050128 --- /dev/null +++ b/__fixtures__/kitchen-sink/misc/indirection-parens.sql @@ -0,0 +1,115 @@ +-- The target of a subscript, slice, field selection or .* must stay +-- parenthesized whenever it is anything other than a plain column or parameter. + +-- ARRAY constructors +SELECT (ARRAY[1, 2, 3])[2]; +SELECT (ARRAY[1, 2, 3])[2:3]; +SELECT (ARRAY[1, 2, 3])[:2], (ARRAY[1, 2, 3])[2:], (ARRAY[1, 2, 3])[:]; +SELECT (ARRAY[ARRAY[1, 2], ARRAY[3, 4]])[1][2]; +SELECT (ARRAY[ARRAY[1, 2], ARRAY[3, 4]])[1:2][2:2]; +SELECT (ARRAY[[1, 2], [3, 4]])[2][1]; +SELECT (ARRAY['a', 'b'])[i] FROM t; +SELECT (ARRAY(SELECT id FROM t ORDER BY id))[1]; +SELECT (ARRAY[]::int[])[1]; +SELECT (ARRAY[ROW(1, 'a')::rt, ROW(2, 'b')::rt])[1].f1; + +-- ROW constructors and composite field selection +SELECT (ROW(1, 2)).f1; +SELECT (ROW(1, 2)::rt).*; +SELECT (ROW(1, ROW(2, 3)::inner_t)::outer_t).f2.f1; +SELECT ((1, 2)::rt).f1; +SELECT (t.c).f1, (t.c).*, (c).f1, (s.t.c).f1 FROM s.t; +SELECT (t.c).f1.f2, ((t.c).f1).f2, (t.arr[1]).f1, (t.c).arr[1] FROM t; +SELECT (t).*, (t.*).f1 FROM t; +SELECT (c).f1[1], (c).f1[1:2].g FROM t; + +-- Casts +SELECT ('{1,2,3}'::int[])[1]; +SELECT ('{1,2,3}'::int[])[1:2]; +SELECT (CAST('{1,2,3}' AS int[]))[1]; +SELECT ('(1,2)'::rt).f1, ('(1,2)'::rt).*; +SELECT (c::int[])[1], (c::text[])[i + 1][j] FROM t; +SELECT ('{"a": [1, 2]}'::jsonb)['a'][0]; +SELECT (int4range(1, 5)::text)[1]; +SELECT (TIMESTAMP '2001-02-16 20:38:40')[1]; + +-- Function calls +SELECT (f(x)).*; +SELECT (f(x)).a, (s.f(x, y)).a.b, (f()).*; +SELECT (f(x))[1], (f(x))[1:2], (f(x))[1].a; +SELECT (string_to_array('a,b', ','))[1]; +SELECT (regexp_match(memo, '(a)(b)'))[2] FROM t; +SELECT (array_agg(id ORDER BY id))[1] FROM t; +SELECT (array_agg(id) FILTER (WHERE id > 1))[1:2] FROM t; +SELECT (array_agg(id) OVER (PARTITION BY kind))[1] FROM t; +SELECT (coalesce(a, b))[1], (nullif(a, b))[1], (greatest(a, b)).f1 FROM t; +SELECT (current_schemas(true))[1], (CURRENT_USER)[1]; +SELECT (each(h)).key, (each(h)).value FROM t; +SELECT (jsonb_populate_record(NULL::rt, j)).* FROM t; +SELECT (unnest(ARRAY[ROW(1, 2)::rt])).f1; + +-- Subselects +SELECT (SELECT arr FROM t LIMIT 1)[1]; +SELECT (SELECT arr FROM t LIMIT 1)[1:2]; +SELECT (SELECT c FROM t LIMIT 1).f1; +SELECT (SELECT c FROM t LIMIT 1).*; +SELECT (SELECT array_agg(id) FROM t)[1], ((SELECT array_agg(id) FROM t))[2]; +SELECT (ARRAY(SELECT id FROM t))[1:2]; + +-- Operator and boolean expressions +SELECT (a || b)[1] FROM t; +SELECT (a || b)[1:2], (a || ARRAY[1])[1], (ARRAY[1] || a)[2] FROM t; +SELECT (a -> 'k')[0], (a #> '{x,y}')[1], (- a)[1] FROM t; +SELECT (a + b).f1, (a OPERATOR(pg_catalog.||) b)[1] FROM t; +SELECT (a AND b)[1], (NOT a)[1], (a IS NULL)[1], (a IN (1, 2))[1] FROM t; +SELECT (a BETWEEN 1 AND 2)[1], (a LIKE 'x')[1], (a IS DISTINCT FROM b)[1] FROM t; +SELECT (a = ANY (b))[1], (a AT TIME ZONE 'UTC')[1], (a COLLATE "C")[1] FROM t; +SELECT (EXISTS (SELECT 1))[1], (a IS TRUE)[1], (a IS NOT DOCUMENT)[1] FROM t; + +-- CASE and other compound expressions +SELECT (CASE WHEN x THEN a ELSE b END)[1] FROM t; +SELECT (CASE WHEN x THEN a ELSE b END)[1:2], (CASE x WHEN 1 THEN c END).f1 FROM t; +SELECT (COALESCE(a, b))[1], (NULLIF(a, b))[1], (GREATEST(a, b))[1], (LEAST(a, b)).f1 FROM t; +SELECT ($1)[1], $1[1], ($1).f1, ($1::int[])[1], $2[1:2]; +SELECT ('{1,2}')[1], (NULL)[1], (1)[1], (TRUE)[1]; +SELECT (a[1])[2], a[1][2], ((a)[1])[2], (a[1:2])[1] FROM t; +SELECT (GROUPING(a))[1] FROM t GROUP BY a; +SELECT (XMLELEMENT(NAME x))[1], (JSON_OBJECT('a': 1))[1], (JSON_ARRAY(1, 2))[1]; +SELECT (EXTRACT(year FROM d))[1], (SUBSTRING(s FROM 1 FOR 2))[1], (TRIM(s))[1], (POSITION('a' IN s))[1], (OVERLAY(s PLACING 'x' FROM 1))[1] FROM t; +SELECT (CURRENT_TIMESTAMP)[1], (CURRENT_DATE)[1], (LOCALTIME)[1], (SESSION_USER)[1], (CURRENT_CATALOG)[1]; +SELECT (DEFAULT)[1] FROM t; + +-- Nested and combined +SELECT ((ARRAY[1, 2, 3])[2:3])[1]; +SELECT ((f(x)).arr)[1], ((f(x)).arr[1]).g, (((f(x)).a).b).c; +SELECT ((ARRAY[ROW(1, ARRAY[2, 3])::rt])[1]).f2[1]; +SELECT ((a || b)[1:2] || c)[1], (((a)))[1] FROM t; +SELECT (ARRAY[(ARRAY[1, 2])[1], (f(x))[2]])[1]; +SELECT (ARRAY[1, 2, 3])[(SELECT 1)], (ARRAY[1, 2, 3])[(ARRAY[1, 2])[1]], (ARRAY[1, 2, 3])[(f(x))[1]] FROM t; +SELECT (ARRAY[1, 2, 3])[1]::text, - (ARRAY[1, 2, 3])[1], (ARRAY[1, 2, 3])[1] + (f(x)).a, NOT (ARRAY[TRUE])[1]; +SELECT f((ARRAY[1, 2, 3])[1], (g(x)).a), count((f(x)).a) FROM t; + +-- Outside the SELECT list +SELECT * FROM t WHERE (ARRAY[1, 2, 3])[t.i] = 2 AND (f(t.x)).ok ORDER BY (string_to_array(t.s, ','))[1], (t.c).f1; +SELECT * FROM t JOIN u ON (t.c).id = (u.c).id AND (ARRAY[t.a, t.b])[1] = u.a GROUP BY (t.c).f1 HAVING (array_agg(u.a))[1] > 0; +SELECT * FROM generate_series(1, (ARRAY[3, 4])[1]) AS g, LATERAL (SELECT (ARRAY[1, 2])[g]) s; +SELECT (x).* FROM (SELECT f(y) AS x FROM t) sub; +INSERT INTO t (a, b) VALUES ((ARRAY[1, 2, 3])[2], (ROW(1, 2)::rt).f1); +INSERT INTO t (a) SELECT (f(x)).a FROM u ON CONFLICT (a) DO UPDATE SET a = (ARRAY[excluded.a, t.a])[1] RETURNING (t.c).f1; +UPDATE t SET a = (ARRAY[1, 2, 3])[2], b = (f(x)).b, arr[1] = (ARRAY[5])[1], c.f1 = (c).f1 + 1 WHERE (c).f1 = (string_to_array(s, ','))[1]::int; +UPDATE t SET (a, b) = (SELECT (f(x)).a, (ARRAY[1, 2])[1]); +DELETE FROM t WHERE (ARRAY['a', 'b'])[i] = s RETURNING (c).*; +CREATE TABLE t (a int DEFAULT (ARRAY[1, 2, 3])[2], b int CHECK (b > (ARRAY[1, 2, 3])[1]), c rt, CHECK ((c).f1 > 0)); +CREATE TABLE t (a int GENERATED ALWAYS AS ((string_to_array(s, ','))[1]::int) STORED, s text); +ALTER TABLE t ALTER COLUMN a SET DEFAULT (ARRAY[1, 2, 3])[2], ADD CONSTRAINT k CHECK ((c).f1 > (f(a)).lo); +ALTER TABLE t ALTER COLUMN a TYPE int USING (string_to_array(a, ','))[1]::int; +CREATE INDEX i ON t (((c).f1), ((string_to_array(s, ','))[1])) WHERE (c).f2 IS NOT NULL; +CREATE VIEW v AS SELECT (ARRAY[1, 2, 3])[2] AS a, (f(x)).* FROM t; +CREATE POLICY p ON t USING ((string_to_array(current_setting('x'), ','))[1] = owner) WITH CHECK ((c).f1 > 0); +CREATE TRIGGER trg BEFORE UPDATE ON t FOR EACH ROW WHEN ((new.c).f1 IS DISTINCT FROM (old.c).f1 AND (ARRAY[1, 2])[1] = 1) EXECUTE FUNCTION f(); +CREATE FUNCTION f(a int[] DEFAULT ARRAY[1], b int DEFAULT (ARRAY[1, 2, 3])[2]) RETURNS int LANGUAGE sql RETURN (ARRAY[a[1], b])[1]; +CREATE DOMAIN d AS int[] CHECK ((VALUE)[1] > 0 AND (array_remove(VALUE, NULL))[1] IS NOT NULL); +WITH x AS (SELECT (ARRAY[1, 2, 3])[2:3] AS a) SELECT (a)[1], (x.a)[1], (SELECT (a)[2]) FROM x; +SELECT CASE WHEN (ARRAY[1, 2])[1] = 1 THEN (f(x)).a ELSE (ROW(1, 2)::rt).f1 END FROM t; +SELECT sum((c).f1) OVER (PARTITION BY (ARRAY[a, b])[1] ORDER BY (f(x)).a) FROM t; +PREPARE q (int[], rt) AS SELECT $1[1], ($2).f1, ($1)[1:2], ($1 || $1)[1]; diff --git a/__fixtures__/kitchen-sink/misc/multiline-string-literals.sql b/__fixtures__/kitchen-sink/misc/multiline-string-literals.sql new file mode 100644 index 000000000..05d3b4cfa --- /dev/null +++ b/__fixtures__/kitchen-sink/misc/multiline-string-literals.sql @@ -0,0 +1,447 @@ +-- A string literal that spans lines must keep its exact value: pretty mode may +-- indent the SQL around it but never the lines inside it. + +-- Column DEFAULT +CREATE TABLE t (memo text DEFAULT 'line one +line two'); +CREATE TABLE t (id int PRIMARY KEY, memo text NOT NULL DEFAULT 'line one + line two + line three', n int); +CREATE TABLE t (memo text DEFAULT E'tab\there +back\\slash +quote''s'); +CREATE TABLE t (memo text DEFAULT 'it''s +''quoted'' +'); +CREATE TABLE t (memo text DEFAULT ' +'); +CREATE TABLE t (memo text DEFAULT ' + +leading and trailing blank lines + +'); +CREATE TABLE t (a text DEFAULT 'first +literal', b text DEFAULT 'second +literal', c text DEFAULT 'one line'); +CREATE TABLE t (memo text DEFAULT $body$dollar 'quoted' + body $$ with +a tag$body$); +CREATE TABLE t (memo text DEFAULT 'a +b' || 'c +d'); +CREATE TABLE t (memo text DEFAULT concat('a +b', upper('c +d'))); +CREATE TABLE t (memo text GENERATED ALWAYS AS (other || ' +suffix') STORED, other text); + +-- Column and table CHECK constraints +CREATE TABLE t (memo text CHECK (memo <> 'line one +line two')); +CREATE TABLE t (memo text, CHECK (memo <> 'line one +line two')); +CREATE TABLE t (memo text, kind text, CONSTRAINT memo_ok CHECK (memo <> 'line one +line two' AND kind IN ('a +b', 'c') OR memo IS NULL)); +CREATE TABLE t (memo text, CONSTRAINT memo_ok CHECK (memo <> 'line one +line two') NOT VALID, CONSTRAINT memo_len CHECK (length(memo) < 10)); +CREATE TABLE s.t ( + id uuid PRIMARY KEY DEFAULT gen_random_uuid(), + memo text NOT NULL DEFAULT 'line one +line two', + kind text NOT NULL DEFAULT 'plain', + owner_id uuid REFERENCES s.owners (id) ON DELETE CASCADE, + CONSTRAINT memo_ok CHECK (memo <> 'x +y'), + UNIQUE (owner_id, kind) +); +CREATE DOMAIN d AS text DEFAULT 'a +b' CHECK (VALUE <> 'c +d'); + +-- ALTER TABLE +ALTER TABLE t ALTER COLUMN memo SET DEFAULT 'line one +line two'; +ALTER TABLE t ADD COLUMN memo text DEFAULT 'line one +line two'; +ALTER TABLE t ADD COLUMN memo text NOT NULL DEFAULT 'line one +line two' CHECK (memo <> 'x +y'); +ALTER TABLE t ADD CONSTRAINT memo_ok CHECK (memo <> 'line one +line two'); +ALTER TABLE t ADD CONSTRAINT memo_ok CHECK (memo <> 'line one +line two' AND memo <> 'x +y') NOT VALID; +ALTER TABLE t ALTER COLUMN memo TYPE text USING coalesce(memo, 'line one +line two'); +ALTER TABLE t ADD COLUMN a text DEFAULT 'a +b', ALTER COLUMN c SET DEFAULT 'c +d', ADD CONSTRAINT e CHECK (c <> 'e +f'); +ALTER DOMAIN d SET DEFAULT 'a +b'; +ALTER DOMAIN d ADD CONSTRAINT c CHECK (VALUE <> 'a +b'); + +-- CREATE POLICY / ALTER POLICY +CREATE POLICY p ON t USING (memo = 'line one +line two'); +CREATE POLICY p ON t FOR INSERT WITH CHECK (memo = 'line one +line two'); +CREATE POLICY p ON s.t AS RESTRICTIVE FOR UPDATE TO authenticated USING (memo = 'line one +line two' AND owner_id = current_user_id()) WITH CHECK (memo <> 'x +y' OR kind = 'k +l'); +CREATE POLICY p ON t FOR SELECT USING (EXISTS (SELECT 1 FROM u WHERE u.memo = 'line one +line two' AND u.id = t.id)); +ALTER POLICY p ON t USING (memo = 'line one +line two') WITH CHECK (memo = 'x +y'); + +-- CREATE TRIGGER / CREATE RULE +CREATE TRIGGER trg BEFORE UPDATE ON t FOR EACH ROW WHEN (new.memo = 'line one +line two') EXECUTE FUNCTION f(); +CREATE TRIGGER trg AFTER INSERT OR UPDATE OF memo ON s.t FOR EACH ROW WHEN (new.memo IS DISTINCT FROM 'line one +line two' AND old.memo <> 'x +y') EXECUTE FUNCTION s.f('arg one +arg two', 'b'); +CREATE TRIGGER trg BEFORE INSERT ON t FOR EACH ROW EXECUTE FUNCTION f('arg one +arg two'); +CREATE CONSTRAINT TRIGGER trg AFTER INSERT ON t DEFERRABLE INITIALLY DEFERRED FOR EACH ROW WHEN (new.memo = 'a +b') EXECUTE FUNCTION f(); +CREATE RULE r AS ON INSERT TO t WHERE new.memo = 'a +b' DO INSTEAD INSERT INTO u (memo) VALUES ('c +d'); +CREATE RULE r AS ON UPDATE TO t DO ALSO (INSERT INTO u (memo) VALUES ('c +d'); UPDATE v SET memo = 'e +f' WHERE id = new.id); + +-- INSERT +INSERT INTO t (id, memo) VALUES (1, 'line one +line two'); +INSERT INTO t (id, memo) VALUES (1, 'a +b'), (2, 'c +d'), (3, 'e'); +INSERT INTO t (id, memo) VALUES (1, 'a') ON CONFLICT (id) DO UPDATE SET memo = 'line one +line two'; +INSERT INTO t (id, memo, kind) VALUES (1, 'a +b', 'k') ON CONFLICT (id) WHERE kind = 'k +l' DO UPDATE SET memo = excluded.memo || ' +appended', kind = 'x +y' WHERE t.memo <> 'p +q' RETURNING memo, 'r +s' AS tag; +INSERT INTO t (id, memo) SELECT id, 'line one +line two' FROM u WHERE memo = 'x +y'; +INSERT INTO t (memo) VALUES ('a +b') ON CONFLICT ON CONSTRAINT t_pkey DO NOTHING RETURNING 'c +d'; +WITH src AS (SELECT 'a +b' AS memo) INSERT INTO t (memo) SELECT memo FROM src ON CONFLICT (memo) DO UPDATE SET memo = 'c +d'; + +-- UPDATE / DELETE / MERGE +UPDATE t SET memo = 'line one +line two' WHERE id = 1; +UPDATE t SET memo = 'a +b', kind = 'c +d' FROM u WHERE u.id = t.id AND u.memo = 'e +f' RETURNING t.memo, 'g +h'; +UPDATE t SET (memo, kind) = ('a +b', 'c +d') WHERE id = 1; +UPDATE t SET memo = (SELECT 'a +b' FROM u WHERE u.memo = 'c +d' LIMIT 1) WHERE id IN (SELECT id FROM v WHERE memo = 'e +f'); +DELETE FROM t WHERE memo = 'line one +line two'; +DELETE FROM t USING u WHERE t.id = u.id AND u.memo = 'a +b' AND t.memo = 'c +d' RETURNING 'e +f'; +MERGE INTO t USING u ON t.id = u.id AND u.memo = 'a +b' WHEN MATCHED AND t.memo = 'c +d' THEN UPDATE SET memo = 'e +f' WHEN NOT MATCHED THEN INSERT (id, memo) VALUES (u.id, 'g +h'); + +-- SELECT clauses +SELECT 'line one +line two'; +SELECT 'a +b' AS x, 'c +d' AS y, id FROM t; +SELECT id FROM t WHERE memo = 'line one +line two'; +SELECT id FROM t WHERE memo = 'a +b' AND kind = 'c +d' OR (memo <> 'e +f' AND kind IS NULL); +SELECT id FROM t WHERE memo IN ('a +b', 'c +d') AND kind LIKE 'e +%' AND memo BETWEEN 'f +g' AND 'h +i'; +SELECT t.id FROM t JOIN u ON u.id = t.id AND u.memo = 'a +b' LEFT JOIN v ON v.id = t.id AND v.memo = 'c +d' AND v.kind = 'a long enough condition to be wrapped onto its own line'; +SELECT kind, count(*) FROM t GROUP BY kind, memo || 'a +b' HAVING max(memo) = 'c +d' ORDER BY kind || 'e +f', 2 LIMIT 5; +SELECT DISTINCT ON (memo || 'a +b') memo FROM t; +SELECT * FROM (SELECT 'a +b' AS memo, id FROM t WHERE kind = 'c +d') sub WHERE sub.memo = 'e +f'; +SELECT * FROM t WHERE EXISTS (SELECT 1 FROM u WHERE u.memo = 'a +b' AND u.id = t.id) AND id = ANY (SELECT id FROM v WHERE memo = 'c +d'); +SELECT 'a +b' UNION ALL SELECT 'c +d' UNION ALL SELECT memo FROM t WHERE memo = 'e +f'; +SELECT * FROM (VALUES (1, 'a +b'), (2, 'c +d')) AS v (id, memo); +VALUES (1, 'a +b'), (2, 'c +d'); +SELECT * FROM f('a +b', 'c') AS x, LATERAL g(x.id, 'd +e') AS y; +SELECT 'a +b'::text, CAST('c +d' AS varchar(20)), text 'e +f'; +SELECT E'a\nb +c', U&'d\0061 +e', B'101', X'1F', N'f +g'; +SELECT $$dollar +quoted$$, $tag$with 'quotes' +and $$ inside$tag$; +SELECT 'trailing space +and tab +', ' leading spaces + kept'; +SELECT "quoted +identifier" FROM "quoted +table" AS "alias +name" WHERE "quoted +identifier" = 'a +b'; + +-- CASE, function arguments, aggregates and window functions +SELECT CASE WHEN memo = 'a +b' THEN 'c +d' WHEN kind = 'k' THEN 'one line' ELSE 'e +f' END FROM t; +SELECT CASE memo WHEN 'a +b' THEN 1 ELSE 2 END, CASE WHEN id > 1 THEN CASE WHEN memo = 'c +d' THEN 'e +f' ELSE 'g' END END FROM t; +SELECT concat('a +b', memo, 'c +d'), coalesce(memo, 'e +f'), nullif(memo, 'g +h'), greatest('i +j', memo) FROM t; +SELECT string_agg(memo, ', +' ORDER BY memo || 'a +b') FILTER (WHERE memo <> 'c +d') FROM t; +SELECT count(*) FILTER (WHERE memo = 'a +b') OVER (PARTITION BY kind || 'c +d' ORDER BY memo || 'e +f' ROWS BETWEEN 1 PRECEDING AND CURRENT ROW) FROM t; +SELECT lag(memo, 1, 'a +b') OVER w FROM t WINDOW w AS (PARTITION BY memo = 'c +d' ORDER BY id); +SELECT format('%s +%s', 'a', 'b'), regexp_replace(memo, '\s +', 'x +y', 'g') FROM t; +SELECT f(a => 'a +b', b := 'c +d'); + +-- Array and row constructors +SELECT ARRAY['a +b', 'c +d'], ARRAY[ARRAY['e +f'], ARRAY['g']], ROW('h +i', 2), ('j +k', 'l'); +SELECT * FROM t WHERE (memo, kind) = ('a +b', 'c +d') AND memo = ANY (ARRAY['e +f', 'g']); +SELECT '{"a +b","c"}'::text[], '{"k": "v +w"}'::jsonb -> 'k', jsonb_build_object('a +b', 'c +d'); + +-- CTEs +WITH a AS (SELECT 'a +b' AS memo) SELECT memo FROM a WHERE memo = 'c +d'; +WITH a AS (SELECT 'a +b' AS memo), b AS (SELECT memo FROM a WHERE memo <> 'c +d'), c AS MATERIALIZED (SELECT 'one line' AS memo) SELECT * FROM b UNION ALL SELECT 'e +f' FROM c; +WITH RECURSIVE r (n, memo) AS (SELECT 1, 'a +b' UNION ALL SELECT n + 1, memo || 'c +d' FROM r WHERE n < 3) SELECT * FROM r; +WITH upd AS (UPDATE t SET memo = 'a +b' WHERE memo = 'c +d' RETURNING id), del AS (DELETE FROM u WHERE memo = 'e +f' RETURNING id) SELECT * FROM upd, del; + +-- Views, materialized views, CREATE TABLE AS +CREATE VIEW v AS SELECT id, 'line one +line two' AS memo FROM t WHERE kind = 'a +b'; +CREATE OR REPLACE VIEW s.v (id, memo) WITH (security_barrier = true) AS SELECT id, CASE WHEN memo = 'a +b' THEN 'c +d' ELSE memo END FROM t WHERE memo <> 'e +f' WITH CHECK OPTION; +CREATE MATERIALIZED VIEW mv AS SELECT 'a +b' AS memo FROM t WHERE memo = 'c +d' WITH NO DATA; +CREATE TABLE t2 AS SELECT 'a +b' AS memo FROM t WHERE memo = 'c +d'; +SELECT 'a +b' AS memo INTO t3 FROM t WHERE memo = 'c +d'; + +-- Indexes +CREATE INDEX i ON t (lower(memo)) WHERE memo <> 'line one +line two'; +CREATE UNIQUE INDEX i ON s.t USING btree ((memo || 'a +b'), kind) WHERE memo <> 'c +d' AND kind = 'e +f'; +ALTER TABLE t ADD CONSTRAINT ex EXCLUDE USING gist (memo WITH =) WHERE (memo <> 'a +b'); + +-- COMMENT ON / SECURITY LABEL +COMMENT ON TABLE t IS 'line one +line two'; +COMMENT ON COLUMN s.t.memo IS 'line one + indented line two + +line four'; +COMMENT ON FUNCTION f(int, text) IS E'tab\there +second line'; +COMMENT ON CONSTRAINT memo_ok ON t IS 'a +b'; +COMMENT ON POLICY p ON t IS 'a +b'; +COMMENT ON TRIGGER trg ON t IS 'a +b'; +SECURITY LABEL FOR p ON TABLE t IS 'a +b'; + +-- Functions, procedures, DO blocks +CREATE FUNCTION f() RETURNS text LANGUAGE sql AS $$SELECT 'line one +line two'$$; +CREATE FUNCTION f(a text DEFAULT 'a +b', b text DEFAULT 'c') RETURNS text LANGUAGE sql IMMUTABLE AS $$ + SELECT a || 'c +d'; +$$; +CREATE FUNCTION f(a text DEFAULT 'a +b') RETURNS text LANGUAGE sql RETURN a || 'c +d'; +CREATE FUNCTION f() RETURNS SETOF text LANGUAGE sql BEGIN ATOMIC SELECT 'a +b'; SELECT memo FROM t WHERE memo = 'c +d'; END; +CREATE FUNCTION f() RETURNS trigger LANGUAGE plpgsql SET search_path = 'a +b' AS $fn$ +BEGIN + IF new.memo = 'line one +line two' THEN + RAISE EXCEPTION 'bad +memo'; + END IF; + RETURN new; +END; +$fn$; +CREATE PROCEDURE p(a text DEFAULT 'a +b') LANGUAGE sql AS $$INSERT INTO t (memo) VALUES ('c +d')$$; +DO $$ +BEGIN + RAISE NOTICE 'line one +line two'; +END +$$; +CALL p('a +b', x => 'c +d'); + +-- Types, sequences and other DDL carrying strings +CREATE TYPE e AS ENUM ('a +b', 'c'); +ALTER TYPE e ADD VALUE 'd +e' BEFORE 'a +b'; +ALTER TYPE e RENAME VALUE 'a +b' TO 'f +g'; +CREATE TABLE p1 PARTITION OF p FOR VALUES IN ('a +b', 'c +d'); +CREATE TABLE p2 PARTITION OF p (memo DEFAULT 'a +b') FOR VALUES FROM ('c +d') TO ('e +f'); +CREATE AGGREGATE agg (text) (SFUNC = f, STYPE = text, INITCOND = 'a +b'); +CREATE FOREIGN TABLE ft (memo text OPTIONS (column_name 'c +d') DEFAULT 'a +b') SERVER srv OPTIONS (table_name 'e +f'); +CREATE SERVER srv FOREIGN DATA WRAPPER w OPTIONS (host 'a +b'); +ALTER ROLE r SET search_path = 'a +b'; +SET application_name = 'a +b'; +CREATE EXTENSION x WITH SCHEMA s VERSION 'a +b'; +COPY t (memo) FROM STDIN WITH (FORMAT csv, NULL 'a +b', DELIMITER ',') WHERE memo <> 'c +d'; +COPY (SELECT 'a +b' FROM t WHERE memo = 'c +d') TO STDOUT; +PREPARE q (text) AS SELECT $1 || 'a +b' FROM t WHERE memo = 'c +d'; +EXECUTE q ('a +b'); +EXPLAIN (ANALYZE) SELECT 'a +b' FROM t WHERE memo = 'c +d'; +DECLARE c CURSOR FOR SELECT 'a +b' FROM t WHERE memo = 'c +d'; +NOTIFY ch, 'a +b'; +GRANT SELECT ON t TO r; +CREATE PUBLICATION pub FOR TABLE t WHERE (memo <> 'a +b'); +CREATE STATISTICS st ON (memo || 'a +b'), kind FROM t; +CREATE SCHEMA s CREATE TABLE t (memo text DEFAULT 'a +b') CREATE VIEW v AS SELECT 'c +d' AS memo; diff --git a/__fixtures__/plpgsql-generated/generated.json b/__fixtures__/plpgsql-generated/generated.json index 11206b7a2..925cb0ad9 100644 --- a/__fixtures__/plpgsql-generated/generated.json +++ b/__fixtures__/plpgsql-generated/generated.json @@ -165,6 +165,8 @@ "plpgsql_deparser_fixes-65.sql": "CREATE FUNCTION test_alias_trigger() RETURNS trigger\nLANGUAGE plpgsql AS $$\nDECLARE\n prior ALIAS FOR old;\n updated ALIAS FOR new;\nBEGIN\n updated.updated_at := now();\n RETURN updated;\nEND$$", "plpgsql_deparser_fixes-66.sql": "CREATE FUNCTION test_assign_named_args() RETURNS text\nLANGUAGE plpgsql AS $$\nDECLARE\n v_body text;\nBEGIN\n v_body := ast_helpers.create_function(v_schema_name := 'app_public', v_function_name := 'f');\n RETURN v_body;\nEND$$", "plpgsql_deparser_fixes-67.sql": "CREATE FUNCTION test_assign_targets() RETURNS void\nLANGUAGE plpgsql AS $$\nDECLARE\n a int[] := ARRAY[1, 2];\n r record;\nBEGIN\n SELECT 1 AS f INTO r;\n a[2] := coalesce(nullif(3, 0), 4);\n r.f := greatest(1, 2);\nEND$$", + "plpgsql_deparser_fixes-68.sql": "CREATE FUNCTION test_multiline_literals(x boolean) RETURNS text\nLANGUAGE plpgsql AS $$\nDECLARE\n v text := 'declared\ndefault';\nBEGIN\n IF x THEN\n FOR i IN 1..2 LOOP\n RAISE NOTICE 'line one\nline two';\n PERFORM length('a\nb');\n v := 'c\nd' || E'tab\\there\nquote\\'s';\n EXECUTE $q$SELECT 'e\nf'$q$;\n BEGIN\n INSERT INTO t (memo) VALUES ('g\nh') ON CONFLICT (memo) DO UPDATE SET memo = 'i\nj';\n EXCEPTION WHEN others THEN\n RAISE EXCEPTION 'failed:\n%', sqlerrm;\n END;\n END LOOP;\n ELSIF v = 'k\nl' THEN\n CASE v WHEN 'm\nn' THEN\n RETURN 'o\np';\n ELSE\n NULL;\n END CASE;\n END IF;\n RETURN v;\nEND$$", + "plpgsql_deparser_fixes-69.sql": "DO $do$\nDECLARE\n r record;\nBEGIN\n FOR r IN SELECT \"odd\ncolumn\" AS c FROM t WHERE memo = $s$dollar\nquoted$s$ LOOP\n WHILE r.c IS NOT NULL LOOP\n RAISE NOTICE '%', r.c || '\nsuffix';\n EXIT;\n END LOOP;\n END LOOP;\nEND$do$", "plpgsql_control-1.sql": "do $$\nbegin\n -- basic case\n for i in 1..3 loop\n raise notice '1..3: i = %', i;\n end loop;\n -- with BY, end matches exactly\n for i in 1..10 by 3 loop\n raise notice '1..10 by 3: i = %', i;\n end loop;\n -- with BY, end does not match\n for i in 1..11 by 3 loop\n raise notice '1..11 by 3: i = %', i;\n end loop;\n -- zero iterations\n for i in 1..0 by 3 loop\n raise notice '1..0 by 3: i = %', i;\n end loop;\n -- REVERSE\n for i in reverse 10..0 by 3 loop\n raise notice 'reverse 10..0 by 3: i = %', i;\n end loop;\n -- potential overflow\n for i in 2147483620..2147483647 by 10 loop\n raise notice '2147483620..2147483647 by 10: i = %', i;\n end loop;\n -- potential overflow, reverse direction\n for i in reverse -2147483620..-2147483647 by 10 loop\n raise notice 'reverse -2147483620..-2147483647 by 10: i = %', i;\n end loop;\nend$$", "plpgsql_control-2.sql": "do $$\nbegin\n for i in 1..3 by 0 loop\n raise notice '1..3 by 0: i = %', i;\n end loop;\nend$$", "plpgsql_control-3.sql": "do $$\nbegin\n for i in 1..3 by -1 loop\n raise notice '1..3 by -1: i = %', i;\n end loop;\nend$$", diff --git a/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql b/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql index 56ac57d08..4d38593bd 100644 --- a/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql +++ b/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql @@ -837,3 +837,59 @@ BEGIN a[2] := coalesce(nullif(3, 0), 4); r.f := greatest(1, 2); END$$; + +-- Test 68: multi-line string literals inside nested blocks keep their value +CREATE FUNCTION test_multiline_literals(x boolean) RETURNS text +LANGUAGE plpgsql AS $$ +DECLARE + v text := 'declared +default'; +BEGIN + IF x THEN + FOR i IN 1..2 LOOP + RAISE NOTICE 'line one +line two'; + PERFORM length('a +b'); + v := 'c +d' || E'tab\there +quote\'s'; + EXECUTE $q$SELECT 'e +f'$q$; + BEGIN + INSERT INTO t (memo) VALUES ('g +h') ON CONFLICT (memo) DO UPDATE SET memo = 'i +j'; + EXCEPTION WHEN others THEN + RAISE EXCEPTION 'failed: +%', sqlerrm; + END; + END LOOP; + ELSIF v = 'k +l' THEN + CASE v WHEN 'm +n' THEN + RETURN 'o +p'; + ELSE + NULL; + END CASE; + END IF; + RETURN v; +END$$; + +-- Test 69: multi-line quoted identifiers and dollar-quoted strings inside nested blocks +DO $do$ +DECLARE + r record; +BEGIN + FOR r IN SELECT "odd +column" AS c FROM t WHERE memo = $s$dollar +quoted$s$ LOOP + WHILE r.c IS NOT NULL LOOP + RAISE NOTICE '%', r.c || ' +suffix'; + EXIT; + END LOOP; + END LOOP; +END$do$; diff --git a/packages/deparser/DEPARSER_USAGE.md b/packages/deparser/DEPARSER_USAGE.md index 70022f0d1..8636643d4 100644 --- a/packages/deparser/DEPARSER_USAGE.md +++ b/packages/deparser/DEPARSER_USAGE.md @@ -174,7 +174,14 @@ Pretty formatting is supported for: **Important Notes:** - Pretty formatting preserves SQL semantics - the formatted SQL parses to the same AST -- Multi-line string literals are preserved without indentation to maintain their content +- Multi-line string literals are preserved without indentation to maintain their content: indentation is applied only at line breaks the formatter itself emits, never at a newline inside a single-quoted (`'...'`), escape (`E'...'`) or dollar-quoted (`$tag$...$tag$`) string, a quoted identifier, or a comment — so a continuation line of a literal stays at column 0 while the SQL around it is indented: + +```sql +CREATE TABLE t ( + memo text DEFAULT 'line one +line two' +) +``` - Complex expressions maintain proper parentheses and operator precedence ## Instance Usage diff --git a/packages/deparser/__tests__/kitchen-sink/misc-indirection-parens.test.ts b/packages/deparser/__tests__/kitchen-sink/misc-indirection-parens.test.ts new file mode 100644 index 000000000..59a216aba --- /dev/null +++ b/packages/deparser/__tests__/kitchen-sink/misc-indirection-parens.test.ts @@ -0,0 +1,103 @@ + +import { FixtureTestUtils } from '../../test-utils'; +const fixtures = new FixtureTestUtils(); + +it('misc-indirection-parens', async () => { + await fixtures.runFixtureTests([ + "misc/indirection-parens-1.sql", + "misc/indirection-parens-2.sql", + "misc/indirection-parens-3.sql", + "misc/indirection-parens-4.sql", + "misc/indirection-parens-5.sql", + "misc/indirection-parens-6.sql", + "misc/indirection-parens-7.sql", + "misc/indirection-parens-8.sql", + "misc/indirection-parens-9.sql", + "misc/indirection-parens-10.sql", + "misc/indirection-parens-11.sql", + "misc/indirection-parens-12.sql", + "misc/indirection-parens-13.sql", + "misc/indirection-parens-14.sql", + "misc/indirection-parens-15.sql", + "misc/indirection-parens-16.sql", + "misc/indirection-parens-17.sql", + "misc/indirection-parens-18.sql", + "misc/indirection-parens-19.sql", + "misc/indirection-parens-20.sql", + "misc/indirection-parens-21.sql", + "misc/indirection-parens-22.sql", + "misc/indirection-parens-23.sql", + "misc/indirection-parens-24.sql", + "misc/indirection-parens-25.sql", + "misc/indirection-parens-26.sql", + "misc/indirection-parens-27.sql", + "misc/indirection-parens-28.sql", + "misc/indirection-parens-29.sql", + "misc/indirection-parens-30.sql", + "misc/indirection-parens-31.sql", + "misc/indirection-parens-32.sql", + "misc/indirection-parens-33.sql", + "misc/indirection-parens-34.sql", + "misc/indirection-parens-35.sql", + "misc/indirection-parens-36.sql", + "misc/indirection-parens-37.sql", + "misc/indirection-parens-38.sql", + "misc/indirection-parens-39.sql", + "misc/indirection-parens-40.sql", + "misc/indirection-parens-41.sql", + "misc/indirection-parens-42.sql", + "misc/indirection-parens-43.sql", + "misc/indirection-parens-44.sql", + "misc/indirection-parens-45.sql", + "misc/indirection-parens-46.sql", + "misc/indirection-parens-47.sql", + "misc/indirection-parens-48.sql", + "misc/indirection-parens-49.sql", + "misc/indirection-parens-50.sql", + "misc/indirection-parens-51.sql", + "misc/indirection-parens-52.sql", + "misc/indirection-parens-53.sql", + "misc/indirection-parens-54.sql", + "misc/indirection-parens-55.sql", + "misc/indirection-parens-56.sql", + "misc/indirection-parens-57.sql", + "misc/indirection-parens-58.sql", + "misc/indirection-parens-59.sql", + "misc/indirection-parens-60.sql", + "misc/indirection-parens-61.sql", + "misc/indirection-parens-62.sql", + "misc/indirection-parens-63.sql", + "misc/indirection-parens-64.sql", + "misc/indirection-parens-65.sql", + "misc/indirection-parens-66.sql", + "misc/indirection-parens-67.sql", + "misc/indirection-parens-68.sql", + "misc/indirection-parens-69.sql", + "misc/indirection-parens-70.sql", + "misc/indirection-parens-71.sql", + "misc/indirection-parens-72.sql", + "misc/indirection-parens-73.sql", + "misc/indirection-parens-74.sql", + "misc/indirection-parens-75.sql", + "misc/indirection-parens-76.sql", + "misc/indirection-parens-77.sql", + "misc/indirection-parens-78.sql", + "misc/indirection-parens-79.sql", + "misc/indirection-parens-80.sql", + "misc/indirection-parens-81.sql", + "misc/indirection-parens-82.sql", + "misc/indirection-parens-83.sql", + "misc/indirection-parens-84.sql", + "misc/indirection-parens-85.sql", + "misc/indirection-parens-86.sql", + "misc/indirection-parens-87.sql", + "misc/indirection-parens-88.sql", + "misc/indirection-parens-89.sql", + "misc/indirection-parens-90.sql", + "misc/indirection-parens-91.sql", + "misc/indirection-parens-92.sql", + "misc/indirection-parens-93.sql", + "misc/indirection-parens-94.sql", + "misc/indirection-parens-95.sql" +]); +}); diff --git a/packages/deparser/__tests__/kitchen-sink/misc-multiline-string-literals.test.ts b/packages/deparser/__tests__/kitchen-sink/misc-multiline-string-literals.test.ts new file mode 100644 index 000000000..cf3ca1bc7 --- /dev/null +++ b/packages/deparser/__tests__/kitchen-sink/misc-multiline-string-literals.test.ts @@ -0,0 +1,138 @@ + +import { FixtureTestUtils } from '../../test-utils'; +const fixtures = new FixtureTestUtils(); + +it('misc-multiline-string-literals', async () => { + await fixtures.runFixtureTests([ + "misc/multiline-string-literals-1.sql", + "misc/multiline-string-literals-2.sql", + "misc/multiline-string-literals-3.sql", + "misc/multiline-string-literals-4.sql", + "misc/multiline-string-literals-5.sql", + "misc/multiline-string-literals-6.sql", + "misc/multiline-string-literals-7.sql", + "misc/multiline-string-literals-8.sql", + "misc/multiline-string-literals-9.sql", + "misc/multiline-string-literals-10.sql", + "misc/multiline-string-literals-11.sql", + "misc/multiline-string-literals-12.sql", + "misc/multiline-string-literals-13.sql", + "misc/multiline-string-literals-14.sql", + "misc/multiline-string-literals-15.sql", + "misc/multiline-string-literals-16.sql", + "misc/multiline-string-literals-17.sql", + "misc/multiline-string-literals-18.sql", + "misc/multiline-string-literals-19.sql", + "misc/multiline-string-literals-20.sql", + "misc/multiline-string-literals-21.sql", + "misc/multiline-string-literals-22.sql", + "misc/multiline-string-literals-23.sql", + "misc/multiline-string-literals-24.sql", + "misc/multiline-string-literals-25.sql", + "misc/multiline-string-literals-26.sql", + "misc/multiline-string-literals-27.sql", + "misc/multiline-string-literals-28.sql", + "misc/multiline-string-literals-29.sql", + "misc/multiline-string-literals-30.sql", + "misc/multiline-string-literals-31.sql", + "misc/multiline-string-literals-32.sql", + "misc/multiline-string-literals-33.sql", + "misc/multiline-string-literals-34.sql", + "misc/multiline-string-literals-35.sql", + "misc/multiline-string-literals-36.sql", + "misc/multiline-string-literals-37.sql", + "misc/multiline-string-literals-38.sql", + "misc/multiline-string-literals-39.sql", + "misc/multiline-string-literals-40.sql", + "misc/multiline-string-literals-41.sql", + "misc/multiline-string-literals-42.sql", + "misc/multiline-string-literals-43.sql", + "misc/multiline-string-literals-44.sql", + "misc/multiline-string-literals-45.sql", + "misc/multiline-string-literals-46.sql", + "misc/multiline-string-literals-47.sql", + "misc/multiline-string-literals-48.sql", + "misc/multiline-string-literals-49.sql", + "misc/multiline-string-literals-50.sql", + "misc/multiline-string-literals-51.sql", + "misc/multiline-string-literals-52.sql", + "misc/multiline-string-literals-53.sql", + "misc/multiline-string-literals-54.sql", + "misc/multiline-string-literals-55.sql", + "misc/multiline-string-literals-56.sql", + "misc/multiline-string-literals-57.sql", + "misc/multiline-string-literals-58.sql", + "misc/multiline-string-literals-59.sql", + "misc/multiline-string-literals-60.sql", + "misc/multiline-string-literals-61.sql", + "misc/multiline-string-literals-62.sql", + "misc/multiline-string-literals-63.sql", + "misc/multiline-string-literals-64.sql", + "misc/multiline-string-literals-65.sql", + "misc/multiline-string-literals-66.sql", + "misc/multiline-string-literals-67.sql", + "misc/multiline-string-literals-68.sql", + "misc/multiline-string-literals-69.sql", + "misc/multiline-string-literals-70.sql", + "misc/multiline-string-literals-71.sql", + "misc/multiline-string-literals-72.sql", + "misc/multiline-string-literals-73.sql", + "misc/multiline-string-literals-74.sql", + "misc/multiline-string-literals-75.sql", + "misc/multiline-string-literals-76.sql", + "misc/multiline-string-literals-77.sql", + "misc/multiline-string-literals-78.sql", + "misc/multiline-string-literals-79.sql", + "misc/multiline-string-literals-80.sql", + "misc/multiline-string-literals-81.sql", + "misc/multiline-string-literals-82.sql", + "misc/multiline-string-literals-83.sql", + "misc/multiline-string-literals-84.sql", + "misc/multiline-string-literals-85.sql", + "misc/multiline-string-literals-86.sql", + "misc/multiline-string-literals-87.sql", + "misc/multiline-string-literals-88.sql", + "misc/multiline-string-literals-89.sql", + "misc/multiline-string-literals-90.sql", + "misc/multiline-string-literals-91.sql", + "misc/multiline-string-literals-92.sql", + "misc/multiline-string-literals-93.sql", + "misc/multiline-string-literals-94.sql", + "misc/multiline-string-literals-95.sql", + "misc/multiline-string-literals-96.sql", + "misc/multiline-string-literals-97.sql", + "misc/multiline-string-literals-98.sql", + "misc/multiline-string-literals-99.sql", + "misc/multiline-string-literals-100.sql", + "misc/multiline-string-literals-101.sql", + "misc/multiline-string-literals-102.sql", + "misc/multiline-string-literals-103.sql", + "misc/multiline-string-literals-104.sql", + "misc/multiline-string-literals-105.sql", + "misc/multiline-string-literals-106.sql", + "misc/multiline-string-literals-107.sql", + "misc/multiline-string-literals-108.sql", + "misc/multiline-string-literals-109.sql", + "misc/multiline-string-literals-110.sql", + "misc/multiline-string-literals-111.sql", + "misc/multiline-string-literals-112.sql", + "misc/multiline-string-literals-113.sql", + "misc/multiline-string-literals-114.sql", + "misc/multiline-string-literals-115.sql", + "misc/multiline-string-literals-116.sql", + "misc/multiline-string-literals-117.sql", + "misc/multiline-string-literals-118.sql", + "misc/multiline-string-literals-119.sql", + "misc/multiline-string-literals-120.sql", + "misc/multiline-string-literals-121.sql", + "misc/multiline-string-literals-122.sql", + "misc/multiline-string-literals-123.sql", + "misc/multiline-string-literals-124.sql", + "misc/multiline-string-literals-125.sql", + "misc/multiline-string-literals-126.sql", + "misc/multiline-string-literals-127.sql", + "misc/multiline-string-literals-128.sql", + "misc/multiline-string-literals-129.sql", + "misc/multiline-string-literals-130.sql" +]); +}); diff --git a/packages/deparser/__tests__/pretty/__snapshots__/misc-pretty.test.ts.snap b/packages/deparser/__tests__/pretty/__snapshots__/misc-pretty.test.ts.snap index 88f227f33..3a8dcc81d 100644 --- a/packages/deparser/__tests__/pretty/__snapshots__/misc-pretty.test.ts.snap +++ b/packages/deparser/__tests__/pretty/__snapshots__/misc-pretty.test.ts.snap @@ -93,14 +93,14 @@ exports[`pretty: pretty/misc-4.sql 1`] = ` "SELECT p.id, p.title, -CASE - WHEN EXISTS (SELECT 1 - FROM reviews AS r - WHERE - r.product_id = p.id - AND r.rating >= 4) THEN 'Popular' - ELSE 'Unrated' -END AS status + CASE + WHEN EXISTS (SELECT 1 + FROM reviews AS r + WHERE + r.product_id = p.id + AND r.rating >= 4) THEN 'Popular' + ELSE 'Unrated' + END AS status FROM products AS p WHERE p.archived = false" @@ -108,13 +108,13 @@ WHERE exports[`pretty: pretty/misc-5.sql 1`] = ` "WITH -logs AS (SELECT - id, - payload::json ->> 'event' AS event, - CAST(payload::json ->> 'ts' AS timestamp) AS ts -FROM event_log -WHERE - ts > (now() - '7 days'::interval)) + logs AS (SELECT + id, + payload::json ->> 'event' AS event, + CAST(payload::json ->> 'ts' AS timestamp) AS ts + FROM event_log + WHERE + ts > (now() - '7 days'::interval)) SELECT event, count(*) AS freq @@ -145,20 +145,23 @@ JOIN products AS p ON OR (p.sku = oi.product_sku AND (p.discontinued = false OR p.replacement_id IS NOT NULL)) -LEFT JOIN shipping AS sh ON sh.order_id = o.id - AND ((sh.carrier = 'UPS' - AND sh.tracking_number IS NOT NULL) - OR (sh.carrier = 'FedEx' - AND sh.shipped_at > (o.created_at + '1 day'::interval))) -LEFT JOIN statuses AS s ON s.id = o.status_id - AND (s.name <> 'cancelled' - OR (s.name = 'cancelled' - AND s.updated_at > (now() - '7 days'::interval))) -LEFT JOIN refunds AS r ON r.order_id = o.id - AND ((r.status = 'approved' - AND r.processed_at IS NOT NULL) - OR (r.status = 'pending' - AND r.requested_at < (now() - '14 days'::interval))) +LEFT JOIN shipping AS sh ON + sh.order_id = o.id + AND ((sh.carrier = 'UPS' + AND sh.tracking_number IS NOT NULL) + OR (sh.carrier = 'FedEx' + AND sh.shipped_at > (o.created_at + '1 day'::interval))) +LEFT JOIN statuses AS s ON + s.id = o.status_id + AND (s.name <> 'cancelled' + OR (s.name = 'cancelled' + AND s.updated_at > (now() - '7 days'::interval))) +LEFT JOIN refunds AS r ON + r.order_id = o.id + AND ((r.status = 'approved' + AND r.processed_at IS NOT NULL) + OR (r.status = 'pending' + AND r.requested_at < (now() - '14 days'::interval))) WHERE o.created_at > (now() - '90 days'::interval) AND u.active = true @@ -175,66 +178,66 @@ ORDER BY exports[`pretty: pretty/misc-7.sql 1`] = ` "SELECT -CASE - WHEN n = 2 THEN ARRAY['month'] - WHEN n = 4 THEN ARRAY['year'] - WHEN n = 6 THEN ARRAY['year', 'month'] - WHEN n = 8 THEN ARRAY['day'] - WHEN n = 1024 THEN ARRAY['hour'] - WHEN n = 1032 THEN ARRAY['day', 'hour'] - WHEN n = 2048 THEN ARRAY['minute'] - WHEN n = 3072 THEN ARRAY['hour', 'minute'] - WHEN n = 3080 THEN ARRAY['day', 'minute'] - WHEN n = 4096 THEN ARRAY['second'] - WHEN n = 6144 THEN ARRAY['minute', 'second'] - WHEN n = 7168 THEN ARRAY['hour', 'second'] - WHEN n = 7176 THEN ARRAY['day', 'second'] - WHEN n = 32767 THEN CAST(ARRAY[] AS text[]) -END" + CASE + WHEN n = 2 THEN ARRAY['month'] + WHEN n = 4 THEN ARRAY['year'] + WHEN n = 6 THEN ARRAY['year', 'month'] + WHEN n = 8 THEN ARRAY['day'] + WHEN n = 1024 THEN ARRAY['hour'] + WHEN n = 1032 THEN ARRAY['day', 'hour'] + WHEN n = 2048 THEN ARRAY['minute'] + WHEN n = 3072 THEN ARRAY['hour', 'minute'] + WHEN n = 3080 THEN ARRAY['day', 'minute'] + WHEN n = 4096 THEN ARRAY['second'] + WHEN n = 6144 THEN ARRAY['minute', 'second'] + WHEN n = 7168 THEN ARRAY['hour', 'second'] + WHEN n = 7176 THEN ARRAY['day', 'second'] + WHEN n = 32767 THEN CAST(ARRAY[] AS text[]) + END" `; exports[`pretty: pretty/misc-8.sql 1`] = ` "SELECT -CASE - WHEN n = 2 - OR n = 3 THEN ARRAY['month', COALESCE(extra_label, 'unknown')] -WHEN n IN (4, 5) THEN CASE - WHEN is_leap_year THEN ARRAY['year', 'leap'] - ELSE ARRAY['year'] -END - WHEN n = 6 THEN ARRAY['year', 'month', 'quarter'] - WHEN n = 8 THEN ARRAY['day', 'week', compute_label(n)] - WHEN n = 1024 THEN ARRAY['hour', format('%s-hour', extra_label)] - WHEN n = 1032 - AND flag = true THEN ARRAY['day', 'hour', 'flagged'] - WHEN n BETWEEN 2048 AND 2049 THEN ARRAY['minute', 'tick'] - WHEN n = 3072 THEN ARRAY['hour', 'minute', current_setting('timezone')] - WHEN n = 3080 THEN ARRAY['day', 'minute', to_char(now(), 'HH24:MI')] - WHEN n IN (4096, 4097, 4098) THEN ARRAY['second', 'millisecond'] -WHEN n = 6144 THEN ARRAY['minute', 'second', CASE - WHEN use_micro = true THEN 'microsecond' - ELSE 'none' -END] - WHEN n = 7168 - OR (n > 7170 - AND n < 7180) THEN ARRAY['hour', 'second', 'buffered'] - WHEN n = 7176 THEN ARRAY['day', 'second', extra_info::text] - WHEN n = 32767 THEN CAST(ARRAY[] AS text[]) - ELSE ARRAY['undefined', 'unknown', 'fallback'] -END" + CASE + WHEN n = 2 + OR n = 3 THEN ARRAY['month', COALESCE(extra_label, 'unknown')] + WHEN n IN (4, 5) THEN CASE + WHEN is_leap_year THEN ARRAY['year', 'leap'] + ELSE ARRAY['year'] + END + WHEN n = 6 THEN ARRAY['year', 'month', 'quarter'] + WHEN n = 8 THEN ARRAY['day', 'week', compute_label(n)] + WHEN n = 1024 THEN ARRAY['hour', format('%s-hour', extra_label)] + WHEN n = 1032 + AND flag = true THEN ARRAY['day', 'hour', 'flagged'] + WHEN n BETWEEN 2048 AND 2049 THEN ARRAY['minute', 'tick'] + WHEN n = 3072 THEN ARRAY['hour', 'minute', current_setting('timezone')] + WHEN n = 3080 THEN ARRAY['day', 'minute', to_char(now(), 'HH24:MI')] + WHEN n IN (4096, 4097, 4098) THEN ARRAY['second', 'millisecond'] + WHEN n = 6144 THEN ARRAY['minute', 'second', CASE + WHEN use_micro = true THEN 'microsecond' + ELSE 'none' + END] + WHEN n = 7168 + OR (n > 7170 + AND n < 7180) THEN ARRAY['hour', 'second', 'buffered'] + WHEN n = 7176 THEN ARRAY['day', 'second', extra_info::text] + WHEN n = 32767 THEN CAST(ARRAY[] AS text[]) + ELSE ARRAY['undefined', 'unknown', 'fallback'] + END" `; exports[`pretty: pretty/misc-9.sql 1`] = ` "SELECT user_id, -CASE - WHEN EXISTS (SELECT 1 - FROM logins - WHERE - logins.user_id = users.user_id - AND success = false) THEN 'risky' - ELSE 'safe' -END AS risk_status + CASE + WHEN EXISTS (SELECT 1 + FROM logins + WHERE + logins.user_id = users.user_id + AND success = false) THEN 'risky' + ELSE 'safe' + END AS risk_status FROM users" `; @@ -252,33 +255,33 @@ END)" exports[`pretty: pretty/misc-11.sql 1`] = ` "SELECT * FROM users AS u, LATERAL ( SELECT -CASE - WHEN u.is_admin THEN 'admin_dashboard' - ELSE 'user_dashboard' -END AS dashboard_view ) AS derived" + CASE + WHEN u.is_admin THEN 'admin_dashboard' + ELSE 'user_dashboard' + END AS dashboard_view ) AS derived" `; exports[`pretty: pretty/misc-12.sql 1`] = ` "SELECT id, -(SELECT -CASE - WHEN count(*) > 5 THEN 'frequent' - ELSE 'occasional' -END -FROM purchases AS p -WHERE - p.user_id = u.id) AS purchase_freq + (SELECT + CASE + WHEN count(*) > 5 THEN 'frequent' + ELSE 'occasional' + END + FROM purchases AS p + WHERE + p.user_id = u.id) AS purchase_freq FROM users AS u" `; exports[`pretty: pretty/misc-13.sql 1`] = ` "SELECT id, -CASE - WHEN rank() OVER (ORDER BY score DESC) = 1 THEN 'top' - ELSE 'normal' -END AS tier + CASE + WHEN rank() OVER (ORDER BY score DESC) = 1 THEN 'top' + ELSE 'normal' + END AS tier FROM players" `; @@ -288,7 +291,7 @@ exports[`pretty: pretty/misc-14.sql 1`] = ` ON dashboard_jobs.jobs FOR EACH ROW WHEN (old.queue_name IS NOT NULL) - EXECUTE PROCEDURE dashboard_jobs.tg_decrease_job_queue_count()" + EXECUTE FUNCTION dashboard_jobs.tg_decrease_job_queue_count()" `; exports[`pretty: pretty/misc-15.sql 1`] = ` diff --git a/packages/deparser/__tests__/pretty/__snapshots__/triggers-pretty.test.ts.snap b/packages/deparser/__tests__/pretty/__snapshots__/triggers-pretty.test.ts.snap index be2d1e705..4e4795fd4 100644 --- a/packages/deparser/__tests__/pretty/__snapshots__/triggers-pretty.test.ts.snap +++ b/packages/deparser/__tests__/pretty/__snapshots__/triggers-pretty.test.ts.snap @@ -25,7 +25,7 @@ exports[`pretty: pretty/triggers-1.sql 1`] = ` AFTER INSERT ON public.users FOR EACH ROW - EXECUTE PROCEDURE log_user_insert()" + EXECUTE FUNCTION log_user_insert()" `; exports[`pretty: pretty/triggers-2.sql 1`] = ` @@ -33,7 +33,7 @@ exports[`pretty: pretty/triggers-2.sql 1`] = ` AFTER DELETE ON "SensitiveData" FOR EACH ROW - EXECUTE PROCEDURE public.log_deletion()" + EXECUTE FUNCTION public.log_deletion()" `; exports[`pretty: pretty/triggers-3.sql 1`] = ` @@ -42,7 +42,7 @@ exports[`pretty: pretty/triggers-3.sql 1`] = ` ON accounts FOR EACH ROW WHEN (old.active = false) - EXECUTE PROCEDURE "ArchiveFunction"()" + EXECUTE FUNCTION "ArchiveFunction"()" `; exports[`pretty: pretty/triggers-4.sql 1`] = ` @@ -50,7 +50,7 @@ exports[`pretty: pretty/triggers-4.sql 1`] = ` AFTER INSERT OR UPDATE ON metrics.stats FOR EACH ROW - EXECUTE PROCEDURE metrics.update_stats('user', 'true')" + EXECUTE FUNCTION metrics.update_stats('user', 'true')" `; exports[`pretty: pretty/triggers-5.sql 1`] = ` @@ -59,7 +59,7 @@ exports[`pretty: pretty/triggers-5.sql 1`] = ` ON "weirdSchema"."ComplexTable" FOR EACH ROW WHEN (old.status = 'pending') - EXECUTE PROCEDURE "weirdSchema"."ComplexFn"('arg1', '42')" + EXECUTE FUNCTION "weirdSchema"."ComplexFn"('arg1', '42')" `; exports[`pretty: pretty/triggers-6.sql 1`] = ` @@ -67,7 +67,7 @@ exports[`pretty: pretty/triggers-6.sql 1`] = ` AFTER INSERT OR DELETE OR UPDATE ON users FOR EACH ROW - EXECUTE PROCEDURE audit.activity_log()" + EXECUTE FUNCTION audit.activity_log()" `; exports[`pretty: pretty/triggers-7.sql 1`] = ` @@ -75,7 +75,7 @@ exports[`pretty: pretty/triggers-7.sql 1`] = ` BEFORE INSERT ON log_table FOR EACH ROW - EXECUTE PROCEDURE update_log()" + EXECUTE FUNCTION update_log()" `; exports[`pretty: pretty/triggers-8.sql 1`] = ` @@ -84,7 +84,7 @@ exports[`pretty: pretty/triggers-8.sql 1`] = ` ON profiles FOR EACH ROW WHEN (new."accessLevel" = 'admin') - EXECUTE PROCEDURE flag_admin_change()" + EXECUTE FUNCTION flag_admin_change()" `; exports[`pretty: pretty/triggers-9.sql 1`] = ` @@ -92,7 +92,7 @@ exports[`pretty: pretty/triggers-9.sql 1`] = ` BEFORE INSERT ON datapoints FOR EACH ROW - EXECUTE PROCEDURE "HandleInsert"('TYPE_A', 'Region-1')" + EXECUTE FUNCTION "HandleInsert"('TYPE_A', 'Region-1')" `; exports[`pretty: pretty/triggers-10.sql 1`] = ` @@ -100,5 +100,5 @@ exports[`pretty: pretty/triggers-10.sql 1`] = ` AFTER DELETE ON events_log_partition FOR EACH ROW - EXECUTE PROCEDURE propagate_deletion()" + EXECUTE FUNCTION propagate_deletion()" `; diff --git a/packages/deparser/src/deparser.ts b/packages/deparser/src/deparser.ts index 263563425..ffbf7e294 100644 --- a/packages/deparser/src/deparser.ts +++ b/packages/deparser/src/deparser.ts @@ -563,11 +563,7 @@ export class Deparser implements DeparserVisitor { // Check if single target is complex - if so, use multiline format if (this.isComplexSelectTarget(targetNode)) { output.push('SELECT' + distinctPart); - if (this.containsMultilineStringLiteral(target)) { - output.push(target); - } else { - output.push(context.indent(target)); - } + output.push(context.indent(target)); } else { output.push('SELECT' + distinctPart + ' ' + target); } @@ -575,9 +571,6 @@ export class Deparser implements DeparserVisitor { const targetStrings = targetList .map(e => { const targetStr = this.visit(e as Node, context.spawn('SelectStmt', { select: true })); - if (this.containsMultilineStringLiteral(targetStr)) { - return targetStr; - } return context.indent(targetStr); }); const formattedTargets = targetStrings.join(',' + context.newline()); @@ -631,9 +624,6 @@ export class Deparser implements DeparserVisitor { return context.parens(values.join(', ')); }); const indentedTuples = lists.map(tuple => { - if (this.containsMultilineStringLiteral(tuple)) { - return tuple; - } return context.indent(tuple); }); output.push(indentedTuples.join(',\n')); @@ -653,9 +643,6 @@ export class Deparser implements DeparserVisitor { const groupItems = groupList .map(e => { const groupStr = this.visit(e as Node, context.spawn('SelectStmt', { group: true, indentLevel: context.indentLevel + 1 })); - if (this.containsMultilineStringLiteral(groupStr)) { - return groupStr; - } return context.indent(groupStr); }) .join(',' + context.newline()); @@ -674,11 +661,7 @@ export class Deparser implements DeparserVisitor { if (context.isPretty()) { output.push('HAVING'); const havingStr = this.visit(node.havingClause as Node, context); - if (this.containsMultilineStringLiteral(havingStr)) { - output.push(havingStr); - } else { - output.push(context.indent(havingStr)); - } + output.push(context.indent(havingStr)); } else { output.push('HAVING'); output.push(this.visit(node.havingClause as Node, context)); @@ -700,9 +683,6 @@ export class Deparser implements DeparserVisitor { const sortItems = sortList .map(e => { const sortStr = this.visit(e as Node, context.spawn('SelectStmt', { sort: true, indentLevel: context.indentLevel + 1 })); - if (this.containsMultilineStringLiteral(sortStr)) { - return sortStr; - } return context.indent(sortStr); }) .join(',' + context.newline()); @@ -1197,7 +1177,7 @@ export class Deparser implements DeparserVisitor { if (context.isPretty()) { // Put each assignment on its own line for pretty printing const indentedTargets = targets.map(target => context.indent(target)); - output.push('\n' + indentedTargets.join(',\n')); + output[output.length - 1] += '\n' + indentedTargets.join(',\n'); } else { output.push(targets.join(', ')); } @@ -1369,9 +1349,6 @@ export class Deparser implements DeparserVisitor { const cteStrings = ctes.map((cte, index) => { const cteStr = this.visit(cte, context); const prefix = index === 0 ? context.newline() : ',' + context.newline(); - if (this.containsMultilineStringLiteral(cteStr)) { - return prefix + cteStr; - } return prefix + context.indent(cteStr); }); output.push(cteStrings.join('')); @@ -2399,7 +2376,9 @@ export class Deparser implements DeparserVisitor { let argStr = this.visit(node.arg, context); const argType = this.getNodeType(node.arg); - if (argType === 'TypeCast' || argType === 'SubLink' || argType === 'A_Expr' || argType === 'FuncCall' || argType === 'A_Indirection' || argType === 'ColumnRef' || argType === 'RowExpr') { + // Grammar: only a parameter takes indirection bare; every other target is + // `'(' a_expr ')' opt_indirection` (a plain column subscript is the same node). + if (argType !== 'ParamRef') { argStr = `(${argStr})`; } @@ -2434,20 +2413,12 @@ export class Deparser implements DeparserVisitor { if (context.isPretty() && args.length > 0) { for (const arg of args) { const whenClause = this.visit(arg, context); - if (this.containsMultilineStringLiteral(whenClause)) { - output.push(context.newline() + whenClause); - } else { - output.push(context.newline() + context.indent(whenClause)); - } + output.push(context.newline() + context.indent(whenClause)); } if (node.defresult) { const elseResult = this.visit(node.defresult, context); - if (this.containsMultilineStringLiteral(elseResult)) { - output.push(context.newline() + 'ELSE ' + elseResult); - } else { - output.push(context.newline() + context.indent('ELSE ' + elseResult)); - } + output.push(context.newline() + context.indent('ELSE ' + elseResult)); } output.push(context.newline() + 'END'); @@ -4182,11 +4153,7 @@ export class Deparser implements DeparserVisitor { if (context.isPretty()) { // For complex JOIN conditions, format with proper indentation if (qualsStr.includes('AND') || qualsStr.includes('OR') || qualsStr.length > 50) { - if (this.containsMultilineStringLiteral(qualsStr)) { - output.push(` ON ${qualsStr}`); - } else { - output.push(` ON${context.newline()}${context.indent(qualsStr)}`); - } + output.push(` ON${context.newline()}${context.indent(qualsStr)}`); } else { output.push(` ON ${qualsStr}`); } @@ -6302,7 +6269,7 @@ export class Deparser implements DeparserVisitor { if (node.defname === 'new_version') { // argValue is unquoted due to DefElem context, so we need to quote it const quotedValue = this.quoteDefElemArg(node.arg, argValue); - return `UPDATE TO ${quotedValue}`; + return `TO ${quotedValue}`; } if (node.defname === 'schema') { return `SET SCHEMA ${argValue}`; @@ -6328,6 +6295,12 @@ export class Deparser implements DeparserVisitor { if (node.defname === 'cascade') { return argValue === 'true' ? 'CASCADE' : ''; } + if (node.defname === 'new_version') { + return `VERSION ${this.quoteDefElemArg(node.arg, argValue)}`; + } + if (node.defname === 'schema' && node.arg && this.getNodeType(node.arg) === 'String') { + return `SCHEMA ${QuoteUtils.quoteIdentifier(this.getNodeData(node.arg).sval)}`; + } return `${node.defname.toUpperCase()} ${argValue}`; } @@ -6623,6 +6596,8 @@ export class Deparser implements DeparserVisitor { output.push(this.quoteIfNeeded(node.extname)); } + output.push('UPDATE'); + if (node.options && node.options.length > 0) { const extContext = context.spawn('AlterExtensionStmt'); const options = ListUtils.unwrapList(node.options) @@ -9187,6 +9162,10 @@ export class Deparser implements DeparserVisitor { components.push(context.indent('REFERENCING ' + transitionClauses)); } + if (node.constrrel) { + components.push(context.indent('FROM ' + this.RangeVar(node.constrrel, context))); + } + if (node.deferrable) { components.push(context.indent('DEFERRABLE')); } @@ -9211,7 +9190,7 @@ export class Deparser implements DeparserVisitor { const funcName = ListUtils.unwrapList(node.funcname) .map(name => this.visit(name, context)) .join('.'); - executeStr += ' PROCEDURE ' + funcName; + executeStr += ' FUNCTION ' + funcName; } if (node.args && node.args.length > 0) { @@ -11953,9 +11932,4 @@ export class Deparser implements DeparserVisitor { return output.join(' '); } - - private containsMultilineStringLiteral(content: string): boolean { - const stringLiteralRegex = /'[^']*\n[^']*'/g; - return stringLiteralRegex.test(content); - } } diff --git a/packages/deparser/src/index.ts b/packages/deparser/src/index.ts index 0654a4e15..9128eb1c4 100644 --- a/packages/deparser/src/index.ts +++ b/packages/deparser/src/index.ts @@ -11,4 +11,5 @@ export const deparse = async (...args: Parameters): Promis }; export { Deparser, DeparserOptions }; +export { splitSqlLines } from './utils/sql-formatter'; export { QuoteUtils } from '@pgsql/quotes'; diff --git a/packages/deparser/src/utils/sql-formatter.ts b/packages/deparser/src/utils/sql-formatter.ts index a3daee530..a1b5f387d 100644 --- a/packages/deparser/src/utils/sql-formatter.ts +++ b/packages/deparser/src/utils/sql-formatter.ts @@ -1,3 +1,99 @@ +const isIdentChar = (ch: string | undefined): boolean => + ch !== undefined && (/[A-Za-z0-9_$]/.test(ch) || ch.charCodeAt(0) >= 0x80); + +const DOLLAR_TAG = /\$(?:[A-Za-z_\u0080-\uffff][A-Za-z0-9_\u0080-\uffff]*)?\$/y; + +/** + * Splits SQL text into lines, breaking only at newlines that sit between + * tokens. A newline inside a string literal ('...', E'...', $tag$...$tag$), + * a quoted identifier or a block comment is part of that token's value and + * stays inside its line, so callers can re-indent the lines without changing + * what the SQL means. + */ +export function splitSqlLines(text: string, newlineChar: string = '\n'): string[] { + if (!text.includes(newlineChar)) { + return [text]; + } + + const lines: string[] = []; + const length = text.length; + let lineStart = 0; + let i = 0; + + while (i < length) { + const ch = text[i]; + + if (ch === "'") { + const prev = text[i - 1]; + const backslashEscapes = (prev === 'E' || prev === 'e') && !isIdentChar(text[i - 2]); + i++; + while (i < length) { + if (backslashEscapes && text[i] === '\\') { + i += 2; + } else if (text[i] === "'") { + if (text[i + 1] === "'") { + i += 2; + } else { + break; + } + } else { + i++; + } + } + i++; + } else if (ch === '"') { + i++; + while (i < length) { + if (text[i] === '"') { + if (text[i + 1] === '"') { + i += 2; + } else { + break; + } + } else { + i++; + } + } + i++; + } else if (ch === '$' && !isIdentChar(text[i - 1])) { + DOLLAR_TAG.lastIndex = i; + const tag = DOLLAR_TAG.exec(text); + if (tag) { + const close = text.indexOf(tag[0], i + tag[0].length); + i = close === -1 ? length : close + tag[0].length; + } else { + i++; + } + } else if (ch === '-' && text[i + 1] === '-') { + const end = text.indexOf('\n', i); + i = end === -1 ? length : end; + } else if (ch === '/' && text[i + 1] === '*') { + let depth = 1; + i += 2; + while (i < length && depth > 0) { + if (text[i] === '/' && text[i + 1] === '*') { + depth++; + i += 2; + } else if (text[i] === '*' && text[i + 1] === '/') { + depth--; + i += 2; + } else { + i++; + } + } + } else if (text.startsWith(newlineChar, i)) { + lines.push(text.slice(lineStart, i)); + i += newlineChar.length; + lineStart = i; + } else { + i++; + } + } + + lines.push(text.slice(lineStart)); + return lines; +} + export class SqlFormatter { private newlineChar: string; private tabChar: string; @@ -18,7 +114,7 @@ export class SqlFormatter { return text; } const indentation = this.tabChar.repeat(count); - return text.split(this.newlineChar).map(line => + return splitSqlLines(text, this.newlineChar).map(line => line.trim() ? indentation + line : line ).join(this.newlineChar); } diff --git a/packages/parse/__tests__/__snapshots__/roundtrip.test.ts.snap b/packages/parse/__tests__/__snapshots__/roundtrip.test.ts.snap index 1d8094fbf..759944a3c 100644 --- a/packages/parse/__tests__/__snapshots__/roundtrip.test.ts.snap +++ b/packages/parse/__tests__/__snapshots__/roundtrip.test.ts.snap @@ -219,5 +219,5 @@ CREATE TRIGGER users_audit AFTER INSERT OR UPDATE ON app.users FOR EACH ROW - EXECUTE PROCEDURE app.audit_trigger();" + EXECUTE FUNCTION app.audit_trigger();" `; diff --git a/packages/pgsql-types/src/field-metadata.json b/packages/pgsql-types/src/field-metadata.json index 3b1ce2dc0..e617af2ca 100644 --- a/packages/pgsql-types/src/field-metadata.json +++ b/packages/pgsql-types/src/field-metadata.json @@ -6,6 +6,7 @@ "A_ArrayExpr", "A_Const", "A_Expr", + "A_Indirection", "CaseExpr", "CoalesceExpr", "ColumnRef", @@ -90,7 +91,9 @@ "tags": [ "A_Const", "A_Expr", - "ColumnRef" + "A_Indirection", + "ColumnRef", + "SubLink" ], "isArray": false } @@ -99,13 +102,30 @@ "arg": { "nullable": false, "tags": [ + "A_ArrayExpr", + "A_Const", + "A_Expr", "A_Indirection", + "BoolExpr", + "BooleanTest", + "CaseExpr", + "CoalesceExpr", + "CollateClause", "ColumnRef", "FuncCall", + "GroupingFunc", + "JsonArrayConstructor", "JsonFuncExpr", + "JsonObjectConstructor", + "MinMaxExpr", + "NullTest", + "ParamRef", "RowExpr", + "SQLValueFunction", + "SetToDefault", "SubLink", - "TypeCast" + "TypeCast", + "XmlExpr" ], "isArray": false }, @@ -301,6 +321,7 @@ "with_check": { "nullable": true, "tags": [ + "A_Expr", "SubLink" ], "isArray": false @@ -418,6 +439,7 @@ "ATAlterConstraint", "A_Const", "A_Expr", + "A_Indirection", "ColumnDef", "Constraint", "FuncCall", @@ -489,6 +511,7 @@ "tags": [ "A_Const", "A_Expr", + "A_Indirection", "BoolExpr", "BooleanTest", "CaseExpr", @@ -562,6 +585,7 @@ "A_ArrayExpr", "A_Const", "A_Expr", + "A_Indirection", "CaseExpr", "ColumnRef", "FuncCall", @@ -688,6 +712,7 @@ "A_Const", "A_Expr", "CaseExpr", + "CoalesceExpr", "FuncCall", "TypeCast" ], @@ -826,6 +851,7 @@ "tags": [ "A_Const", "A_Expr", + "A_Indirection", "BoolExpr", "CaseExpr", "ColumnRef", @@ -1580,7 +1606,9 @@ "defexpr": { "nullable": true, "tags": [ + "A_ArrayExpr", "A_Const", + "A_Indirection", "FuncCall", "SQLValueFunction", "TypeCast" @@ -1701,6 +1729,7 @@ "tags": [ "A_Const", "A_Expr", + "A_Indirection", "CoalesceExpr", "CollateClause", "FuncCall", @@ -1951,6 +1980,7 @@ "A_ArrayExpr", "A_Const", "A_Expr", + "A_Indirection", "BoolExpr", "CoalesceExpr", "CollateClause", @@ -2480,6 +2510,7 @@ "nullable": true, "tags": [ "A_Const", + "A_Expr", "ColumnRef" ], "isArray": true @@ -2502,6 +2533,7 @@ "tags": [ "A_Const", "A_Expr", + "A_Indirection", "CollateClause", "ColumnRef", "FuncCall", @@ -2841,6 +2873,7 @@ "partitionClause": { "nullable": true, "tags": [ + "A_Expr", "ColumnRef" ], "isArray": true diff --git a/packages/plpgsql-deparser/__tests__/__snapshots__/hydrate-demo.test.ts.snap b/packages/plpgsql-deparser/__tests__/__snapshots__/hydrate-demo.test.ts.snap index 1d3eeb740..9cd09dbf9 100644 --- a/packages/plpgsql-deparser/__tests__/__snapshots__/hydrate-demo.test.ts.snap +++ b/packages/plpgsql-deparser/__tests__/__snapshots__/hydrate-demo.test.ts.snap @@ -139,7 +139,7 @@ BEGIN note, updated_at ) VALUES - (p_org_id, p_user_id, p_from_ts, p_to_ts, p_currency, v_orders_scanned, v_gross, v_discount, v_tax, v_net, v_avg, v_top_sku, v_top_sku_qty, p_note, now()) ON CONFLICT (org_id, user_id, period_from, period_to, currency) DO UPDATE SET + (p_org_id, p_user_id, p_from_ts, p_to_ts, p_currency, v_orders_scanned, v_gross, v_discount, v_tax, v_net, v_avg, v_top_sku, v_top_sku_qty, p_note, now()) ON CONFLICT (org_id, user_id, period_from, period_to, currency) DO UPDATE SET orders_scanned = excluded.orders_scanned, gross_total = excluded.gross_total, discount_total = excluded.discount_total, diff --git a/packages/plpgsql-deparser/src/plpgsql-deparser.ts b/packages/plpgsql-deparser/src/plpgsql-deparser.ts index ab40695d7..ac0ade170 100644 --- a/packages/plpgsql-deparser/src/plpgsql-deparser.ts +++ b/packages/plpgsql-deparser/src/plpgsql-deparser.ts @@ -11,7 +11,7 @@ * CREATE FUNCTION statement. */ -import { QuoteUtils } from 'pgsql-deparser'; +import { QuoteUtils, splitSqlLines } from 'pgsql-deparser'; import { ParseMode } from './hydrate-types'; import { @@ -1248,7 +1248,7 @@ export class PLpgSQLDeparser { // We need to extract just the value part let whenExpr = whenData.expr ? this.deparseExpr(whenData.expr) : ''; // Try to extract the value from IN clause - const inMatch = whenExpr.match(/IN \((.+)\)$/); + const inMatch = whenExpr.match(/IN \(([\s\S]+)\)$/); if (inMatch) { whenExpr = inMatch[1]; } @@ -1266,10 +1266,10 @@ export class PLpgSQLDeparser { } // ELSE clause - if (caseStmt.have_else && caseStmt.else_stmts) { + if (caseStmt.have_else) { parts.push(this.indent(kw('ELSE'), context.indentLevel + 1)); const bodyContext = { ...context, indentLevel: context.indentLevel + 2 }; - for (const stmt of caseStmt.else_stmts) { + for (const stmt of caseStmt.else_stmts ?? []) { const stmtStr = this.deparseStmt(stmt, bodyContext); parts.push(this.indent(stmtStr + ';', bodyContext.indentLevel)); } @@ -2406,7 +2406,7 @@ export class PLpgSQLDeparser { */ private indent(text: string, level: number): string { const indent = this.options.indent!.repeat(level); - return indent + text.replace(/\n/g, '\n' + indent); + return indent + splitSqlLines(text).join('\n' + indent); } /** diff --git a/packages/plpgsql-parse/__tests__/__snapshots__/roundtrip.test.ts.snap b/packages/plpgsql-parse/__tests__/__snapshots__/roundtrip.test.ts.snap index f8b3cd7ad..0742cb366 100644 --- a/packages/plpgsql-parse/__tests__/__snapshots__/roundtrip.test.ts.snap +++ b/packages/plpgsql-parse/__tests__/__snapshots__/roundtrip.test.ts.snap @@ -94,7 +94,7 @@ BEGIN v_status := 'standard'; END IF; -- Finally, record the result - UPDATE orders SET status = v_status,total = v_total WHERE id = p_order_id; + UPDATE orders SET status = v_status, total = v_total WHERE id = p_order_id; END $$;" `; diff --git a/packages/transform/__fixtures__/output/kitchen-sink.sql b/packages/transform/__fixtures__/output/kitchen-sink.sql index db59bff0c..8e293b449 100644 --- a/packages/transform/__fixtures__/output/kitchen-sink.sql +++ b/packages/transform/__fixtures__/output/kitchen-sink.sql @@ -116,13 +116,13 @@ CREATE TRIGGER trg_audit_insert AFTER INSERT ON my_schema.users FOR EACH ROW - EXECUTE PROCEDURE other_schema.log_change(); + EXECUTE FUNCTION other_schema.log_change(); CREATE TRIGGER trg_audit_update AFTER UPDATE ON my_schema.users FOR EACH ROW - EXECUTE PROCEDURE my_schema.on_user_update(); + EXECUTE FUNCTION my_schema.on_user_update(); ALTER TABLE my_schema.users SET SCHEMA other_schema; From ec181402f33e1b120e9085a150432578eae22c12 Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Fri, 13 Nov 2026 22:04:50 +0000 Subject: [PATCH 2/6] fix(deparser): do not loop in splitSqlLines on an empty newline option --- packages/deparser/src/utils/sql-formatter.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/deparser/src/utils/sql-formatter.ts b/packages/deparser/src/utils/sql-formatter.ts index a1b5f387d..2fa3bd6e1 100644 --- a/packages/deparser/src/utils/sql-formatter.ts +++ b/packages/deparser/src/utils/sql-formatter.ts @@ -11,7 +11,7 @@ const DOLLAR_TAG = /\$(?:[A-Za-z_\u0080-\uffff][A-Za-z0-9_\u0080-\uffff]*)?\$/y; * what the SQL means. */ export function splitSqlLines(text: string, newlineChar: string = '\n'): string[] { - if (!text.includes(newlineChar)) { + if (!newlineChar || !text.includes(newlineChar)) { return [text]; } From 68b056a251fd0d58fd21c0c13dc63de8a46be229 Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Fri, 13 Nov 2026 22:04:51 +0000 Subject: [PATCH 3/6] fix(plpgsql-deparser): keep IN (...) conditions of a searched CASE --- __fixtures__/plpgsql-generated/generated.json | 1 + __fixtures__/plpgsql/plpgsql_deparser_fixes.sql | 15 +++++++++++++++ packages/plpgsql-deparser/src/plpgsql-deparser.ts | 7 +++++-- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/__fixtures__/plpgsql-generated/generated.json b/__fixtures__/plpgsql-generated/generated.json index 925cb0ad9..3b11f9c24 100644 --- a/__fixtures__/plpgsql-generated/generated.json +++ b/__fixtures__/plpgsql-generated/generated.json @@ -167,6 +167,7 @@ "plpgsql_deparser_fixes-67.sql": "CREATE FUNCTION test_assign_targets() RETURNS void\nLANGUAGE plpgsql AS $$\nDECLARE\n a int[] := ARRAY[1, 2];\n r record;\nBEGIN\n SELECT 1 AS f INTO r;\n a[2] := coalesce(nullif(3, 0), 4);\n r.f := greatest(1, 2);\nEND$$", "plpgsql_deparser_fixes-68.sql": "CREATE FUNCTION test_multiline_literals(x boolean) RETURNS text\nLANGUAGE plpgsql AS $$\nDECLARE\n v text := 'declared\ndefault';\nBEGIN\n IF x THEN\n FOR i IN 1..2 LOOP\n RAISE NOTICE 'line one\nline two';\n PERFORM length('a\nb');\n v := 'c\nd' || E'tab\\there\nquote\\'s';\n EXECUTE $q$SELECT 'e\nf'$q$;\n BEGIN\n INSERT INTO t (memo) VALUES ('g\nh') ON CONFLICT (memo) DO UPDATE SET memo = 'i\nj';\n EXCEPTION WHEN others THEN\n RAISE EXCEPTION 'failed:\n%', sqlerrm;\n END;\n END LOOP;\n ELSIF v = 'k\nl' THEN\n CASE v WHEN 'm\nn' THEN\n RETURN 'o\np';\n ELSE\n NULL;\n END CASE;\n END IF;\n RETURN v;\nEND$$", "plpgsql_deparser_fixes-69.sql": "DO $do$\nDECLARE\n r record;\nBEGIN\n FOR r IN SELECT \"odd\ncolumn\" AS c FROM t WHERE memo = $s$dollar\nquoted$s$ LOOP\n WHILE r.c IS NOT NULL LOOP\n RAISE NOTICE '%', r.c || '\nsuffix';\n EXIT;\n END LOOP;\n END LOOP;\nEND$do$", + "plpgsql_deparser_fixes-70.sql": "CREATE FUNCTION test_searched_case_in(x int) RETURNS text\nLANGUAGE plpgsql AS $$\nBEGIN\n CASE\n WHEN x IN (1, 2) THEN\n RETURN 'low';\n WHEN x IN (\n 3, 4) THEN\n RETURN 'mid';\n ELSE\n RETURN 'high';\n END CASE;\nEND$$", "plpgsql_control-1.sql": "do $$\nbegin\n -- basic case\n for i in 1..3 loop\n raise notice '1..3: i = %', i;\n end loop;\n -- with BY, end matches exactly\n for i in 1..10 by 3 loop\n raise notice '1..10 by 3: i = %', i;\n end loop;\n -- with BY, end does not match\n for i in 1..11 by 3 loop\n raise notice '1..11 by 3: i = %', i;\n end loop;\n -- zero iterations\n for i in 1..0 by 3 loop\n raise notice '1..0 by 3: i = %', i;\n end loop;\n -- REVERSE\n for i in reverse 10..0 by 3 loop\n raise notice 'reverse 10..0 by 3: i = %', i;\n end loop;\n -- potential overflow\n for i in 2147483620..2147483647 by 10 loop\n raise notice '2147483620..2147483647 by 10: i = %', i;\n end loop;\n -- potential overflow, reverse direction\n for i in reverse -2147483620..-2147483647 by 10 loop\n raise notice 'reverse -2147483620..-2147483647 by 10: i = %', i;\n end loop;\nend$$", "plpgsql_control-2.sql": "do $$\nbegin\n for i in 1..3 by 0 loop\n raise notice '1..3 by 0: i = %', i;\n end loop;\nend$$", "plpgsql_control-3.sql": "do $$\nbegin\n for i in 1..3 by -1 loop\n raise notice '1..3 by -1: i = %', i;\n end loop;\nend$$", diff --git a/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql b/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql index 4d38593bd..ba6eaff7f 100644 --- a/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql +++ b/__fixtures__/plpgsql/plpgsql_deparser_fixes.sql @@ -893,3 +893,18 @@ suffix'; END LOOP; END LOOP; END$do$; + +-- Test 70: searched CASE keeps an IN (...) condition, single- and multi-line +CREATE FUNCTION test_searched_case_in(x int) RETURNS text +LANGUAGE plpgsql AS $$ +BEGIN + CASE + WHEN x IN (1, 2) THEN + RETURN 'low'; + WHEN x IN ( + 3, 4) THEN + RETURN 'mid'; + ELSE + RETURN 'high'; + END CASE; +END$$; diff --git a/packages/plpgsql-deparser/src/plpgsql-deparser.ts b/packages/plpgsql-deparser/src/plpgsql-deparser.ts index ac0ade170..fe24310ba 100644 --- a/packages/plpgsql-deparser/src/plpgsql-deparser.ts +++ b/packages/plpgsql-deparser/src/plpgsql-deparser.ts @@ -1247,8 +1247,11 @@ export class PLpgSQLDeparser { // The expr contains the full condition like "__Case__Variable_9__" IN (0) // We need to extract just the value part let whenExpr = whenData.expr ? this.deparseExpr(whenData.expr) : ''; - // Try to extract the value from IN clause - const inMatch = whenExpr.match(/IN \(([\s\S]+)\)$/); + // Only a simple CASE (with a search expression) has that synthetic wrapper; + // a searched CASE's condition is emitted as written + const inMatch = caseStmt.t_expr + ? whenExpr.match(/^"?__Case__Variable_\d+__"? IN \(([\s\S]+)\)$/) + : null; if (inMatch) { whenExpr = inMatch[1]; } From da94153d89fab8722932cf650c100d734246748f Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Fri, 13 Nov 2026 22:23:11 +0000 Subject: [PATCH 4/6] fix(deparser): keep a quoted EXTRACT field quoted unless it round-trips as a bare keyword --- __fixtures__/generated/generated.json | 2 ++ __fixtures__/kitchen-sink/misc/extract.sql | 5 +++++ .../deparser/__tests__/kitchen-sink/misc-extract.test.ts | 4 +++- packages/deparser/src/deparser.ts | 4 +++- 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/__fixtures__/generated/generated.json b/__fixtures__/generated/generated.json index 9192ee89e..4b7688b5f 100644 --- a/__fixtures__/generated/generated.json +++ b/__fixtures__/generated/generated.json @@ -21979,6 +21979,8 @@ "misc/extract-16.sql": "SELECT EXTRACT(TIMEZONE FROM CURRENT_TIMESTAMP)", "misc/extract-17.sql": "SELECT EXTRACT(TIMEZONE_HOUR FROM CURRENT_TIMESTAMP)", "misc/extract-18.sql": "SELECT EXTRACT(TIMEZONE_MINUTE FROM CURRENT_TIMESTAMP)", + "misc/extract-19.sql": "SELECT EXTRACT('Year' FROM d), EXTRACT('time zone' FROM d), EXTRACT('select' FROM d), EXTRACT('zone' FROM d), EXTRACT('' FROM d) FROM t", + "misc/extract-20.sql": "SELECT EXTRACT('multi\nline' FROM d), EXTRACT('it''s' FROM d), EXTRACT(\"Quoted\" FROM d), EXTRACT(year FROM d), EXTRACT('year' FROM d) FROM t", "misc/cascades-1.sql": "DROP TABLE IF EXISTS some_table CASCADE", "misc/cascades-2.sql": "DROP VIEW IF EXISTS some_view CASCADE", "misc/cascades-3.sql": "DROP MATERIALIZED VIEW IF EXISTS some_mat_view CASCADE", diff --git a/__fixtures__/kitchen-sink/misc/extract.sql b/__fixtures__/kitchen-sink/misc/extract.sql index 059c0da87..68cf3e721 100644 --- a/__fixtures__/kitchen-sink/misc/extract.sql +++ b/__fixtures__/kitchen-sink/misc/extract.sql @@ -18,3 +18,8 @@ SELECT EXTRACT(WEEK FROM TIMESTAMP '2001-02-16 20:38:40'); SELECT EXTRACT(TIMEZONE FROM CURRENT_TIMESTAMP); SELECT EXTRACT(TIMEZONE_HOUR FROM CURRENT_TIMESTAMP); SELECT EXTRACT(TIMEZONE_MINUTE FROM CURRENT_TIMESTAMP); + +-- A string field that is not a bare lower-case word must stay quoted +SELECT EXTRACT('Year' FROM d), EXTRACT('time zone' FROM d), EXTRACT('select' FROM d), EXTRACT('zone' FROM d), EXTRACT('' FROM d) FROM t; +SELECT EXTRACT('multi +line' FROM d), EXTRACT('it''s' FROM d), EXTRACT("Quoted" FROM d), EXTRACT(year FROM d), EXTRACT('year' FROM d) FROM t; diff --git a/packages/deparser/__tests__/kitchen-sink/misc-extract.test.ts b/packages/deparser/__tests__/kitchen-sink/misc-extract.test.ts index 0ef3ba058..c1c9e968e 100644 --- a/packages/deparser/__tests__/kitchen-sink/misc-extract.test.ts +++ b/packages/deparser/__tests__/kitchen-sink/misc-extract.test.ts @@ -21,6 +21,8 @@ it('misc-extract', async () => { "misc/extract-15.sql", "misc/extract-16.sql", "misc/extract-17.sql", - "misc/extract-18.sql" + "misc/extract-18.sql", + "misc/extract-19.sql", + "misc/extract-20.sql" ]); }); diff --git a/packages/deparser/src/deparser.ts b/packages/deparser/src/deparser.ts index ffbf7e294..8907fd87e 100644 --- a/packages/deparser/src/deparser.ts +++ b/packages/deparser/src/deparser.ts @@ -1547,7 +1547,9 @@ export class Deparser implements DeparserVisitor { const source = this.visit(args[1], context); // EXTRACT requires an unquoted uppercase keyword (EPOCH, YEAR, etc.) // but A_Const sval deparsing wraps it in single quotes — strip and uppercase - if (field.startsWith("'") && field.endsWith("'")) { + // only when it is spelled the way the bare-keyword form parses back + if (/^'(?:year|month|day|hour|minute|second)'$/.test(field) + || (/^'[a-z_][a-z0-9_]*'$/.test(field) && keywordKindOf(field.slice(1, -1)) === 'NO_KEYWORD')) { field = field.slice(1, -1).toUpperCase(); } return `EXTRACT(${field} FROM ${source})`; From 636c1813e07c22b0aee8aa4592753041f5ea44e6 Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Fri, 13 Nov 2026 22:23:11 +0000 Subject: [PATCH 5/6] ci: test pgsql-parse, plpgsql-parse and @pgsql/utils; fail on stale generated fixtures --- .github/workflows/run-tests.yaml | 42 ++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/.github/workflows/run-tests.yaml b/.github/workflows/run-tests.yaml index 577ba3dc3..a3f124c3c 100644 --- a/.github/workflows/run-tests.yaml +++ b/.github/workflows/run-tests.yaml @@ -20,6 +20,9 @@ jobs: - pgsql-parser - plpgsql-deparser - plpgsql-parser + - pgsql-parse + - plpgsql-parse + - '@pgsql/utils' - pg-proto-parser - '@pgsql/quotes' - '@pgsql/transform-ast' @@ -54,3 +57,42 @@ jobs: - name: test run: pnpm --filter ${{ matrix.package }} test + + generated-files: + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@v3 + + - name: setup pnpm + uses: pnpm/action-setup@v4 + with: + version: 9 + + - name: setup node + uses: actions/setup-node@v4 + with: + node-version: '20' + cache: 'pnpm' + + - name: install dependencies + run: pnpm install + + - name: build + run: pnpm build + + - name: regenerate fixtures + run: | + pnpm --filter pgsql-deparser run kitchen-sink + pnpm --filter plpgsql-deparser run fixtures + + # A fixture .sql that was added without regenerating is never tested + - name: generated fixtures and tests are up to date + run: | + paths="__fixtures__/generated __fixtures__/plpgsql-generated packages/deparser/__tests__/kitchen-sink packages/pgsql-types/src/field-metadata.json" + if [ -n "$(git status --porcelain -- $paths)" ]; then + git status --porcelain -- $paths + git --no-pager diff --stat -- $paths + echo "::error::Generated files are stale. Run 'npm run kitchen-sink' in packages/deparser, 'npm run fixtures' in packages/plpgsql-deparser and 'pnpm build', then commit the result." + exit 1 + fi From c95398ef93886509c310dbd2ceca862505a8e2fc Mon Sep 17 00:00:00 2001 From: Dan Lynch Date: Fri, 13 Nov 2026 22:33:53 +0000 Subject: [PATCH 6/6] ci: guard the test matrix, test @pgsql/cli and pgsql-types, check all generated files - scripts/check-ci-matrix.ts fails CI when a package with tests is missing from the matrix - @pgsql/cli and pgsql-types get real tests and matrix entries (their test script used to exit 1) - pg-proto-parser: includeHeaderVersion option; in-repo generated sources no longer carry the generator version, so a release does not make them stale - regenerate pgsql-types narrowed types from the current field metadata - generated-files job now checks the whole tree after build + regeneration --- .github/workflows/run-tests.yaml | 23 +++++--- packages/pgsql-cli/__tests__/cli.test.ts | 59 +++++++++++++++++++ .../__tests__/field-metadata.test.ts | 53 +++++++++++++++++ packages/pgsql-types/jest.config.js | 18 ++++++ packages/pgsql-types/src/types.ts | 32 +++++----- packages/proto-parser/src/options/defaults.ts | 1 + packages/proto-parser/src/options/types.ts | 3 + packages/proto-parser/src/utils/utils.ts | 7 ++- .../transform-ast/scripts/pg-proto-parser.ts | 1 + packages/transform-ast/src/13/enums.ts | 2 +- packages/transform-ast/src/13/types.ts | 2 +- packages/transform-ast/src/14/enums.ts | 2 +- packages/transform-ast/src/14/types.ts | 2 +- packages/transform-ast/src/15/enums.ts | 2 +- packages/transform-ast/src/15/types.ts | 2 +- packages/transform-ast/src/16/enums.ts | 2 +- packages/transform-ast/src/16/types.ts | 2 +- packages/transform-ast/src/17/enums.ts | 2 +- packages/transform-ast/src/17/types.ts | 2 +- packages/transform-ast/src/18/enums.ts | 2 +- packages/transform-ast/src/18/types.ts | 2 +- packages/traverse/scripts/pg-proto-parser.ts | 1 + packages/traverse/src/18/runtime-schema.ts | 2 +- packages/utils/scripts/pg-proto-parser.ts | 1 + packages/utils/src/asts.ts | 2 +- packages/utils/src/runtime-schema.ts | 2 +- packages/utils/src/wrapped.ts | 2 +- scripts/check-ci-matrix.ts | 45 ++++++++++++++ 28 files changed, 233 insertions(+), 43 deletions(-) create mode 100644 packages/pgsql-cli/__tests__/cli.test.ts create mode 100644 packages/pgsql-types/__tests__/field-metadata.test.ts create mode 100644 packages/pgsql-types/jest.config.js create mode 100644 scripts/check-ci-matrix.ts diff --git a/.github/workflows/run-tests.yaml b/.github/workflows/run-tests.yaml index a3f124c3c..8d228c343 100644 --- a/.github/workflows/run-tests.yaml +++ b/.github/workflows/run-tests.yaml @@ -23,6 +23,8 @@ jobs: - pgsql-parse - plpgsql-parse - '@pgsql/utils' + - '@pgsql/cli' + - pgsql-types - pg-proto-parser - '@pgsql/quotes' - '@pgsql/transform-ast' @@ -81,18 +83,23 @@ jobs: - name: build run: pnpm build - - name: regenerate fixtures + - name: every package with tests is in the test matrix + run: npx ts-node scripts/check-ci-matrix.ts + + - name: regenerate fixtures and types run: | pnpm --filter pgsql-deparser run kitchen-sink pnpm --filter plpgsql-deparser run fixtures + pnpm --filter @pgsql/traverse run build:proto + pnpm --filter pgsql-types run generate - # A fixture .sql that was added without regenerating is never tested - - name: generated fixtures and tests are up to date + # A fixture .sql that was added without regenerating is never tested, + # and generated sources must match what the build produces + - name: generated files are up to date run: | - paths="__fixtures__/generated __fixtures__/plpgsql-generated packages/deparser/__tests__/kitchen-sink packages/pgsql-types/src/field-metadata.json" - if [ -n "$(git status --porcelain -- $paths)" ]; then - git status --porcelain -- $paths - git --no-pager diff --stat -- $paths - echo "::error::Generated files are stale. Run 'npm run kitchen-sink' in packages/deparser, 'npm run fixtures' in packages/plpgsql-deparser and 'pnpm build', then commit the result." + if [ -n "$(git status --porcelain)" ]; then + git status --porcelain + git --no-pager diff --stat + echo "::error::Generated files are stale. Run 'pnpm build', 'npm run kitchen-sink' in packages/deparser and 'npm run fixtures' in packages/plpgsql-deparser, then commit the result." exit 1 fi diff --git a/packages/pgsql-cli/__tests__/cli.test.ts b/packages/pgsql-cli/__tests__/cli.test.ts new file mode 100644 index 000000000..df48f81e5 --- /dev/null +++ b/packages/pgsql-cli/__tests__/cli.test.ts @@ -0,0 +1,59 @@ +import { mkdtempSync, readFileSync, rmSync, writeFileSync } from 'fs'; +import { tmpdir } from 'os'; +import { join } from 'path'; + +import { deparseCommand } from '../src/commands/deparse'; +import { parseCommand } from '../src/commands/parse'; + +const sql = `SELECT (ARRAY[1, 2, 3])[2:3] AS slice, 'line one +line two' AS memo FROM t WHERE id = 1`; + +let dir: string; + +beforeEach(() => { + dir = mkdtempSync(join(tmpdir(), 'pgsql-cli-')); + jest.spyOn(console, 'log').mockImplementation(() => undefined); +}); + +afterEach(() => { + jest.restoreAllMocks(); + rmSync(dir, { recursive: true, force: true }); +}); + +const parseToFile = async (input: string, format?: string) => { + const sqlFile = join(dir, 'in.sql'); + const astFile = join(dir, `ast-${format ?? 'default'}.json`); + writeFileSync(sqlFile, input); + await parseCommand({ _: ['parse', sqlFile], output: astFile, format }); + return astFile; +}; + +const positionKeys = /^(location|stmt_location|stmt_len|list_start|list_end|rexpr_list_start|rexpr_list_end)$/; +const withoutLocations = (ast: unknown) => + JSON.parse(JSON.stringify(ast, (key, value) => (positionKeys.test(key) ? undefined : value))); + +describe('pgsql parse', () => { + it('writes the AST as indented JSON by default and compact JSON with --format json', async () => { + const pretty = readFileSync(await parseToFile(sql), 'utf-8'); + const compact = readFileSync(await parseToFile(sql, 'json'), 'utf-8'); + + expect(pretty).toContain('\n'); + expect(compact).not.toContain('\n '); + expect(JSON.parse(pretty)).toEqual(JSON.parse(compact)); + expect(JSON.parse(pretty).stmts).toHaveLength(1); + }); +}); + +describe('pgsql deparse', () => { + it('turns a parsed AST back into SQL that parses to the same AST', async () => { + const astFile = await parseToFile(sql); + const outFile = join(dir, 'out.sql'); + await deparseCommand({ _: ['deparse'], input: astFile, output: outFile }); + + const roundTripped = readFileSync(outFile, 'utf-8'); + const reparsedFile = await parseToFile(roundTripped, 'json'); + + expect(withoutLocations(JSON.parse(readFileSync(reparsedFile, 'utf-8')))) + .toEqual(withoutLocations(JSON.parse(readFileSync(astFile, 'utf-8')))); + }); +}); diff --git a/packages/pgsql-types/__tests__/field-metadata.test.ts b/packages/pgsql-types/__tests__/field-metadata.test.ts new file mode 100644 index 000000000..3f57cfc07 --- /dev/null +++ b/packages/pgsql-types/__tests__/field-metadata.test.ts @@ -0,0 +1,53 @@ +import { runtimeSchema } from '../../utils/src/runtime-schema'; +import fieldMetadata from '../src/field-metadata.json'; + +interface FieldMetadata { + nullable: boolean; + tags: string[]; + isArray: boolean; +} + +const metadata = fieldMetadata as Record>; +const schema = new Map(runtimeSchema.map(spec => [spec.name, spec])); + +describe('field-metadata.json', () => { + it('only describes Node-typed fields that exist in the runtime schema', () => { + const unknown: string[] = []; + for (const [nodeName, fields] of Object.entries(metadata)) { + const spec = schema.get(nodeName); + for (const fieldName of Object.keys(fields)) { + const field = spec?.fields.find(f => f.name === fieldName); + if (!field || field.type !== 'Node') { + unknown.push(`${nodeName}.${fieldName}`); + } + } + } + expect(unknown).toEqual([]); + }); + + it('only infers tags that are node types, sorted and without duplicates', () => { + const bad: string[] = []; + for (const [nodeName, fields] of Object.entries(metadata)) { + for (const [fieldName, field] of Object.entries(fields)) { + const sorted = [...new Set(field.tags)].sort(); + if (sorted.join() !== field.tags.join() || field.tags.some(tag => !schema.has(tag))) { + bad.push(`${nodeName}.${fieldName}`); + } + } + } + expect(bad).toEqual([]); + }); + + it('marks a field as an array exactly when the schema says so', () => { + const mismatched: string[] = []; + for (const [nodeName, fields] of Object.entries(metadata)) { + for (const [fieldName, field] of Object.entries(fields)) { + const spec = schema.get(nodeName)?.fields.find(f => f.name === fieldName); + if (spec && spec.isArray !== field.isArray) { + mismatched.push(`${nodeName}.${fieldName}`); + } + } + } + expect(mismatched).toEqual([]); + }); +}); diff --git a/packages/pgsql-types/jest.config.js b/packages/pgsql-types/jest.config.js new file mode 100644 index 000000000..057a9420e --- /dev/null +++ b/packages/pgsql-types/jest.config.js @@ -0,0 +1,18 @@ +/** @type {import('ts-jest').JestConfigWithTsJest} */ +module.exports = { + preset: 'ts-jest', + testEnvironment: 'node', + transform: { + '^.+\\.tsx?$': [ + 'ts-jest', + { + babelConfig: false, + tsconfig: 'tsconfig.json', + }, + ], + }, + transformIgnorePatterns: [`/node_modules/*`], + testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$', + moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'], + modulePathIgnorePatterns: ['dist/*'] +}; diff --git a/packages/pgsql-types/src/types.ts b/packages/pgsql-types/src/types.ts index 85ebeabb4..35b288ec9 100644 --- a/packages/pgsql-types/src/types.ts +++ b/packages/pgsql-types/src/types.ts @@ -12,13 +12,13 @@ export type { Node } from '@pgsql/types'; export * from '@pgsql/enums'; // Internal type aliases for narrowed Node-typed fields (not exported) -type A_ArrayExpr_elements = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { TypeCast: TypeCast }; +type A_ArrayExpr_elements = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { TypeCast: TypeCast }; type A_Expr_lexpr = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { GroupingFunc: GroupingFunc } | { JsonFuncExpr: JsonFuncExpr } | { MinMaxExpr: MinMaxExpr } | { NullTest: NullTest } | { ParamRef: ParamRef } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SubLink: SubLink } | { TypeCast: TypeCast } | { XmlSerialize: XmlSerialize }; type A_Expr_name = { String: String }; type A_Expr_rexpr = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { List: List } | { MergeSupportFunc: MergeSupportFunc } | { NullTest: NullTest } | { ParamRef: ParamRef } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SubLink: SubLink } | { TypeCast: TypeCast } | { XmlSerialize: XmlSerialize }; type A_Indices_lidx = { A_Const: A_Const }; -type A_Indices_uidx = { A_Const: A_Const } | { A_Expr: A_Expr } | { ColumnRef: ColumnRef }; -type A_Indirection_arg = { A_Indirection: A_Indirection } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonFuncExpr: JsonFuncExpr } | { RowExpr: RowExpr } | { SubLink: SubLink } | { TypeCast: TypeCast }; +type A_Indices_uidx = { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { ColumnRef: ColumnRef } | { SubLink: SubLink }; +type A_Indirection_arg = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { BooleanTest: BooleanTest } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { GroupingFunc: GroupingFunc } | { JsonArrayConstructor: JsonArrayConstructor } | { JsonFuncExpr: JsonFuncExpr } | { JsonObjectConstructor: JsonObjectConstructor } | { MinMaxExpr: MinMaxExpr } | { NullTest: NullTest } | { ParamRef: ParamRef } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SetToDefault: SetToDefault } | { SubLink: SubLink } | { TypeCast: TypeCast } | { XmlExpr: XmlExpr }; type A_Indirection_indirection = { A_Indices: A_Indices } | { A_Star: A_Star } | { String: String }; type AccessPriv_cols = { String: String }; type AlterCollationStmt_collname = { String: String }; @@ -40,7 +40,7 @@ type AlterOperatorStmt_options = { DefElem: DefElem }; type AlterOwnerStmt_object = { Integer: Integer } | { List: List } | { ObjectWithArgs: ObjectWithArgs } | { String: String }; type AlterPolicyStmt_qual = { A_Const: A_Const } | { A_Expr: A_Expr } | { SubLink: SubLink }; type AlterPolicyStmt_roles = { RoleSpec: RoleSpec }; -type AlterPolicyStmt_with_check = { SubLink: SubLink }; +type AlterPolicyStmt_with_check = { A_Expr: A_Expr } | { SubLink: SubLink }; type AlterPublicationStmt_options = { DefElem: DefElem }; type AlterPublicationStmt_pubobjects = { PublicationObjSpec: PublicationObjSpec }; type AlterRoleStmt_options = { DefElem: DefElem }; @@ -54,17 +54,17 @@ type AlterTSConfigurationStmt_dicts = { List: List }; type AlterTSConfigurationStmt_tokentype = { String: String }; type AlterTSDictionaryStmt_dictname = { String: String }; type AlterTSDictionaryStmt_options = { DefElem: DefElem }; -type AlterTableCmd_def = { ATAlterConstraint: ATAlterConstraint } | { A_Const: A_Const } | { A_Expr: A_Expr } | { ColumnDef: ColumnDef } | { Constraint: Constraint } | { FuncCall: FuncCall } | { Integer: Integer } | { List: List } | { PartitionCmd: PartitionCmd } | { RangeVar: RangeVar } | { ReplicaIdentityStmt: ReplicaIdentityStmt } | { String: String } | { TypeCast: TypeCast } | { TypeName: TypeName }; +type AlterTableCmd_def = { ATAlterConstraint: ATAlterConstraint } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { ColumnDef: ColumnDef } | { Constraint: Constraint } | { FuncCall: FuncCall } | { Integer: Integer } | { List: List } | { PartitionCmd: PartitionCmd } | { RangeVar: RangeVar } | { ReplicaIdentityStmt: ReplicaIdentityStmt } | { String: String } | { TypeCast: TypeCast } | { TypeName: TypeName }; type AlterTableSpaceOptionsStmt_options = { DefElem: DefElem }; type AlterTableStmt_cmds = { AlterTableCmd: AlterTableCmd }; type AlterTypeStmt_options = { DefElem: DefElem }; type AlterTypeStmt_typeName = { String: String }; type AlterUserMappingStmt_options = { DefElem: DefElem }; -type BoolExpr_args = { A_Const: A_Const } | { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { BooleanTest: BooleanTest } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonIsPredicate: JsonIsPredicate } | { NullTest: NullTest } | { ParamRef: ParamRef } | { SubLink: SubLink } | { TypeCast: TypeCast } | { XmlExpr: XmlExpr }; +type BoolExpr_args = { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { BooleanTest: BooleanTest } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonIsPredicate: JsonIsPredicate } | { NullTest: NullTest } | { ParamRef: ParamRef } | { SubLink: SubLink } | { TypeCast: TypeCast } | { XmlExpr: XmlExpr }; type BooleanTest_arg = { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { ColumnRef: ColumnRef } | { TypeCast: TypeCast }; type CaseExpr_arg = { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { GroupingFunc: GroupingFunc } | { MergeSupportFunc: MergeSupportFunc } | { TypeCast: TypeCast }; type CaseExpr_args = { CaseWhen: CaseWhen }; -type CaseExpr_defresult = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { SubLink: SubLink } | { TypeCast: TypeCast }; +type CaseExpr_defresult = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { SubLink: SubLink } | { TypeCast: TypeCast }; type CaseWhen_expr = { A_Const: A_Const } | { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { BooleanTest: BooleanTest } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonIsPredicate: JsonIsPredicate } | { NullTest: NullTest } | { SubLink: SubLink } | { TypeCast: TypeCast }; type CaseWhen_result = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { SubLink: SubLink } | { TypeCast: TypeCast }; type CoalesceExpr_args = { A_Const: A_Const } | { A_Expr: A_Expr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { RowExpr: RowExpr } | { TypeCast: TypeCast }; @@ -72,7 +72,7 @@ type CollateClause_arg = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { type CollateClause_collname = { String: String }; type ColumnDef_constraints = { Constraint: Constraint }; type ColumnDef_fdwoptions = { DefElem: DefElem }; -type ColumnDef_raw_default = { A_Const: A_Const } | { A_Expr: A_Expr } | { CaseExpr: CaseExpr } | { FuncCall: FuncCall } | { TypeCast: TypeCast }; +type ColumnDef_raw_default = { A_Const: A_Const } | { A_Expr: A_Expr } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { FuncCall: FuncCall } | { TypeCast: TypeCast }; type ColumnRef_fields = { A_Star: A_Star } | { String: String }; type CommentStmt_object = { Integer: Integer } | { List: List } | { ObjectWithArgs: ObjectWithArgs } | { String: String } | { TypeName: TypeName }; type CommonTableExpr_aliascolnames = { String: String }; @@ -85,7 +85,7 @@ type Constraint_including = { String: String }; type Constraint_keys = { String: String }; type Constraint_options = { DefElem: DefElem }; type Constraint_pk_attrs = { String: String }; -type Constraint_raw_expr = { A_Const: A_Const } | { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonFuncExpr: JsonFuncExpr } | { JsonIsPredicate: JsonIsPredicate } | { NullTest: NullTest } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SubLink: SubLink } | { TypeCast: TypeCast }; +type Constraint_raw_expr = { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonFuncExpr: JsonFuncExpr } | { JsonIsPredicate: JsonIsPredicate } | { NullTest: NullTest } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SubLink: SubLink } | { TypeCast: TypeCast }; type Constraint_where_clause = { A_Expr: A_Expr } | { NullTest: NullTest }; type ConstraintsSetStmt_constraints = { RangeVar: RangeVar }; type CopyStmt_attlist = { String: String }; @@ -163,7 +163,7 @@ type FuncCall_agg_filter = { A_Const: A_Const } | { A_Expr: A_Expr } | { BoolExp type FuncCall_agg_order = { SortBy: SortBy }; type FuncCall_args = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { CaseExpr: CaseExpr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { JsonFuncExpr: JsonFuncExpr } | { JsonParseExpr: JsonParseExpr } | { JsonSerializeExpr: JsonSerializeExpr } | { MinMaxExpr: MinMaxExpr } | { NamedArgExpr: NamedArgExpr } | { ParamRef: ParamRef } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SubLink: SubLink } | { TypeCast: TypeCast } | { XmlExpr: XmlExpr }; type FuncCall_funcname = { String: String }; -type FunctionParameter_defexpr = { A_Const: A_Const } | { FuncCall: FuncCall } | { SQLValueFunction: SQLValueFunction } | { TypeCast: TypeCast }; +type FunctionParameter_defexpr = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Indirection: A_Indirection } | { FuncCall: FuncCall } | { SQLValueFunction: SQLValueFunction } | { TypeCast: TypeCast }; type GrantRoleStmt_granted_roles = { AccessPriv: AccessPriv }; type GrantRoleStmt_grantee_roles = { RoleSpec: RoleSpec }; type GrantRoleStmt_opt = { DefElem: DefElem }; @@ -175,7 +175,7 @@ type GroupingSet_content = { A_Const: A_Const } | { A_Expr: A_Expr } | { ColumnR type ImportForeignSchemaStmt_options = { DefElem: DefElem }; type ImportForeignSchemaStmt_table_list = { RangeVar: RangeVar }; type IndexElem_collation = { String: String }; -type IndexElem_expr = { A_Const: A_Const } | { A_Expr: A_Expr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { FuncCall: FuncCall } | { JsonFuncExpr: JsonFuncExpr } | { RowExpr: RowExpr } | { TypeCast: TypeCast }; +type IndexElem_expr = { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { FuncCall: FuncCall } | { JsonFuncExpr: JsonFuncExpr } | { RowExpr: RowExpr } | { TypeCast: TypeCast }; type IndexElem_opclass = { String: String }; type IndexElem_opclassopts = { DefElem: DefElem }; type IndexStmt_indexIncludingParams = { IndexElem: IndexElem }; @@ -200,7 +200,7 @@ type JsonTable_columns = { JsonTableColumn: JsonTableColumn }; type JsonTable_passing = { JsonArgument: JsonArgument }; type JsonTableColumn_columns = { JsonTableColumn: JsonTableColumn }; type JsonValueExpr_raw_expr = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { ColumnRef: ColumnRef } | { JsonArrayConstructor: JsonArrayConstructor } | { TypeCast: TypeCast }; -type List_items = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { ColumnDef: ColumnDef } | { ColumnRef: ColumnRef } | { DefElem: DefElem } | { FuncCall: FuncCall } | { FunctionParameter: FunctionParameter } | { IndexElem: IndexElem } | { List: List } | { ParamRef: ParamRef } | { RoleSpec: RoleSpec } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SetToDefault: SetToDefault } | { String: String } | { SubLink: SubLink } | { TypeCast: TypeCast } | { TypeName: TypeName }; +type List_items = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { BoolExpr: BoolExpr } | { CoalesceExpr: CoalesceExpr } | { CollateClause: CollateClause } | { ColumnDef: ColumnDef } | { ColumnRef: ColumnRef } | { DefElem: DefElem } | { FuncCall: FuncCall } | { FunctionParameter: FunctionParameter } | { IndexElem: IndexElem } | { List: List } | { ParamRef: ParamRef } | { RoleSpec: RoleSpec } | { RowExpr: RowExpr } | { SQLValueFunction: SQLValueFunction } | { SetToDefault: SetToDefault } | { String: String } | { SubLink: SubLink } | { TypeCast: TypeCast } | { TypeName: TypeName }; type LockStmt_relations = { RangeVar: RangeVar }; type LockingClause_lockedRels = { RangeVar: RangeVar }; type MergeStmt_joinCondition = { A_Const: A_Const } | { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { SubLink: SubLink }; @@ -225,7 +225,7 @@ type RangeFunction_coldeflist = { ColumnDef: ColumnDef }; type RangeFunction_functions = { List: List }; type RangeSubselect_subquery = { SelectStmt: SelectStmt }; type RangeTableFunc_columns = { RangeTableFuncCol: RangeTableFuncCol }; -type RangeTableFunc_docexpr = { A_Const: A_Const } | { ColumnRef: ColumnRef }; +type RangeTableFunc_docexpr = { A_Const: A_Const } | { ColumnRef: ColumnRef } | { SubLink: SubLink }; type RangeTableFunc_namespaces = { ResTarget: ResTarget }; type RangeTableFunc_rowexpr = { A_Const: A_Const } | { A_Expr: A_Expr } | { RowExpr: RowExpr }; type RangeTableFuncCol_coldefexpr = { A_Const: A_Const } | { A_Expr: A_Expr }; @@ -244,9 +244,9 @@ type RowExpr_args = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { A_Ex type RuleStmt_actions = { DeleteStmt: DeleteStmt } | { InsertStmt: InsertStmt } | { NotifyStmt: NotifyStmt } | { SelectStmt: SelectStmt } | { UpdateStmt: UpdateStmt }; type RuleStmt_whereClause = { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { SubLink: SubLink }; type SecLabelStmt_object = { List: List } | { ObjectWithArgs: ObjectWithArgs } | { String: String }; -type SelectStmt_distinctClause = { A_Const: A_Const } | { ColumnRef: ColumnRef }; +type SelectStmt_distinctClause = { A_Const: A_Const } | { A_Expr: A_Expr } | { ColumnRef: ColumnRef }; type SelectStmt_fromClause = { JoinExpr: JoinExpr } | { JsonTable: JsonTable } | { RangeFunction: RangeFunction } | { RangeSubselect: RangeSubselect } | { RangeTableFunc: RangeTableFunc } | { RangeTableSample: RangeTableSample } | { RangeVar: RangeVar }; -type SelectStmt_groupClause = { A_Const: A_Const } | { A_Expr: A_Expr } | { CollateClause: CollateClause } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { GroupingSet: GroupingSet } | { RowExpr: RowExpr } | { TypeCast: TypeCast }; +type SelectStmt_groupClause = { A_Const: A_Const } | { A_Expr: A_Expr } | { A_Indirection: A_Indirection } | { CollateClause: CollateClause } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { GroupingSet: GroupingSet } | { RowExpr: RowExpr } | { TypeCast: TypeCast }; type SelectStmt_havingClause = { A_Expr: A_Expr } | { BoolExpr: BoolExpr } | { ColumnRef: ColumnRef } | { SubLink: SubLink }; type SelectStmt_limitCount = { A_Const: A_Const } | { A_Expr: A_Expr } | { CaseExpr: CaseExpr } | { FuncCall: FuncCall }; type SelectStmt_limitOffset = { A_Const: A_Const } | { A_Expr: A_Expr } | { CaseExpr: CaseExpr } | { ColumnRef: ColumnRef }; @@ -280,7 +280,7 @@ type ViewStmt_options = { DefElem: DefElem }; type ViewStmt_query = { SelectStmt: SelectStmt }; type WindowDef_endOffset = { A_Const: A_Const } | { TypeCast: TypeCast }; type WindowDef_orderClause = { SortBy: SortBy }; -type WindowDef_partitionClause = { ColumnRef: ColumnRef }; +type WindowDef_partitionClause = { A_Expr: A_Expr } | { ColumnRef: ColumnRef }; type WindowDef_startOffset = { A_Const: A_Const } | { TypeCast: TypeCast }; type XmlExpr_args = { A_ArrayExpr: A_ArrayExpr } | { A_Const: A_Const } | { ColumnRef: ColumnRef } | { FuncCall: FuncCall } | { ParamRef: ParamRef } | { TypeCast: TypeCast } | { XmlExpr: XmlExpr }; type XmlExpr_named_args = { ResTarget: ResTarget }; diff --git a/packages/proto-parser/src/options/defaults.ts b/packages/proto-parser/src/options/defaults.ts index 911770a93..92ab5a855 100644 --- a/packages/proto-parser/src/options/defaults.ts +++ b/packages/proto-parser/src/options/defaults.ts @@ -7,6 +7,7 @@ import { PgProtoParserOptions } from './types'; export const defaultPgProtoParserOptions: PgProtoParserOptions = { outDir: join(process.cwd(), 'out'), includeHeader: true, + includeHeaderVersion: true, exclude: [], utils: { enums: { diff --git a/packages/proto-parser/src/options/types.ts b/packages/proto-parser/src/options/types.ts index 9db023ad8..f67767dad 100644 --- a/packages/proto-parser/src/options/types.ts +++ b/packages/proto-parser/src/options/types.ts @@ -100,6 +100,9 @@ export interface PgProtoStoreOptions { // Whether to include a header in generated TypeScript files. includeHeader?: boolean; + // Whether that header names the pg-proto-parser version. Turn off for output + // committed to a repository, so a generator release does not touch every file. + includeHeaderVersion?: boolean; } diff --git a/packages/proto-parser/src/utils/utils.ts b/packages/proto-parser/src/utils/utils.ts index 44bd02d3d..95d895b82 100644 --- a/packages/proto-parser/src/utils/utils.ts +++ b/packages/proto-parser/src/utils/utils.ts @@ -54,10 +54,11 @@ export const getFieldName = (field: Field, fallbackName: string) => { return field.options?.json_name ? field.options.json_name : fallbackName; }; -export const getHeader = () => { +export const getHeader = (includeVersion: boolean = true) => { const version = process.env.NODE_ENV === 'test' ? 'latest' : pkg.version; + const generator = includeVersion ? `pg-proto-parser@${version}` : 'pg-proto-parser'; return `/** -* This file was automatically generated by pg-proto-parser@${version}. +* This file was automatically generated by ${generator}. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ @@ -65,7 +66,7 @@ export const getHeader = () => { }; export const writeFileToDisk = (path: string, contents: string, options: PgProtoParserOptions) => { - const c = (options.includeHeader && extname(path) === '.ts') ? `${getHeader()}${contents}` : contents; + const c = (options.includeHeader && extname(path) === '.ts') ? `${getHeader(options.includeHeaderVersion !== false)}${contents}` : contents; writeFileSync(path, c); }; diff --git a/packages/transform-ast/scripts/pg-proto-parser.ts b/packages/transform-ast/scripts/pg-proto-parser.ts index 5a42a0b05..9d0620bb4 100644 --- a/packages/transform-ast/scripts/pg-proto-parser.ts +++ b/packages/transform-ast/scripts/pg-proto-parser.ts @@ -10,6 +10,7 @@ for (const version of versions) { const options: PgProtoParserOptions = { outDir, + includeHeaderVersion: false, types: { enabled: true, wrappedNodeTypeExport: true diff --git a/packages/transform-ast/src/13/enums.ts b/packages/transform-ast/src/13/enums.ts index 544ed2e7b..7f9e18761 100644 --- a/packages/transform-ast/src/13/enums.ts +++ b/packages/transform-ast/src/13/enums.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/13/types.ts b/packages/transform-ast/src/13/types.ts index b1b78509c..4e427cc1e 100644 --- a/packages/transform-ast/src/13/types.ts +++ b/packages/transform-ast/src/13/types.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/14/enums.ts b/packages/transform-ast/src/14/enums.ts index 4cef004d8..f80378aca 100644 --- a/packages/transform-ast/src/14/enums.ts +++ b/packages/transform-ast/src/14/enums.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/14/types.ts b/packages/transform-ast/src/14/types.ts index 17f1eb625..321c2b6e9 100644 --- a/packages/transform-ast/src/14/types.ts +++ b/packages/transform-ast/src/14/types.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/15/enums.ts b/packages/transform-ast/src/15/enums.ts index e619f9cca..af6688b94 100644 --- a/packages/transform-ast/src/15/enums.ts +++ b/packages/transform-ast/src/15/enums.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/15/types.ts b/packages/transform-ast/src/15/types.ts index 827a66b70..1fbb684b3 100644 --- a/packages/transform-ast/src/15/types.ts +++ b/packages/transform-ast/src/15/types.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/16/enums.ts b/packages/transform-ast/src/16/enums.ts index e2532f822..2ac582547 100644 --- a/packages/transform-ast/src/16/enums.ts +++ b/packages/transform-ast/src/16/enums.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/16/types.ts b/packages/transform-ast/src/16/types.ts index 455e4273e..a53a57774 100644 --- a/packages/transform-ast/src/16/types.ts +++ b/packages/transform-ast/src/16/types.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/17/enums.ts b/packages/transform-ast/src/17/enums.ts index 5ba9e11ac..c6e8a2804 100644 --- a/packages/transform-ast/src/17/enums.ts +++ b/packages/transform-ast/src/17/enums.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/17/types.ts b/packages/transform-ast/src/17/types.ts index 730b88889..318e97f92 100644 --- a/packages/transform-ast/src/17/types.ts +++ b/packages/transform-ast/src/17/types.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/18/enums.ts b/packages/transform-ast/src/18/enums.ts index 58095a150..063b18fa8 100644 --- a/packages/transform-ast/src/18/enums.ts +++ b/packages/transform-ast/src/18/enums.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/transform-ast/src/18/types.ts b/packages/transform-ast/src/18/types.ts index f202d394f..b335f4ef6 100644 --- a/packages/transform-ast/src/18/types.ts +++ b/packages/transform-ast/src/18/types.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/traverse/scripts/pg-proto-parser.ts b/packages/traverse/scripts/pg-proto-parser.ts index 944fc541a..a9ae23d5d 100644 --- a/packages/traverse/scripts/pg-proto-parser.ts +++ b/packages/traverse/scripts/pg-proto-parser.ts @@ -10,6 +10,7 @@ for (const version of versions) { const options: PgProtoParserOptions = { outDir, + includeHeaderVersion: false, runtimeSchema: { enabled: true, filename: 'runtime-schema.ts', diff --git a/packages/traverse/src/18/runtime-schema.ts b/packages/traverse/src/18/runtime-schema.ts index 1bd392664..e327b8152 100644 --- a/packages/traverse/src/18/runtime-schema.ts +++ b/packages/traverse/src/18/runtime-schema.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.30.6. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/utils/scripts/pg-proto-parser.ts b/packages/utils/scripts/pg-proto-parser.ts index 92d669102..f8c756949 100644 --- a/packages/utils/scripts/pg-proto-parser.ts +++ b/packages/utils/scripts/pg-proto-parser.ts @@ -6,6 +6,7 @@ const outDir: string = resolve(join(__dirname, '../src')); const options: PgProtoParserOptions = { outDir, + includeHeaderVersion: false, types: { enabled: false }, diff --git a/packages/utils/src/asts.ts b/packages/utils/src/asts.ts index 691eb30d6..bbced81b9 100644 --- a/packages/utils/src/asts.ts +++ b/packages/utils/src/asts.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/utils/src/runtime-schema.ts b/packages/utils/src/runtime-schema.ts index b0101a291..e327b8152 100644 --- a/packages/utils/src/runtime-schema.ts +++ b/packages/utils/src/runtime-schema.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/packages/utils/src/wrapped.ts b/packages/utils/src/wrapped.ts index c52acca8a..d662bb9fb 100644 --- a/packages/utils/src/wrapped.ts +++ b/packages/utils/src/wrapped.ts @@ -1,5 +1,5 @@ /** -* This file was automatically generated by pg-proto-parser@1.32.5. +* This file was automatically generated by pg-proto-parser. * DO NOT MODIFY IT BY HAND. Instead, modify the source proto file, * and run the pg-proto-parser generate command to regenerate this file. */ diff --git a/scripts/check-ci-matrix.ts b/scripts/check-ci-matrix.ts new file mode 100644 index 000000000..47b65792d --- /dev/null +++ b/scripts/check-ci-matrix.ts @@ -0,0 +1,45 @@ +// Fails when a workspace package that has tests is missing from the CI test matrix. +import { existsSync, readdirSync, readFileSync } from 'fs'; +import { join } from 'path'; + +const root = join(__dirname, '..'); +const workflowPath = '.github/workflows/run-tests.yaml'; +const packagesDir = join(root, 'packages'); + +const hasTests = (dir: string): boolean => + readdirSync(dir, { withFileTypes: true }).some(entry => { + if (entry.name === 'node_modules' || entry.name === 'dist') return false; + if (entry.isDirectory()) { + return entry.name === '__tests__' || hasTests(join(dir, entry.name)); + } + return /\.(test|spec)\.[jt]sx?$/.test(entry.name); + }); + +const workflow = readFileSync(join(root, workflowPath), 'utf-8'); +const matrixBlock = /^ {8}package:\n((?: {10}- .*\n)+)/m.exec(workflow); +if (!matrixBlock) { + console.error(`Could not find the package matrix in ${workflowPath}`); + process.exit(1); +} +const matrix = new Set( + matrixBlock[1].trim().split('\n').map(line => line.trim().replace(/^- /, '').replace(/^['"]|['"]$/g, '')) +); + +const tested = readdirSync(packagesDir) + .filter(dir => existsSync(join(packagesDir, dir, 'package.json'))) + .filter(dir => hasTests(join(packagesDir, dir))) + .map(dir => JSON.parse(readFileSync(join(packagesDir, dir, 'package.json'), 'utf-8')).name as string); + +const missing = tested.filter(name => !matrix.has(name)); +const stale = [...matrix].filter(name => !tested.includes(name)); + +for (const name of missing) { + console.error(`${name} has tests but is not in the package matrix of ${workflowPath}`); +} +for (const name of stale) { + console.error(`${name} is in the package matrix of ${workflowPath} but is not a workspace package with tests`); +} +if (missing.length || stale.length) { + process.exit(1); +} +console.log(`CI matrix covers all ${tested.length} packages with tests.`);