Postgresql 中文操作指南

createuser

createuser — 定义新的 PostgreSQL 用户帐户

createuser — define a new PostgreSQL user account

Synopsis

createuser [ connection-option …​] [ option …​] [ username ]

createuser [connection-option…​] [option…​] [username]

Description

createuser 创建新的 PostgreSQL 用户（更准确地说，创建一个角色）。只有超级用户和具有 CREATEROLE 权限的用户可以创建新用户，因此 createuser 必须由可以连接为超级用户或具有 CREATEROLE 权限的用户调用。

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.

如果希望创建具有 SUPERUSER 、 REPLICATION 或 BYPASSRLS 权限的角色，则必须连接为超级用户，而不仅仅是具有 CREATEROLE 权限。成为超级用户意味着能够绕过数据库中的所有访问权限检查，因此不应轻易授予超级用户权限。 CREATEROLE 也传达 very extensive privileges 。

If you wish to create a role with the SUPERUSER, REPLICATION, or BYPASSRLS privilege, you must connect as a superuser, not merely with CREATEROLE privilege. Being a superuser implies the ability to bypass all access permission checks within the database, so superuser access should not be granted lightly. CREATEROLE also conveys very extensive privileges.

createuser 是 SQL 命令 CREATE ROLE 的包装器。通过此实用工具创建用户与通过其他方法访问服务器创建用户之间没有实际区别。

createuser is a wrapper around the SQL command CREATE ROLE. There is no effective difference between creating users via this utility and via other methods for accessing the server.

Options

createuser 接受以下命令行参数：

createuser accepts the following command-line arguments:

  • username

    • Specifies the name of the PostgreSQL user to be created. This name must be different from all existing roles in this PostgreSQL installation.

  • -a _role—​with-admin=_role

    • Specifies an existing role that will be automatically added as a member of the new role with admin option, giving it the right to grant membership in the new role to others. Multiple existing roles can be specified by writing multiple -a switches.

  • -c _number—​connection-limit=_number

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

  • -d_—​createdb_

    • The new user will be allowed to create databases.

  • -D_—​no-createdb_

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

  • -e_—​echo_

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

  • -E_—​encrypted_

    • This option is obsolete but still accepted for backward compatibility.

  • -g _role—​member-of=_role—​role=role__ (deprecated)

    • Specifies the new role should be automatically added as a member of the specified existing role. Multiple existing roles can be specified by writing multiple -g switches.

  • -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.

  • —​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, -s/-S is not specified on the command line. (This was the default behavior up to PostgreSQL 9.1.)

  • -l_—​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 the default.

  • -L_—​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 database permissions.)

  • -m _role—​with-member=_role

    • Specifies an existing role that will be automatically added as a member of the new role. Multiple existing roles can be specified by writing multiple -m switches.

  • -P_—​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 using password authentication.

  • -r_—​createrole_

    • The new user will be allowed to create, alter, drop, comment on, change the security label for other roles; that is, this user will have CREATEROLE privilege. See role creation for more details about what capabilities are conferred by this privilege.

  • -R_—​no-createrole_

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

  • -s_—​superuser_

    • The new user will be a superuser.

  • -S_—​no-superuser_

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

  • -v _timestamp—​valid-until=_timestamp

    • Set a date and time after which the role’s password is no longer valid. The default is to set no password expiry date.

  • -V_—​version_

    • Print the createuser version and exit.

  • —​bypassrls

    • The new user will bypass every row-level security (RLS) policy.

  • —​no-bypassrls

    • The new user will not bypass row-level security (RLS) policies. This is the default.

  • —​replication

    • The new user will have the REPLICATION privilege, which is described more fully in the documentation for CREATE ROLE.

  • —​no-replication

    • The new user will not have the REPLICATION privilege, which is described more fully in the documentation for CREATE ROLE. This is the default.

  • -?_—​help_

    • Show help about createuser command line arguments, and exit.

createuser 还接受以下用于连接参数的命令行参数：

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 the value begins with a slash, it is used as the directory for the Unix domain socket.

  • -p _port—​port=_port

    • Specifies the TCP 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 create).

  • -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 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 password authentication. However, createuser 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

    • Default connection parameters

  • PG_COLOR

    • Specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

此实用程序与大多数其他 PostgreSQL 实用程序一样，还使用 libpq 支持的环境变量（请参阅 Section 34.15 ）。

This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 34.15).

Diagnostics

遇到困难时，请参阅 CREATE ROLE 和 psql 了解潜在问题和错误消息的讨论。数据库服务器必须在目标主机上运行。此外，libpq 前端库使用的任何默认连接设置和环境变量都将适用。

In case of difficulty, see CREATE ROLE and psql 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

要在默认数据库服务器上创建用户 joe ：

To create a user joe on the default database server:

$ createuser joe

要在默认数据库服务器上创建一个用户 joe ，同时提示输入一些其他属性：

To create a user joe on the default database server with prompting for some additional attributes:

$ createuser --interactive joe
Shall the new role be a superuser? (y/n) n
Shall the new role be allowed to create databases? (y/n) n
Shall the new role be allowed to create more new roles? (y/n) n

要使用主机 eden 上的服务器和端口 5000、明确指定属性创建相同用户 joe ，查看基础命令：

To create the same user joe using the server on host eden, port 5000, with attributes explicitly specified, taking a look at the underlying command:

$ createuser -h eden -p 5000 -S -D -R -e joe
CREATE ROLE joe NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN;

要将用户 joe 创建为超级用户，并立即分配密码：

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

$ createuser -P -s -e joe
Enter password for new role: xyzzy
Enter it again: xyzzy
CREATE 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, the password is encrypted before it is sent to the client.

See Also

dropuser 、 CREATE ROLE 、 createrole_self_grant

dropuser, CREATE ROLE, createrole_self_grant