1999-12-04 05:53:22 +01:00
|
|
|
<!--
|
2010-09-20 22:08:53 +02:00
|
|
|
doc/src/sgml/ref/dropuser.sgml
|
2001-12-08 04:24:40 +01:00
|
|
|
PostgreSQL documentation
|
1999-12-04 05:53:22 +01:00
|
|
|
-->
|
|
|
|
|
2017-10-20 03:16:39 +02:00
|
|
|
<refentry id="app-dropuser">
|
2014-02-24 03:25:35 +01:00
|
|
|
<indexterm zone="app-dropuser">
|
|
|
|
<primary>dropuser</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
<refmeta>
|
2010-04-03 09:23:02 +02:00
|
|
|
<refentrytitle><application>dropuser</application></refentrytitle>
|
2000-11-12 00:01:45 +01:00
|
|
|
<manvolnum>1</manvolnum>
|
1999-12-04 05:53:22 +01:00
|
|
|
<refmiscinfo>Application</refmiscinfo>
|
|
|
|
</refmeta>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
<refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<refname>dropuser</refname>
|
2001-09-03 14:57:50 +02:00
|
|
|
<refpurpose>remove a <productname>PostgreSQL</productname> user account</refpurpose>
|
1999-12-04 05:53:22 +01:00
|
|
|
</refnamediv>
|
2000-11-12 00:01:45 +01:00
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
<refsynopsisdiv>
|
2000-11-12 00:01:45 +01:00
|
|
|
<cmdsynopsis>
|
|
|
|
<command>dropuser</command>
|
2010-02-19 04:50:03 +01:00
|
|
|
<arg rep="repeat"><replaceable>connection-option</replaceable></arg>
|
2003-03-24 15:32:51 +01:00
|
|
|
<arg rep="repeat"><replaceable>option</replaceable></arg>
|
2012-05-03 21:50:04 +02:00
|
|
|
<arg choice="opt"><replaceable>username</replaceable></arg>
|
2000-11-12 00:01:45 +01:00
|
|
|
</cmdsynopsis>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsynopsisdiv>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<application>dropuser</application> removes an existing
|
2005-08-15 04:40:36 +02:00
|
|
|
<productname>PostgreSQL</productname> user.
|
2017-10-09 03:44:17 +02:00
|
|
|
Only superusers and users with the <literal>CREATEROLE</literal> privilege can
|
2005-08-15 04:40:36 +02:00
|
|
|
remove <productname>PostgreSQL</productname> users. (To remove a
|
|
|
|
superuser, you must yourself be a superuser.)
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-06-18 14:19:11 +02:00
|
|
|
<application>dropuser</application> is a wrapper around the
|
2017-11-23 15:39:47 +01:00
|
|
|
<acronym>SQL</acronym> command <xref linkend="sql-droprole"/>.
|
2003-09-12 02:12:47 +02:00
|
|
|
There is no effective difference between dropping users via
|
|
|
|
this utility and via other methods for accessing the server.
|
2002-07-28 17:22:21 +02:00
|
|
|
</para>
|
2003-09-12 02:12:47 +02:00
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<para>
|
|
|
|
<application>dropuser</application> accepts the following command-line arguments:
|
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2002-10-12 01:03:48 +02:00
|
|
|
<term><replaceable class="parameter">username</replaceable></term>
|
1999-12-04 05:53:22 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2010-11-23 21:27:50 +01:00
|
|
|
Specifies the name of the <productname>PostgreSQL</productname> user to be removed.
|
2012-02-07 13:55:34 +01:00
|
|
|
You will be prompted for a name if none is specified on the command
|
|
|
|
line and the <option>-i</option>/<option>--interactive</option> option
|
|
|
|
is used.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-e</option></term>
|
|
|
|
<term><option>--echo</option></term>
|
1999-12-04 05:53:22 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
Echo the commands that <application>dropuser</application> generates
|
2005-08-15 04:40:36 +02:00
|
|
|
and sends to the server.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-i</option></term>
|
|
|
|
<term><option>--interactive</option></term>
|
1999-12-04 05:53:22 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2012-02-07 13:55:34 +01:00
|
|
|
Prompt for confirmation before actually removing the user, and prompt
|
|
|
|
for the user name if none is specified on the command line.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2010-02-19 15:36:45 +01:00
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-V</option></term>
|
|
|
|
<term><option>--version</option></term>
|
2010-02-19 15:36:45 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Print the <application>dropuser</application> version and exit.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2012-06-18 01:44:00 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>--if-exists</option></term>
|
2012-06-18 01:44:00 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Do not throw an error if the user does not exist. A notice is
|
|
|
|
issued in this case.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2010-02-19 15:36:45 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-?</option></term>
|
|
|
|
<term><option>--help</option></term>
|
2010-02-19 15:36:45 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Show help about <application>dropuser</application> command line
|
|
|
|
arguments, and exit.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
</variablelist>
|
|
|
|
</para>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<para>
|
2003-09-12 02:12:47 +02:00
|
|
|
<application>dropuser</application> also accepts the following
|
2002-10-12 01:03:48 +02:00
|
|
|
command-line arguments for connection parameters:
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<variablelist>
|
1999-12-04 05:53:22 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-h <replaceable class="parameter">host</replaceable></option></term>
|
|
|
|
<term><option>--host=<replaceable class="parameter">host</replaceable></option></term>
|
1999-12-04 05:53:22 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2010-11-23 21:27:50 +01:00
|
|
|
Specifies the host name of the machine on which the
|
2005-08-15 04:40:36 +02:00
|
|
|
server
|
2010-11-23 21:27:50 +01:00
|
|
|
is running. If the value begins with a slash, it is used
|
2005-08-15 04:40:36 +02:00
|
|
|
as the directory for the Unix domain socket.
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-p <replaceable class="parameter">port</replaceable></option></term>
|
|
|
|
<term><option>--port=<replaceable class="parameter">port</replaceable></option></term>
|
1999-12-04 05:53:22 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2010-11-23 21:27:50 +01:00
|
|
|
Specifies the TCP port or local Unix domain socket file
|
2005-08-15 04:40:36 +02:00
|
|
|
extension on which the server
|
|
|
|
is listening for connections.
|
2002-10-12 01:03:48 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
|
|
|
|
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
|
2002-10-12 01:03:48 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2007-12-11 20:57:32 +01:00
|
|
|
User name to connect as (not the user name to drop).
|
1999-12-04 05:53:22 +01:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2009-02-26 17:02:39 +01:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-w</option></term>
|
|
|
|
<term><option>--no-password</option></term>
|
2009-02-26 17:02:39 +01:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Never issue a password prompt. If the server requires
|
|
|
|
password authentication and a password is not available by
|
|
|
|
other means such as a <filename>.pgpass</filename> file, the
|
|
|
|
connection attempt will fail. This option can be useful in
|
|
|
|
batch jobs and scripts where no user is present to enter a
|
|
|
|
password.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2002-10-12 01:03:48 +02:00
|
|
|
<varlistentry>
|
2017-10-09 03:44:17 +02:00
|
|
|
<term><option>-W</option></term>
|
|
|
|
<term><option>--password</option></term>
|
2002-10-12 01:03:48 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
2007-12-11 20:57:32 +01:00
|
|
|
Force <application>dropuser</application> to prompt for a
|
2010-11-23 21:27:50 +01:00
|
|
|
password before connecting to a database.
|
2007-12-11 20:57:32 +01:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
This option is never essential, since
|
|
|
|
<application>dropuser</application> will automatically prompt
|
|
|
|
for a password if the server demands password authentication.
|
|
|
|
However, <application>dropuser</application> will waste a
|
|
|
|
connection attempt finding out that the server wants a password.
|
2017-10-09 03:44:17 +02:00
|
|
|
In some cases it is worth typing <option>-W</option> to avoid the extra
|
2007-12-11 20:57:32 +01:00
|
|
|
connection attempt.
|
2002-10-12 01:03:48 +02:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Environment</title>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><envar>PGHOST</envar></term>
|
|
|
|
<term><envar>PGPORT</envar></term>
|
|
|
|
<term><envar>PGUSER</envar></term>
|
|
|
|
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Default connection parameters
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
Unified logging system for command-line programs
This unifies the various ad hoc logging (message printing, error
printing) systems used throughout the command-line programs.
Features:
- Program name is automatically prefixed.
- Message string does not end with newline. This removes a common
source of inconsistencies and omissions.
- Additionally, a final newline is automatically stripped, simplifying
use of PQerrorMessage() etc., another common source of mistakes.
- I converted error message strings to use %m where possible.
- As a result of the above several points, more translatable message
strings can be shared between different components and between
frontends and backend, without gratuitous punctuation or whitespace
differences.
- There is support for setting a "log level". This is not meant to be
user-facing, but can be used internally to implement debug or
verbose modes.
- Lazy argument evaluation, so no significant overhead if logging at
some level is disabled.
- Some color in the messages, similar to gcc and clang. Set
PG_COLOR=auto to try it out. Some colors are predefined, but can be
customized by setting PG_COLORS.
- Common files (common/, fe_utils/, etc.) can handle logging much more
simply by just using one API without worrying too much about the
context of the calling program, requiring callbacks, or having to
pass "progname" around everywhere.
- Some programs called setvbuf() to make sure that stderr is
unbuffered, even on Windows. But not all programs did that. This
is now done centrally.
Soft goals:
- Reduces vertical space use and visual complexity of error reporting
in the source code.
- Encourages more deliberate classification of messages. For example,
in some cases it wasn't clear without analyzing the surrounding code
whether a message was meant as an error or just an info.
- Concepts and terms are vaguely aligned with popular logging
frameworks such as log4j and Python logging.
This is all just about printing stuff out. Nothing affects program
flow (e.g., fatal exits). The uses are just too varied to do that.
Some existing code had wrappers that do some kind of print-and-exit,
and I adapted those.
I tried to keep the output mostly the same, but there is a lot of
historical baggage to unwind and special cases to consider, and I
might not always have succeeded. One significant change is that
pg_rewind used to write all error messages to stdout. That is now
changed to stderr.
Reviewed-by: Donald Dong <xdong@csumb.edu>
Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
2019-04-01 14:24:37 +02:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><envar>PG_COLOR</envar></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2020-03-09 02:53:22 +01:00
|
|
|
Specifies whether to use color in diagnostic messages. Possible values
|
|
|
|
are <literal>always</literal>, <literal>auto</literal> and
|
Unified logging system for command-line programs
This unifies the various ad hoc logging (message printing, error
printing) systems used throughout the command-line programs.
Features:
- Program name is automatically prefixed.
- Message string does not end with newline. This removes a common
source of inconsistencies and omissions.
- Additionally, a final newline is automatically stripped, simplifying
use of PQerrorMessage() etc., another common source of mistakes.
- I converted error message strings to use %m where possible.
- As a result of the above several points, more translatable message
strings can be shared between different components and between
frontends and backend, without gratuitous punctuation or whitespace
differences.
- There is support for setting a "log level". This is not meant to be
user-facing, but can be used internally to implement debug or
verbose modes.
- Lazy argument evaluation, so no significant overhead if logging at
some level is disabled.
- Some color in the messages, similar to gcc and clang. Set
PG_COLOR=auto to try it out. Some colors are predefined, but can be
customized by setting PG_COLORS.
- Common files (common/, fe_utils/, etc.) can handle logging much more
simply by just using one API without worrying too much about the
context of the calling program, requiring callbacks, or having to
pass "progname" around everywhere.
- Some programs called setvbuf() to make sure that stderr is
unbuffered, even on Windows. But not all programs did that. This
is now done centrally.
Soft goals:
- Reduces vertical space use and visual complexity of error reporting
in the source code.
- Encourages more deliberate classification of messages. For example,
in some cases it wasn't clear without analyzing the surrounding code
whether a message was meant as an error or just an info.
- Concepts and terms are vaguely aligned with popular logging
frameworks such as log4j and Python logging.
This is all just about printing stuff out. Nothing affects program
flow (e.g., fatal exits). The uses are just too varied to do that.
Some existing code had wrappers that do some kind of print-and-exit,
and I adapted those.
I tried to keep the output mostly the same, but there is a lot of
historical baggage to unwind and special cases to consider, and I
might not always have succeeded. One significant change is that
pg_rewind used to write all error messages to stdout. That is now
changed to stderr.
Reviewed-by: Donald Dong <xdong@csumb.edu>
Reviewed-by: Arthur Zakirov <a.zakirov@postgrespro.ru>
Discussion: https://www.postgresql.org/message-id/flat/6a609b43-4f57-7348-6480-bd022f924310@2ndquadrant.com
2019-04-01 14:24:37 +02:00
|
|
|
<literal>never</literal>.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2002-07-28 17:22:21 +02:00
|
|
|
</variablelist>
|
2007-02-20 19:10:59 +01:00
|
|
|
|
|
|
|
<para>
|
2017-10-09 03:44:17 +02:00
|
|
|
This utility, like most other <productname>PostgreSQL</productname> utilities,
|
|
|
|
also uses the environment variables supported by <application>libpq</application>
|
2017-11-23 15:39:47 +01:00
|
|
|
(see <xref linkend="libpq-envars"/>).
|
2007-02-20 19:10:59 +01:00
|
|
|
</para>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
2003-09-13 01:04:46 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Diagnostics</title>
|
|
|
|
|
|
|
|
<para>
|
2017-11-23 15:39:47 +01:00
|
|
|
In case of difficulty, see <xref linkend="sql-droprole"/>
|
|
|
|
and <xref linkend="app-psql"/> for
|
2003-09-13 01:04:46 +02:00
|
|
|
discussions of potential problems and error messages.
|
|
|
|
The database server must be running at the
|
|
|
|
targeted host. Also, any default connection settings and environment
|
|
|
|
variables used by the <application>libpq</application> front-end
|
|
|
|
library will apply.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Examples</title>
|
1999-12-04 05:53:22 +01:00
|
|
|
|
2000-11-12 00:01:45 +01:00
|
|
|
<para>
|
|
|
|
To remove user <literal>joe</literal> from the default database
|
|
|
|
server:
|
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>dropuser joe</userinput>
|
|
|
|
</screen>
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2003-03-24 15:32:51 +01:00
|
|
|
To remove user <literal>joe</literal> using the server on host
|
2002-01-20 23:19:57 +01:00
|
|
|
<literal>eden</literal>, port 5000, with verification and a peek at the underlying
|
2003-03-24 15:32:51 +01:00
|
|
|
command:
|
2000-11-12 00:01:45 +01:00
|
|
|
<screen>
|
|
|
|
<prompt>$ </prompt><userinput>dropuser -p 5000 -h eden -i -e joe</userinput>
|
2005-08-15 04:40:36 +02:00
|
|
|
<computeroutput>Role "joe" will be permanently removed.
|
2000-11-12 00:01:45 +01:00
|
|
|
Are you sure? (y/n) </computeroutput><userinput>y</userinput>
|
2007-06-21 12:43:09 +02:00
|
|
|
<computeroutput>DROP ROLE joe;</computeroutput>
|
2011-08-07 09:49:45 +02:00
|
|
|
</screen></para>
|
1999-12-04 05:53:22 +01:00
|
|
|
</refsect1>
|
|
|
|
|
2002-07-28 17:22:21 +02:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
2017-11-23 15:39:47 +01:00
|
|
|
<member><xref linkend="app-createuser"/></member>
|
|
|
|
<member><xref linkend="sql-droprole"/></member>
|
2002-07-28 17:22:21 +02:00
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
|
|
|
|
1999-12-04 05:53:22 +01:00
|
|
|
</refentry>
|