USE

Syntax

USE { DATABASE | ORGANIZATION | ROLE | SCHEMA | STORE } entity_name;

Description

This switches the current session’s Database, Organization, Role, Schema, or Store.

Arguments

entity_name

The name of an existing entity to set as the user’s current for the active session. Use SET DEFAULT to persist the change for new sessions. For case-sensitive names, the name must be wrapped in double quotes; otherwise, the lowercase name will be used.

When using a new Schema, a fully qualified Schema name can optionally be used to set the current Database and Schema.

Examples

Use a new Organization

In the following example, we have access to different Organizations, and we switch to the demo2 Organization in the current sessions from the test Organization:

<no-db>/<no-store># LIST ORGANIZATIONS;
+--------------------------------------+------------+-------------+-------------+--------------+--------------------+-------------------------------+
|  ID                                  |  Name      |  Is Current |  Is Default |  Description |  Profile Image Uri |  Created At                   |
+======================================+============+=============+=============+==============+====================+===============================+
| a2ab163c-a166-49b0-8282-10679479cd58 | test       | true        | true        | <null>       | <null>             | 2024-05-07 18:43:48 +0000 UTC |
+--------------------------------------+------------+-------------+-------------+--------------+--------------------+-------------------------------+
| 3736b067-e006-456d-96bf-3fb35b17bf91 | demo2      | false       | false       | <null>       | <null>             | 2024-05-07 18:43:58 +0000 UTC |
+--------------------------------------+------------+-------------+-------------+--------------+--------------------+-------------------------------+
<no-db>/<no-store># USE ORGANIZATION demo2;
+--------------+------------+------------+--------------------------+
|  Type        |  Name      |  Command   |  Summary                 |
+==============+============+============+==========================+
| organization | demo2      | USE        | using organization demo2 |
+--------------+------------+------------+--------------------------+
<no-db>/<no-store># LIST ORGANIZATIONS;
+--------------------------------------+------------+-------------+-------------+--------------+--------------------+-------------------------------+
|  ID                                  |  Name      |  Is Current |  Is Default |  Description |  Profile Image Uri |  Created At                   |
+======================================+============+=============+=============+==============+====================+===============================+
| a2ab163c-a166-49b0-8282-10679479cd58 | test       | false       | true        | <null>       | <null>             | 2024-05-07 18:43:48 +0000 UTC |
+--------------------------------------+------------+-------------+-------------+--------------+--------------------+-------------------------------+
| 3736b067-e006-456d-96bf-3fb35b17bf91 | demo2      | true        | false       | <null>       | <null>             | 2024-05-07 18:43:58 +0000 UTC |
+--------------------------------------+------------+-------------+-------------+--------------+--------------------+-------------------------------+

Use a new Database

In the following example, we are creating a new Database called demodb2 and using it. Note the Database in the command line prompt changing from demodb to demodb2:

demodb.public/demostore# CREATE DATABASE demodb2;
+------------+----------------+------------+------------------------------------------+
|  Type      |  Name          |  Command   |  Summary                                 |
+============+================+============+==========================================+
| database   | demodb2        | CREATE     | database demodb2 was successfully        |
|            |                |            | created                                  |
+------------+----------------+------------+------------------------------------------+
| schema     | demodb2.public | CREATE     | schema demodb2.public was successfully   |
|            |                |            | created                                  |
+------------+----------------+------------+------------------------------------------+
demodb.public/demostore# LIST DATABASES;
+------------+-------------+------------+-------------------------------+
|  Name      |  Is Default |  Owner     |  Created At                   |
+============+=============+============+===============================+
| demodb2    | false       | sysadmin   | 2024-05-07 18:23:24 +0000 UTC |
+------------+-------------+------------+-------------------------------+
| demodb     | true        | sysadmin   | 2024-05-07 18:19:38 +0000 UTC |
+------------+-------------+------------+-------------------------------+
demodb.public/demostore# USE DATABASE demodb2;
+------------+------------+------------+------------------------+
|  Type      |  Name      |  Command   |  Summary               |
+============+============+============+========================+
| database   | demodb2    | USE        | using database demodb2 |
+------------+------------+------------+------------------------+
demodb2.public/demostore#

