Linux "createuser" Command Line Options and Examples
define a new PostgreSQL user account

createuser creates a new PostgreSQL user (or more precisely, a role). Only superusers and users with CREATEROLE privilege can create new users, so createuser must be invoked by someone who can connect as a superuser or a user with CREATEROLE privilege. If you wish to create a new superuser, you must connect as a superuser, not merely with CREATEROLE privilege.


Usage:

createuser [connection-option...] [option...] [username]




Command Line Options:

--connection-limit
Set a maximum number of connections for the new user. The default is to set no limit.
createuser --connection-limit ...
--createdb
The new user will be allowed to create databases.
createuser --createdb ...
--no-createdb
The new user will not be allowed to create databases. This is the default.
createuser --no-createdb ...
--echo
Echo the commands that createuser generates and sends to the server.
createuser --echo ...
--encrypted
This option is obsolete but still accepted for backward compatibility.
createuser --encrypted ...
--role
Indicates role to which this role will be added immediately as a new member. Multiple roles to which this role will be added as amember can be specified by writing multiple -g switches.
createuser --role ...
--inherit
The new role will automatically inherit privileges of roles it is a member of. This is the default.
createuser --inherit ...
--no-inherit
The new role will not automatically inherit privileges of roles it is a member of.
createuser --no-inherit ...
--interactive
Prompt for the user name if none is specified on the command line, and also prompt for whichever of the options -d/-D, -r/-R,
createuser --interactive ...
-s/-S
is not specified on the command line. (This was the default behavior up to PostgreSQL 9.1.)
createuser -s/-S ...
--login
The new user will be allowed to log in (that is, the user name can be used as the initial session user identifier). This is thedefault.
createuser --login ...
--no-login
The new user will not be allowed to log in. (A role without login privilege is still useful as a means of managing databasepermissions.)
createuser --no-login ...
--pwprompt
If given, createuser will issue a prompt for the password of the new user. This is not necessary if you do not plan on usingpassword authentication.
createuser --pwprompt ...
--createrole
The new user will be allowed to create new roles (that is, this user will have CREATEROLE privilege).
createuser --createrole ...
--no-createrole
The new user will not be allowed to create new roles. This is the default.
createuser --no-createrole ...
--superuser
The new user will be a superuser.
createuser --superuser ...
--no-superuser
The new user will not be a superuser. This is the default.
createuser --no-superuser ...
--version
Print the createuser version and exit.
createuser --version ...
--replication
The new user will have the REPLICATION privilege, which is described more fully in the documentation for CREATE ROLE(CREATE_ROLE(7)).
createuser --replication ...
--no-replication
The new user will not have the REPLICATION privilege, which is described more fully in the documentation for CREATE ROLE(CREATE_ROLE(7)).
createuser --no-replication ...
--help
Show help about createuser command line arguments, and exit.createuser also accepts the following command-line arguments for connection parameters:
createuser --help ...
--host
Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as thedirectory for the Unix domain socket.
createuser --host ...
--port
Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.
createuser --port ...
--username
User name to connect as (not the user name to create).
createuser --username ...
--no-password
Never issue a password prompt. If the server requires password authentication and a password is not available by other means suchas a .pgpass file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is presentto enter a password.
createuser --no-password ...
--password
Force createuser to prompt for a password (for connecting to the server, not for the password of the new user).This option is never essential, since createuser will automatically prompt for a password if the server demands passwordauthentication. However, createuser will waste a connection attempt finding out that the server wants a password. In some casesit is worth typing -W to avoid the extra connection attempt.ENVIRONMENTPGHOSTPGPORTPGUSERDefault connection parametersThis utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 33.14).DIAGNOSTICSIn case of difficulty, see CREATE ROLE (CREATE_ROLE(7)) and psql(1) for discussions of potential problems and error messages. Thedatabase server must be running at the targeted host. Also, any default connection settings and environment variables used by thelibpq front-end library will apply.EXAMPLESTo create a user joe on the default database server:$ createuser joeTo create a user joe on the default database server with prompting for some additional attributes:$ createuser --interactive joeShall the new role be a superuser? (y/n) nShall the new role be allowed to create databases? (y/n) nShall the new role be allowed to create more new roles? (y/n) nTo create the same user joe using the server on host eden, port 5000, with attributes explicitly specified, taking a look at theunderlying command:$ createuser -h eden -p 5000 -S -D -R -e joeCREATE ROLE joe NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN;To create the user joe as a superuser, and assign a password immediately:$ createuser -P -s -e joeEnter password for new role: xyzzyEnter it again: xyzzyCREATE ROLE joe PASSWORD 'md5b5f5ba1a423792b526f799ae4eb3d59e' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN;In the above example, the new password isn't actually echoed when typed, but we show what was typed for clarity. As you see, thepassword is encrypted before it is sent to the client.
createuser --password ...