subscriptioncmds.h File Reference

#include "catalog/objectaddress.h"
#include "parser/parse_node.h"

Include dependency graph for subscriptioncmds.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
ObjectAddress	CreateSubscription (ParseState *pstate, CreateSubscriptionStmt *stmt, bool isTopLevel)
ObjectAddress	AlterSubscription (ParseState *pstate, AlterSubscriptionStmt *stmt, bool isTopLevel)
void	DropSubscription (DropSubscriptionStmt *stmt, bool isTopLevel)
ObjectAddress	AlterSubscriptionOwner (const char *name, Oid newOwnerId)
void	AlterSubscriptionOwner_oid (Oid subid, Oid newOwnerId)
char	defGetStreamingMode (DefElem *def)
void	CheckSubDeadTupleRetention (bool check_guc, bool sub_disabled, int elevel_for_sub_disabled, bool retain_dead_tuples, bool retention_active, bool max_retention_set)

Function Documentation

AlterSubscription()

ObjectAddress AlterSubscription ( ParseState *  pstate, AlterSubscriptionStmt *  stmt, bool  isTopLevel  )

extern

Definition at line 1370 of file subscriptioncmds.c.

{
    Relation    rel;
    ObjectAddress myself;
    bool        nulls[Natts_pg_subscription];
    bool        replaces[Natts_pg_subscription];
    Datum       values[Natts_pg_subscription];
    HeapTuple   tup;
    Oid         subid;
    bool        update_tuple = false;
    bool        update_failover = false;
    bool        update_two_phase = false;
    bool        check_pub_rdt = false;
    bool        retain_dead_tuples;
    int         max_retention;
    bool        retention_active;
    char       *origin;
    Subscription *sub;
    Form_pg_subscription form;
    bits32      supported_opts;
    SubOpts     opts = {0};
 
    rel = table_open(SubscriptionRelationId, RowExclusiveLock);
 
    /* Fetch the existing tuple. */
    tup = SearchSysCacheCopy2(SUBSCRIPTIONNAME, ObjectIdGetDatum(MyDatabaseId),
                              CStringGetDatum(stmt->subname));
 
    if (!HeapTupleIsValid(tup))
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("subscription \"%s\" does not exist",
                        stmt->subname)));
 
    form = (Form_pg_subscription) GETSTRUCT(tup);
    subid = form->oid;
 
    /* must be owner */
    if (!object_ownercheck(SubscriptionRelationId, subid, GetUserId()))
        aclcheck_error(ACLCHECK_NOT_OWNER, OBJECT_SUBSCRIPTION,
                       stmt->subname);
 
    sub = GetSubscription(subid, false);
 
    retain_dead_tuples = sub->retaindeadtuples;
    origin = sub->origin;
    max_retention = sub->maxretention;
    retention_active = sub->retentionactive;
 
    /*
     * Don't allow non-superuser modification of a subscription with
     * password_required=false.
     */
    if (!sub->passwordrequired && !superuser())
        ereport(ERROR,
                (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                 errmsg("password_required=false is superuser-only"),
                 errhint("Subscriptions with the password_required option set to false may only be created or modified by the superuser.")));
 
    /* Lock the subscription so nobody else can do anything with it. */
    LockSharedObject(SubscriptionRelationId, subid, 0, AccessExclusiveLock);
 
    /* Form a new tuple. */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
    memset(replaces, false, sizeof(replaces));
 
    switch (stmt->kind)
    {
        case ALTER_SUBSCRIPTION_OPTIONS:
            {
                supported_opts = (SUBOPT_SLOT_NAME |
                                  SUBOPT_SYNCHRONOUS_COMMIT | SUBOPT_BINARY |
                                  SUBOPT_STREAMING | SUBOPT_TWOPHASE_COMMIT |
                                  SUBOPT_DISABLE_ON_ERR |
                                  SUBOPT_PASSWORD_REQUIRED |
                                  SUBOPT_RUN_AS_OWNER | SUBOPT_FAILOVER |
                                  SUBOPT_RETAIN_DEAD_TUPLES |
                                  SUBOPT_MAX_RETENTION_DURATION |
                                  SUBOPT_WAL_RECEIVER_TIMEOUT |
                                  SUBOPT_ORIGIN);
 
                parse_subscription_options(pstate, stmt->options,
                                           supported_opts, &opts);
 
                if (IsSet(opts.specified_opts, SUBOPT_SLOT_NAME))
                {
                    /*
                     * The subscription must be disabled to allow slot_name as
                     * 'none', otherwise, the apply worker will repeatedly try
                     * to stream the data using that slot_name which neither
                     * exists on the publisher nor the user will be allowed to
                     * create it.
                     */
                    if (sub->enabled && !opts.slot_name)
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("cannot set %s for enabled subscription",
                                        "slot_name = NONE")));
 
                    if (opts.slot_name)
                        values[Anum_pg_subscription_subslotname - 1] =
                            DirectFunctionCall1(namein, CStringGetDatum(opts.slot_name));
                    else
                        nulls[Anum_pg_subscription_subslotname - 1] = true;
                    replaces[Anum_pg_subscription_subslotname - 1] = true;
                }
 
                if (opts.synchronous_commit)
                {
                    values[Anum_pg_subscription_subsynccommit - 1] =
                        CStringGetTextDatum(opts.synchronous_commit);
                    replaces[Anum_pg_subscription_subsynccommit - 1] = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_BINARY))
                {
                    values[Anum_pg_subscription_subbinary - 1] =
                        BoolGetDatum(opts.binary);
                    replaces[Anum_pg_subscription_subbinary - 1] = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_STREAMING))
                {
                    values[Anum_pg_subscription_substream - 1] =
                        CharGetDatum(opts.streaming);
                    replaces[Anum_pg_subscription_substream - 1] = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_DISABLE_ON_ERR))
                {
                    values[Anum_pg_subscription_subdisableonerr - 1]
                        = BoolGetDatum(opts.disableonerr);
                    replaces[Anum_pg_subscription_subdisableonerr - 1]
                        = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_PASSWORD_REQUIRED))
                {
                    /* Non-superuser may not disable password_required. */
                    if (!opts.passwordrequired && !superuser())
                        ereport(ERROR,
                                (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                                 errmsg("password_required=false is superuser-only"),
                                 errhint("Subscriptions with the password_required option set to false may only be created or modified by the superuser.")));
 
                    values[Anum_pg_subscription_subpasswordrequired - 1]
                        = BoolGetDatum(opts.passwordrequired);
                    replaces[Anum_pg_subscription_subpasswordrequired - 1]
                        = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_RUN_AS_OWNER))
                {
                    values[Anum_pg_subscription_subrunasowner - 1] =
                        BoolGetDatum(opts.runasowner);
                    replaces[Anum_pg_subscription_subrunasowner - 1] = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_TWOPHASE_COMMIT))
                {
                    /*
                     * We need to update both the slot and the subscription
                     * for the two_phase option. We can enable the two_phase
                     * option for a slot only once the initial data
                     * synchronization is done. This is to avoid missing some
                     * data as explained in comments atop worker.c.
                     */
                    update_two_phase = !opts.twophase;
 
                    CheckAlterSubOption(sub, "two_phase", update_two_phase,
                                        isTopLevel);
 
                    /*
                     * Modifying the two_phase slot option requires a slot
                     * lookup by slot name, so changing the slot name at the
                     * same time is not allowed.
                     */
                    if (update_two_phase &&
                        IsSet(opts.specified_opts, SUBOPT_SLOT_NAME))
                        ereport(ERROR,
                                (errcode(ERRCODE_SYNTAX_ERROR),
                                 errmsg("\"slot_name\" and \"two_phase\" cannot be altered at the same time")));
 
                    /*
                     * Note that workers may still survive even if the
                     * subscription has been disabled.
                     *
                     * Ensure workers have already been exited to avoid
                     * getting prepared transactions while we are disabling
                     * the two_phase option. Otherwise, the changes of an
                     * already prepared transaction can be replicated again
                     * along with its corresponding commit, leading to
                     * duplicate data or errors.
                     */
                    if (logicalrep_workers_find(subid, true, true))
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("cannot alter \"two_phase\" when logical replication worker is still running"),
                                 errhint("Try again after some time.")));
 
                    /*
                     * two_phase cannot be disabled if there are any
                     * uncommitted prepared transactions present otherwise it
                     * can lead to duplicate data or errors as explained in
                     * the comment above.
                     */
                    if (update_two_phase &&
                        sub->twophasestate == LOGICALREP_TWOPHASE_STATE_ENABLED &&
                        LookupGXactBySubid(subid))
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("cannot disable \"two_phase\" when prepared transactions exist"),
                                 errhint("Resolve these transactions and try again.")));
 
                    /* Change system catalog accordingly */
                    values[Anum_pg_subscription_subtwophasestate - 1] =
                        CharGetDatum(opts.twophase ?
                                     LOGICALREP_TWOPHASE_STATE_PENDING :
                                     LOGICALREP_TWOPHASE_STATE_DISABLED);
                    replaces[Anum_pg_subscription_subtwophasestate - 1] = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_FAILOVER))
                {
                    /*
                     * Similar to the two_phase case above, we need to update
                     * the failover option for both the slot and the
                     * subscription.
                     */
                    update_failover = true;
 
                    CheckAlterSubOption(sub, "failover", update_failover,
                                        isTopLevel);
 
                    values[Anum_pg_subscription_subfailover - 1] =
                        BoolGetDatum(opts.failover);
                    replaces[Anum_pg_subscription_subfailover - 1] = true;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_RETAIN_DEAD_TUPLES))
                {
                    values[Anum_pg_subscription_subretaindeadtuples - 1] =
                        BoolGetDatum(opts.retaindeadtuples);
                    replaces[Anum_pg_subscription_subretaindeadtuples - 1] = true;
 
                    /*
                     * Update the retention status only if there's a change in
                     * the retain_dead_tuples option value.
                     *
                     * Automatically marking retention as active when
                     * retain_dead_tuples is enabled may not always be ideal,
                     * especially if retention was previously stopped and the
                     * user toggles retain_dead_tuples without adjusting the
                     * publisher workload. However, this behavior provides a
                     * convenient way for users to manually refresh the
                     * retention status. Since retention will be stopped again
                     * unless the publisher workload is reduced, this approach
                     * is acceptable for now.
                     */
                    if (opts.retaindeadtuples != sub->retaindeadtuples)
                    {
                        values[Anum_pg_subscription_subretentionactive - 1] =
                            BoolGetDatum(opts.retaindeadtuples);
                        replaces[Anum_pg_subscription_subretentionactive - 1] = true;
 
                        retention_active = opts.retaindeadtuples;
                    }
 
                    CheckAlterSubOption(sub, "retain_dead_tuples", false, isTopLevel);
 
                    /*
                     * Workers may continue running even after the
                     * subscription has been disabled.
                     *
                     * To prevent race conditions (as described in
                     * CheckAlterSubOption()), ensure that all worker
                     * processes have already exited before proceeding.
                     */
                    if (logicalrep_workers_find(subid, true, true))
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("cannot alter retain_dead_tuples when logical replication worker is still running"),
                                 errhint("Try again after some time.")));
 
                    /*
                     * Notify the launcher to manage the replication slot for
                     * conflict detection. This ensures that replication slot
                     * is efficiently handled (created, updated, or dropped)
                     * in response to any configuration changes.
                     */
                    ApplyLauncherWakeupAtCommit();
 
                    check_pub_rdt = opts.retaindeadtuples;
                    retain_dead_tuples = opts.retaindeadtuples;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_MAX_RETENTION_DURATION))
                {
                    values[Anum_pg_subscription_submaxretention - 1] =
                        Int32GetDatum(opts.maxretention);
                    replaces[Anum_pg_subscription_submaxretention - 1] = true;
 
                    max_retention = opts.maxretention;
                }
 
                /*
                 * Ensure that system configuration parameters are set
                 * appropriately to support retain_dead_tuples and
                 * max_retention_duration.
                 */
                if (IsSet(opts.specified_opts, SUBOPT_RETAIN_DEAD_TUPLES) ||
                    IsSet(opts.specified_opts, SUBOPT_MAX_RETENTION_DURATION))
                    CheckSubDeadTupleRetention(true, !sub->enabled, NOTICE,
                                               retain_dead_tuples,
                                               retention_active,
                                               (max_retention > 0));
 
                if (IsSet(opts.specified_opts, SUBOPT_ORIGIN))
                {
                    values[Anum_pg_subscription_suborigin - 1] =
                        CStringGetTextDatum(opts.origin);
                    replaces[Anum_pg_subscription_suborigin - 1] = true;
 
                    /*
                     * Check if changes from different origins may be received
                     * from the publisher when the origin is changed to ANY
                     * and retain_dead_tuples is enabled.
                     */
                    check_pub_rdt = retain_dead_tuples &&
                        pg_strcasecmp(opts.origin, LOGICALREP_ORIGIN_ANY) == 0;
 
                    origin = opts.origin;
                }
 
                if (IsSet(opts.specified_opts, SUBOPT_WAL_RECEIVER_TIMEOUT))
                {
                    values[Anum_pg_subscription_subwalrcvtimeout - 1] =
                        CStringGetTextDatum(opts.wal_receiver_timeout);
                    replaces[Anum_pg_subscription_subwalrcvtimeout - 1] = true;
                }
 
                update_tuple = true;
                break;
            }
 
        case ALTER_SUBSCRIPTION_ENABLED:
            {
                parse_subscription_options(pstate, stmt->options,
                                           SUBOPT_ENABLED, &opts);
                Assert(IsSet(opts.specified_opts, SUBOPT_ENABLED));
 
                if (!sub->slotname && opts.enabled)
                    ereport(ERROR,
                            (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                             errmsg("cannot enable subscription that does not have a slot name")));
 
                /*
                 * Check track_commit_timestamp only when enabling the
                 * subscription in case it was disabled after creation. See
                 * comments atop CheckSubDeadTupleRetention() for details.
                 */
                CheckSubDeadTupleRetention(opts.enabled, !opts.enabled,
                                           WARNING, sub->retaindeadtuples,
                                           sub->retentionactive, false);
 
                values[Anum_pg_subscription_subenabled - 1] =
                    BoolGetDatum(opts.enabled);
                replaces[Anum_pg_subscription_subenabled - 1] = true;
 
                if (opts.enabled)
                    ApplyLauncherWakeupAtCommit();
 
                update_tuple = true;
 
                /*
                 * The subscription might be initially created with
                 * connect=false and retain_dead_tuples=true, meaning the
                 * remote server's status may not be checked. Ensure this
                 * check is conducted now.
                 */
                check_pub_rdt = sub->retaindeadtuples && opts.enabled;
                break;
            }
 
        case ALTER_SUBSCRIPTION_CONNECTION:
            /* Load the library providing us libpq calls. */
            load_file("libpqwalreceiver", false);
            /* Check the connection info string. */
            walrcv_check_conninfo(stmt->conninfo,
                                  sub->passwordrequired && !sub->ownersuperuser);
 
            values[Anum_pg_subscription_subconninfo - 1] =
                CStringGetTextDatum(stmt->conninfo);
            replaces[Anum_pg_subscription_subconninfo - 1] = true;
            update_tuple = true;
 
            /*
             * Since the remote server configuration might have changed,
             * perform a check to ensure it permits enabling
             * retain_dead_tuples.
             */
            check_pub_rdt = sub->retaindeadtuples;
            break;
 
        case ALTER_SUBSCRIPTION_SET_PUBLICATION:
            {
                supported_opts = SUBOPT_COPY_DATA | SUBOPT_REFRESH;
                parse_subscription_options(pstate, stmt->options,
                                           supported_opts, &opts);
 
                values[Anum_pg_subscription_subpublications - 1] =
                    publicationListToArray(stmt->publication);
                replaces[Anum_pg_subscription_subpublications - 1] = true;
 
                update_tuple = true;
 
                /* Refresh if user asked us to. */
                if (opts.refresh)
                {
                    if (!sub->enabled)
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("ALTER SUBSCRIPTION with refresh is not allowed for disabled subscriptions"),
                                 errhint("Use ALTER SUBSCRIPTION ... SET PUBLICATION ... WITH (refresh = false).")));
 
                    /*
                     * See ALTER_SUBSCRIPTION_REFRESH_PUBLICATION for details
                     * why this is not allowed.
                     */
                    if (sub->twophasestate == LOGICALREP_TWOPHASE_STATE_ENABLED && opts.copy_data)
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("ALTER SUBSCRIPTION with refresh and copy_data is not allowed when two_phase is enabled"),
                                 errhint("Use ALTER SUBSCRIPTION ... SET PUBLICATION with refresh = false, or with copy_data = false, or use DROP/CREATE SUBSCRIPTION.")));
 
                    PreventInTransactionBlock(isTopLevel, "ALTER SUBSCRIPTION with refresh");
 
                    /* Make sure refresh sees the new list of publications. */
                    sub->publications = stmt->publication;
 
                    AlterSubscription_refresh(sub, opts.copy_data,
                                              stmt->publication);
                }
 
                break;
            }
 
        case ALTER_SUBSCRIPTION_ADD_PUBLICATION:
        case ALTER_SUBSCRIPTION_DROP_PUBLICATION:
            {
                List       *publist;
                bool        isadd = stmt->kind == ALTER_SUBSCRIPTION_ADD_PUBLICATION;
 
                supported_opts = SUBOPT_REFRESH | SUBOPT_COPY_DATA;
                parse_subscription_options(pstate, stmt->options,
                                           supported_opts, &opts);
 
                publist = merge_publications(sub->publications, stmt->publication, isadd, stmt->subname);
                values[Anum_pg_subscription_subpublications - 1] =
                    publicationListToArray(publist);
                replaces[Anum_pg_subscription_subpublications - 1] = true;
 
                update_tuple = true;
 
                /* Refresh if user asked us to. */
                if (opts.refresh)
                {
                    /* We only need to validate user specified publications. */
                    List       *validate_publications = (isadd) ? stmt->publication : NULL;
 
                    if (!sub->enabled)
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("ALTER SUBSCRIPTION with refresh is not allowed for disabled subscriptions"),
                        /* translator: %s is an SQL ALTER command */
                                 errhint("Use %s instead.",
                                         isadd ?
                                         "ALTER SUBSCRIPTION ... ADD PUBLICATION ... WITH (refresh = false)" :
                                         "ALTER SUBSCRIPTION ... DROP PUBLICATION ... WITH (refresh = false)")));
 
                    /*
                     * See ALTER_SUBSCRIPTION_REFRESH_PUBLICATION for details
                     * why this is not allowed.
                     */
                    if (sub->twophasestate == LOGICALREP_TWOPHASE_STATE_ENABLED && opts.copy_data)
                        ereport(ERROR,
                                (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                                 errmsg("ALTER SUBSCRIPTION with refresh and copy_data is not allowed when two_phase is enabled"),
                        /* translator: %s is an SQL ALTER command */
                                 errhint("Use %s with refresh = false, or with copy_data = false, or use DROP/CREATE SUBSCRIPTION.",
                                         isadd ?
                                         "ALTER SUBSCRIPTION ... ADD PUBLICATION" :
                                         "ALTER SUBSCRIPTION ... DROP PUBLICATION")));
 
                    PreventInTransactionBlock(isTopLevel, "ALTER SUBSCRIPTION with refresh");
 
                    /* Refresh the new list of publications. */
                    sub->publications = publist;
 
                    AlterSubscription_refresh(sub, opts.copy_data,
                                              validate_publications);
                }
 
                break;
            }
 
        case ALTER_SUBSCRIPTION_REFRESH_PUBLICATION:
            {
                if (!sub->enabled)
                    ereport(ERROR,
                            (errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                             errmsg("%s is not allowed for disabled subscriptions",
                                    "ALTER SUBSCRIPTION ... REFRESH PUBLICATION")));
 
                parse_subscription_options(pstate, stmt->options,
                                           SUBOPT_COPY_DATA, &opts);
 
                /*
                 * The subscription option "two_phase" requires that
                 * replication has passed the initial table synchronization
                 * phase before the two_phase becomes properly enabled.
                 *
                 * But, having reached this two-phase commit "enabled" state
                 * we must not allow any subsequent table initialization to
                 * occur. So the ALTER SUBSCRIPTION ... REFRESH PUBLICATION is
                 * disallowed when the user had requested two_phase = on mode.
                 *
                 * The exception to this restriction is when copy_data =
                 * false, because when copy_data is false the tablesync will
                 * start already in READY state and will exit directly without
                 * doing anything.
                 *
                 * For more details see comments atop worker.c.
                 */
                if (sub->twophasestate == LOGICALREP_TWOPHASE_STATE_ENABLED && opts.copy_data)
                    ereport(ERROR,
                            (errcode(ERRCODE_SYNTAX_ERROR),
                             errmsg("ALTER SUBSCRIPTION ... REFRESH PUBLICATION with copy_data is not allowed when two_phase is enabled"),
                             errhint("Use ALTER SUBSCRIPTION ... REFRESH PUBLICATION with copy_data = false, or use DROP/CREATE SUBSCRIPTION.")));
 
                PreventInTransactionBlock(isTopLevel, "ALTER SUBSCRIPTION ... REFRESH PUBLICATION");
 
                AlterSubscription_refresh(sub, opts.copy_data, NULL);
 
                break;
            }
 
        case ALTER_SUBSCRIPTION_REFRESH_SEQUENCES:
            {
                if (!sub->enabled)
                    ereport(ERROR,
                            errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                            errmsg("%s is not allowed for disabled subscriptions",
                                   "ALTER SUBSCRIPTION ... REFRESH SEQUENCES"));
 
                AlterSubscription_refresh_seq(sub);
 
                break;
            }
 
        case ALTER_SUBSCRIPTION_SKIP:
            {
                parse_subscription_options(pstate, stmt->options, SUBOPT_LSN, &opts);
 
                /* ALTER SUBSCRIPTION ... SKIP supports only LSN option */
                Assert(IsSet(opts.specified_opts, SUBOPT_LSN));
 
                /*
                 * If the user sets subskiplsn, we do a sanity check to make
                 * sure that the specified LSN is a probable value.
                 */
                if (XLogRecPtrIsValid(opts.lsn))
                {
                    ReplOriginId originid;
                    char        originname[NAMEDATALEN];
                    XLogRecPtr  remote_lsn;
 
                    ReplicationOriginNameForLogicalRep(subid, InvalidOid,
                                                       originname, sizeof(originname));
                    originid = replorigin_by_name(originname, false);
                    remote_lsn = replorigin_get_progress(originid, false);
 
                    /* Check the given LSN is at least a future LSN */
                    if (XLogRecPtrIsValid(remote_lsn) && opts.lsn < remote_lsn)
                        ereport(ERROR,
                                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                                 errmsg("skip WAL location (LSN %X/%08X) must be greater than origin LSN %X/%08X",
                                        LSN_FORMAT_ARGS(opts.lsn),
                                        LSN_FORMAT_ARGS(remote_lsn))));
                }
 
                values[Anum_pg_subscription_subskiplsn - 1] = LSNGetDatum(opts.lsn);
                replaces[Anum_pg_subscription_subskiplsn - 1] = true;
 
                update_tuple = true;
                break;
            }
 
        default:
            elog(ERROR, "unrecognized ALTER SUBSCRIPTION kind %d",
                 stmt->kind);
    }
 
    /* Update the catalog if needed. */
    if (update_tuple)
    {
        tup = heap_modify_tuple(tup, RelationGetDescr(rel), values, nulls,
                                replaces);
 
        CatalogTupleUpdate(rel, &tup->t_self, tup);
 
        heap_freetuple(tup);
    }
 
    /*
     * Try to acquire the connection necessary either for modifying the slot
     * or for checking if the remote server permits enabling
     * retain_dead_tuples.
     *
     * This has to be at the end because otherwise if there is an error while
     * doing the database operations we won't be able to rollback altered
     * slot.
     */
    if (update_failover || update_two_phase || check_pub_rdt)
    {
        bool        must_use_password;
        char       *err;
        WalReceiverConn *wrconn;
 
        /* Load the library providing us libpq calls. */
        load_file("libpqwalreceiver", false);
 
        /*
         * Try to connect to the publisher, using the new connection string if
         * available.
         */
        must_use_password = sub->passwordrequired && !sub->ownersuperuser;
        wrconn = walrcv_connect(stmt->conninfo ? stmt->conninfo : sub->conninfo,
                                true, true, must_use_password, sub->name,
                                &err);
        if (!wrconn)
            ereport(ERROR,
                    (errcode(ERRCODE_CONNECTION_FAILURE),
                     errmsg("subscription \"%s\" could not connect to the publisher: %s",
                            sub->name, err)));
 
        PG_TRY();
        {
            if (retain_dead_tuples)
                check_pub_dead_tuple_retention(wrconn);
 
            check_publications_origin_tables(wrconn, sub->publications, false,
                                             retain_dead_tuples, origin, NULL, 0,
                                             sub->name);
 
            if (update_failover || update_two_phase)
                walrcv_alter_slot(wrconn, sub->slotname,
                                  update_failover ? &opts.failover : NULL,
                                  update_two_phase ? &opts.twophase : NULL);
        }
        PG_FINALLY();
        {
            walrcv_disconnect(wrconn);
        }
        PG_END_TRY();
    }
 
    table_close(rel, RowExclusiveLock);
 
    ObjectAddressSet(myself, SubscriptionRelationId, subid);
 
    InvokeObjectPostAlterHook(SubscriptionRelationId, subid, 0);
 
    /* Wake up related replication workers to handle this change quickly. */
    LogicalRepWorkersWakeupAtCommit(subid);
 
    return myself;
}

