Method: projects.databases.clone

Creates a new database by cloning an existing one.

The new database must be in the same cloud region or multi-region location as the existing database. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing database.

The long-running operation can be used to track the progress of the clone, with the Operation's metadata field type being the CloneDatabaseMetadata. The response type is the Database if the clone was successful. The new database is not readable or writeable until the LRO has completed.

HTTP request

POST https://firestore.googleapis.com/v1/{parent=projects/*}/databases:clone

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project to clone the database in. Format is projects/{projectId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "databaseId": string,
  "pitrSnapshot": {
    object (PitrSnapshot)
  },
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "tags": {
    string: string,
    ...
  }
}
Fields
databaseId

string

Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database.

This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

"(default)" database ID is also valid.
pitrSnapshot

object (PitrSnapshot)

Required. Specification of the PITR data to clone from. The source database must exist.

The cloned database will be created in the same location as the source database.
encryptionConfig

object (EncryptionConfig)

Optional. Encryption configuration for the cloned database.

If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely useSourceEncryption.
tags

map (key: string, value: string)

Optional. Immutable. Tags to be bound to the cloned database.

The tags should be provided in the format of tagKeys/{tag_key_id} -> tagValues/{tag_value_id}.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.