GRANT - CockroachDB

The GRANT controls each for interacting with specific , , , or . For privileges required by specific statements, see the documentation for the respective . You can use GRANT to directly grant privileges to a role or user, or you can grant membership to an existing role, which grants that role’s privileges to the grantee. Users granted a privilege with WITH GRANT OPTION can in turn grant that privilege to others. The owner of an object implicitly has the GRANT OPTION for all privileges, and the GRANT OPTION is inherited through role memberships. For new databases, users with the following roles are automatically granted the :

Every user who is part of (including ).
Every user who is part of for the new database.

The “ statement performs a schema change. For more information about how online schema changes work in CockroachDB, see .

Syntax

Parameters

Parameter	Description
`ALL` `ALL PRIVILEGES`	Grant all privileges.
`privilege_list`	A comma-separated list of privileges to grant. For guidelines, see .
`grant_targets`	A comma-separated list of database, table, sequence, or function names. The list should be preceded by the object type (e.g., `DATABASE mydatabase`). If the object type is not specified, all names are interpreted as table or sequence names.
`target_types`	A comma-separated list of .
`ALL SEQUENCES IN SCHEMA`	Grant privileges on all sequences in a schema or list of schemas.
`ALL TABLES IN SCHEMA`	Grant privileges on all tables and sequences in a schema or list of schemas.
`ALL FUNCTIONS IN SCHEMA`	Grant privileges on all in a schema or list of schemas.
`schema_name_list`	A comma-separated list of .
`role_spec_list`	A comma-separated list of .
`WITH ADMIN OPTION`	Designate the user as a role admin. Role admins can grant or membership for the specified role.
`WITH GRANT OPTION`	Allow the user to grant the specified privilege to others.

Supported privileges

Roles and users can be granted the following privileges:

Privilege	Levels	Description
`ALL`	System, Database, Schema, Table, Sequence, Type	For the object to which `ALL` is applied, grants all privileges at the system, database, schema, table, sequence, or type level.
`BACKUP`	System, Database, Table	Grants the ability to create at the system, database, or table level.
`CANCELQUERY`	System	Grants the ability to cancel queries.
`CHANGEFEED`	Table	Grants the ability to create on a table.
`CONNECT`	Database	Grants the ability to view a database’s metadata, which consists of objects in a database’s `information_schema` and `pg_catalog` system catalogs. This allows the role to view the database’s table, schemas, user-defined types, and list the database when running `SHOW DATABASES`. The `CONNECT` privilege is also required to run backups of the database.
`CONTROLJOB`	System	Grants the ability to , , and jobs. Non-admin roles cannot control jobs created by admin roles.
`CREATE`	Database, Schema, Table, Sequence	Grants the ability to create objects at the database, schema, table, or sequence level. When applied at the database level, grants the ability to configure .
`CREATEDB`	System	Grants the ability to or a database.
`CREATELOGIN`	System	Grants the ability to manage authentication using the `WITH PASSWORD`, `VALID UNTIL`, and `LOGIN`/`NOLOGIN` role options.
`CREATEROLE`	System	Grants the ability to , modify, or non-admin roles.
`DELETE`	Table, Sequence	Grants the ability to delete objects at the table or sequence level.
`DROP`	Database, Table, Sequence	Grants the ability to drop objects at the database, table, or sequence level.
`EXECUTE`	Function	Grants the ability to execute .
`EXTERNALCONNECTION`	System	Grants the ability to connect to external systems such as object stores, key management systems, Kafka feeds, or external file systems. Often used in conjunction with the `BACKUP`, `RESTORE`, and `CHANGEFEED` privilege.
`EXTERNALIOIMPLICITACCESS`	System	Grants the ability to interact with external resources that require implicit access.
`INSERT`	Table, Sequence	Grants the ability to insert objects at the table or sequence level.
`MODIFYCLUSTERSETTING`	System	Grants the ability to modify .
`MODIFYSQLCLUSTERSETTING`	System	Grants the ability to modify SQL (cluster settings prefixed with `sql.`).
`NOSQLLOGIN`	System	Prevents roles from connecting to the SQL interface of a cluster.
`RESTORE`	System, Database	Grants the ability to restore at the system or database level. Refer to `RESTORE` for more details.
`SELECT`	Table, Sequence	Grants the ability to run at the table or sequence level.
`UPDATE`	Table, Sequence	Grants the ability to run at the table or sequence level.
`USAGE`	Schema, Sequence, Type	Grants the ability to use , , or .
`VIEWACTIVITY`	System	Grants the ability to view other user’s activity statistics of a cluster.
`VIEWACTIVITYREDACTED`	System	Grants the ability to view other user’s activity statistics, but prevents the role from accessing the statement diagnostics bundle in the DB Console, and viewing some columns in introspection queries that contain data about the cluster.
`VIEWCLUSTERMETADATA`	System	Grants the ability to view range information, data distribution, store information, and Raft information.
`VIEWCLUSTERSETTING`	System	Grants the ability to view and their values.
`VIEWDEBUG`	System	Grants the ability to view the of the DB Console and work with the debugging and profiling endpoints.
`VIEWJOB`	System	Grants the ability to view on the cluster.
`VIEWSYSTEMTABLE`	System	Grants read-only access (`SELECT`) on all tables in the `system` database, without granting the ability to modify the cluster. This privilege was introduced in v23.1.11.
`ZONECONFIG`	Database, Table, Sequence	Grants the ability to configure at the database, table, and sequence level.