References AccessExclusiveLock, aclcheck_error(), ACLCHECK_NOT_OWNER, ALTER_SUBSCRIPTION_ADD_PUBLICATION, ALTER_SUBSCRIPTION_CONNECTION, ALTER_SUBSCRIPTION_DROP_PUBLICATION, ALTER_SUBSCRIPTION_ENABLED, ALTER_SUBSCRIPTION_OPTIONS, ALTER_SUBSCRIPTION_REFRESH_PUBLICATION, ALTER_SUBSCRIPTION_REFRESH_SEQUENCES, ALTER_SUBSCRIPTION_SET_PUBLICATION, ALTER_SUBSCRIPTION_SKIP, AlterSubscription_refresh(), AlterSubscription_refresh_seq(), ApplyLauncherWakeupAtCommit(), Assert, BoolGetDatum(), CatalogTupleUpdate(), CharGetDatum(), check_pub_dead_tuple_retention(), check_publications_origin_tables(), CheckAlterSubOption(), CheckSubDeadTupleRetention(), Subscription::conninfo, CStringGetDatum(), CStringGetTextDatum, DirectFunctionCall1, elog, Subscription::enabled, ereport, err(), errcode(), errhint(), errmsg(), ERROR, fb(), Form_pg_subscription, GETSTRUCT(), GetSubscription(), GetUserId(), heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, Int32GetDatum(), InvalidOid, InvokeObjectPostAlterHook, IsSet, load_file(), LockSharedObject(), logicalrep_workers_find(), LogicalRepWorkersWakeupAtCommit(), LookupGXactBySubid(), LSN_FORMAT_ARGS, LSNGetDatum(), Subscription::maxretention, merge_publications(), MyDatabaseId, Subscription::name, NAMEDATALEN, namein(), NOTICE, object_ownercheck(), OBJECT_SUBSCRIPTION, ObjectAddressSet, ObjectIdGetDatum(), opts, Subscription::origin, Subscription::ownersuperuser, parse_subscription_options(), Subscription::passwordrequired, PG_END_TRY, PG_FINALLY, pg_strcasecmp(), PG_TRY, PreventInTransactionBlock(), publicationListToArray(), Subscription::publications, RelationGetDescr, ReplicationOriginNameForLogicalRep(), replorigin_by_name(), replorigin_get_progress(), Subscription::retaindeadtuples, Subscription::retentionactive, RowExclusiveLock, SearchSysCacheCopy2, Subscription::slotname, stmt, SUBOPT_BINARY, SUBOPT_COPY_DATA, SUBOPT_DISABLE_ON_ERR, SUBOPT_ENABLED, SUBOPT_FAILOVER, SUBOPT_LSN, SUBOPT_MAX_RETENTION_DURATION, SUBOPT_ORIGIN, SUBOPT_PASSWORD_REQUIRED, SUBOPT_REFRESH, SUBOPT_RETAIN_DEAD_TUPLES, SUBOPT_RUN_AS_OWNER, SUBOPT_SLOT_NAME, SUBOPT_STREAMING, SUBOPT_SYNCHRONOUS_COMMIT, SUBOPT_TWOPHASE_COMMIT, SUBOPT_WAL_RECEIVER_TIMEOUT, superuser(), table_close(), table_open(), Subscription::twophasestate, values, walrcv_alter_slot, walrcv_check_conninfo, walrcv_connect, walrcv_disconnect, WARNING, wrconn, and XLogRecPtrIsValid.

