api.cloneDatabase() - RevoEngine

`api.cloneDatabase()`

Clones a logical database by name. Notes:

Unavailable with readOnly: true (throws an error).
By default waits for the clone and returns cloned database metadata.
Set { async: true } to start a backend clone task and return immediately with an accepted response.
Omit name to use the backend default source-name plus _Clone.

Signature

static cloneDatabase<TAsync extends boolean = false>(
      name: string,
      options?: DatabaseCloneInput & { async?: TAsync },
    ): Promise<
      TAsync extends true
        ? CloneDatabaseAcceptedResponse
        : TAsync extends false
          ? CloneDatabaseCompletedResponse
          : CloneDatabaseResponse
    >;

Example

const result = await api.cloneDatabase('customers', {
  includeItems: false,
  includePartitions: true,
});

return result.databases;

See all api methods or runtime basics.

Last modified on November 8, 2026