summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man7/DROP_SUBSCRIPTION.7
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/man7/DROP_SUBSCRIPTION.7')
-rw-r--r--doc/src/sgml/man7/DROP_SUBSCRIPTION.797
1 files changed, 97 insertions, 0 deletions
diff --git a/doc/src/sgml/man7/DROP_SUBSCRIPTION.7 b/doc/src/sgml/man7/DROP_SUBSCRIPTION.7
new file mode 100644
index 0000000..fe1116b
--- /dev/null
+++ b/doc/src/sgml/man7/DROP_SUBSCRIPTION.7
@@ -0,0 +1,97 @@
+'\" t
+.\" Title: DROP SUBSCRIPTION
+.\" Author: The PostgreSQL Global Development Group
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2023
+.\" Manual: PostgreSQL 15.4 Documentation
+.\" Source: PostgreSQL 15.4
+.\" Language: English
+.\"
+.TH "DROP SUBSCRIPTION" "7" "2023" "PostgreSQL 15.4" "PostgreSQL 15.4 Documentation"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+DROP_SUBSCRIPTION \- remove a subscription
+.SH "SYNOPSIS"
+.sp
+.nf
+DROP SUBSCRIPTION [ IF EXISTS ] \fIname\fR [ CASCADE | RESTRICT ]
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBDROP SUBSCRIPTION\fR
+removes a subscription from the database cluster\&.
+.PP
+A subscription can only be dropped by a superuser\&.
+.PP
+\fBDROP SUBSCRIPTION\fR
+cannot be executed inside a transaction block if the subscription is associated with a replication slot\&. (You can use
+\fBALTER SUBSCRIPTION\fR
+to unset the slot\&.)
+.SH "PARAMETERS"
+.PP
+\fIname\fR
+.RS 4
+The name of a subscription to be dropped\&.
+.RE
+.PP
+CASCADE
+.br
+RESTRICT
+.RS 4
+These key words do not have any effect, since there are no dependencies on subscriptions\&.
+.RE
+.SH "NOTES"
+.PP
+When dropping a subscription that is associated with a replication slot on the remote host (the normal state),
+\fBDROP SUBSCRIPTION\fR
+will connect to the remote host and try to drop the replication slot (and any remaining table synchronization slots) as part of its operation\&. This is necessary so that the resources allocated for the subscription on the remote host are released\&. If this fails, either because the remote host is not reachable or because the remote replication slot cannot be dropped or does not exist or never existed, the
+\fBDROP SUBSCRIPTION\fR
+command will fail\&. To proceed in this situation, first disable the subscription by executing
+ALTER SUBSCRIPTION \&.\&.\&. DISABLE, and then disassociate it from the replication slot by executing
+ALTER SUBSCRIPTION \&.\&.\&. SET (slot_name = NONE)\&. After that,
+\fBDROP SUBSCRIPTION\fR
+will no longer attempt any actions on a remote host\&. Note that if the remote replication slot still exists, it (and any related table synchronization slots) should then be dropped manually; otherwise it/they will continue to reserve WAL and might eventually cause the disk to fill up\&. See also
+Section\ \&31.2.1\&.
+.PP
+If a subscription is associated with a replication slot, then
+\fBDROP SUBSCRIPTION\fR
+cannot be executed inside a transaction block\&.
+.SH "EXAMPLES"
+.PP
+Drop a subscription:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+DROP SUBSCRIPTION mysub;
+.fi
+.if n \{\
+.RE
+.\}
+.SH "COMPATIBILITY"
+.PP
+\fBDROP SUBSCRIPTION\fR
+is a
+PostgreSQL
+extension\&.
+.SH "SEE ALSO"
+CREATE SUBSCRIPTION (\fBCREATE_SUBSCRIPTION\fR(7)), ALTER SUBSCRIPTION (\fBALTER_SUBSCRIPTION\fR(7))