Required privileges

To grant privileges, the user granting the privileges must also have the privilege being granted on the target database or tables. For example, a user granting the SELECT privilege on a table to another user must have the SELECT privileges on that table and WITH GRANT OPTION on SELECT.
To grant roles, the user granting role membership must be a role admin (i.e., members with the WITH ADMIN OPTION) or a member of the admin role. To grant membership to the admin role, the user must have WITH ADMIN OPTION on the admin role.

Details

Granting privileges

When a role or user is granted privileges for a table, the privileges are limited to the table. The user does not automatically get privileges to new or existing tables in the database. To grant privileges to a user on all new and/or existing tables in a database, see Grant privileges on all tables in a database. For privileges required by specific statements, see the documentation for the respective .

Granting roles

Users and roles can be members of roles.
The root user is automatically created as an admin role and assigned the ALL privilege for new databases.
All privileges of a role are inherited by all its members.
Membership loops are not allowed (direct: A is a member of B is a member of A or indirect: A is a member of B is a member of C ... is a member of A).

Limitations

User/role management operations (such as and ) are . As such, they inherit the . For example, schema changes wait for concurrent using the same resources as the schema changes to complete. In the case of being modified inside a transaction, most transactions need access to the set of role memberships. Using the default settings, role modifications require schema leases to expire, which can take up to 5 minutes. This means that elsewhere in the system can cause user/role management operations inside transactions to take several minutes to complete. This can have a cascading effect. When a user/role management operation inside a transaction takes a long time to complete, it can in turn block all user-initiated transactions being run by your application, since the user/role management operation in the transaction has to commit before any other transactions that access role memberships (i.e., most transactions) can make progress. If you want user/role management operations to finish more quickly, and do not care whether concurrent transactions will immediately see the side effects of those operations, set the allow_role_memberships_to_change_during_transaction to true. When this session variable is enabled, any user/role management operations issued in the current session will only need to wait for the completion of statements in other sessions where allow_role_memberships_to_change_during_transaction is not enabled. To accelerate user/role management operations across your entire application, you have the following options:

Set the session variable in all sessions by .
Apply the allow_role_memberships_to_change_during_transaction setting globally to an entire cluster using the statement:
ALTER ROLE ALL SET allow_role_memberships_to_change_during_transaction = true;

Examples

Setup

The following examples use MovR, a fictional vehicle-sharing application, to demonstrate CockroachDB SQL statements. For more information about the MovR example application and dataset, see . To follow along, run to start a temporary, in-memory cluster with the movr dataset preloaded:

$ cockroach demo

Grant privileges on databases

CREATE USER IF NOT EXISTS max WITH PASSWORD 'roach';

GRANT ALL ON DATABASE movr TO max WITH GRANT OPTION;

SHOW GRANTS ON DATABASE movr;

  database_name | grantee | privilege_type | is_grantable
----------------+---------+----------------+---------------
  movr          | admin   | ALL            |      t
  movr          | max     | ALL            |      t
  movr          | public  | CONNECT        |      f
  movr          | root    | ALL            |      t
(4 rows)

Grant privileges on specific tables in a database

GRANT DELETE ON TABLE rides TO max;

SHOW GRANTS ON TABLE rides;

  database_name | schema_name | table_name | grantee | privilege_type | is_grantable
----------------+-------------+------------+---------+----------------+---------------
  movr          | public      | rides      | admin   | ALL            |      t
  movr          | public      | rides      | max     | DELETE         |      f
  movr          | public      | rides      | root    | ALL            |      t
(3 rows)

Grant privileges on all tables in a database or schema

To grant all the privileges on existing tables to a user:

GRANT ALL ON * TO max;

SHOW GRANTS ON TABLE movr.public.*;

  database_name | schema_name |         table_name         | grantee | privilege_type | is_grantable
----------------+-------------+----------------------------+---------+----------------+---------------
  movr          | public      | promo_codes                | admin   | ALL            |      t
  movr          | public      | promo_codes                | max     | ALL            |      f
  movr          | public      | promo_codes                | root    | ALL            |      t
  movr          | public      | rides                      | admin   | ALL            |      t
  movr          | public      | rides                      | max     | ALL            |      f
  movr          | public      | rides                      | root    | ALL            |      t
  movr          | public      | user_promo_codes           | admin   | ALL            |      t
  movr          | public      | user_promo_codes           | max     | ALL            |      f
  movr          | public      | user_promo_codes           | root    | ALL            |      t
  movr          | public      | users                      | admin   | ALL            |      t
  movr          | public      | users                      | max     | ALL            |      f
  movr          | public      | users                      | root    | ALL            |      t
  movr          | public      | vehicle_location_histories | admin   | ALL            |      t
  movr          | public      | vehicle_location_histories | max     | ALL            |      f
  movr          | public      | vehicle_location_histories | root    | ALL            |      t
  movr          | public      | vehicles                   | admin   | ALL            |      t
  movr          | public      | vehicles                   | max     | ALL            |      f
  movr          | public      | vehicles                   | root    | ALL            |      t
(18 rows)

To ensure that any time a new table is created, all the privileges on that table are granted to a user, use :

ALTER DEFAULT PRIVILEGES FOR ALL ROLES GRANT ALL ON TABLES TO max;

To check that this is working as expected, :

CREATE TABLE IF NOT EXISTS usertable(x INT);

Then, check that the all privileges on the newly created table are granted to the user you specified using :

SHOW GRANTS ON TABLE usertable;

  database_name | schema_name | table_name | grantee | privilege_type | is_grantable
----------------+-------------+------------+---------+----------------+---------------
  movr          | public      | usertable  | admin   | ALL            |      t
  movr          | public      | usertable  | max     | ALL            |      f
  movr          | public      | usertable  | root    | ALL            |      t
(3 rows)

Grant system-level privileges on the entire cluster

live above the database level and apply to the entire cluster. root and users have system-level privileges by default, and are capable of granting it to other users and roles using the GRANT statement. For example, the following statement allows the user max (created in a previous example) to use the statement by assigning the MODIFYCLUSTERSETTING system privilege:

GRANT SYSTEM MODIFYCLUSTERSETTING TO max;

Make a table readable to every user in the system

GRANT SELECT ON TABLE vehicles TO public;

SHOW GRANTS ON TABLE vehicles;

  database_name | schema_name | table_name | grantee | privilege_type | is_grantable