Referenced by ProcessUtilitySlow().

AlterSubscriptionOwner()

ObjectAddress AlterSubscriptionOwner ( const char *  name, Oid  newOwnerId  )

extern

Definition at line 2459 of file subscriptioncmds.c.

{
    Oid         subid;
    HeapTuple   tup;
    Relation    rel;
    ObjectAddress address;
    Form_pg_subscription form;
 
    rel = table_open(SubscriptionRelationId, RowExclusiveLock);
 
    tup = SearchSysCacheCopy2(SUBSCRIPTIONNAME, ObjectIdGetDatum(MyDatabaseId),
                              CStringGetDatum(name));
 
    if (!HeapTupleIsValid(tup))
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("subscription \"%s\" does not exist", name)));
 
    form = (Form_pg_subscription) GETSTRUCT(tup);
    subid = form->oid;
 
    AlterSubscriptionOwner_internal(rel, tup, newOwnerId);
 
    ObjectAddressSet(address, SubscriptionRelationId, subid);
 
    heap_freetuple(tup);
 
    table_close(rel, RowExclusiveLock);
 
    return address;
}

References AlterSubscriptionOwner_internal(), CStringGetDatum(), ereport, errcode(), errmsg(), ERROR, fb(), Form_pg_subscription, GETSTRUCT(), heap_freetuple(), HeapTupleIsValid, MyDatabaseId, name, ObjectAddressSet, ObjectIdGetDatum(), RowExclusiveLock, SearchSysCacheCopy2, table_close(), and table_open().

