Method: projects.import

Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an projects.import operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.

HTTP request

POST https://datastore.googleapis.com/v1/projects/{projectId}:import

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
projectId

string

Project ID against which to make the request.

Request body

The request body contains data with the following structure:

JSON representation
{
  "databaseId": string,
  "labels": {
    string: string,
    ...
  },
  "inputUrl": string,
  "entityFilter": {
    object(EntityFilter)
  }
}
Fields
databaseId

string

Database ID against which to make the request. Unset indicates the default database. Not currently supported.

labels

map (key: string, value: string)

Client-assigned labels.

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

inputUrl

string

The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So inputUrl should be of the form: gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE, where BUCKET_NAME is the name of the Cloud Storage bucket, NAMESPACE_PATH is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and OVERALL_EXPORT_METADATA_FILE is the metadata file written by the projects.export operation. For more information about Cloud Storage namespace paths, see Object name considerations.

For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.

entityFilter

object(EntityFilter)

Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.

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 Authentication Overview.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Datastore