Use a new Schema

In the following example, we are switching from the current public Schema to use a new Schema called newschema. Note how after the command is issued, the session's Schema changes from public to newschema:

demodb.public/demostore# LIST SCHEMAS;
+------------+-------------+------------+-------------------------------+
|  Name      |  Is Default |  Owner     |  Created At                   |
+============+=============+============+===============================+
| public     | true        | sysadmin   | 2024-05-07 18:19:38 +0000 UTC |
+------------+-------------+------------+-------------------------------+
| newschema  | false       | sysadmin   | 2024-05-07 18:20:03 +0000 UTC |
+------------+-------------+------------+-------------------------------+
demodb.public/demostore# USE SCHEMA newschema;
demodb.newschema/demostore#

Use a new Store

The following shows how msk Store is set as the current Store for the session to use:

demodb.public/demostore# LIST STORES;
+-------------+------------+----------------+------------+-------------+------------+-------------------------------+-------------------------------+
|  Name       |  Type      |  Access Region |  State     |  Is Default |  Owner     |  Created At                   |  Updated At                   |
+=============+============+================+============+=============+============+===============================+===============================+
| msk         | Kafka      | AWS us-east-1  | ready      | false       | sysadmin   | 2024-05-07 18:16:39 +0000 UTC | 2024-05-07 18:16:39 +0000 UTC |
+-------------+------------+----------------+------------+-------------+------------+-------------------------------+-------------------------------+
| demostore   | Kafka      | AWS us-east-1  | ready      | true        | sysadmin   | 2024-05-07 18:16:07 +0000 UTC | 2024-05-07 18:16:07 +0000 UTC |
+-------------+------------+----------------+------------+-------------+------------+-------------------------------+-------------------------------+
demodb.public/demostore# USE STORE msk;
+------------+------------+------------+-----------------+
|  Type      |  Name      |  Command   |  Summary        |
+============+============+============+=================+
| store      | msk        | USE        | Using store msk |
+------------+------------+------------+-----------------+
demodb.public/msk#

Use a new Role

The following example shows how the current Role can be update to useradmin to allow managing users and Roles in the current session:

demodb.public/demostore# USE ROLE useradmin;
+------------+------------+------------+------------------------+
|  Type      |  Name      |  Command   |  Summary               |
+============+============+============+========================+
| role       | useradmin  | USE        | using role "useradmin" |
+------------+------------+------------+------------------------+
demodb.public/demostore# LIST ROLES;
+---------------+-------------+-------------+-------------------------------+-------------------------------+
|  Name         |  Is Current |  Is Default |  Created At                   |  Updated At                   |
+===============+=============+=============+===============================+===============================+
| public        | false       | false       | 2024-05-07 18:07:22 +0000 UTC | 2024-05-07 18:07:22 +0000 UTC |
+---------------+-------------+-------------+-------------------------------+-------------------------------+
| orgadmin      | false       | false       | 2024-05-07 18:07:22 +0000 UTC | 2024-05-07 18:07:22 +0000 UTC |
+---------------+-------------+-------------+-------------------------------+-------------------------------+
| securityadmin | false       | false       | 2024-05-07 18:07:22 +0000 UTC | 2024-05-07 18:07:22 +0000 UTC |
+---------------+-------------+-------------+-------------------------------+-------------------------------+
| useradmin     | true        | false       | 2024-05-07 18:07:22 +0000 UTC | 2024-05-07 18:07:22 +0000 UTC |
+---------------+-------------+-------------+-------------------------------+-------------------------------+
| sysadmin      | false       | true        | 2024-05-07 18:07:22 +0000 UTC | 2024-05-07 18:07:22 +0000 UTC |
+---------------+-------------+-------------+-------------------------------+-------------------------------+