client.renameDatabase()

DOCS • API • Client API

---

Programmatically perform a RENAME DATABASE operation.

See also ➞ ALTER DATABASE

Syntax

client.renameDatabase(
    fromName: string,
    toName: string,
    options?: QueryOptions
): Promise<DDLResult>;

Param	Interfaces	Description
fromName	-	An existing database name.
toName	-	The intended new database name.
options	QueryOptions	Optional extra parameters for the query.

Interface	Description
DDLResult	The result type for DDL operations.

Usage

Rename a database:

const savepoint = await client.renameDatabase(
    'database_1',
    'database_1_new',
    { desc: 'Just testing database rename' }
);