database.renameTable()

Programmatically perform a RENAME TABLE operation.

Syntax

database.renameTable(
    fromName: string,
    toName: string,
    options?: QueryOptions
): Promise<Savepoint | boolean>;

Param	Type	Description
fromName	string	An existing table name.
toName	string	The intended new table name.
options	QueryOptions	Standard QueryOptions.

Return Value

• Savepoint | boolean: a Savepoint instance (See ➞ Savepoint) or the boolean true when savepoint creation has been disabled via options.noCreateSavepoint; (Compare ➞ Query Return Value)

Usage

Rename a table:

const savepoint = await database.renameTable(
    'table_1',
    'table_1_new',
    { desc: 'Just testing table rename' }
);