Referenced by ExecAlterOwnerStmt().

AlterSubscriptionOwner_oid()

void AlterSubscriptionOwner_oid ( Oid  subid, Oid  newOwnerId  )

extern

Definition at line 2495 of file subscriptioncmds.c.

{
    HeapTuple   tup;
    Relation    rel;
 
    rel = table_open(SubscriptionRelationId, RowExclusiveLock);
 
    tup = SearchSysCacheCopy1(SUBSCRIPTIONOID, ObjectIdGetDatum(subid));
 
    if (!HeapTupleIsValid(tup))
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("subscription with OID %u does not exist", subid)));
 
    AlterSubscriptionOwner_internal(rel, tup, newOwnerId);
 
    heap_freetuple(tup);
 
    table_close(rel, RowExclusiveLock);
}

References AlterSubscriptionOwner_internal(), ereport, errcode(), errmsg(), ERROR, fb(), heap_freetuple(), HeapTupleIsValid, ObjectIdGetDatum(), RowExclusiveLock, SearchSysCacheCopy1, table_close(), and table_open().

Referenced by shdepReassignOwned_Owner().

CheckSubDeadTupleRetention()

void CheckSubDeadTupleRetention ( bool  check_guc, bool  sub_disabled, int  elevel_for_sub_disabled, bool  retain_dead_tuples, bool  retention_active, bool  max_retention_set  )

