createuser
createuser — создать новую учётную запись Postgres Pro
Синтаксис
createuser [параметр-подключения...] [параметр...] [имя_пользователя]
Описание
createuser создаёт нового пользователя Postgres Pro, а если точнее — роль. Лишь суперпользователь и пользователи с привилегией CREATEROLE могут создавать новые роли, таким образом, createuser должна запускаться от их лица.
Чтобы создать роль с правом SUPERUSER, REPLICATION или BYPASSRLS, необходимо подключиться от имени существующего суперпользователя, одного лишь права CREATEROLE недостаточно. Поскольку суперпользователи могут обходить все ограничения доступа в базе данных, к назначению этих полномочий не следует относиться легкомысленно.
createuser — это обёртка для SQL-команды CREATE ROLE. Создание пользователей с её помощью по сути не отличается от выполнения того же действия при обращении к серверу другими способами.
Параметры
createuser принимает следующие аргументы:
имя_пользователяЗадаёт имя создаваемого пользователя Postgres Pro. Это имя должно отличаться от имён всех существующих ролей в данной инсталляции Postgres Pro.
-arole--with-admin=roleУказывает существующую роль, которая автоматически добавляется в качестве члена новой роли с правом
ADMIN OPTION, что позволяет ей выдавать членство в новой роли другим ролям. Можно указать несколько существующих ролей, добавив ключ-aнесколько раз.-cномер--connection-limit=номерУстанавливает максимальное допустимое количество соединений для создаваемого пользователя. По умолчанию ограничение в количестве соединений отсутствует.
-d--createdbРазрешает новому пользователю создавать базы данных.
-D--no-createdbЗапрещает новому пользователю создавать базы данных. Это поведение по умолчанию.
-e--echoВывести команды к серверу, генерируемые при выполнении createuser.
-E--encryptedПараметр является устаревшим, но в целях совместимости ещё работает.
-grole--member-of=role--role=(устаревший аргумент)рольУказывает, что новая роль должна быть автоматически добавлена в качестве члена указанной существующей группы. Можно указать несколько существующих ролей, добавив ключ
-gнесколько раз.-i--inheritСоздаваемая роль автоматически унаследует права ролей, в которые она включается. Это поведение по умолчанию.
-I--no-inheritРоль не будет наследовать права ролей, в которые она включается.
--interactiveЗапросить имя для создаваемого пользователя, а также значения для флагов
-d/-D,-r/-R,-s/-S, если они явно не указаны в командной строке. До версии PostgreSQL 9.1 включительно это было поведением по умолчанию.-l--loginНовый пользователь сможет подключаться к серверу (то есть его имя может быть идентификатором начального пользователя сеанса). Это свойство по умолчанию.
-L--no-loginНовый пользователь не сможет подключаться к серверу. (Роль без права входа на сервер тем не менее полезна для управления разрешениями в базе данных.)
-mrole--with-member=roleУказывает существующую роль, которая автоматически добавляется в качестве члена новой роли. Можно указать несколько существующих ролей, добавив ключ
-mнесколько раз.-P--pwpromptЕсли флаг указан, то createuser запросит пароль для создаваемого пользователя. Если не планируется аутентификация по паролю, то пароль можно не устанавливать.
-r--createroleНовый пользователь сможет создавать, изменять и удалять другие роли, добавлять для них комментарии и изменять метку безопасности (то есть этот пользователь будет иметь право
CREATEROLE). Подробнее возможности, предоставляемые этим правом, описаны в Создание роли.-R--no-createroleЗапрещает пользователю создавать новые роли. Это поведение по умолчанию.
-s--superuserСоздаваемая роль будет иметь права суперпользователя.
-S--no-superuserНовый пользователь не будет суперпользователем. Это поведение по умолчанию.
-vотметка_времени--valid-until=отметка_времениЗадаёт дату и время, после которого пароль роли перестаёт действовать. По умолчанию срок действия пароля будет неограниченным.
-V--versionВывести версию createuser и завершить выполнение.
--bypassrlsНовый пользователь не подчиняется никаким политикам защиты на уровне строк (RLS).
--no-bypassrlsНа нового пользователя распространяются политики защиты на уровне строк (RLS). Это поведение по умолчанию.
--profile=профильНовой роли будет назначен профиль, применяющий политику управления паролями. Все ограничения этого профиля будут применяться к роли.
--replicationСоздаваемый пользователь будет наделён правом
REPLICATION. Это рассмотрено подробнее в документации по CREATE ROLE.--no-replicationСоздаваемый пользователь не будет иметь привилегии
REPLICATION, что рассмотрено подробнее в документации по CREATE ROLE. Это поведение по умолчанию.-?--helpВывести помощь по команде createuser.
createuser также принимает из командной строки параметры подключения:
-hсервер--host=серверУказывает имя компьютера, на котором работает сервер. Если значение начинается с косой черты, оно определяет каталог Unix-сокета.
-pпорт--port=портУказывает TCP-порт или расширение файла локального Unix-сокета, через который сервер принимает подключения.
-Uимя_пользователя--username=имя_пользователяИмя пользователя для подключения (не имя создаваемого пользователя).
-w--no-passwordНе выдавать запрос на ввод пароля. Если сервер требует аутентификацию по паролю и пароль не доступен с помощью других средств, таких как файл
.pgpass, попытка соединения не удастся. Этот параметр может быть полезен в пакетных заданиях и скриптах, где нет пользователя, который вводит пароль.-W--passwordПринудительно запрашивать пароль перед подключением к базе данных.
Это несущественный параметр, так как createuser запрашивает пароль автоматически, если сервер проверяет подлинность по паролю. Однако чтобы понять это, createuser лишний раз подключается к серверу. Поэтому иногда имеет смысл ввести
-W, чтобы исключить эту ненужную попытку подключения.
Переменные окружения
PGHOSTPGPORTPGUSERПараметры подключения по умолчанию
PG_COLORВыбирает вариант использования цвета в диагностических сообщениях. Возможные значения:
always(всегда),auto(автоматически) иnever(никогда).
Эта утилита, как и большинство других утилит Postgres Pro, также использует переменные среды, поддерживаемые libpq (см. Раздел 33.15).
Диагностика
В случае возникновения трудностей, обратитесь к CREATE ROLE и psql. Переменные окружения и параметры подключения по умолчанию libpq будут применены при запуске утилиты, это следует учитывать при диагностике.
Примеры
Чтобы создать роль joe на сервере, используемом по умолчанию:
$createuser joe
Чтобы создать роль joe на сервере, используемом по умолчанию, с запросом дополнительных параметров:
$createuser --interactive joeНазначить роль суперпользователем? (y/n)nРазрешить новой роли создавать базы данных? (y/n)nРазрешить новой роли создавать другие роли? (y/n)n
Чтобы создать того же пользователя joe с явно заданными атрибутами, подключившись к компьютеру eden, порту 5000:
$createuser -h eden -p 5000 -S -D -R -e joeCREATE ROLE joe NOSUPERUSER NOCREATEDB NOCREATEROLE INHERIT LOGIN;
Чтобы создать роль joe с правами суперпользователя и предустановленным паролем:
$createuser -P -s -e joeВведите пароль для новой роли:xyzzyПовторите его:xyzzyCREATE ROLE joe PASSWORD 'SCRAM-SHA-256$4096:44560wPMLfjqiAzyPDZ/eQ==$4CA054rZlSFEq8Z3FEhToBTa2X6KnWFxFkPwIbKoDe0=:L/nbSZRCjp6RhOhKK56GoR1zibCCSePKshCJ9lnl3yw=' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN NOREPLICATION NOBYPASSRLS;
В приведённом примере введённый пароль отображается лишь для отражения сути, на деле же он не выводится на экран. Как можно видеть, он шифруется, прежде чем передаётся в команде клиенту.
См. также
dropuser, CREATE ROLE, createrole_self_grantcreateuser
createuser — define a new Postgres Pro user account
Synopsis
createuser [connection-option...] [option...] [username]
Description
createuser creates a new Postgres Pro 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 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 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 accepts the following command-line arguments:
usernameSpecifies the name of the Postgres Pro user to be created. This name must be different from all existing roles in this Postgres Pro installation.
-arole--with-admin=roleSpecifies 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
-aswitches.-cnumber--connection-limit=numberSet a maximum number of connections for the new user. The default is to set no limit.
-d--createdbThe new user will be allowed to create databases.
-D--no-createdbThe new user will not be allowed to create databases. This is the default.
-e--echoEcho the commands that createuser generates and sends to the server.
-E--encryptedThis option is obsolete but still accepted for backward compatibility.
-grole--member-of=role--role=(deprecated)roleSpecifies the new role should be automatically added as a member of the specified existing role. Multiple existing roles can be specified by writing multiple
-gswitches.-i--inheritThe new role will automatically inherit privileges of roles it is a member of. This is the default.
-I--no-inheritThe new role will not automatically inherit privileges of roles it is a member of.
--interactivePrompt 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/-Sis not specified on the command line. (This was the default behavior up to PostgreSQL 9.1.)-l--loginThe 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-loginThe new user will not be allowed to log in. (A role without login privilege is still useful as a means of managing database permissions.)
-mrole--with-member=roleSpecifies an existing role that will be automatically added as a member of the new role. Multiple existing roles can be specified by writing multiple
-mswitches.-P--pwpromptIf 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--createroleThe new user will be allowed to create, alter, drop, comment on, change the security label for other roles; that is, this user will have
CREATEROLEprivilege. See role creation for more details about what capabilities are conferred by this privilege.-R--no-createroleThe new user will not be allowed to create new roles. This is the default.
-s--superuserThe new user will be a superuser.
-S--no-superuserThe new user will not be a superuser. This is the default.
-vtimestamp--valid-until=timestampSet a date and time after which the role's password is no longer valid. The default is to set no password expiry date.
-V--versionPrint the createuser version and exit.
--bypassrlsThe new user will bypass every row-level security (RLS) policy.
--no-bypassrlsThe new user will not bypass row-level security (RLS) policies. This is the default.
--profile=profileThe new role will be assigned the profile that enforces password management policy. All restrictions of this profile will apply to the role.
--replicationThe new user will have the
REPLICATIONprivilege, which is described more fully in the documentation for CREATE ROLE.--no-replicationThe new user will not have the
REPLICATIONprivilege, which is described more fully in the documentation for CREATE ROLE. This is the default.-?--helpShow help about createuser command line arguments, and exit.
createuser also accepts the following command-line arguments for connection parameters:
-hhost--host=hostSpecifies 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.
-pport--port=portSpecifies the TCP port or local Unix domain socket file extension on which the server is listening for connections.
-Uusername--username=usernameUser name to connect as (not the user name to create).
-w--no-passwordNever issue a password prompt. If the server requires password authentication and a password is not available by other means such as a
.pgpassfile, 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--passwordForce 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
-Wto avoid the extra connection attempt.
Environment
PGHOSTPGPORTPGUSERDefault connection parameters
PG_COLORSpecifies whether to use color in diagnostic messages. Possible values are
always,autoandnever.
This utility, like most other Postgres Pro utilities, also uses the environment variables supported by libpq (see Section 33.15).
Diagnostics
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
To create a user joe on the default database server:
$createuser joe
To 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)n
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 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 'SCRAM-SHA-256$4096:44560wPMLfjqiAzyPDZ/eQ==$4CA054rZlSFEq8Z3FEhToBTa2X6KnWFxFkPwIbKoDe0=:L/nbSZRCjp6RhOhKK56GoR1zibCCSePKshCJ9lnl3yw=' SUPERUSER CREATEDB CREATEROLE INHERIT LOGIN NOREPLICATION NOBYPASSRLS;
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.
