summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man7/ALTER_SYSTEM.7
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/man7/ALTER_SYSTEM.7')
-rw-r--r--doc/src/sgml/man7/ALTER_SYSTEM.7132
1 files changed, 132 insertions, 0 deletions
diff --git a/doc/src/sgml/man7/ALTER_SYSTEM.7 b/doc/src/sgml/man7/ALTER_SYSTEM.7
new file mode 100644
index 0000000..0e7c77b
--- /dev/null
+++ b/doc/src/sgml/man7/ALTER_SYSTEM.7
@@ -0,0 +1,132 @@
+'\" t
+.\" Title: ALTER SYSTEM
+.\" 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 "ALTER SYSTEM" "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"
+ALTER_SYSTEM \- change a server configuration parameter
+.SH "SYNOPSIS"
+.sp
+.nf
+ALTER SYSTEM SET \fIconfiguration_parameter\fR { TO | = } { \fIvalue\fR | \*(Aq\fIvalue\fR\*(Aq | DEFAULT }
+
+ALTER SYSTEM RESET \fIconfiguration_parameter\fR
+ALTER SYSTEM RESET ALL
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBALTER SYSTEM\fR
+is used for changing server configuration parameters across the entire database cluster\&. It can be more convenient than the traditional method of manually editing the
+postgresql\&.conf
+file\&.
+\fBALTER SYSTEM\fR
+writes the given parameter setting to the
+postgresql\&.auto\&.conf
+file, which is read in addition to
+postgresql\&.conf\&. Setting a parameter to
+DEFAULT, or using the
+\fBRESET\fR
+variant, removes that configuration entry from the
+postgresql\&.auto\&.conf
+file\&. Use
+RESET ALL
+to remove all such configuration entries\&.
+.PP
+Values set with
+\fBALTER SYSTEM\fR
+will be effective after the next server configuration reload, or after the next server restart in the case of parameters that can only be changed at server start\&. A server configuration reload can be commanded by calling the SQL function
+\fBpg_reload_conf()\fR, running
+pg_ctl reload, or sending a
+SIGHUP
+signal to the main server process\&.
+.PP
+Only superusers and users granted
+ALTER SYSTEM
+privilege on a parameter can change it using
+\fBALTER SYSTEM\fR\&. Also, since this command acts directly on the file system and cannot be rolled back, it is not allowed inside a transaction block or function\&.
+.SH "PARAMETERS"
+.PP
+\fIconfiguration_parameter\fR
+.RS 4
+Name of a settable configuration parameter\&. Available parameters are documented in
+Chapter\ \&20\&.
+.RE
+.PP
+\fIvalue\fR
+.RS 4
+New value of the parameter\&. Values can be specified as string constants, identifiers, numbers, or comma\-separated lists of these, as appropriate for the particular parameter\&.
+DEFAULT
+can be written to specify removing the parameter and its value from
+postgresql\&.auto\&.conf\&.
+.RE
+.SH "NOTES"
+.PP
+This command can\*(Aqt be used to set
+data_directory, nor parameters that are not allowed in
+postgresql\&.conf
+(e\&.g\&.,
+preset options)\&.
+.PP
+See
+Section\ \&20.1
+for other ways to set the parameters\&.
+.SH "EXAMPLES"
+.PP
+Set the
+wal_level:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ALTER SYSTEM SET wal_level = replica;
+.fi
+.if n \{\
+.RE
+.\}
+.PP
+Undo that, restoring whatever setting was effective in
+postgresql\&.conf:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ALTER SYSTEM RESET wal_level;
+.fi
+.if n \{\
+.RE
+.\}
+.SH "COMPATIBILITY"
+.PP
+The
+\fBALTER SYSTEM\fR
+statement is a
+PostgreSQL
+extension\&.
+.SH "SEE ALSO"
+\fBSET\fR(7), \fBSHOW\fR(7)