extern

Definition at line 2856 of file subscriptioncmds.c.

{
    Assert(elevel_for_sub_disabled == NOTICE ||
           elevel_for_sub_disabled == WARNING);
 
    if (retain_dead_tuples)
    {
        if (check_guc && wal_level < WAL_LEVEL_REPLICA)
            ereport(ERROR,
                    errcode(ERRCODE_OBJECT_NOT_IN_PREREQUISITE_STATE),
                    errmsg("\"wal_level\" is insufficient to create the replication slot required by retain_dead_tuples"),
                    errhint("\"wal_level\" must be set to \"replica\" or \"logical\" at server start."));
 
        if (check_guc && !track_commit_timestamp)
            ereport(WARNING,
                    errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                    errmsg("commit timestamp and origin data required for detecting conflicts won't be retained"),
                    errhint("Consider setting \"%s\" to true.",
                            "track_commit_timestamp"));
 
        if (sub_disabled && retention_active)
            ereport(elevel_for_sub_disabled,
                    errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                    errmsg("deleted rows to detect conflicts would not be removed until the subscription is enabled"),
                    (elevel_for_sub_disabled > NOTICE)
                    ? errhint("Consider setting %s to false.",
                              "retain_dead_tuples") : 0);
    }
    else if (max_retention_set)
    {
        ereport(NOTICE,
                errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                errmsg("max_retention_duration is ineffective when retain_dead_tuples is disabled"));
    }
}

References Assert, ereport, errcode(), errhint(), errmsg(), ERROR, fb(), NOTICE, track_commit_timestamp, wal_level, WAL_LEVEL_REPLICA, and WARNING.

Referenced by AlterSubscription(), CreateSubscription(), and DisableSubscriptionAndExit().

CreateSubscription()

ObjectAddress CreateSubscription ( ParseState *  pstate, CreateSubscriptionStmt *  stmt, bool  isTopLevel  )

extern

Definition at line 612 of file subscriptioncmds.c.

