table of contents
DROPUSER(1) | PostgreSQL 16.5 Documentation | DROPUSER(1) |
NAME¶
dropuser - remove a PostgreSQL user account
SYNOPSIS¶
dropuser [connection-option...] [option...] [username]
DESCRIPTION¶
dropuser removes an existing PostgreSQL user. Superusers can use this command to remove any role; otherwise, only non-superuser roles can be removed, and only by a user who possesses the CREATEROLE privilege and has been granted ADMIN OPTION on the target role.
dropuser is a wrapper around the SQL command DROP ROLE. There is no effective difference between dropping users via this utility and via other methods for accessing the server.
OPTIONS¶
dropuser accepts the following command-line arguments:
username
-e
--echo
-i
--interactive
-V
--version
--if-exists
-?
--help
dropuser also accepts the following command-line arguments for connection parameters:
-h host
--host=host
-p port
--port=port
-U username
--username=username
-w
--no-password
-W
--password
This option is never essential, since dropuser will automatically prompt for a password if the server demands password authentication. However, dropuser will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt.
ENVIRONMENT¶
PGHOST
PGPORT
PGUSER
PG_COLOR
This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 34.15).
DIAGNOSTICS¶
In case of difficulty, see DROP ROLE (DROP_ROLE(7)) and psql(1) for 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 libpq front-end library will apply.
EXAMPLES¶
To remove user joe from the default database server:
$ dropuser joe
To remove user joe using the server on host eden, port 5000, with verification and a peek at the underlying command:
$ dropuser -p 5000 -h eden -i -e joe Role "joe" will be permanently removed. Are you sure? (y/n) y DROP ROLE joe;
SEE ALSO¶
createuser(1), DROP ROLE (DROP_ROLE(7))
2024 | PostgreSQL 16.5 |