GRANT

On this page

The GRANT statement controls each role or user's SQL privileges for interacting with specific databases, schemas, tables, or user-defined types. For privileges required by specific statements, see the documentation for the respective SQL statement.

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 ALL privilege:

Every user who is part of the admin role (including the root user).
Every user who is part of the owner role for the new database.

Note:

The GRANT statement performs a schema change. For more information about how online schema changes work in CockroachDB, see Online Schema Changes.

Syntax

Parameters

Parameter	Description
`ALL` `ALL PRIVILEGES`	Grant all privileges.
`privilege_list`	A comma-separated list of privileges to grant. For guidelines, see Managing privileges.
`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 user-defined types.
`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 user-defined functions in a schema or list of schemas.
`schema_name_list`	A comma-separated list of schemas.
`role_spec_list`	A comma-separated list of roles.
`WITH ADMIN OPTION`	Designate the user as a role admin. Role admins can grant or revoke 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
`ALL`	Database, Schema, Table, Sequence, Type
`CREATE`	Database, Schema, Table, Sequence
`DROP`	Database, Table, Sequence
`EXECUTE`	Function
`GRANT`	Database, Function, Schema, Table, Sequence, Type
`CONNECT`	Database
`SELECT`	Table, Sequence
`INSERT`	Table, Sequence
`DELETE`	Table, Sequence
`UPDATE`	Table, Sequence
`USAGE`	Function, Schema, Sequence, Type
`ZONECONFIG`	Database, Table, Sequence
`EXTERNALCONNECTION`	System
`BACKUP`	System, Database, Table
`RESTORE`	System, Database
`EXTERNALIOIMPLICITACCESS`	System
`MODIFYCLUSTERSETTING`	System
`VIEWACTIVITY`	System
`VIEWACTIVITYREDACTED`	System
`VIEWCLUSTERMETADATA`	System
`VIEWCLUSTERSETTING`	System
`VIEWDEBUG`	System
`CANCELQUERY`	System
`NOSQLLOGIN`	System

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 SQL statement.

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

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 MovR: A Global Vehicle-sharing App.

To follow along, run cockroach demo 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             | true
  movr          | max     | ALL             | true
  movr          | root    | ALL             | true
(3 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             | true
  movr          | public      | rides      | max     | DELETE          | false
  movr          | public      | rides      | root    | ALL             | true
(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                | demo    | 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                      | demo    | ALL            |      t
  movr          | public      | rides                      | max     | ALL            |      f
  movr          | public      | rides                      | max     | UPDATE         |      t
  movr          | public      | rides                      | root    | ALL            |      t
  movr          | public      | user_promo_codes           | admin   | ALL            |      t
  movr          | public      | user_promo_codes           | demo    | 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                      | demo    | 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 | demo    | 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                   | demo    | ALL            |      t
  movr          | public      | vehicles                   | max     | ALL            |      f
  movr          | public      | vehicles                   | public  | SELECT         |      f
  movr          | public      | vehicles                   | root    | ALL            |      t
(26 rows)

To ensure that anytime a new table is created, all the privileges on that table are granted to a user, use ALTER DEFAULT PRIVILEGES:

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

To check that this is working as expected, create a table:

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:

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  | demo    | ALL            |      t
  movr          | public      | usertable  | max     | ALL            |      f
  movr          | public      | usertable  | root    | ALL            |      t
(4 rows)

Grant system-level privileges on the entire cluster

System-level privileges live above the database level and apply to the entire cluster.

root and admin 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 maxroach to use the SET CLUSTER SETTING statement by assigning the MODIFYCLUSTERSETTING system privilege:

CREATE USER IF NOT EXISTS maxroach WITH PASSWORD 'setecastronomy';

GRANT SYSTEM MODIFYCLUSTERSETTING TO maxroach;

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             | true
  movr          | public      | vehicles   | max     | SELECT          | false
  movr          | public      | vehicles   | public  | SELECT          | false
  movr          | public      | vehicles   | root    | ALL             | true
(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             | true
  movr          | cockroach_labs | max     | ALL             | true
  movr          | cockroach_labs | root    | ALL             | true
(3 rows)

Grant privileges on user-defined types

CREATE TYPE IF NOT EXISTS status AS ENUM ('available', 'unavailable');

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             | true
  movr          | public      | status    | demo    | ALL             | false
  movr          | public      | status    | max     | ALL             | true
  movr          | public      | status    | public  | USAGE           | false
  movr          | public      | status    | root    | ALL             | true
(5 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 CONFIGURE ZONE 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  | is_grantable
------------+--------+-----------+-----------
  developer | abbey  |  false    | false
(1 row)

Grant the admin option

GRANT developer TO abbey WITH ADMIN OPTION;

SHOW GRANTS ON ROLE developer;

  role_name | member | is_admin  | is_grantable
------------+--------+-----------+-----------
  developer | abbey  |   true    | true
(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             | true
  movr          | public      | rides      | max     | UPDATE          | true
  movr          | public      | rides      | root    | ALL             | true
(3 rows)

Cockroach
University

Docs Hub

GRANT

Syntax

Parameters

Supported privileges

Required privileges

Details

Granting privileges

Granting roles

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

Cockroach University

Docs Hub

Cockroach University

Docs Hub

GRANT

Syntax

Parameters

Supported privileges

Required privileges

Details

Granting privileges

Granting roles

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

Cockroach
University

Cockroach
University