{
    Relation    rel;
    ObjectAddress myself;
    Oid         subid;
    bool        nulls[Natts_pg_subscription];
    Datum       values[Natts_pg_subscription];
    Oid         owner = GetUserId();
    HeapTuple   tup;
    char       *conninfo;
    char        originname[NAMEDATALEN];
    List       *publications;
    bits32      supported_opts;
    SubOpts     opts = {0};
    AclResult   aclresult;
 
    /*
     * Parse and check options.
     *
     * Connection and publication should not be specified here.
     */
    supported_opts = (SUBOPT_CONNECT | SUBOPT_ENABLED | SUBOPT_CREATE_SLOT |
                      SUBOPT_SLOT_NAME | SUBOPT_COPY_DATA |
                      SUBOPT_SYNCHRONOUS_COMMIT | SUBOPT_BINARY |
                      SUBOPT_STREAMING | SUBOPT_TWOPHASE_COMMIT |
                      SUBOPT_DISABLE_ON_ERR | SUBOPT_PASSWORD_REQUIRED |
                      SUBOPT_RUN_AS_OWNER | SUBOPT_FAILOVER |
                      SUBOPT_RETAIN_DEAD_TUPLES |
                      SUBOPT_MAX_RETENTION_DURATION |
                      SUBOPT_WAL_RECEIVER_TIMEOUT | SUBOPT_ORIGIN);
    parse_subscription_options(pstate, stmt->options, supported_opts, &opts);
 
    /*
     * Since creating a replication slot is not transactional, rolling back
     * the transaction leaves the created replication slot.  So we cannot run
     * CREATE SUBSCRIPTION inside a transaction block if creating a
     * replication slot.
     */
    if (opts.create_slot)
        PreventInTransactionBlock(isTopLevel, "CREATE SUBSCRIPTION ... WITH (create_slot = true)");
 
    /*
     * We don't want to allow unprivileged users to be able to trigger
     * attempts to access arbitrary network destinations, so require the user
     * to have been specifically authorized to create subscriptions.
     */
    if (!has_privs_of_role(owner, ROLE_PG_CREATE_SUBSCRIPTION))
        ereport(ERROR,
                (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                 errmsg("permission denied to create subscription"),
                 errdetail("Only roles with privileges of the \"%s\" role may create subscriptions.",
                           "pg_create_subscription")));
 
    /*
     * Since a subscription is a database object, we also check for CREATE
     * permission on the database.
     */
    aclresult = object_aclcheck(DatabaseRelationId, MyDatabaseId,
                                owner, ACL_CREATE);
    if (aclresult != ACLCHECK_OK)
        aclcheck_error(aclresult, OBJECT_DATABASE,
                       get_database_name(MyDatabaseId));
 
    /*
     * Non-superusers are required to set a password for authentication, and
     * that password must be used by the target server, but the superuser can
     * exempt a subscription from this requirement.
     */
    if (!opts.passwordrequired && !superuser_arg(owner))
        ereport(ERROR,
                (errcode(ERRCODE_INSUFFICIENT_PRIVILEGE),
                 errmsg("password_required=false is superuser-only"),
                 errhint("Subscriptions with the password_required option set to false may only be created or modified by the superuser.")));
 
    /*
     * If built with appropriate switch, whine when regression-testing
     * conventions for subscription names are violated.
     */
#ifdef ENFORCE_REGRESSION_TEST_NAME_RESTRICTIONS
    if (strncmp(stmt->subname, "regress_", 8) != 0)
        elog(WARNING, "subscriptions created by regression test cases should have names starting with \"regress_\"");
#endif
 
    rel = table_open(SubscriptionRelationId, RowExclusiveLock);
 
    /* Check if name is used */
    subid = GetSysCacheOid2(SUBSCRIPTIONNAME, Anum_pg_subscription_oid,
                            ObjectIdGetDatum(MyDatabaseId), CStringGetDatum(stmt->subname));
    if (OidIsValid(subid))
    {
        ereport(ERROR,
                (errcode(ERRCODE_DUPLICATE_OBJECT),
                 errmsg("subscription \"%s\" already exists",
                        stmt->subname)));
    }
 
    /*
     * Ensure that system configuration parameters are set appropriately to
     * support retain_dead_tuples and max_retention_duration.
     */
    CheckSubDeadTupleRetention(true, !opts.enabled, WARNING,
                               opts.retaindeadtuples, opts.retaindeadtuples,
                               (opts.maxretention > 0));
 
    if (!IsSet(opts.specified_opts, SUBOPT_SLOT_NAME) &&
        opts.slot_name == NULL)
        opts.slot_name = stmt->subname;
 
    /* The default for synchronous_commit of subscriptions is off. */
    if (opts.synchronous_commit == NULL)
        opts.synchronous_commit = "off";
 
    /*
     * The default for wal_receiver_timeout of subscriptions is -1, which
     * means the value is inherited from the server configuration, command
     * line, or role/database settings.
     */
    if (opts.wal_receiver_timeout == NULL)
        opts.wal_receiver_timeout = "-1";
 
    conninfo = stmt->conninfo;
    publications = stmt->publication;
 
    /* Load the library providing us libpq calls. */
    load_file("libpqwalreceiver", false);
 
    /* Check the connection info string. */
    walrcv_check_conninfo(conninfo, opts.passwordrequired && !superuser());
 
    /* Everything ok, form a new tuple. */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
 
    subid = GetNewOidWithIndex(rel, SubscriptionObjectIndexId,
                               Anum_pg_subscription_oid);
    values[Anum_pg_subscription_oid - 1] = ObjectIdGetDatum(subid);
    values[Anum_pg_subscription_subdbid - 1] = ObjectIdGetDatum(MyDatabaseId);
    values[Anum_pg_subscription_subskiplsn - 1] = LSNGetDatum(InvalidXLogRecPtr);
    values[Anum_pg_subscription_subname - 1] =
        DirectFunctionCall1(namein, CStringGetDatum(stmt->subname));
    values[Anum_pg_subscription_subowner - 1] = ObjectIdGetDatum(owner);
    values[Anum_pg_subscription_subenabled - 1] = BoolGetDatum(opts.enabled);
    values[Anum_pg_subscription_subbinary - 1] = BoolGetDatum(opts.binary);
    values[Anum_pg_subscription_substream - 1] = CharGetDatum(opts.streaming);
    values[Anum_pg_subscription_subtwophasestate - 1] =
        CharGetDatum(opts.twophase ?
                     LOGICALREP_TWOPHASE_STATE_PENDING :
                     LOGICALREP_TWOPHASE_STATE_DISABLED);
    values[Anum_pg_subscription_subdisableonerr - 1] = BoolGetDatum(opts.disableonerr);
    values[Anum_pg_subscription_subpasswordrequired - 1] = BoolGetDatum(opts.passwordrequired);
    values[Anum_pg_subscription_subrunasowner - 1] = BoolGetDatum(opts.runasowner);
    values[Anum_pg_subscription_subfailover - 1] = BoolGetDatum(opts.failover);
    values[Anum_pg_subscription_subretaindeadtuples - 1] =
        BoolGetDatum(opts.retaindeadtuples);
    values[Anum_pg_subscription_submaxretention - 1] =
        Int32GetDatum(opts.maxretention);
    values[Anum_pg_subscription_subretentionactive - 1] =
        Int32GetDatum(opts.retaindeadtuples);
    values[Anum_pg_subscription_subconninfo - 1] =
        CStringGetTextDatum(conninfo);
    if (opts.slot_name)
        values[Anum_pg_subscription_subslotname - 1] =
            DirectFunctionCall1(namein, CStringGetDatum(opts.slot_name));
    else
        nulls[Anum_pg_subscription_subslotname - 1] = true;
    values[Anum_pg_subscription_subsynccommit - 1] =
        CStringGetTextDatum(opts.synchronous_commit);
    values[Anum_pg_subscription_subwalrcvtimeout - 1] =
        CStringGetTextDatum(opts.wal_receiver_timeout);
    values[Anum_pg_subscription_subpublications - 1] =
        publicationListToArray(publications);
    values[Anum_pg_subscription_suborigin - 1] =
        CStringGetTextDatum(opts.origin);
 
    tup = heap_form_tuple(RelationGetDescr(rel), values, nulls);
 
    /* Insert tuple into catalog. */
    CatalogTupleInsert(rel, tup);
    heap_freetuple(tup);
 
    recordDependencyOnOwner(SubscriptionRelationId, subid, owner);
 
    /*
     * A replication origin is currently created for all subscriptions,
     * including those that only contain sequences or are otherwise empty.
     *
     * XXX: While this is technically unnecessary, optimizing it would require
     * additional logic to skip origin creation during DDL operations and
     * apply workers initialization, and to handle origin creation dynamically
     * when tables are added to the subscription. It is not clear whether
     * preventing creation of origins is worth additional complexity.
     */
    ReplicationOriginNameForLogicalRep(subid, InvalidOid, originname, sizeof(originname));
    replorigin_create(originname);
 
    /*
     * Connect to remote side to execute requested commands and fetch table
     * and sequence info.
     */
    if (opts.connect)
    {
        char       *err;
        WalReceiverConn *wrconn;
        bool        must_use_password;
 
        /* Try to connect to the publisher. */
        must_use_password = !superuser_arg(owner) && opts.passwordrequired;
        wrconn = walrcv_connect(conninfo, true, true, must_use_password,
                                stmt->subname, &err);
        if (!wrconn)
            ereport(ERROR,
                    (errcode(ERRCODE_CONNECTION_FAILURE),
                     errmsg("subscription \"%s\" could not connect to the publisher: %s",
                            stmt->subname, err)));
 
        PG_TRY();
        {
            bool        has_tables = false;
            List       *pubrels;
            char        relation_state;
 
            check_publications(wrconn, publications);
            check_publications_origin_tables(wrconn, publications,
                                             opts.copy_data,
                                             opts.retaindeadtuples, opts.origin,
                                             NULL, 0, stmt->subname);
            check_publications_origin_sequences(wrconn, publications,
                                                opts.copy_data, opts.origin,
                                                NULL, 0, stmt->subname);
 
            if (opts.retaindeadtuples)
                check_pub_dead_tuple_retention(wrconn);
 
            /*
             * Set sync state based on if we were asked to do data copy or
             * not.
             */
            relation_state = opts.copy_data ? SUBREL_STATE_INIT : SUBREL_STATE_READY;
 
            /*
             * Build local relation status info. Relations are for both tables
             * and sequences from the publisher.
             */
            pubrels = fetch_relation_list(wrconn, publications);
 
            foreach_ptr(PublicationRelKind, pubrelinfo, pubrels)
            {
                Oid         relid;
                char        relkind;
                RangeVar   *rv = pubrelinfo->rv;
 
                relid = RangeVarGetRelid(rv, AccessShareLock, false);
                relkind = get_rel_relkind(relid);
 
                /* Check for supported relkind. */
                CheckSubscriptionRelkind(relkind, pubrelinfo->relkind,
                                         rv->schemaname, rv->relname);
                has_tables |= (relkind != RELKIND_SEQUENCE);
                AddSubscriptionRelState(subid, relid, relation_state,
                                        InvalidXLogRecPtr, true);
            }
 
            /*
             * If requested, create permanent slot for the subscription. We
             * won't use the initial snapshot for anything, so no need to
             * export it.
             *
             * XXX: Similar to origins, it is not clear whether preventing the
             * slot creation for empty and sequence-only subscriptions is
             * worth additional complexity.
             */
            if (opts.create_slot)
            {
                bool        twophase_enabled = false;
 
                Assert(opts.slot_name);
 
                /*
                 * Even if two_phase is set, don't create the slot with
                 * two-phase enabled. Will enable it once all the tables are
                 * synced and ready. This avoids race-conditions like prepared
                 * transactions being skipped due to changes not being applied
                 * due to checks in should_apply_changes_for_rel() when
                 * tablesync for the corresponding tables are in progress. See
                 * comments atop worker.c.
                 *
                 * Note that if tables were specified but copy_data is false
                 * then it is safe to enable two_phase up-front because those
                 * tables are already initially in READY state. When the
                 * subscription has no tables, we leave the twophase state as
                 * PENDING, to allow ALTER SUBSCRIPTION ... REFRESH
                 * PUBLICATION to work.
                 */
                if (opts.twophase && !opts.copy_data && has_tables)
                    twophase_enabled = true;
 
                walrcv_create_slot(wrconn, opts.slot_name, false, twophase_enabled,
                                   opts.failover, CRS_NOEXPORT_SNAPSHOT, NULL);
 
                if (twophase_enabled)
                    UpdateTwoPhaseState(subid, LOGICALREP_TWOPHASE_STATE_ENABLED);
 
                ereport(NOTICE,
                        (errmsg("created replication slot \"%s\" on publisher",
                                opts.slot_name)));
            }
        }
        PG_FINALLY();
        {
            walrcv_disconnect(wrconn);
        }
        PG_END_TRY();
    }
    else
        ereport(WARNING,
                (errmsg("subscription was created, but is not connected"),
                 errhint("To initiate replication, you must manually create the replication slot, enable the subscription, and alter the subscription to refresh publications.")));
 
    table_close(rel, RowExclusiveLock);
 
    pgstat_create_subscription(subid);
 
    /*
     * Notify the launcher to start the apply worker if the subscription is
     * enabled, or to create the conflict detection slot if retain_dead_tuples
     * is enabled.
     *
     * Creating the conflict detection slot is essential even when the
     * subscription is not enabled. This ensures that dead tuples are
     * retained, which is necessary for accurately identifying the type of
     * conflict during replication.
     */
    if (opts.enabled || opts.retaindeadtuples)
        ApplyLauncherWakeupAtCommit();
 
    ObjectAddressSet(myself, SubscriptionRelationId, subid);
 
    InvokeObjectPostCreateHook(SubscriptionRelationId, subid, 0);
 
    return myself;
}

