dropuser

Name

dropuser -- remove a PostgreSQL user account

Synopsis

dropuser [options...] [username]

Description

dropuser removes an existing PostgreSQL user and the databases which that user owned. Only users with usesuper set in the pg_shadow table can destroy PostgreSQL users.

dropuser is a shell script wrapper around the SQL command DROP USER via the PostgreSQL interactive terminal psql. Thus, there is nothing special about removing users via this or other methods. This means that the psql must be found by the script and that a database server is running at the targeted host. Also, any default settings and environment variables available to psql and the libpq front-end library do apply.

Options

dropuser accepts the following command-line arguments:

username: Specifies the name of the PostgreSQL user to be removed. This name must exist in the PostgreSQL installation. You will be prompted for a name if none is specified on the command line.
-e --echo: Echo the queries that dropuser generates and sends to the server.
-i --interactive: Prompt for confirmation before actually removing the user.
-q --quiet: Do not display a response.

createuser also accepts the following command-line arguments for connection parameters:

-h host --host host: Specifies the host name of the machine on which the server is running. If host begins with a slash, it is used as the directory for the Unix domain socket.
-p port --port port: Specifies the Internet TCP/IP port or local Unix domain socket file extension on which the server is listening for connections.
-U username --username username: User name to connect as (not the user name to drop)
-W --password: Force password prompt (to connect to the server, not for the password of the user to be dropped).

Environment

PGHOST PGPORT PGUSER: Default connection parameters

Diagnostics

DROP USER: All is well.
dropuser: deletion of user "username" failed: Something went wrong. The user was not removed.

If there is an error condition, the backend error message will be displayed. See DROP USER and psql for possibilities.

Examples

To remove user joe from the default database server:

$ dropuser joe
DROP USER

To remove user joe using the postmaster on host eden, port 5000, with verification and a peek at the underlying query:

$ dropuser -p 5000 -h eden -i -e joe
User "joe" and any owned databases will be permanently deleted.
Are you sure? (y/n) y
DROP USER "joe"
DROP USER