----------------+-------------+------------+---------+----------------+---------------
  movr          | public      | vehicles   | admin   | ALL            |      t
  movr          | public      | vehicles   | max     | ALL            |      f
  movr          | public      | vehicles   | public  | SELECT         |      f
  movr          | public      | vehicles   | root    | ALL            |      t
(4 rows)

Grant privileges on schemas

CREATE SCHEMA IF NOT EXISTS cockroach_labs;

GRANT ALL ON SCHEMA cockroach_labs TO max WITH GRANT OPTION;

SHOW GRANTS ON SCHEMA cockroach_labs;

  database_name |  schema_name   | grantee | privilege_type | is_grantable
----------------+----------------+---------+----------------+---------------
  movr          | cockroach_labs | admin   | ALL            |      t
  movr          | cockroach_labs | max     | ALL            |      t
  movr          | cockroach_labs | root    | ALL            |      t
(3 rows)

Grant privileges on user-defined types

To grant privileges on , use the following statements.

CREATE TYPE IF NOT EXISTS status AS ENUM ('open', 'closed', 'inactive');

GRANT ALL ON TYPE status TO max WITH GRANT OPTION;

SHOW GRANTS ON TYPE status;

  database_name | schema_name | type_name | grantee | privilege_type | is_grantable
----------------+-------------+-----------+---------+----------------+---------------
  movr          | public      | status    | admin   | ALL            |      t
  movr          | public      | status    | max     | ALL            |      t
  movr          | public      | status    | public  | USAGE          |      f
  movr          | public      | status    | root    | ALL            |      t
(4 rows)

Grant the privilege to manage the replication zones for a database or table

GRANT ZONECONFIG ON TABLE rides TO max;

The user max can then use the statement to add, modify, reset, or remove replication zones for the table rides.

Grant role membership

CREATE ROLE IF NOT EXISTS developer WITH CREATEDB;

CREATE USER IF NOT EXISTS abbey WITH PASSWORD 'lincoln';

GRANT developer TO abbey;

SHOW GRANTS ON ROLE developer;

  role_name | member | is_admin
------------+--------+-----------
  developer | abbey  |    f
(1 row)

Grant the admin option

GRANT developer TO abbey WITH ADMIN OPTION;

SHOW GRANTS ON ROLE developer;

  role_name | member | is_admin
------------+--------+-----------
  developer | abbey  |    t
(1 row)

Grant privileges with the option to grant to others

GRANT UPDATE ON TABLE rides TO max WITH GRANT OPTION;

SHOW GRANTS ON TABLE rides;

  database_name | schema_name | table_name | grantee | privilege_type | is_grantable
----------------+-------------+------------+---------+----------------+---------------
  movr          | public      | rides      | admin   | ALL            |      t
  movr          | public      | rides      | max     | ALL            |      f
  movr          | public      | rides      | max     | UPDATE         |      t
  movr          | public      | rides      | root    | ALL            |      t
(4 rows)

​Syntax

​Parameters

​Supported privileges

​Required privileges

​Details

​Granting privileges

​Granting roles

​Limitations

​Examples

​Setup

​Grant privileges on databases

​Grant privileges on specific tables in a database

​Grant privileges on all tables in a database or schema

​Grant system-level privileges on the entire cluster

​Make a table readable to every user in the system

​Grant privileges on schemas

​Grant privileges on user-defined types

​Grant the privilege to manage the replication zones for a database or table

​Grant role membership

​Grant the admin option

​Grant privileges with the option to grant to others

​See also

Syntax

Parameters

Supported privileges

Required privileges

Details

Granting privileges

Granting roles

Limitations

Examples

Setup

Grant privileges on databases

Grant privileges on specific tables in a database

Grant privileges on all tables in a database or schema

Grant system-level privileges on the entire cluster

Make a table readable to every user in the system

Grant privileges on schemas

Grant privileges on user-defined types

Grant the privilege to manage the replication zones for a database or table

Grant role membership

Grant the admin option

Grant privileges with the option to grant to others

See also