References AccessShareLock, ACL_CREATE, aclcheck_error(), ACLCHECK_OK, AddSubscriptionRelState(), ApplyLauncherWakeupAtCommit(), Assert, BoolGetDatum(), CatalogTupleInsert(), CharGetDatum(), check_pub_dead_tuple_retention(), check_publications(), check_publications_origin_sequences(), check_publications_origin_tables(), CheckSubDeadTupleRetention(), CheckSubscriptionRelkind(), CRS_NOEXPORT_SNAPSHOT, CStringGetDatum(), CStringGetTextDatum, DirectFunctionCall1, elog, ereport, err(), errcode(), ERRCODE_DUPLICATE_OBJECT, errdetail(), errhint(), errmsg(), ERROR, fb(), fetch_relation_list(), foreach_ptr, get_database_name(), get_rel_relkind(), GetNewOidWithIndex(), GetSysCacheOid2, GetUserId(), has_privs_of_role(), heap_form_tuple(), heap_freetuple(), Int32GetDatum(), InvalidOid, InvalidXLogRecPtr, InvokeObjectPostCreateHook, IsSet, load_file(), LSNGetDatum(), MyDatabaseId, NAMEDATALEN, namein(), NOTICE, object_aclcheck(), OBJECT_DATABASE, ObjectAddressSet, ObjectIdGetDatum(), OidIsValid, opts, parse_subscription_options(), PG_END_TRY, PG_FINALLY, PG_TRY, pgstat_create_subscription(), PreventInTransactionBlock(), publicationListToArray(), RangeVarGetRelid, recordDependencyOnOwner(), RelationGetDescr, RangeVar::relname, ReplicationOriginNameForLogicalRep(), replorigin_create(), RowExclusiveLock, RangeVar::schemaname, stmt, SUBOPT_BINARY, SUBOPT_CONNECT, SUBOPT_COPY_DATA, SUBOPT_CREATE_SLOT, SUBOPT_DISABLE_ON_ERR, SUBOPT_ENABLED, SUBOPT_FAILOVER, SUBOPT_MAX_RETENTION_DURATION, SUBOPT_ORIGIN, SUBOPT_PASSWORD_REQUIRED, SUBOPT_RETAIN_DEAD_TUPLES, SUBOPT_RUN_AS_OWNER, SUBOPT_SLOT_NAME, SUBOPT_STREAMING, SUBOPT_SYNCHRONOUS_COMMIT, SUBOPT_TWOPHASE_COMMIT, SUBOPT_WAL_RECEIVER_TIMEOUT, superuser(), superuser_arg(), table_close(), table_open(), UpdateTwoPhaseState(), values, walrcv_check_conninfo, walrcv_connect, walrcv_create_slot, walrcv_disconnect, WARNING, and wrconn.

Referenced by ProcessUtilitySlow().

defGetStreamingMode()

char defGetStreamingMode ( DefElem *  def )

extern

Definition at line 3187 of file subscriptioncmds.c.

{
    /*
     * If no parameter value given, assume "true" is meant.
     */
    if (!def->arg)
        return LOGICALREP_STREAM_ON;
 
    /*
     * Allow 0, 1, "false", "true", "off", "on" or "parallel".
     */
    switch (nodeTag(def->arg))
    {
        case T_Integer:
            switch (intVal(def->arg))
            {
                case 0:
                    return LOGICALREP_STREAM_OFF;
                case 1:
                    return LOGICALREP_STREAM_ON;
                default:
                    /* otherwise, error out below */
                    break;
            }
            break;
        default:
            {
                char       *sval = defGetString(def);
 
                /*
                 * The set of strings accepted here should match up with the
                 * grammar's opt_boolean_or_string production.
                 */
                if (pg_strcasecmp(sval, "false") == 0 ||
                    pg_strcasecmp(sval, "off") == 0)
                    return LOGICALREP_STREAM_OFF;
                if (pg_strcasecmp(sval, "true") == 0 ||
                    pg_strcasecmp(sval, "on") == 0)
                    return LOGICALREP_STREAM_ON;
                if (pg_strcasecmp(sval, "parallel") == 0)
                    return LOGICALREP_STREAM_PARALLEL;
            }
            break;
    }
 
    ereport(ERROR,
            (errcode(ERRCODE_SYNTAX_ERROR),
             errmsg("%s requires a Boolean value or \"parallel\"",
                    def->defname)));
    return LOGICALREP_STREAM_OFF;   /* keep compiler quiet */
}

References DefElem::arg, defGetString(), DefElem::defname, ereport, errcode(), errmsg(), ERROR, fb(), intVal, nodeTag, and pg_strcasecmp().

Referenced by parse_output_parameters(), and parse_subscription_options().

DropSubscription()

void DropSubscription ( DropSubscriptionStmt *  stmt, bool  isTopLevel  )

extern

Definition at line 2055 of file subscriptioncmds.c.

