The CREATE USER statement creates SQL users, which let you control privileges on your databases and tables.
The CREATE USER statement performs a schema change. For more information about how online schema changes work in CockroachDB, see Online Schema Changes.
The keywords ROLE and USER can be used interchangeably in SQL statements for enhanced PostgreSQL compatibility.
CREATE USER is equivalent to the statement CREATE ROLE, with one exception: CREATE ROLE sets the NOLOGIN option by default, preventing the new role from being used to log in to the database. You can use CREATE ROLE and specify the LOGIN option to achieve the same result as CREATE USER.
Considerations
- Usernames:
- Are case-insensitive
- Must start with a letter or underscore.
- Must contain only letters, numbers, periods, or underscores
- Must be between 1 and 63 characters.
- Cannot be
none. - Cannot start with
pg_orcrdb_internal. Object names with these prefixes are reserved for system catalogs.
- After creating users, you must grant them privileges to databases and tables.
- All users belong to the
publicrole, to which you can grant and revoke privileges. - On secure clusters, you must create client certificates for users and users must authenticate their access to the cluster.
Required privileges
To create other users, the user must be a member of the admin role or have the CREATEROLE parameter set.
Synopsis
Parameters
| Parameter | Description |
|---|---|
name |
The name of the user you want to create. Usernames are case-insensitive; must start with a letter or underscore; must contain only letters, numbers, or underscores; and must be between 1 and 63 characters. |
WITH role_option |
Apply a role option to the role. |
Role options
| Role option | Description |
|---|---|
CANCELQUERY/NOCANCELQUERY |
Allow or disallow a user to cancel queries and sessions of other users. Without this role option, users can only cancel their own queries and sessions. Even with the CANCELQUERY role option, non-admin users cannot cancel admin queries or sessions. This option should usually be combined with VIEWACTIVITY so that the user can view other users' query and session information. By default, the role option is set to NOCANCELQUERY for all non-admin users. |
CONTROLCHANGEFEED/NOCONTROLCHANGEFEED |
Allow or disallow a user to run CREATE CHANGEFEED on tables they have SELECT privileges on. By default, the role option is set to NOCONTROLCHANGEFEED for all non-admin users. |
CONTROLJOB/NOCONTROLJOB |
Allow or disallow a user to pause, resume, and cancel jobs. Non-admin users cannot control jobs created by admin users. By default, the role option is set to NOCONTROLJOB for all non-admin users. |
CREATEDB/NOCREATEDB |
Allow or disallow a user to create or rename a database. The user is assigned as the owner of the database. By default, the role option is set to NOCREATEDB for all non-admin users. |
CREATELOGIN/NOCREATELOGIN |
Allow or disallow a user to manage authentication using the WITH PASSWORD, VALID UNTIL, and LOGIN/NOLOGIN role options. By default, the role option is set to NOCREATELOGIN for all non-admin users. |
CREATEROLE/NOCREATEROLE |
Allow or disallow a new user to create, alter, and drop other non-admin users. By default, the role option is set to NOCREATEROLE for all non-admin users. |
LOGIN/NOLOGIN |
Allow or disallow a user to log in with one of the client authentication methods. Setting the role option to NOLOGIN prevents the user from logging in using any authentication method. |
MODIFYCLUSTERSETTING/NOMODIFYCLUSTERSETTING |
Allow or disallow a user to modify the cluster settings with the sql.defaults prefix. By default, the role option is set to NOMODIFYCLUSTERSETTING for all non-admin users. |
PASSWORD password/PASSWORD NULL |
The credential the user uses to authenticate their access to a secure cluster. A password should be entered as a string literal. For compatibility with PostgreSQL, a password can also be entered as an identifier. To prevent a user from using password authentication and to mandate certificate-based client authentication, set the password as NULL. |
SQLLOGIN/NOSQLLOGIN |
Allow or disallow a user to log in using the SQL CLI with one of the client authentication methods. The role option to NOSQLLOGIN prevents the user from logging in using the SQL CLI with any authentication method while retaining the ability to log in to DB Console. It is possible to have both NOSQLLOGIN and LOGIN set for a user and NOSQLLOGIN takes precedence on restrictions. Without any role options all login behavior is permitted. |
VALID UNTIL |
The date and time (in the timestamp format) after which the password is not valid. |
VIEWACTIVITY/NOVIEWACTIVITY |
Allow or disallow a user to see other users' queries and sessions using SHOW STATEMENTS, SHOW SESSIONS, and the Statements and Transactions pages in the DB Console. VIEWACTIVITY also permits visibility of node hostnames and IP addresses in the DB Console. With NOVIEWACTIVITY, the SHOW commands show only the user's own data, and DB Console pages redact node hostnames and IP addresses.By default, the role option is set to NOVIEWACTIVITY for all non-admin users. |
VIEWCLUSTERSETTING / NOVIEWCLUSTERSETTING |
Allow or disallow a user to view the cluster settings with SHOW CLUSTER SETTING or to access the Cluster Settings page in the DB Console. By default, the role option is set to NOVIEWCLUSTERSETTING for all non-admin users. |
VIEWACTIVITYREDACTED/NOVIEWACTIVITYREDACTED |
Allow or disallow a user to see other users' queries and sessions using SHOW STATEMENTS, SHOW SESSIONS, and the Statements and Transactions pages in the DB Console. With VIEWACTIVITYREDACTED, a user will not have access to the usage of statements diagnostics bundle (which can contain PII information) in the DB Console, and will not be able to list queries containing constants for other users when using the listSessions endpoint through the Cluster API. It is possible to have both VIEWACTIVITY and VIEWACTIVITYREDACTED, and VIEWACTIVITYREDACTED takes precedence on restrictions. If the user has VIEWACTIVITY but doesn't have VIEWACTIVITYREDACTED, they will be able to see DB Console pages and have access to the statements diagnostics bundle. By default, the role option is set to NOVIEWACTIVITYREDACTED for all non-admin users. |
User authentication
Secure clusters require users to authenticate their access to databases and tables. CockroachDB offers three methods for this:
Client certificate and key authentication, which is available to all users. To ensure the highest level of security, we recommend only using client certificate and key authentication.
Password authentication, which is available to users and roles who you've created passwords for. To create a user with a password, use the
WITH PASSWORDclause ofCREATE USER. To add a password to an existing user, use theALTER USERstatement.Users can use passwords to authenticate without supplying client certificates and keys; however, we recommend using certificate-based authentication whenever possible.
Password creation is supported only in secure clusters.
GSSAPI authentication, which is available to Enterprise users.
Examples
To run the following examples, start a secure single-node cluster and use the built-in SQL shell:
$ cockroach sql --certs-dir=certs
> SHOW USERS;
username | options | member_of
---------+---------+------------
admin | | {}
root | | {admin}
(2 rows)
The following statements are run by the root user that is a member of the admin role and has ALL privileges.
Create a user
Usernames are case-insensitive; must start with a letter or underscore; must contain only letters, numbers, periods, or underscores; and must be between 1 and 63 characters.
root@:26257/defaultdb> CREATE USER no_options;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
-------------+---------+------------
admin | | {}
no_options | | {}
root | | {admin}
(3 rows)
After creating users, you must:
- Grant them privileges to databases.
- For secure clusters, you must also create their client certificates.
Create a user with a password
root@:26257/defaultdb> CREATE USER with_password WITH LOGIN PASSWORD '$tr0nGpassW0rD' VALID UNTIL '2021-10-10';
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
--------------+---------------------------------------+------------
admin | | {}
no_options | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(4 rows)
Prevent a user from using password authentication
The following statement prevents the user from using password authentication and mandates certificate-based client authentication:
root@:26257/defaultdb> CREATE USER no_password WITH PASSWORD NULL;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
--------------+---------------------------------------+------------
admin | | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(5 rows)
Create a user that can create other users and manage authentication methods for the new users
The following example allows the user to create other users and manage authentication methods for them:
root@:26257/defaultdb> CREATE USER can_create_users WITH CREATEROLE CREATELOGIN;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
-----------------+---------------------------------------+------------
admin | | {}
can_create_users | CREATELOGIN, CREATEROLE | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(6 rows)
Create a user that can create and rename databases
The following example allows the user to create or rename databases:
root@:26257/defaultdb> CREATE USER can_create_db WITH CREATEDB;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
----------------------+---------------------------------------+------------
admin | | {}
can_create_db | CREATEDB | {}
can_create_users | CREATELOGIN, CREATEROLE | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(7 rows)
Create a user that can pause, resume, and cancel non-admin jobs
The following example allows the user to cancel queries and sessions for other non-admin roles:
The following example allows the user to pause, resume, and cancel jobs:
root@:26257/defaultdb> CREATE USER can_control_job WITH CONTROLJOB;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
----------------------+---------------------------------------+------------
admin | | {}
can_control_job | CONTROLJOB | {}
can_create_db | CREATEDB | {}
can_create_users | CREATELOGIN, CREATEROLE | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(8 rows)
Create a user that can see and cancel non-admin queries and sessions
The following example allows the user to cancel queries and sessions for other non-admin roles:
root@:26257/defaultdb> CREATE USER can_manage_queries WITH CANCELQUERY VIEWACTIVITY;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
----------------------+---------------------------------------+------------
admin | | {}
can_control_job | CONTROLJOB | {}
can_create_db | CREATEDB | {}
can_create_users | CREATELOGIN, CREATEROLE | {}
can_manage_queries | CANCELQUERY, VIEWACTIVITY | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(9 rows)
Create a user that can control changefeeds
The following example allows the user to run CREATE CHANGEFEED:
root@:26257/defaultdb> CREATE USER can_control_changefeed WITH CONTROLCHANGEFEED;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
-----------------------+---------------------------------------+------------
admin | | {}
can_control_changefeed | CONTROLCHANGEFEED | {}
can_control_job | CONTROLJOB | {}
can_create_db | CREATEDB | {}
can_create_users | CREATELOGIN, CREATEROLE | {}
can_manage_queries | CANCELQUERY, VIEWACTIVITY | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(10 rows)
Create a user that can modify cluster settings
The following example allows the user to modify cluster settings:
root@:26257/defaultdb> CREATE USER can_modify_cluster_setting WITH MODIFYCLUSTERSETTING;
root@:26257/defaultdb> SHOW USERS;
username | options | member_of
---------------------------+---------------------------------------+------------
admin | | {}
can_control_changefeed | CONTROLCHANGEFEED | {}
can_control_job | CONTROLJOB | {}
can_create_db | CREATEDB | {}
can_create_users | CREATELOGIN, CREATEROLE | {}
can_manage_queries | CANCELQUERY, VIEWACTIVITY | {}
can_modify_cluster_setting | MODIFYCLUSTERSETTING | {}
no_options | | {}
no_password | | {}
root | | {admin}
with_password | VALID UNTIL=2021-10-10 00:00:00+00:00 | {}
(11 rows)
See also
- Authorization
ALTER USERDROP USERSHOW USERSGRANTSHOW GRANTS- Create Security Certificates
- SQL Statements
- Online Schema Changes
Was this helpful?
