-
Notifications
You must be signed in to change notification settings - Fork 464
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bf9913d
commit 4a7cc46
Showing
13 changed files
with
773 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| --- | ||
| title: ALTER SCHEMA | ||
| summary: The ALTER SCHEMA statement modifies a user-defined schema in a database. | ||
| toc: true | ||
| --- | ||
|
|
||
| <span class="version-tag">New in v20.2:</span> The `ALTER SCHEMA` [statement](sql-statements.html) modifies a user-defined [schema](sql-name-resolution.html#logical-schemas-and-namespaces). CockroachDB currently supports changing the name of the schema and the owner of the schema. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ~~~ | ||
| ALTER SCHEMA ... RENAME TO <newschemaname> | ||
| ALTER SCHEMA ... OWNER TO {<newowner> | CURRENT_USER | SESSION_USER } | ||
| ~~~ | ||
|
|
||
| ### Parameters | ||
|
|
||
| Parameter | Description | ||
| ----------|------------ | ||
| `RENAME TO ...` | Rename the schema. | ||
| `OWNER TO ...` | Change the owner of the schema. You can specify the new owner with a string literal or the [`CURRENT_USER` or `SESSION_USER` keywords](functions-and-operators.html#special-syntax-forms). | ||
|
|
||
| ## Required privileges | ||
|
|
||
| - To rename a schema, the user must be the owner of the schema. | ||
| - To change the owner of a schema, the user must be the current owner of the schema and a member of the new owner [role](authorization.html#roles). The new owner role must also have the `CREATE` [privilege](authorization.html#assign-privileges) on the database to which the schema belongs. | ||
|
|
||
| ## Example | ||
|
|
||
| ### Rename a schema | ||
|
|
||
| Suppose that you access the [SQL shell](cockroach-sql.html) as user `root`, and [create a new user](create-user.html) `max` and [a schema](create-schema.html) `org_one` with `max` as the owner: | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > CREATE USER max; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > CREATE SCHEMA org_one AUTHORIZATION max; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW SCHEMAS; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| schema_name | ||
| ---------------------- | ||
| crdb_internal | ||
| information_schema | ||
| org_one | ||
| pg_catalog | ||
| pg_extension | ||
| public | ||
| (6 rows) | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SELECT | ||
| nspname, usename | ||
| FROM | ||
| pg_catalog.pg_namespace | ||
| LEFT JOIN pg_catalog.pg_user ON pg_namespace.nspowner = pg_user.usesysid | ||
| WHERE | ||
| nspname LIKE 'org_one'; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| nspname | usename | ||
| ----------+---------- | ||
| org_one | max | ||
| (1 row) | ||
| ~~~ | ||
|
|
||
| Now, suppose you want to rename the schema: | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > ALTER SCHEMA org_one RENAME TO org_two; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| ERROR: must be owner of schema "org_one" | ||
| SQLSTATE: 42501 | ||
| ~~~ | ||
|
|
||
| Because you are executing the `ALTER SCHEMA` command as a non-owner of the schema (i.e., `root`), CockroachDB returns an error. | ||
|
|
||
| [Drop the schema](drop-schema.html) and create it again, this time with with `root` as the owner. | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > DROP SCHEMA org_one; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > CREATE SCHEMA org_one; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SELECT | ||
| nspname, usename | ||
| FROM | ||
| pg_catalog.pg_namespace | ||
| LEFT JOIN pg_catalog.pg_user ON pg_namespace.nspowner = pg_user.usesysid | ||
| WHERE | ||
| nspname LIKE 'org_one'; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| nspname | usename | ||
| ----------+---------- | ||
| org_one | root | ||
| (1 row) | ||
| ~~~ | ||
|
|
||
| Rename the schema as its owner: | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > ALTER SCHEMA org_one RENAME TO org_two; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SHOW SCHEMAS; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| schema_name | ||
| ---------------------- | ||
| crdb_internal | ||
| information_schema | ||
| org_two | ||
| pg_catalog | ||
| pg_extension | ||
| public | ||
| (6 rows) | ||
| ~~~ | ||
|
|
||
| ### Change a schema's owner | ||
|
|
||
| Suppose that you access the [SQL shell](cockroach-sql.html) as user `root`, and [create a new schema](create-schema.html) named `org_one`: | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > CREATE SCHEMA org_one; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SELECT | ||
| nspname, usename | ||
| FROM | ||
| pg_catalog.pg_namespace | ||
| LEFT JOIN pg_catalog.pg_user ON pg_namespace.nspowner = pg_user.usesysid | ||
| WHERE | ||
| nspname LIKE 'org_one'; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| nspname | usename | ||
| ----------+---------- | ||
| org_one | root | ||
| (1 row) | ||
| ~~~ | ||
|
|
||
| Now, suppose that you want to change the owner of the schema `org_one` to an existing user named `max`. To change the owner of a schema, the current owner must belong to the role of the new owner (in this case, `max`), and the new owner must have `CREATE` privileges on the database. | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > GRANT max TO root; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > GRANT CREATE ON DATABASE defaultdb TO max; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > ALTER SCHEMA org_one OWNER TO max; | ||
| ~~~ | ||
|
|
||
| {% include copy-clipboard.html %} | ||
| ~~~ sql | ||
| > SELECT | ||
| nspname, usename | ||
| FROM | ||
| pg_catalog.pg_namespace | ||
| LEFT JOIN pg_catalog.pg_user ON pg_namespace.nspowner = pg_user.usesysid | ||
| WHERE | ||
| nspname LIKE 'org_one'; | ||
| ~~~ | ||
|
|
||
| ~~~ | ||
| nspname | usename | ||
| ----------+---------- | ||
| org_one | max | ||
| (1 row) | ||
| ~~~ | ||
|
|
||
| ## See also | ||
|
|
||
| - [`CREATE SCHEMA`](create-schema.html) | ||
| - [`SHOW SCHEMAS`](show-schemas.html) | ||
| - [`DROP SCHEMA`](drop-schema.html) |
Oops, something went wrong.