dropuser

Name

dropuser -- Drops (removes) a PostgreSQL user

Synopsis

dropuser [options] [username]

Inputs

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 createdb generates and sends to the backend.

-h, --host host

Specifies the hostname of the machine on which the postmaster is running. If host begins with a slash, it is used as the directory for the UNIX domain socket.

-i, --interactive

Prompt for confirmation before actually removing the user.

-p, --port port

Specifies the Internet TCP/IP port or local UNIX domain socket file extension on which the postmaster is listening for connections.

-q, --quiet

Do not display a response.

The options -h, -p, and -e, are passed on literally to psql. The psql options -U and -W are available as well, but they can be confusing in this context.

Outputs

DROP USER

The user was successfully removed.

dropuser: deletion of user "username" failed

The user failed to be removed.

If there is an error condition, the backend error message will be displayed. See the section on psql for possibilities.

Description

dropuser removes an existing PostgreSQL user. 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.

Usage

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