createuser

Creates a new database role.

Synopsis

  1. createuser [<connection_options>] [<role_attribute_options>] [-e | --echo] <role_name>
  3. createuser --help 
  5. createuser --version

where:

  1. <connection_options> =
  2.     [-h <host> | --host <host>] 
  3.     [-p <port> | -- port <port>] 
  4.     [-U <username> | --username <username>] 
  5.     [-W | --password]
  7. <role_attribute_options> = 
  8.     [-c <number> | --connection-limit <number>]
  9.     [(-D | --no-createdb) | (-d | --createdb)]
  10.     [(-E | --encrypted) | (-N | --unencrypted)]
  11.     [(-i | --inherit) | (-I | --no-inherit)]
  12.     [(-l | --login) | (-L | --no-login)]
  13.     [-P | --pwprompt]
  14.     [(-r | --createrole) | (-R | --no-createrole)]
  15.     [(-s | --superuser) | -S | --no-superuser]

Description

createuser creates a new HAWQ role. You must be a superuser or have the CREATEROLE privilege to create new roles. You must connect to the database as a superuser to create new superusers.

Superusers can bypass all access permission checks within the database, so superuser privileges should not be granted lightly.

createuser is a wrapper around the SQL command CREATE ROLE.

Arguments

<role_name>

The name of the role to be created. This name must be different from all existing roles in this HAWQ installation.

Options

-e, —echo

Echo the commands that createuser generates and sends to the server.

<role_attribute_options>

-c, —connection-limit <number>

Set a maximum number of connections for the new role. The default is to set no limit.

-D, —no-createdb

The new role will not be allowed to create databases. This is the default.

-d, —createdb

The new role will be allowed to create databases.

-E, —encrypted

Encrypts the role’s password stored in the database. If not specified, the default password behavior is used.

-i, —inherit

The new role will automatically inherit privileges of roles it is a member of. This is the default.

-I, —no-inherit

The new role will not automatically inherit privileges of roles it is a member of.

-l, —login

The new role will be allowed to log in to HAWQ. This is the default.

-L, —no-login

The new role will not be allowed to log in (a group-level role).

-N, —unencrypted

Does not encrypt the role’s password stored in the database. If not specified, the default password behavior is used.

-P, —pwprompt

If given, createuser will issue a prompt for the password of the new role. This is not necessary if you do not plan on using password authentication.

-r, —createrole

The new role will be allowed to create new roles (CREATEROLE privilege).

-R, —no-createrole

The new role will not be allowed to create new roles. This is the default.

-s, —superuser

The new role will be a superuser.

-S, —no-superuser

The new role will not be a superuser. This is the default.

<connection_options>

-h, —host <host>

The host name of the machine on which the HAWQ master database server is running. If not specified, reads from the environment variable PGHOST or defaults to localhost.

-p, —port <port>

The TCP port on which the HAWQ master database server is listening for connections. If not specified, reads from the environment variable PGPORT or defaults to 5432.

-U, —username <username>

The database role name to connect as. If not specified, reads from the environment variable PGUSER or defaults to the current system role name.

-w, —no-password

Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass 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.

-W, —password

Force a password prompt.

Other Options

--help

Displays the online help.

--version

Displays the version of this utility.

Examples

Create a role named joe using the default options:

  1. $ createuser joe
  2. Shall the new role be a superuser? (y/n) n
  3. Shall the new role be allowed to create databases? (y/n) n
  4. Shall the new role be allowed to create more new roles? (y/n) n
  5. CREATE ROLE

To create the same role joe using connection options and avoiding the prompts and taking a look at the underlying command:

  1. $ createuser -h masterhost -p 54321 -S -D -R -e joe
  2. CREATE ROLE joe NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT 
  3. LOGIN;
  4. CREATE ROLE

To create the role joe as a superuser, and assign password admin123 immediately:

  1. $ createuser -P -s -e joe
  2. Enter password for new role: admin123
  3. Enter it again: admin123
  4. CREATE ROLE joe PASSWORD 'admin123' SUPERUSER CREATEDB 
  5. CREATEROLE INHERIT LOGIN;
  6. CREATE ROLE

In the above example, the new password is not actually echoed when typed, but we show what was typed for clarity. However the password will appear in the echoed command, as illustrated if the -e option is used.