{
    Relation    rel;
    ObjectAddress myself;
    HeapTuple   tup;
    Oid         subid;
    Oid         subowner;
    Datum       datum;
    bool        isnull;
    char       *subname;
    char       *conninfo;
    char       *slotname;
    List       *subworkers;
    ListCell   *lc;
    char        originname[NAMEDATALEN];
    char       *err = NULL;
    WalReceiverConn *wrconn;
    Form_pg_subscription form;
    List       *rstates;
    bool        must_use_password;
 
    /*
     * The launcher may concurrently start a new worker for this subscription.
     * During initialization, the worker checks for subscription validity and
     * exits if the subscription has already been dropped. See
     * InitializeLogRepWorker.
     */
    rel = table_open(SubscriptionRelationId, RowExclusiveLock);
 
    tup = SearchSysCache2(SUBSCRIPTIONNAME, ObjectIdGetDatum(MyDatabaseId),
                          CStringGetDatum(stmt->subname));
 
    if (!HeapTupleIsValid(tup))
    {
        table_close(rel, NoLock);
 
        if (!stmt->missing_ok)
            ereport(ERROR,
                    (errcode(ERRCODE_UNDEFINED_OBJECT),
                     errmsg("subscription \"%s\" does not exist",
                            stmt->subname)));
        else
            ereport(NOTICE,
                    (errmsg("subscription \"%s\" does not exist, skipping",
                            stmt->subname)));
 
        return;
    }
 
    form = (Form_pg_subscription) GETSTRUCT(tup);
    subid = form->oid;
    subowner = form->subowner;
    must_use_password = !superuser_arg(subowner) && form->subpasswordrequired;
 
    /* must be owner */
    if (!object_ownercheck(SubscriptionRelationId, subid, GetUserId()))
        aclcheck_error(ACLCHECK_NOT_OWNER, OBJECT_SUBSCRIPTION,
                       stmt->subname);
 
    /* DROP hook for the subscription being removed */
    InvokeObjectDropHook(SubscriptionRelationId, subid, 0);
 
    /*
     * Lock the subscription so nobody else can do anything with it (including
     * the replication workers).
     */
    LockSharedObject(SubscriptionRelationId, subid, 0, AccessExclusiveLock);
 
    /* Get subname */
    datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID, tup,
                                   Anum_pg_subscription_subname);
    subname = pstrdup(NameStr(*DatumGetName(datum)));
 
    /* Get conninfo */
    datum = SysCacheGetAttrNotNull(SUBSCRIPTIONOID, tup,
                                   Anum_pg_subscription_subconninfo);
    conninfo = TextDatumGetCString(datum);
 
    /* Get slotname */
    datum = SysCacheGetAttr(SUBSCRIPTIONOID, tup,
                            Anum_pg_subscription_subslotname, &isnull);
    if (!isnull)
        slotname = pstrdup(NameStr(*DatumGetName(datum)));
    else
        slotname = NULL;
 
    /*
     * Since dropping a replication slot is not transactional, the replication
     * slot stays dropped even if the transaction rolls back.  So we cannot
     * run DROP SUBSCRIPTION inside a transaction block if dropping the
     * replication slot.  Also, in this case, we report a message for dropping
     * the subscription to the cumulative stats system.
     *
     * XXX The command name should really be something like "DROP SUBSCRIPTION
     * of a subscription that is associated with a replication slot", but we
     * don't have the proper facilities for that.
     */
    if (slotname)
        PreventInTransactionBlock(isTopLevel, "DROP SUBSCRIPTION");
 
    ObjectAddressSet(myself, SubscriptionRelationId, subid);
    EventTriggerSQLDropAddObject(&myself, true, true);
 
    /* Remove the tuple from catalog. */
    CatalogTupleDelete(rel, &tup->t_self);
 
    ReleaseSysCache(tup);
 
    /*
     * Stop all the subscription workers immediately.
     *
     * This is necessary if we are dropping the replication slot, so that the
     * slot becomes accessible.
     *
     * It is also necessary if the subscription is disabled and was disabled
     * in the same transaction.  Then the workers haven't seen the disabling
     * yet and will still be running, leading to hangs later when we want to
     * drop the replication origin.  If the subscription was disabled before
     * this transaction, then there shouldn't be any workers left, so this
     * won't make a difference.
     *
     * New workers won't be started because we hold an exclusive lock on the
     * subscription till the end of the transaction.
     */
    subworkers = logicalrep_workers_find(subid, false, true);
    foreach(lc, subworkers)
    {
        LogicalRepWorker *w = (LogicalRepWorker *) lfirst(lc);
 
        logicalrep_worker_stop(w->type, w->subid, w->relid);
    }
    list_free(subworkers);
 
    /*
     * Remove the no-longer-useful entry in the launcher's table of apply
     * worker start times.
     *
     * If this transaction rolls back, the launcher might restart a failed
     * apply worker before wal_retrieve_retry_interval milliseconds have
     * elapsed, but that's pretty harmless.
     */
    ApplyLauncherForgetWorkerStartTime(subid);
 
    /*
     * Cleanup of tablesync replication origins.
     *
     * Any READY-state relations would already have dealt with clean-ups.
     *
     * Note that the state can't change because we have already stopped both
     * the apply and tablesync workers and they can't restart because of
     * exclusive lock on the subscription.
     */
    rstates = GetSubscriptionRelations(subid, true, false, true);
    foreach(lc, rstates)
    {
        SubscriptionRelState *rstate = (SubscriptionRelState *) lfirst(lc);
        Oid         relid = rstate->relid;
 
        /* Only cleanup resources of tablesync workers */
        if (!OidIsValid(relid))
            continue;
 
        /*
         * Drop the tablesync's origin tracking if exists.
         *
         * It is possible that the origin is not yet created for tablesync
         * worker so passing missing_ok = true. This can happen for the states
         * before SUBREL_STATE_DATASYNC.
         */
        ReplicationOriginNameForLogicalRep(subid, relid, originname,
                                           sizeof(originname));
        replorigin_drop_by_name(originname, true, false);
    }
 
    /* Clean up dependencies */
    deleteSharedDependencyRecordsFor(SubscriptionRelationId, subid, 0);
 
    /* Remove any associated relation synchronization states. */
    RemoveSubscriptionRel(subid, InvalidOid);
 
    /* Remove the origin tracking if exists. */
    ReplicationOriginNameForLogicalRep(subid, InvalidOid, originname, sizeof(originname));
    replorigin_drop_by_name(originname, true, false);
 
    /*
     * Tell the cumulative stats system that the subscription is getting
     * dropped.
     */
    pgstat_drop_subscription(subid);
 
    /*
     * If there is no slot associated with the subscription, we can finish
     * here.
     */
    if (!slotname && rstates == NIL)
    {
        table_close(rel, NoLock);
        return;
    }
 
    /*
     * Try to acquire the connection necessary for dropping slots.
     *
     * Note: If the slotname is NONE/NULL then we allow the command to finish
     * and users need to manually cleanup the apply and tablesync worker slots
     * later.
     *
     * This has to be at the end because otherwise if there is an error while
     * doing the database operations we won't be able to rollback dropped
     * slot.
     */
    load_file("libpqwalreceiver", false);
 
    wrconn = walrcv_connect(conninfo, true, true, must_use_password,
                            subname, &err);
    if (wrconn == NULL)
    {
        if (!slotname)
        {
            /* be tidy */
            list_free(rstates);
            table_close(rel, NoLock);
            return;
        }
        else
        {
            ReportSlotConnectionError(rstates, subid, slotname, err);
        }
    }
 
    PG_TRY();
    {
        foreach(lc, rstates)
        {
            SubscriptionRelState *rstate = (SubscriptionRelState *) lfirst(lc);
            Oid         relid = rstate->relid;
 
            /* Only cleanup resources of tablesync workers */
            if (!OidIsValid(relid))
                continue;
 
            /*
             * Drop the tablesync slots associated with removed tables.
             *
             * For SYNCDONE/READY states, the tablesync slot is known to have
             * already been dropped by the tablesync worker.
             *
             * For other states, there is no certainty, maybe the slot does
             * not exist yet. Also, if we fail after removing some of the
             * slots, next time, it will again try to drop already dropped
             * slots and fail. For these reasons, we allow missing_ok = true
             * for the drop.
             */
            if (rstate->state != SUBREL_STATE_SYNCDONE)
            {
                char        syncslotname[NAMEDATALEN] = {0};
 
                ReplicationSlotNameForTablesync(subid, relid, syncslotname,
                                                sizeof(syncslotname));
                ReplicationSlotDropAtPubNode(wrconn, syncslotname, true);
            }
        }
 
        list_free(rstates);
 
        /*
         * If there is a slot associated with the subscription, then drop the
         * replication slot at the publisher.
         */
        if (slotname)
            ReplicationSlotDropAtPubNode(wrconn, slotname, false);
    }
    PG_FINALLY();
    {
        walrcv_disconnect(wrconn);
    }
    PG_END_TRY();
 
    table_close(rel, NoLock);
}

References AccessExclusiveLock, aclcheck_error(), ACLCHECK_NOT_OWNER, ApplyLauncherForgetWorkerStartTime(), CatalogTupleDelete(), CStringGetDatum(), DatumGetName(), deleteSharedDependencyRecordsFor(), ereport, err(), errcode(), errmsg(), ERROR, EventTriggerSQLDropAddObject(), fb(), Form_pg_subscription, GETSTRUCT(), GetSubscriptionRelations(), GetUserId(), HeapTupleIsValid, InvalidOid, InvokeObjectDropHook, lfirst, list_free(), load_file(), LockSharedObject(), logicalrep_worker_stop(), logicalrep_workers_find(), MyDatabaseId, NAMEDATALEN, NameStr, NIL, NoLock, NOTICE, object_ownercheck(), OBJECT_SUBSCRIPTION, ObjectAddressSet, ObjectIdGetDatum(), OidIsValid, PG_END_TRY, PG_FINALLY, PG_TRY, pgstat_drop_subscription(), PreventInTransactionBlock(), pstrdup(), ReleaseSysCache(), SubscriptionRelState::relid, LogicalRepWorker::relid, RemoveSubscriptionRel(), ReplicationOriginNameForLogicalRep(), ReplicationSlotDropAtPubNode(), ReplicationSlotNameForTablesync(), replorigin_drop_by_name(), ReportSlotConnectionError(), RowExclusiveLock, SearchSysCache2(), SubscriptionRelState::state, stmt, LogicalRepWorker::subid, subname, superuser_arg(), SysCacheGetAttr(), SysCacheGetAttrNotNull(), table_close(), table_open(), TextDatumGetCString, LogicalRepWorker::type, walrcv_connect, walrcv_disconnect, and wrconn.

Referenced by ProcessUtilitySlow().