From 222ea85580a6c3beeaf47be3751dcf4753a747d2 Mon Sep 17 00:00:00 2001 From: Shlok Kyal Date: Fri, 18 Jul 2025 15:31:44 +0530 Subject: [PATCH v16 3/3] Skip publishing the columns specified in FOR TABLE EXCEPT A new "TABLE table_name EXCEPT (column_list)" clause for CREATE/ALTER PUBLICATION allows one or more columns to be excluded. The publisher will not send the data of excluded columns to the subscriber. The new syntax allows specifying excluded column list when creating or altering a publication. For example: CREATE PUBLICATION pubname FOR TABLE tabname EXCEPT (col1, col2, col3) or ALTER PUBLICATION pubname ADD TABLE tabname EXCEPT (col1, col2, col3) The column "prexcept" of system catalog "pg_publication_rel" is set to "true" when publication is created with EXCEPT table or EXCEPT column list. If column "prattrs" of system catalog "pg_publication_rel" is also set or column "puballtables" of system catalog "pg_publication" is "false", it indicates the column list is specified with EXCEPT clause and columns in "prattrs" are excluded from being published. pg_dump is updated to identify and dump the excluded column list of the publication. The psql \d family of commands can now display excluded column list. e.g. psql \dRp+ variant will now display associated "EXCEPT (column_list)" if any. --- doc/src/sgml/catalogs.sgml | 5 +- doc/src/sgml/logical-replication.sgml | 114 ++++++++++++---- doc/src/sgml/ref/alter_publication.sgml | 10 +- doc/src/sgml/ref/create_publication.sgml | 52 ++++++-- src/backend/catalog/pg_publication.c | 61 ++++++++- src/backend/commands/publicationcmds.c | 30 ++++- src/backend/parser/gram.y | 65 +++++++++ src/backend/replication/pgoutput/pgoutput.c | 61 ++++++++- src/bin/pg_dump/pg_dump.c | 45 ++++--- src/bin/pg_dump/pg_dump.h | 1 + src/bin/psql/describe.c | 100 +++++++++----- src/bin/psql/tab-complete.in.c | 4 +- src/include/catalog/pg_publication.h | 6 +- src/include/catalog/pg_publication_rel.h | 5 +- src/test/regress/expected/publication.out | 72 ++++++++++ src/test/regress/sql/publication.sql | 52 ++++++++ .../t/036_rep_changes_except_table.pl | 124 +++++++++++++++++- 17 files changed, 694 insertions(+), 113 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 1bb1db26045..b045d814f05 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -6573,7 +6573,10 @@ SCRAM-SHA-256$<iteration count>:&l prexcept bool - True if the relation must be excluded + True if the column list or relation must be excluded from publication. + If a column list is specified in prattrs, then + exclude only those columns. If prattrs is null, + then exclude the entire relation. diff --git a/doc/src/sgml/logical-replication.sgml b/doc/src/sgml/logical-replication.sgml index 2e9f6019474..de32fd33a87 100644 --- a/doc/src/sgml/logical-replication.sgml +++ b/doc/src/sgml/logical-replication.sgml @@ -1372,10 +1372,10 @@ Publications: Column Lists - Each publication can optionally specify which columns of each table are - replicated to subscribers. The table on the subscriber side must have at - least all the columns that are published. If no column list is specified, - then all columns on the publisher are replicated. + Each publication can optionally specify which columns of each table should be + replicated or excluded from replication. The table on the subscriber side + must have at least all the columns that are published. If no column list is + specified, then all columns on the publisher are replicated. See for details on the syntax. @@ -1389,8 +1389,11 @@ Publications: If no column list is specified, any columns added to the table later are - automatically replicated. This means that having a column list which names - all columns is not the same as having no column list at all. + automatically replicated. However, a normal column list (without + EXCEPT) only replicates the specified columns and no more. + Therefore, having a column list that names all columns is not the same as + having no column list at all, as more columns may be added to the table + later. @@ -1402,6 +1405,14 @@ Publications: Generated columns can also be specified in a column list. This allows generated columns to be published, regardless of the publication parameter + publish_generated_columns. Generated columns can be + specified in a column list using the EXCEPT clause. This + excludes the specified generated columns from being published, regardless of + the + publish_generated_columns setting. However, for + generated columns that are not listed in the EXCEPT + clause, whether they are published or not still depends on the value of + publish_generated_columns. See for details. @@ -1423,11 +1434,14 @@ Publications: If a publication publishes UPDATE or - DELETE operations, any column list must include the - table's replica identity columns (see - ). + DELETE operations, any column list must include table's + replica identity columns and any column list specified with + EXCEPT clause must not include the table's replica + identity columns (see ). If a publication publishes only INSERT operations, then - the column list may omit replica identity columns. + the column list may omit replica identity columns and the column list + specified with EXCEPT clause may include replica identity + columns. @@ -1472,18 +1486,21 @@ Publications: Examples - Create a table t1 to be used in the following example. + Create tables t1 and t2 to be used in + the following example. /* pub # */ CREATE TABLE t1(id int, a text, b text, c text, d text, e text, PRIMARY KEY(id)); +/* pub # */ CREATE TABLE t2(id int, a text, b text, c text, d text, e text, PRIMARY KEY(id)); Create a publication p1. A column list is defined for - table t1 to reduce the number of columns that will be - replicated. Notice that the order of column names in the column list does - not matter. + table t1, and another column list is defined for table + t2 using the EXCEPT clause to reduce + the number of columns that will be replicated. Note that the order of column + names in the column lists does not matter. -/* pub # */ CREATE PUBLICATION p1 FOR TABLE t1 (id, b, a, d); +/* pub # */ CREATE PUBLICATION p1 FOR TABLE t1 (id, b, a, d), t2 EXCEPT (d, a); @@ -1491,12 +1508,13 @@ Publications: for each publication. /* pub # */ \dRp+ - Publication p1 - Owner | All tables | Inserts | Updates | Deletes | Truncates | Via root -----------+------------+---------+---------+---------+-----------+---------- - postgres | f | t | t | t | t | f + Publication p1 + Owner | All tables | Inserts | Updates | Deletes | Truncates | Generated columns | Via root +--------+------------+---------+---------+---------+-----------+-------------------+---------- + ubuntu | f | t | t | t | t | none | f Tables: "public.t1" (id, a, b, d) + "public.t2" EXCEPT (a, d) @@ -1517,23 +1535,41 @@ Indexes: "t1_pkey" PRIMARY KEY, btree (id) Publications: "p1" (id, a, b, d) + +/* pub # */ \d t2 + Table "public.t2" + Column | Type | Collation | Nullable | Default +--------+---------+-----------+----------+--------- + id | integer | | not null | + a | text | | | + b | text | | | + c | text | | | + d | text | | | + e | text | | | +Indexes: + "t2_pkey" PRIMARY KEY, btree (id) +Publications: + "p1" EXCEPT (a, d) - On the subscriber node, create a table t1 which now - only needs a subset of the columns that were on the publisher table - t1, and also create the subscription + On the subscriber node, create tables t1 and + t2 which now only needs a subset of the columns that + were on the publisher tables t1 and + t2, and also create the subscription s1 that subscribes to the publication p1. /* sub # */ CREATE TABLE t1(id int, b text, a text, d text, PRIMARY KEY(id)); +/* sub # */ CREATE TABLE t2(id int, b text, c text, e text, PRIMARY KEY(id)); /* sub # */ CREATE SUBSCRIPTION s1 /* sub - */ CONNECTION 'host=localhost dbname=test_pub application_name=s1' /* sub - */ PUBLICATION p1; - On the publisher node, insert some rows to table t1. + On the publisher node, insert some rows to tables t1 + and t2 /* pub # */ INSERT INTO t1 VALUES(1, 'a-1', 'b-1', 'c-1', 'd-1', 'e-1'); /* pub # */ INSERT INTO t1 VALUES(2, 'a-2', 'b-2', 'c-2', 'd-2', 'e-2'); @@ -1545,11 +1581,21 @@ Publications: 2 | a-2 | b-2 | c-2 | d-2 | e-2 3 | a-3 | b-3 | c-3 | d-3 | e-3 (3 rows) +/* pub # */ INSERT INTO t2 VALUES(1, 'a-1', 'b-1', 'c-1', 'd-1', 'e-1'); +/* pub # */ INSERT INTO t2 VALUES(2, 'a-2', 'b-2', 'c-2', 'd-2', 'e-2'); +/* pub # */ INSERT INTO t2 VALUES(3, 'a-3', 'b-3', 'c-3', 'd-3', 'e-3'); +/* pub # */ SELECT * FROM t2 ORDER BY id; + id | a | b | c | d | e +----+-----+-----+-----+-----+----- + 1 | a-1 | b-1 | c-1 | d-1 | e-1 + 2 | a-2 | b-2 | c-2 | d-2 | e-2 + 3 | a-3 | b-3 | c-3 | d-3 | e-3 +(3 rows) - Only data from the column list of publication p1 is - replicated. + Only data specified by the column lists of publication + p1 is replicated. /* sub # */ SELECT * FROM t1 ORDER BY id; id | b | a | d @@ -1558,6 +1604,13 @@ Publications: 2 | b-2 | a-2 | d-2 3 | b-3 | a-3 | d-3 (3 rows) +/* sub # */ SELECT * FROM t2 ORDER BY id; + id | b | c | e +----+-----+-----+----- + 1 | b-1 | c-1 | e-1 + 2 | b-2 | c-2 | e-2 + 3 | b-3 | c-3 | e-3 +(3 rows) @@ -1654,6 +1707,17 @@ Publications: + + Generated columns specified in the column list with the + EXCEPT clause are not published, regardless of the value + of the + publish_generated_columns parameter. However, + generated columns that are not part of the column list with the + EXCEPT clause are published according to the value of the + + publish_generated_columns parameter. + + The following table summarizes behavior when there are generated columns involved in the logical replication. Results are shown for when diff --git a/doc/src/sgml/ref/alter_publication.sgml b/doc/src/sgml/ref/alter_publication.sgml index bd25a1a723c..c8e9c4b216c 100644 --- a/doc/src/sgml/ref/alter_publication.sgml +++ b/doc/src/sgml/ref/alter_publication.sgml @@ -32,7 +32,7 @@ ALTER PUBLICATION name RESET where publication_object is one of: - TABLE [ ONLY ] table_name [ * ] [ ( column_name [, ... ] ) ] [ WHERE ( expression ) ] [, ... ] + TABLE [ ONLY ] table_name [ * ] [ [ EXCEPT ] ( column_name [, ... ] ) ] [ WHERE ( expression ) ] [, ... ] TABLES IN SCHEMA { schema_name | CURRENT_SCHEMA } [, ... ] where exception_object is: @@ -259,6 +259,14 @@ ALTER PUBLICATION production_publication ADD ALL TABLES EXCEPT users, department production_publication: ALTER PUBLICATION production_publication ADD TABLE users, departments, TABLES IN SCHEMA production; + + + + Alter publication mypublication to add table + users except column + security_pin: + +ALTER PUBLICATION production_publication ADD TABLE users EXCEPT (security_pin); diff --git a/doc/src/sgml/ref/create_publication.sgml b/doc/src/sgml/ref/create_publication.sgml index a2f9c0d4825..8ec266c9e97 100644 --- a/doc/src/sgml/ref/create_publication.sgml +++ b/doc/src/sgml/ref/create_publication.sgml @@ -28,7 +28,7 @@ CREATE PUBLICATION name where publication_object is one of: - TABLE [ ONLY ] table_name [ * ] [ ( column_name [, ... ] ) ] [ WHERE ( expression ) ] [, ... ] + TABLE [ ONLY ] table_name [ * ] [ [ EXCEPT ] ( column_name [, ... ] ) ] [ WHERE ( expression ) ] [, ... ] TABLES IN SCHEMA { schema_name | CURRENT_SCHEMA } [, ... ] where exception_object is: @@ -92,17 +92,24 @@ CREATE PUBLICATION name - When a column list is specified, only the named columns are replicated. - The column list can contain stored generated columns as well. If the - column list is omitted, the publication will replicate all non-generated - columns (including any added in the future) by default. Stored generated - columns can also be replicated if publish_generated_columns - is set to stored. Specifying a column list has no - effect on TRUNCATE commands. See + When a column list without EXCEPT is specified, only + the named columns are replicated. The column list can contain stored + generated columns as well. If the column list is omitted, the publication + will replicate all non-generated columns (including any added in the + future) by default. Stored generated columns can also be replicated if + publish_generated_columns is set to + stored. Specifying a column list has no effect on + TRUNCATE commands. See for details about column lists. + + When a column list is specified with EXCEPT, the named + columns are not replicated. Specifying a column list has no effect on + TRUNCATE commands. + + Only persistent base tables and partitioned tables can be part of a publication. Temporary tables, unlogged tables, foreign tables, @@ -335,10 +342,12 @@ CREATE PUBLICATION name - Any column list must include the REPLICA IDENTITY columns - in order for UPDATE or DELETE - operations to be published. There are no column list restrictions if the - publication publishes only INSERT operations. + In order for UPDATE or DELETE + operations to work, all the REPLICA IDENTITY columns must + be published. So, any column list must name all + REPLICA IDENTITY columns, and any + EXCEPT column list must not name any + REPLICA IDENTITY columns. @@ -353,6 +362,16 @@ CREATE PUBLICATION name system columns. + + The generated columns that are part of the column list specified with the + EXCEPT clause are not published, regardless of the + publish_generated_columns option. However, generated + columns that are not part of the column list specified with the + EXCEPT clause are published according to the value of the + publish_generated_columns option. See + for details. + + The generated columns that are part of REPLICA IDENTITY must be published explicitly either by listing them in the column list or @@ -482,6 +501,15 @@ CREATE PUBLICATION mypublication FOR ALL TABLES EXCEPT users, departments; CREATE PUBLICATION users_filtered FOR TABLE users (user_id, firstname); + + + Create a publication that publishes all changes for table + users except changes for column + security_pin: + +CREATE PUBLICATION users_safe FOR TABLE users EXCEPT (security_pin); + + diff --git a/src/backend/catalog/pg_publication.c b/src/backend/catalog/pg_publication.c index 1878fba8748..6bce5adc74e 100644 --- a/src/backend/catalog/pg_publication.c +++ b/src/backend/catalog/pg_publication.c @@ -263,14 +263,19 @@ is_schema_publication(Oid pubid) * If a column list is found, the corresponding bitmap is returned through the * cols parameter, if provided. The bitmap is constructed within the given * memory context (mcxt). + * + * If a column list is found specified with EXCEPT clause, except_columns is set + * to true. */ bool check_and_fetch_column_list(Publication *pub, Oid relid, MemoryContext mcxt, - Bitmapset **cols) + Bitmapset **cols, bool *except_columns) { HeapTuple cftuple; bool found = false; + *except_columns = false; + if (pub->alltables) return false; @@ -296,6 +301,16 @@ check_and_fetch_column_list(Publication *pub, Oid relid, MemoryContext mcxt, found = true; } + /* Lookup the except attribute */ + cfdatum = SysCacheGetAttr(PUBLICATIONRELMAP, cftuple, + Anum_pg_publication_rel_prexcept, &isnull); + + if (!isnull) + { + Assert(!pub->alltables); + *except_columns = DatumGetBool(cfdatum); + } + ReleaseSysCache(cftuple); } @@ -646,10 +661,12 @@ pub_collist_to_bitmapset(Bitmapset *columns, Datum pubcols, MemoryContext mcxt) * Returns a bitmap representing the columns of the specified table. * * Generated columns are included if include_gencols_type is - * PUBLISH_GENCOLS_STORED. + * PUBLISH_GENCOLS_STORED. Columns that are in the exceptcols are excluded from + * the column list. */ Bitmapset * -pub_form_cols_map(Relation relation, PublishGencolsType include_gencols_type) +pub_form_cols_map(Relation relation, PublishGencolsType include_gencols_type, + Bitmapset *except_cols) { Bitmapset *result = NULL; TupleDesc desc = RelationGetDescr(relation); @@ -672,6 +689,9 @@ pub_form_cols_map(Relation relation, PublishGencolsType include_gencols_type) continue; } + if (except_cols && bms_is_member(att->attnum, except_cols)) + continue; + result = bms_add_member(result, att->attnum); } @@ -776,8 +796,10 @@ GetRelationPublications(Oid relid, bool except_flag) { HeapTuple tup = &pubrellist->members[i]->tuple; Oid pubid = ((Form_pg_publication_rel) GETSTRUCT(tup))->prpubid; + bool is_except_table = ((Form_pg_publication_rel) GETSTRUCT(tup))->prexcept && + heap_attisnull(tup, Anum_pg_publication_rel_prattrs, NULL); - if (except_flag == ((Form_pg_publication_rel) GETSTRUCT(tup))->prexcept) + if (except_flag == is_except_table) result = lappend_oid(result, pubid); } @@ -1288,6 +1310,9 @@ pg_get_publication_tables(PG_FUNCTION_ARGS) Oid schemaid = get_rel_namespace(relid); Datum values[NUM_PUBLICATION_TABLES_ELEM] = {0}; bool nulls[NUM_PUBLICATION_TABLES_ELEM] = {0}; + Datum exceptDatum; + bool isnull; + Bitmapset *except_columns = NULL; /* * Form tuple with appropriate data. @@ -1312,7 +1337,6 @@ pg_get_publication_tables(PG_FUNCTION_ARGS) if (HeapTupleIsValid(pubtuple)) { - /* Lookup the column list attribute. */ values[2] = SysCacheGetAttr(PUBLICATIONRELMAP, pubtuple, Anum_pg_publication_rel_prattrs, &(nulls[2])); @@ -1321,6 +1345,18 @@ pg_get_publication_tables(PG_FUNCTION_ARGS) values[3] = SysCacheGetAttr(PUBLICATIONRELMAP, pubtuple, Anum_pg_publication_rel_prqual, &(nulls[3])); + + /* + * We fetch pubtuple if publication is not FOR ALL TABLES and not + * FOR TABLES IN SCHEMA. So if prexcept is true, it indicates that + * prattrs contains columns to be excluded for replication. + */ + exceptDatum = SysCacheGetAttr(PUBLICATIONRELMAP, pubtuple, + Anum_pg_publication_rel_prexcept, + &isnull); + + if (!isnull && DatumGetBool(exceptDatum) && !nulls[2]) + except_columns = pub_collist_to_bitmapset(NULL, values[2], NULL); } else { @@ -1328,8 +1364,12 @@ pg_get_publication_tables(PG_FUNCTION_ARGS) nulls[3] = true; } - /* Show all columns when the column list is not specified. */ - if (nulls[2]) + /* + * Construct column list to show all columns when no column list is + * specified or to show remaining columns when a column list is + * provided with EXCEPT. + */ + if (except_columns || nulls[2]) { Relation rel = table_open(relid, AccessShareLock); int nattnums = 0; @@ -1360,6 +1400,13 @@ pg_get_publication_tables(PG_FUNCTION_ARGS) continue; } + /* + * Skip columns that are part of column list specified with + * EXCEPT. + */ + if (except_columns && bms_is_member(att->attnum, except_columns)) + continue; + attnums[nattnums++] = att->attnum; } diff --git a/src/backend/commands/publicationcmds.c b/src/backend/commands/publicationcmds.c index d25de331c34..e9452748b2a 100644 --- a/src/backend/commands/publicationcmds.c +++ b/src/backend/commands/publicationcmds.c @@ -204,7 +204,6 @@ ObjectsInPublicationToOids(List *pubobjspec_list, ParseState *pstate, switch (pubobj->pubobjtype) { case PUBLICATIONOBJ_TABLE: - pubobj->pubtable->except = false; *rels = lappend(*rels, pubobj->pubtable); break; case PUBLICATIONOBJ_EXCEPT_TABLE: @@ -358,7 +357,8 @@ pub_rf_contains_invalid_column(Oid pubid, Relation relation, List *ancestors, * This function evaluates two conditions: * * 1. Ensures that all columns referenced in the REPLICA IDENTITY are covered - * by the column list. If any column is missing, *invalid_column_list is set + * by the column list and are not part of column list specified with EXCEPT. + * If any column is missing, *invalid_column_list is set * to true. * 2. Ensures that all the generated columns referenced in the REPLICA IDENTITY * are published, either by being explicitly named in the column list or, if @@ -381,6 +381,7 @@ pub_contains_invalid_column(Oid pubid, Relation relation, List *ancestors, TupleDesc desc = RelationGetDescr(relation); Publication *pub; int x; + bool except_columns = false; *invalid_column_list = false; *invalid_gen_col = false; @@ -404,7 +405,8 @@ pub_contains_invalid_column(Oid pubid, Relation relation, List *ancestors, /* Fetch the column list */ pub = GetPublication(pubid); - check_and_fetch_column_list(pub, publish_as_relid, NULL, &columns); + check_and_fetch_column_list(pub, publish_as_relid, NULL, &columns, + &except_columns); if (relation->rd_rel->relreplident == REPLICA_IDENTITY_FULL) { @@ -494,8 +496,14 @@ pub_contains_invalid_column(Oid pubid, Relation relation, List *ancestors, attnum = get_attnum(publish_as_relid, colname); } - /* replica identity column, not covered by the column list */ - *invalid_column_list |= !bms_is_member(attnum, columns); + /* + * Replica identity column, not covered by the column list or is part + * of column list specified with EXCEPT. + */ + if (except_columns) + *invalid_column_list |= bms_is_member(attnum, columns); + else + *invalid_column_list |= !bms_is_member(attnum, columns); if (*invalid_column_list && *invalid_gen_col) break; @@ -1440,6 +1448,7 @@ AlterPublicationTables(AlterPublicationStmt *stmt, HeapTuple tup, HeapTuple rftuple; Node *oldrelwhereclause = NULL; Bitmapset *oldcolumns = NULL; + bool oldexcept = false; /* look up the cache for the old relmap */ rftuple = SearchSysCache2(PUBLICATIONRELMAP, @@ -1455,6 +1464,7 @@ AlterPublicationTables(AlterPublicationStmt *stmt, HeapTuple tup, bool isnull = true; Datum whereClauseDatum; Datum columnListDatum; + Datum exceptDatum; /* Load the WHERE clause for this table. */ whereClauseDatum = SysCacheGetAttr(PUBLICATIONRELMAP, rftuple, @@ -1471,6 +1481,13 @@ AlterPublicationTables(AlterPublicationStmt *stmt, HeapTuple tup, if (!isnull) oldcolumns = pub_collist_to_bitmapset(NULL, columnListDatum, NULL); + exceptDatum = SysCacheGetAttr(PUBLICATIONRELMAP, rftuple, + Anum_pg_publication_rel_prexcept, + &isnull); + + if (!isnull) + oldexcept = DatumGetBool(exceptDatum); + ReleaseSysCache(rftuple); } @@ -1502,7 +1519,8 @@ AlterPublicationTables(AlterPublicationStmt *stmt, HeapTuple tup, if (newrelid == oldrelid) { if (equal(oldrelwhereclause, newpubrel->whereClause) && - bms_equal(oldcolumns, newcolumns)) + bms_equal(oldcolumns, newcolumns) && + oldexcept == newpubrel->except) { found = true; break; diff --git a/src/backend/parser/gram.y b/src/backend/parser/gram.y index bdbbcccd47f..95db9f12e3f 100644 --- a/src/backend/parser/gram.y +++ b/src/backend/parser/gram.y @@ -446,6 +446,7 @@ static Node *makeRecursiveViewSelect(char *relname, List *aliases, Node *query); TriggerTransitions TriggerReferencing vacuum_relation_list opt_vacuum_relation_list drop_option_list pub_obj_list except_pub_obj_list + opt_except_column_list %type returning_clause %type returning_option @@ -4426,6 +4427,10 @@ opt_column_list: | /*EMPTY*/ { $$ = NIL; } ; +opt_except_column_list: + '(' columnList ')' { $$ = $2; } + ; + columnList: columnElem { $$ = list_make1($1); } | columnList ',' columnElem { $$ = lappend($1, $3); } @@ -10744,6 +10749,17 @@ PublicationObjSpec: $$->pubtable->whereClause = $4; $$->location = @1; } + | TABLE relation_expr EXCEPT opt_except_column_list OptWhereClause + { + $$ = makeNode(PublicationObjSpec); + $$->pubobjtype = PUBLICATIONOBJ_TABLE; + $$->pubtable = makeNode(PublicationTable); + $$->pubtable->relation = $2; + $$->pubtable->columns = $4; + $$->pubtable->whereClause = $5; + $$->pubtable->except = true; + $$->location = @1; + } | TABLES IN_P SCHEMA ColId { $$ = makeNode(PublicationObjSpec); @@ -10784,6 +10800,34 @@ PublicationObjSpec: } $$->location = @1; } + | ColId EXCEPT opt_except_column_list OptWhereClause + { + $$ = makeNode(PublicationObjSpec); + $$->pubobjtype = PUBLICATIONOBJ_CONTINUATION; + /* + * If either a row filter or exclude column list is + * specified, create a PublicationTable object. + */ + if ($3 || $4) + { + /* + * The OptWhereClause must be stored here but it is + * valid only for tables. For non-table objects, an + * error will be thrown later via + * preprocess_pubobj_list(). + */ + $$->pubtable = makeNode(PublicationTable); + $$->pubtable->relation = makeRangeVar(NULL, $1, @1); + $$->pubtable->columns = $3; + $$->pubtable->whereClause = $4; + $$->pubtable->except = true; + } + else + { + $$->name = $1; + } + $$->location = @1; + } | ColId indirection opt_column_list OptWhereClause { $$ = makeNode(PublicationObjSpec); @@ -10794,6 +10838,17 @@ PublicationObjSpec: $$->pubtable->whereClause = $4; $$->location = @1; } + | ColId indirection EXCEPT opt_except_column_list OptWhereClause + { + $$ = makeNode(PublicationObjSpec); + $$->pubobjtype = PUBLICATIONOBJ_CONTINUATION; + $$->pubtable = makeNode(PublicationTable); + $$->pubtable->relation = makeRangeVarFromQualifiedName($1, $2, @1, yyscanner); + $$->pubtable->columns = $4; + $$->pubtable->whereClause = $5; + $$->pubtable->except = true; + $$->location = @1; + } /* grammar like tablename * , ONLY tablename, ONLY ( tablename ) */ | extended_relation_expr opt_column_list OptWhereClause { @@ -10804,6 +10859,16 @@ PublicationObjSpec: $$->pubtable->columns = $2; $$->pubtable->whereClause = $3; } + | extended_relation_expr EXCEPT opt_except_column_list OptWhereClause + { + $$ = makeNode(PublicationObjSpec); + $$->pubobjtype = PUBLICATIONOBJ_CONTINUATION; + $$->pubtable = makeNode(PublicationTable); + $$->pubtable->relation = $1; + $$->pubtable->columns = $3; + $$->pubtable->whereClause = $4; + $$->pubtable->except = true; + } | CURRENT_SCHEMA { $$ = makeNode(PublicationObjSpec); diff --git a/src/backend/replication/pgoutput/pgoutput.c b/src/backend/replication/pgoutput/pgoutput.c index 08111b571de..d186564c297 100644 --- a/src/backend/replication/pgoutput/pgoutput.c +++ b/src/backend/replication/pgoutput/pgoutput.c @@ -185,6 +185,16 @@ typedef struct RelationSyncEntry * row filter expressions, column list, etc. */ MemoryContext entry_cxt; + + /* + * Indicates whether no columns are published for a given relation. With + * the introduction of the EXCEPT clause in column lists, it is now + * possible to define a publication that excludes all columns of a table. + * However, the 'columns' attribute cannot represent this case, since a + * NULL value implies that all columns are published. To distinguish this + * scenario, the 'no_cols_published' flag is introduced. + */ + bool no_cols_published; } RelationSyncEntry; /* @@ -1068,12 +1078,21 @@ check_and_init_gencol(PGOutputData *data, List *publications, */ foreach_ptr(Publication, pub, publications) { + bool has_column_list = false; + bool except_columns = false; + + has_column_list = check_and_fetch_column_list(pub, + entry->publish_as_relid, + NULL, NULL, + &except_columns); + /* * The column list takes precedence over the * 'publish_generated_columns' parameter. Those will be checked later, - * see pgoutput_column_list_init. + * see pgoutput_column_list_init. But when a column list is specified + * with EXCEPT, it should be checked. */ - if (check_and_fetch_column_list(pub, entry->publish_as_relid, NULL, NULL)) + if (has_column_list && !except_columns) continue; if (first) @@ -1122,11 +1141,30 @@ pgoutput_column_list_init(PGOutputData *data, List *publications, { Publication *pub = lfirst(lc); Bitmapset *cols = NULL; + bool except_columns = false; + bool no_col_published = false; /* Retrieve the bitmap of columns for a column list publication. */ found_pub_collist |= check_and_fetch_column_list(pub, entry->publish_as_relid, - entry->entry_cxt, &cols); + entry->entry_cxt, &cols, + &except_columns); + + /* + * If column list is specified with EXCEPT retrieve bitmap of columns + * which are not part of this column list. + */ + if (except_columns) + { + MemoryContext oldcxt = MemoryContextSwitchTo(entry->entry_cxt); + + cols = pub_form_cols_map(relation, + entry->include_gencols_type, cols); + MemoryContextSwitchTo(oldcxt); + + if (!cols) + no_col_published = true; + } /* * For non-column list publications — e.g. TABLE (without a column @@ -1134,7 +1172,7 @@ pgoutput_column_list_init(PGOutputData *data, List *publications, * of the table (including generated columns when * 'publish_generated_columns' parameter is true). */ - if (!cols) + if (!no_col_published && !cols) { /* * Cache the table columns for the first publication with no @@ -1146,7 +1184,7 @@ pgoutput_column_list_init(PGOutputData *data, List *publications, MemoryContext oldcxt = MemoryContextSwitchTo(entry->entry_cxt); relcols = pub_form_cols_map(relation, - entry->include_gencols_type); + entry->include_gencols_type, NULL); MemoryContextSwitchTo(oldcxt); } @@ -1156,9 +1194,11 @@ pgoutput_column_list_init(PGOutputData *data, List *publications, if (first) { entry->columns = cols; + entry->no_cols_published = no_col_published; first = false; } - else if (!bms_equal(entry->columns, cols)) + else if ((entry->no_cols_published != no_col_published) || + !bms_equal(entry->columns, cols)) ereport(ERROR, errcode(ERRCODE_FEATURE_NOT_SUPPORTED), errmsg("cannot use different column lists for table \"%s.%s\" in different publications", @@ -1482,6 +1522,13 @@ pgoutput_change(LogicalDecodingContext *ctx, ReorderBufferTXN *txn, relentry = get_rel_sync_entry(data, relation); + /* + * If all columns of a table are present in column list specified with + * EXCEPT, skip publishing the changes. + */ + if (relentry->no_cols_published) + return; + /* First check the table filter */ switch (action) { @@ -2059,6 +2106,7 @@ get_rel_sync_entry(PGOutputData *data, Relation relation) entry->publish_as_relid = InvalidOid; entry->columns = NULL; entry->attrmap = NULL; + entry->no_cols_published = false; } /* Validate the entry */ @@ -2108,6 +2156,7 @@ get_rel_sync_entry(PGOutputData *data, Relation relation) entry->pubactions.pubupdate = false; entry->pubactions.pubdelete = false; entry->pubactions.pubtruncate = false; + entry->no_cols_published = false; /* * Tuple slots cleanups. (Will be rebuilt later if needed). diff --git a/src/bin/pg_dump/pg_dump.c b/src/bin/pg_dump/pg_dump.c index 79747f9a99f..3a6eeee4c51 100644 --- a/src/bin/pg_dump/pg_dump.c +++ b/src/bin/pg_dump/pg_dump.c @@ -4781,24 +4781,7 @@ getPublicationTables(Archive *fout, TableInfo tblinfo[], int numTables) if (tbinfo == NULL) continue; - /* OK, make a DumpableObject for this relationship */ - if (strcmp(prexcept, "f") == 0) - pubrinfo[j].dobj.objType = DO_PUBLICATION_REL; - else - pubrinfo[j].dobj.objType = DO_PUBLICATION_EXCEPT_REL; - - pubrinfo[j].dobj.catId.tableoid = - atooid(PQgetvalue(res, i, i_tableoid)); - pubrinfo[j].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid)); - AssignDumpId(&pubrinfo[j].dobj); - pubrinfo[j].dobj.namespace = tbinfo->dobj.namespace; - pubrinfo[j].dobj.name = tbinfo->dobj.name; - pubrinfo[j].publication = pubinfo; - pubrinfo[j].pubtable = tbinfo; - if (PQgetisnull(res, i, i_prrelqual)) - pubrinfo[j].pubrelqual = NULL; - else - pubrinfo[j].pubrelqual = pg_strdup(PQgetvalue(res, i, i_prrelqual)); + pubrinfo[j].pubexcept = (strcmp(prexcept, "t") == 0); if (!PQgetisnull(res, i, i_prattrs)) { @@ -4824,10 +4807,29 @@ getPublicationTables(Archive *fout, TableInfo tblinfo[], int numTables) else pubrinfo[j].pubrattrs = NULL; + /* OK, make a DumpableObject for this relationship */ + if (pubrinfo[j].pubexcept && !pubrinfo[j].pubrattrs) + pubrinfo[j].dobj.objType = DO_PUBLICATION_EXCEPT_REL; + else + pubrinfo[j].dobj.objType = DO_PUBLICATION_REL; + + pubrinfo[j].dobj.catId.tableoid = + atooid(PQgetvalue(res, i, i_tableoid)); + pubrinfo[j].dobj.catId.oid = atooid(PQgetvalue(res, i, i_oid)); + AssignDumpId(&pubrinfo[j].dobj); + pubrinfo[j].dobj.namespace = tbinfo->dobj.namespace; + pubrinfo[j].dobj.name = tbinfo->dobj.name; + pubrinfo[j].publication = pubinfo; + pubrinfo[j].pubtable = tbinfo; + if (PQgetisnull(res, i, i_prrelqual)) + pubrinfo[j].pubrelqual = NULL; + else + pubrinfo[j].pubrelqual = pg_strdup(PQgetvalue(res, i, i_prrelqual)); + /* Decide whether we want to dump it */ selectDumpablePublicationObject(&(pubrinfo[j].dobj), fout); - if (strcmp(prexcept, "t") == 0) + if (pubrinfo[j].pubexcept && !pubrinfo[j].pubrattrs) simple_ptr_list_append(&exceptinfo, &pubrinfo[j]); j++; @@ -4907,7 +4909,12 @@ dumpPublicationTable(Archive *fout, const PublicationRelInfo *pubrinfo) fmtQualifiedDumpable(tbinfo)); if (pubrinfo->pubrattrs) + { + if (pubrinfo->pubexcept) + appendPQExpBufferStr(query, " EXCEPT"); + appendPQExpBuffer(query, " (%s)", pubrinfo->pubrattrs); + } if (pubrinfo->pubrelqual) { diff --git a/src/bin/pg_dump/pg_dump.h b/src/bin/pg_dump/pg_dump.h index a9cbed8c9ce..3b3d867db58 100644 --- a/src/bin/pg_dump/pg_dump.h +++ b/src/bin/pg_dump/pg_dump.h @@ -682,6 +682,7 @@ typedef struct _PublicationRelInfo TableInfo *pubtable; char *pubrelqual; char *pubrattrs; + bool pubexcept; } PublicationRelInfo; /* diff --git a/src/bin/psql/describe.c b/src/bin/psql/describe.c index 10b5f7f29cb..dff9a2a3006 100644 --- a/src/bin/psql/describe.c +++ b/src/bin/psql/describe.c @@ -3019,12 +3019,14 @@ describeOneTableDetails(const char *schemaname, /* print any publications */ if (pset.sversion >= 100000) { - if (pset.sversion >= 150000) + /* FIXME: 180000 should be changed to 190000 later for PG19. */ + if (pset.sversion >= 180000) { printfPQExpBuffer(&buf, "SELECT pubname\n" " , NULL\n" " , NULL\n" + " , NULL\n" "FROM pg_catalog.pg_publication p\n" " JOIN pg_catalog.pg_publication_namespace pn ON p.oid = pn.pnpubid\n" " JOIN pg_catalog.pg_class pc ON pc.relnamespace = pn.pnnspid\n" @@ -3038,37 +3040,61 @@ describeOneTableDetails(const char *schemaname, " pg_catalog.pg_attribute\n" " WHERE attrelid = pr.prrelid AND attnum = prattrs[s])\n" " ELSE NULL END) " + " , prexcept " "FROM pg_catalog.pg_publication p\n" " JOIN pg_catalog.pg_publication_rel pr ON p.oid = pr.prpubid\n" " JOIN pg_catalog.pg_class c ON c.oid = pr.prrelid\n" - "WHERE pr.prrelid = '%s'\n", - oid, oid, oid); - - /* FIXME: 180000 should be changed to 190000 later for PG19. */ - if (pset.sversion >= 180000) - appendPQExpBufferStr(&buf, " AND NOT pr.prexcept\n"); - - appendPQExpBuffer(&buf, + "WHERE pr.prrelid = '%s' " + "AND c.relnamespace NOT IN (\n " + " SELECT pnnspid FROM\n" + " pg_catalog.pg_publication_namespace)\n" "UNION\n" "SELECT pubname\n" " , NULL\n" " , NULL\n" + " , NULL\n" + "FROM pg_catalog.pg_publication p\n" + "WHERE p.puballtables AND pg_catalog.pg_relation_is_publishable('%s')\n" + " AND NOT EXISTS (\n" + " SELECT 1\n" + " FROM pg_catalog.pg_publication_rel pr\n" + " JOIN pg_catalog.pg_class pc\n" + " ON pr.prrelid = pc.oid\n" + " WHERE pr.prrelid = '%s' AND pr.prpubid = p.oid)\n" + "ORDER BY 1;", + oid, oid, oid, oid, oid); + } + else if (pset.sversion >= 150000) + { + printfPQExpBuffer(&buf, + "SELECT pubname\n" + " , NULL\n" + " , NULL\n" + "FROM pg_catalog.pg_publication p\n" + " JOIN pg_catalog.pg_publication_namespace pn ON p.oid = pn.pnpubid\n" + " JOIN pg_catalog.pg_class pc ON pc.relnamespace = pn.pnnspid\n" + "WHERE pc.oid ='%s' and pg_catalog.pg_relation_is_publishable('%s')\n" + "UNION\n" + "SELECT pubname\n" + " , pg_get_expr(pr.prqual, c.oid)\n" + " , (CASE WHEN pr.prattrs IS NOT NULL THEN\n" + " (SELECT string_agg(attname, ', ')\n" + " FROM pg_catalog.generate_series(0, pg_catalog.array_upper(pr.prattrs::pg_catalog.int2[], 1)) s,\n" + " pg_catalog.pg_attribute\n" + " WHERE attrelid = pr.prrelid AND attnum = prattrs[s])\n" + " ELSE NULL END) " "FROM pg_catalog.pg_publication p\n" - "WHERE p.puballtables AND pg_catalog.pg_relation_is_publishable('%s')\n", - oid); - - /* FIXME: 180000 should be changed to 190000 later for PG19. */ - if (pset.sversion >= 180000) - appendPQExpBuffer(&buf, - " AND NOT EXISTS (\n" - " SELECT 1\n" - " FROM pg_catalog.pg_publication_rel pr\n" - " JOIN pg_catalog.pg_class pc\n" - " ON pr.prrelid = pc.oid\n" - " WHERE pr.prrelid = '%s' AND pr.prpubid = p.oid)\n", - oid); - - appendPQExpBufferStr(&buf, "ORDER BY 1;"); + " JOIN pg_catalog.pg_publication_rel pr ON p.oid = pr.prpubid\n" + " JOIN pg_catalog.pg_class c ON c.oid = pr.prrelid\n" + "WHERE pr.prrelid = '%s'\n" + "UNION\n" + "SELECT pubname\n" + " , NULL\n" + " , NULL\n" + "FROM pg_catalog.pg_publication p\n" + "WHERE p.puballtables AND pg_catalog.pg_relation_is_publishable('%s')\n" + "ORDER BY 1;", + oid, oid, oid, oid); } else { @@ -3106,8 +3132,15 @@ describeOneTableDetails(const char *schemaname, /* column list (if any) */ if (!PQgetisnull(result, i, 2)) - appendPQExpBuffer(&buf, " (%s)", - PQgetvalue(result, i, 2)); + { + if (!PQgetisnull(result, i, 3) && + strcmp(PQgetvalue(result, i, 3), "t") == 0) + appendPQExpBuffer(&buf, " EXCEPT (%s)", + PQgetvalue(result, i, 2)); + else + appendPQExpBuffer(&buf, " (%s)", + PQgetvalue(result, i, 2)); + } /* row filter (if any) */ if (!PQgetisnull(result, i, 1)) @@ -6523,7 +6556,11 @@ addFooterToPublicationDesc(PQExpBuffer buf, const char *footermsg, PQgetvalue(res, i, 1)); if (!PQgetisnull(res, i, 3)) + { + if (!PQgetisnull(res, i, 4) && strcmp(PQgetvalue(res, i, 4), "t") == 0) + appendPQExpBuffer(buf, " EXCEPT"); appendPQExpBuffer(buf, " (%s)", PQgetvalue(res, i, 3)); + } if (!PQgetisnull(res, i, 2)) appendPQExpBuffer(buf, " WHERE %s", PQgetvalue(res, i, 2)); @@ -6706,6 +6743,13 @@ describePublications(const char *pattern) else appendPQExpBufferStr(&buf, ", NULL, NULL"); + + /* FIXME: 180000 should be changed to 190000 later for PG19. */ + if (pset.sversion >= 180000) + appendPQExpBufferStr(&buf, ", prexcept"); + else + appendPQExpBufferStr(&buf, ", NULL"); + appendPQExpBuffer(&buf, "\nFROM pg_catalog.pg_class c,\n" " pg_catalog.pg_namespace n,\n" @@ -6714,10 +6758,6 @@ describePublications(const char *pattern) " AND c.oid = pr.prrelid\n" " AND pr.prpubid = '%s'\n", pubid); - /* FIXME: 180000 should be changed to 190000 later for PG19. */ - if (pset.sversion >= 180000) - appendPQExpBuffer(&buf, " AND NOT pr.prexcept\n"); - appendPQExpBuffer(&buf, "ORDER BY 1,2"); if (!addFooterToPublicationDesc(&buf, _("Tables:"), false, &cont)) goto error_return; diff --git a/src/bin/psql/tab-complete.in.c b/src/bin/psql/tab-complete.in.c index 08b9df5bc3b..d4c9152b1ff 100644 --- a/src/bin/psql/tab-complete.in.c +++ b/src/bin/psql/tab-complete.in.c @@ -2269,6 +2269,8 @@ match_previous_words(int pattern_id, COMPLETE_WITH("ALL TABLES", "TABLES IN SCHEMA", "TABLE"); else if (Matches("ALTER", "PUBLICATION", MatchAny, "ADD", "ALL", "TABLES")) COMPLETE_WITH("EXCEPT TABLE"); + else if (Matches("ALTER", "PUBLICATION", MatchAny, "ADD|SET", "TABLE", MatchAny)) + COMPLETE_WITH("EXCEPT"); else if (Matches("ALTER", "PUBLICATION", MatchAny, "ADD|SET", "TABLE")) COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_tables); else if (Matches("ALTER", "PUBLICATION", MatchAny, "ADD", "ALL", "TABLES", "EXCEPT", "TABLE")) @@ -3594,7 +3596,7 @@ match_previous_words(int pattern_id, else if (Matches("CREATE", "PUBLICATION", MatchAny, "FOR", "TABLES")) COMPLETE_WITH("IN SCHEMA"); else if (Matches("CREATE", "PUBLICATION", MatchAny, "FOR", "TABLE", MatchAny) && !ends_with(prev_wd, ',')) - COMPLETE_WITH("WHERE (", "WITH ("); + COMPLETE_WITH("EXCEPT", "WHERE (", "WITH ("); /* Complete "CREATE PUBLICATION FOR TABLE" with ", ..." */ else if (Matches("CREATE", "PUBLICATION", MatchAny, "FOR", "TABLE")) COMPLETE_WITH_SCHEMA_QUERY(Query_for_list_of_tables); diff --git a/src/include/catalog/pg_publication.h b/src/include/catalog/pg_publication.h index a09f0f2ab99..ec52d23d776 100644 --- a/src/include/catalog/pg_publication.h +++ b/src/include/catalog/pg_publication.h @@ -181,7 +181,8 @@ extern Oid GetTopMostAncestorInPublication(Oid puboid, List *ancestors, extern bool is_publishable_relation(Relation rel); extern bool is_schema_publication(Oid pubid); extern bool check_and_fetch_column_list(Publication *pub, Oid relid, - MemoryContext mcxt, Bitmapset **cols); + MemoryContext mcxt, Bitmapset **cols, + bool *except_columns); extern ObjectAddress publication_add_relation(Oid pubid, PublicationRelInfo *pri, bool if_not_exists); extern Bitmapset *pub_collist_validate(Relation targetrel, List *columns); @@ -191,6 +192,7 @@ extern ObjectAddress publication_add_schema(Oid pubid, Oid schemaid, extern Bitmapset *pub_collist_to_bitmapset(Bitmapset *columns, Datum pubcols, MemoryContext mcxt); extern Bitmapset *pub_form_cols_map(Relation relation, - PublishGencolsType include_gencols_type); + PublishGencolsType include_gencols_type, + Bitmapset *except_cols); #endif /* PG_PUBLICATION_H */ diff --git a/src/include/catalog/pg_publication_rel.h b/src/include/catalog/pg_publication_rel.h index e7d7f3ba85c..6a2168fc32c 100644 --- a/src/include/catalog/pg_publication_rel.h +++ b/src/include/catalog/pg_publication_rel.h @@ -31,11 +31,12 @@ CATALOG(pg_publication_rel,6106,PublicationRelRelationId) Oid oid; /* oid */ Oid prpubid BKI_LOOKUP(pg_publication); /* Oid of the publication */ Oid prrelid BKI_LOOKUP(pg_class); /* Oid of the relation */ - bool prexcept BKI_DEFAULT(f); /* exclude the relation */ + bool prexcept BKI_DEFAULT(f); /* exclude the relation or columns */ #ifdef CATALOG_VARLEN /* variable-length fields start here */ pg_node_tree prqual; /* qualifications */ - int2vector prattrs; /* columns to replicate */ + int2vector prattrs; /* columns to replicate or exclude to + * replicate */ #endif } FormData_pg_publication_rel; diff --git a/src/test/regress/expected/publication.out b/src/test/regress/expected/publication.out index 14b7ede4515..33c8f56b65e 100644 --- a/src/test/regress/expected/publication.out +++ b/src/test/regress/expected/publication.out @@ -2132,6 +2132,78 @@ SET ROLE regress_publication_user; DROP PUBLICATION testpub_reset; DROP TABLE pub_sch1.tbl1; DROP TABLE pub_sch1.tbl2; +-- ====================================================== +-- Test EXCEPT columns for CREATE PUBLICATION +SET client_min_messages = 'ERROR'; +CREATE TABLE pub_test_except1 (a int NOT NULL, b int, c int NOT NULL, d int); +CREATE TABLE pub_sch1.pub_test_except2 (a int, b int, c int, d int); +-- Verify that publication is created with EXCEPT +CREATE PUBLICATION testpub_except FOR TABLE pub_test_except1, pub_sch1.pub_test_except2 EXCEPT (b, c); +SELECT * FROM pg_publication_tables WHERE pubname = 'testpub_except'; + pubname | schemaname | tablename | attnames | rowfilter +----------------+------------+------------------+-----------+----------- + testpub_except | public | pub_test_except1 | {a,b,c,d} | + testpub_except | pub_sch1 | pub_test_except2 | {a,d} | +(2 rows) + +-- Cannot use EXCEPT col-lists combined with TABLES IN SCHEMA +CREATE PUBLICATION testpub_except2 FOR TABLES IN SCHEMA pub_sch1, TABLE pub_test_except1 EXCEPT (b, c); +ERROR: cannot use column list for relation "public.pub_test_except1" in publication "testpub_except2" +DETAIL: Column lists cannot be specified in publications containing FOR TABLES IN SCHEMA elements. +-- Syntax error EXCEPT without a col-list +CREATE PUBLICATION testpub_except2 FOR TABLE pub_test_except1 EXCEPT; +ERROR: syntax error at or near ";" +LINE 1: ...BLICATION testpub_except2 FOR TABLE pub_test_except1 EXCEPT; + ^ +-- Verify ok - ALTER PUBLICATION ... SET ... EXCEPT (col-list) +ALTER PUBLICATION testpub_except SET TABLE pub_test_except1 EXCEPT (a, b), pub_sch1.pub_test_except2; +\dRp+ testpub_except + Publication testpub_except + Owner | All tables | Inserts | Updates | Deletes | Truncates | Generated columns | Via root +--------------------------+------------+---------+---------+---------+-----------+-------------------+---------- + regress_publication_user | f | t | t | t | t | none | f +Tables: + "pub_sch1.pub_test_except2" + "public.pub_test_except1" EXCEPT (a, b) + +-- Verify fails - ALTER PUBLICATION ... DROP ... EXCEPT (col-list) +ALTER PUBLICATION testpub_except DROP TABLE pub_test_except1 EXCEPT (a, b); +ERROR: column list must not be specified in ALTER PUBLICATION ... DROP +-- Verify ok - ALTER PUBLICATION ... DROP +ALTER PUBLICATION testpub_except DROP TABLE pub_test_except1; +-- Verify ok - ALTER PUBLICATION ... ADD ... EXCEPT (col-list) +ALTER PUBLICATION testpub_except ADD TABLE pub_test_except1 EXCEPT (c, d); +\dRp+ testpub_except + Publication testpub_except + Owner | All tables | Inserts | Updates | Deletes | Truncates | Generated columns | Via root +--------------------------+------------+---------+---------+---------+-----------+-------------------+---------- + regress_publication_user | f | t | t | t | t | none | f +Tables: + "pub_sch1.pub_test_except2" + "public.pub_test_except1" EXCEPT (c, d) + +-- Verify that EXCEPT col-list cannot contain RI cols (when using RI FULL) +ALTER TABLE pub_test_except1 REPLICA IDENTITY FULL; +UPDATE pub_test_except1 SET a = 3 WHERE a = 1; +ERROR: cannot update table "pub_test_except1" +DETAIL: Column list used by the publication does not cover the replica identity. +-- Verify that EXCEPT col-list cannot contain RI cols (when using INDEX) +CREATE UNIQUE INDEX pub_test_except1_ac_idx ON pub_test_except1 (a, c); +ALTER TABLE pub_test_except1 REPLICA IDENTITY USING INDEX pub_test_except1_a_idx; +ERROR: index "pub_test_except1_a_idx" for table "pub_test_except1" does not exist +UPDATE pub_test_except1 SET a = 3 WHERE a = 1; +ERROR: cannot update table "pub_test_except1" +DETAIL: Column list used by the publication does not cover the replica identity. +DROP INDEX pub_test_except1_ac_idx; +-- Verify that so long as no clash between RI cols and the EXCEPT +CREATE UNIQUE INDEX pub_test_except1_a_idx ON pub_test_except1 (a); +ALTER TABLE pub_test_except1 REPLICA IDENTITY USING INDEX pub_test_except1_a_idx; +UPDATE pub_test_except1 SET a = 3 WHERE a = 1; +-- cleanup +DROP INDEX pub_test_except1_a_idx; +DROP PUBLICATION testpub_except; +DROP TABLE pub_test_except1; +DROP TABLE pub_sch1.pub_test_except2; DROP SCHEMA pub_sch1; RESET client_min_messages; RESET SESSION AUTHORIZATION; diff --git a/src/test/regress/sql/publication.sql b/src/test/regress/sql/publication.sql index 6e814edace6..ba57529e53f 100644 --- a/src/test/regress/sql/publication.sql +++ b/src/test/regress/sql/publication.sql @@ -1322,6 +1322,58 @@ SET ROLE regress_publication_user; DROP PUBLICATION testpub_reset; DROP TABLE pub_sch1.tbl1; DROP TABLE pub_sch1.tbl2; + +-- ====================================================== +-- Test EXCEPT columns for CREATE PUBLICATION + +SET client_min_messages = 'ERROR'; +CREATE TABLE pub_test_except1 (a int NOT NULL, b int, c int NOT NULL, d int); +CREATE TABLE pub_sch1.pub_test_except2 (a int, b int, c int, d int); + +-- Verify that publication is created with EXCEPT +CREATE PUBLICATION testpub_except FOR TABLE pub_test_except1, pub_sch1.pub_test_except2 EXCEPT (b, c); +SELECT * FROM pg_publication_tables WHERE pubname = 'testpub_except'; + +-- Cannot use EXCEPT col-lists combined with TABLES IN SCHEMA +CREATE PUBLICATION testpub_except2 FOR TABLES IN SCHEMA pub_sch1, TABLE pub_test_except1 EXCEPT (b, c); + +-- Syntax error EXCEPT without a col-list +CREATE PUBLICATION testpub_except2 FOR TABLE pub_test_except1 EXCEPT; + +-- Verify ok - ALTER PUBLICATION ... SET ... EXCEPT (col-list) +ALTER PUBLICATION testpub_except SET TABLE pub_test_except1 EXCEPT (a, b), pub_sch1.pub_test_except2; +\dRp+ testpub_except + +-- Verify fails - ALTER PUBLICATION ... DROP ... EXCEPT (col-list) +ALTER PUBLICATION testpub_except DROP TABLE pub_test_except1 EXCEPT (a, b); + +-- Verify ok - ALTER PUBLICATION ... DROP +ALTER PUBLICATION testpub_except DROP TABLE pub_test_except1; + +-- Verify ok - ALTER PUBLICATION ... ADD ... EXCEPT (col-list) +ALTER PUBLICATION testpub_except ADD TABLE pub_test_except1 EXCEPT (c, d); +\dRp+ testpub_except + +-- Verify that EXCEPT col-list cannot contain RI cols (when using RI FULL) +ALTER TABLE pub_test_except1 REPLICA IDENTITY FULL; +UPDATE pub_test_except1 SET a = 3 WHERE a = 1; + +-- Verify that EXCEPT col-list cannot contain RI cols (when using INDEX) +CREATE UNIQUE INDEX pub_test_except1_ac_idx ON pub_test_except1 (a, c); +ALTER TABLE pub_test_except1 REPLICA IDENTITY USING INDEX pub_test_except1_a_idx; +UPDATE pub_test_except1 SET a = 3 WHERE a = 1; +DROP INDEX pub_test_except1_ac_idx; + +-- Verify that so long as no clash between RI cols and the EXCEPT +CREATE UNIQUE INDEX pub_test_except1_a_idx ON pub_test_except1 (a); +ALTER TABLE pub_test_except1 REPLICA IDENTITY USING INDEX pub_test_except1_a_idx; +UPDATE pub_test_except1 SET a = 3 WHERE a = 1; + +-- cleanup +DROP INDEX pub_test_except1_a_idx; +DROP PUBLICATION testpub_except; +DROP TABLE pub_test_except1; +DROP TABLE pub_sch1.pub_test_except2; DROP SCHEMA pub_sch1; RESET client_min_messages; diff --git a/src/test/subscription/t/036_rep_changes_except_table.pl b/src/test/subscription/t/036_rep_changes_except_table.pl index 1d115283809..660467836a4 100644 --- a/src/test/subscription/t/036_rep_changes_except_table.pl +++ b/src/test/subscription/t/036_rep_changes_except_table.pl @@ -1,7 +1,7 @@ # Copyright (c) 2021-2022, PostgreSQL Global Development Group -# Logical replication tests for except table publications +# Logical replication tests for except table and except column publications use strict; use warnings; use PostgreSQL::Test::Cluster; @@ -77,6 +77,128 @@ $result = $node_subscriber->safe_psql('postgres', "SELECT count(*), min(a), max(a) FROM public.tab1"); is($result, qq(0||), 'check rows on subscriber catchup'); +# Test for except column publications +# Initial setup +$node_publisher->safe_psql('postgres', + "CREATE TABLE tab2 (a int, b int NOT NULL, c int)"); +$node_publisher->safe_psql('postgres', + "CREATE TABLE sch1.tab2 (a int, b int, c int)"); +$node_publisher->safe_psql('postgres', + "CREATE TABLE tab3 (a int, b int, c int)"); +$node_publisher->safe_psql('postgres', + "CREATE TABLE tab4 (a int, b int GENERATED ALWAYS AS (a * 2) STORED, c int GENERATED ALWAYS AS (a * 3) STORED)" +); +$node_publisher->safe_psql('postgres', + "CREATE TABLE tab5 (a int, b int GENERATED ALWAYS AS (a * 2) STORED, c int GENERATED ALWAYS AS (a * 3) STORED)" +); +$node_publisher->safe_psql('postgres', "INSERT INTO tab2 VALUES (1, 2, 3)"); +$node_publisher->safe_psql('postgres', + "INSERT INTO sch1.tab2 VALUES (1, 2, 3)"); +$node_publisher->safe_psql('postgres', + "CREATE PUBLICATION tap_pub_col FOR TABLE tab2 EXCEPT (a), sch1.tab2 EXCEPT (b, c)" +); +$node_subscriber->safe_psql('postgres', + "CREATE TABLE tab2 (a int, b int NOT NULL, c int)"); +$node_subscriber->safe_psql('postgres', + "CREATE TABLE sch1.tab2 (a int, b int, c int)"); +$node_subscriber->safe_psql('postgres', + "CREATE TABLE tab3 (a int, b int, c int)"); +$node_subscriber->safe_psql('postgres', + "CREATE TABLE tab4 (a int, b int, c int)"); +$node_subscriber->safe_psql('postgres', + "CREATE TABLE tab5 (a int, b int, c int)"); +$node_subscriber->safe_psql('postgres', + "CREATE SUBSCRIPTION tap_sub_col CONNECTION '$publisher_connstr' PUBLICATION tap_pub_col" +); +$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub_col'); + +# Test initial sync +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM tab2"); +is($result, qq(|2|3), + 'check that initial sync for except column publication'); +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM sch1.tab2"); +is($result, qq(1||), 'check that initial sync for except column publication'); +$node_publisher->safe_psql('postgres', "INSERT INTO tab2 VALUES (4, 5, 6)"); +$node_publisher->safe_psql('postgres', + "INSERT INTO sch1.tab2 VALUES (4, 5, 6)"); +$node_publisher->wait_for_catchup('tap_sub_col'); + +# Test incremental changes +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM tab2"); +is( $result, qq(|2|3 +|5|6), + 'check incremental insert for except column publication'); +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM sch1.tab2"); +is( $result, qq(1|| +4||), 'check incremental insert for except column publication'); + +# Test for update +$node_publisher->safe_psql('postgres', + "CREATE UNIQUE INDEX b_idx ON tab2 (b)"); +$node_publisher->safe_psql('postgres', + "ALTER TABLE tab2 REPLICA IDENTITY USING INDEX b_idx"); +$node_subscriber->safe_psql('postgres', + "CREATE UNIQUE INDEX b_idx ON tab2 (b)"); +$node_subscriber->safe_psql('postgres', + "ALTER TABLE tab2 REPLICA IDENTITY USING INDEX b_idx"); +$node_publisher->safe_psql('postgres', + "UPDATE tab2 SET a = 3, b = 4, c = 5 WHERE a = 1"); +$node_publisher->wait_for_catchup('tap_sub_col'); +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM tab2"); +is( $result, qq(|5|6 +|4|5), + 'check update for except column publication'); + +# Test ALTER PUBLICATION for EXCEPT (col_list) +$node_publisher->safe_psql('postgres', + "ALTER PUBLICATION tap_pub_col ADD TABLE tab3 EXCEPT(b)"); +$node_subscriber->safe_psql('postgres', + "ALTER SUBSCRIPTION tap_sub_col REFRESH PUBLICATION"); +$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub_col'); + +$node_publisher->safe_psql('postgres', "INSERT INTO tab3 VALUES (1, 2, 3)"); +$node_publisher->wait_for_catchup('tap_sub_col'); +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM tab3"); +is($result, qq(1||3), 'check alter publication with EXCEPT'); + +# Test for publication created with publish_generated_columns as true on table +# with generated columns and column list specified with EXCEPT +$node_publisher->safe_psql('postgres', "INSERT INTO tab4 VALUES (1)"); +$node_publisher->safe_psql('postgres', + "ALTER PUBLICATION tap_pub_col SET (publish_generated_columns)"); +$node_publisher->safe_psql('postgres', + "ALTER PUBLICATION tap_pub_col SET TABLE tab4 EXCEPT(b)"); +$node_subscriber->safe_psql('postgres', + "ALTER SUBSCRIPTION tap_sub_col REFRESH PUBLICATION"); +$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub_col'); + +$node_publisher->safe_psql('postgres', "INSERT INTO tab4 VALUES (2)"); +$node_publisher->wait_for_catchup('tap_sub_col'); +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM tab4"); +is( $result, qq(1||3 +2||6), + 'check publication(publish_generated_columns as true) with generated columns and EXCEPT' +); + +# Test for publication created with publish_generated_columns as false on table +# with generated columns and column list specified with EXCEPT +$node_publisher->safe_psql('postgres', "INSERT INTO tab5 VALUES (1)"); +$node_publisher->safe_psql('postgres', + "ALTER PUBLICATION tap_pub_col SET (publish_generated_columns=none)"); +$node_publisher->safe_psql('postgres', + "ALTER PUBLICATION tap_pub_col SET TABLE tab5 EXCEPT(b)"); +$node_subscriber->safe_psql('postgres', + "ALTER SUBSCRIPTION tap_sub_col REFRESH PUBLICATION"); +$node_subscriber->wait_for_subscription_sync($node_publisher, 'tap_sub_col'); + +$node_publisher->safe_psql('postgres', "INSERT INTO tab5 VALUES (2)"); +$node_publisher->wait_for_catchup('tap_sub_col'); +$result = $node_subscriber->safe_psql('postgres', "SELECT * FROM tab5"); +is( $result, qq(1|| +2||), + 'check publication(publish_generated_columns as false) with generated columns and EXCEPT' +); + $node_subscriber->stop('fast'); $node_publisher->stop('fast'); -- 2.34.1