Warning:
This version of CockroachDB is no longer supported. Cockroach Labs supports the current stable release and two releases prior. Please use one of these supported versions.

The RENAME DATABASE statement changes the name of a database.

Note:
It is not possible to rename a database referenced by a view. For more details, see View Dependencies.
Warning:

Database renames are not transactional. For more information, see Database renaming considerations.

Synopsis

ALTER DATABASE name RENAME TO name

Required Privileges

Only the root user can rename databases.

Parameters

Parameter Description
name The first instance of name is the current name of the database. The second instance is the new name for the database. The new name must be unique and follow these identifier rules.

Database renaming considerations

Database renames are not transactional. There are two phases during a rename:

  1. The system.namespace table is updated. This phase is transactional, and will be rolled back if the transaction aborts.
  2. The database descriptor (an internal data structure) is updated, and announced to every other node. This phase is not transactional. The rename will be announced to other nodes only if the transaction commits, but there is no guarantee on how much time this operation will take.
  3. Once the new name has propagated to every node in the cluster, another internal transaction is run that declares the old name ready for reuse in another context.

This yields a surprising and undesirable behavior: when run inside a BEGIN ... COMMIT block, it’s possible for a rename to be half-done - not persisted in storage, but visible to other nodes or other transactions. This violates A, C, and I in ACID. Only D is guaranteed: If the transaction commits successfully, the new name will persist after that.

This is a known limitation. For an issue tracking this limitation, see cockroach#12123.

Examples

Rename a Database

> SHOW DATABASES;
+----------+
| Database |
+----------+
| db1      |
| db2      |
| system   |
+----------+
> ALTER DATABASE db1 RENAME TO db3;
RENAME DATABASE
> SHOW DATABASES;
+----------+
| Database |
+----------+
| db2      |
| db3      |
| system   |
+----------+

Rename Fails (New Name Already In Use)

> SHOW DATABASES;
+----------+
| Database |
+----------+
| db2      |
| db3      |
| system   |
+----------+
> ALTER DATABASE db2 RENAME TO db3;
pq: the new database name "db3" already exists

See Also



Yes No