Datastore Admin Client

Accesses the google.datastore.admin.v1 DatastoreAdmin API.

class google.cloud.datastore_admin_v1.gapic.datastore_admin_client.DatastoreAdminClient(transport=None, channel=None, credentials=None, client_config=None, client_info=None, client_options=None)

Bases: object

Google Cloud Datastore Admin API

The Datastore Admin API provides several admin services for Cloud Datastore.

Concepts

Project, namespace, kind, and entity as defined in the Google Cloud Datastore API.

Operation: An Operation represents work being performed in the background.

EntityFilter: Allows specifying a subset of entities in a project. This is specified as a combination of kinds and namespaces (either or both of which may be all).

Services

Export/Import

The Export/Import service provides the ability to copy all or a subset of entities to/from Google Cloud Storage.

Exported data may be imported into Cloud Datastore for any Google Cloud Platform project. It is not restricted to the export source project. It is possible to export from one project and then import into another.

Exported data can also be loaded into Google BigQuery for analysis.

Exports and imports are performed asynchronously. An Operation resource is created for each export/import. The state (including any errors encountered) of the export/import may be queried via the Operation resource.

Index

The index service manages Cloud Datastore composite indexes.

Index creation and deletion are performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.

Operation

The Operations collection provides a record of actions performed for the specified project (including any operations in progress). Operations are not created directly but through calls on other collections or resources.

An operation that is not yet done may be cancelled. The request to cancel is asynchronous and the operation may continue to run for some time after the request to cancel is made.

An operation that is done may be deleted so that it is no longer listed as part of the Operation collection.

ListOperations returns all pending operations, but not completed operations.

Operations are created by service DatastoreAdmin, but are accessed via service google.longrunning.Operations.

Constructor.

  • Parameters

    (Union[DatastoreAdminGrpcTransport (transport) – Callable[[~.Credentials, type], ~.DatastoreAdminGrpcTransport]): A transport instance, responsible for actually making the API calls. The default transport uses the gRPC protocol. This argument may also be a callable which returns a transport instance. Callables will be sent the credentials as the first argument and the default transport class as the second argument.

:param

instance, responsible for actually making the API calls.
The default transport uses the gRPC protocol.
This argument may also be a callable which returns a
transport instance. Callables will be sent the credentials
as the first argument and the default transport class as
the second argument.

  • Parameters

    • channel (grpc.Channel) – DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

    • credentials (google.auth.credentials.Credentials) – The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

    • client_config (dict) – DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

    • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

    • client_options (Union[dict, *[google.api_core.client_options.ClientOptions](https://googleapis.dev/python/google-api-core/latest/client_options.html#google.api_core.client_options.ClientOptions)]*) – Client options used to set user options on the client. API Endpoint should be set through client_options.

SERVICE_ADDRESS( = 'datastore.googleapis.com:443 )

The default address of the service.

export_entities(project_id, output_url_prefix, labels=None, entity_filter=None, retry=<_MethodDefault._DEFAULT_VALUE:

Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

Example

>>> from google.cloud import datastore_admin_v1
>>>
>>> client = datastore_admin_v1.DatastoreAdminClient()
>>>
>>> # TODO: Initialize `project_id`:
>>> project_id = ''
>>>
>>> # TODO: Initialize `output_url_prefix`:
>>> output_url_prefix = ''
>>>
>>> response = client.export_entities(project_id, output_url_prefix)
>>>
>>> def callback(operation_future):
...     # Handle result.
...     result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()

  • Parameters

    • project_id (str) – Required. Project ID against which to make the request.

    • output_url_prefix (str) – Required. Location for the export metadata and data files.

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

      The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations.

      By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.

    • labels (dict[str -> str]) – Client-assigned labels.

    • entity_filter (Union[dict, **EntityFilter]) – Description of what data from the project is included in the export.

      If a dict is provided, it must be of the same form as the protobuf message EntityFilter

    • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    • metadata (Optional[Sequence[Tuple[str, *[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]]]*) – Additional metadata that is provided to the method.

  • Returns

    A _OperationFuture instance.

  • Raises

classmethod from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

  • Parameters

    • filename (str) – The path to the service account private key json file.

    • args – Additional arguments to pass to the constructor.

    • kwargs – Additional arguments to pass to the constructor.

  • Returns

    The constructed client.

  • Return type

    DatastoreAdminClient

classmethod from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

  • Parameters

    • filename (str) – The path to the service account private key json file.

    • args – Additional arguments to pass to the constructor.

    • kwargs – Additional arguments to pass to the constructor.

  • Returns

    The constructed client.

  • Return type

    DatastoreAdminClient

get_index(project_id=None, index_id=None, retry=<_MethodDefault._DEFAULT_VALUE:

Gets an index.

Example

>>> from google.cloud import datastore_admin_v1
>>>
>>> client = datastore_admin_v1.DatastoreAdminClient()
>>>
>>> response = client.get_index()

import_entities(project_id, input_url, labels=None, entity_filter=None, retry=<_MethodDefault._DEFAULT_VALUE:

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 ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.

Example

>>> from google.cloud import datastore_admin_v1
>>>
>>> client = datastore_admin_v1.DatastoreAdminClient()
>>>
>>> # TODO: Initialize `project_id`:
>>> project_id = ''
>>>
>>> # TODO: Initialize `input_url`:
>>> input_url = ''
>>>
>>> response = client.import_entities(project_id, input_url)
>>>
>>> def callback(operation_future):
...     # Handle result.
...     result = operation_future.result()
>>>
>>> response.add_done_callback(callback)
>>>
>>> # Handle metadata.
>>> metadata = response.metadata()

  • Parameters

    • project_id (str) – Required. Project ID against which to make the request.

    • input_url (str) – Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url 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 ExportEntities operation. For more information about Cloud Storage namespace paths, see Object name considerations.

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

    • labels (dict[str -> str]) – Client-assigned labels.

    • entity_filter (Union[dict, **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.

      If a dict is provided, it must be of the same form as the protobuf message EntityFilter

    • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    • metadata (Optional[Sequence[Tuple[str, *[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]]]*) – Additional metadata that is provided to the method.

  • Returns

    A _OperationFuture instance.

  • Raises

list_indexes(project_id=None, filter_=None, page_size=None, retry=<_MethodDefault._DEFAULT_VALUE:

Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.

Example

>>> from google.cloud import datastore_admin_v1
>>>
>>> client = datastore_admin_v1.DatastoreAdminClient()
>>>
>>> # Iterate over all results
>>> for element in client.list_indexes():
...     # process element
...     pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_indexes().pages:
...     for element in page:
...         # process element
...         pass

  • Parameters

    • project_id (str) – Project ID against which to make the request.

    • filter (str) –

    • page_size (int) – The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

    • retry (Optional[google.api_core.retry.Retry]) – A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

    • timeout (Optional[float]) – The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

    • metadata (Optional[Sequence[Tuple[str, *[str](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]]]*) – Additional metadata that is provided to the method.

  • Returns

    A PageIterator instance. An iterable of Index instances. You can also iterate over the pages of the response using its pages property.

  • Raises