DatastoreAdminClient

DatastoreAdminClient

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).

Export/Import Service:

  • 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 Service:

  • 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 Service:

  • 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

new DatastoreAdminClient(optionsopt, gaxInstanceopt)

Construct an instance of DatastoreAdminClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DatastoreAdminClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkCreateIndexProgress(name) → {Promise}

Check the status of the long running operation returned by createIndex().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID against which to make the request.
   */
  // const projectId = 'abc123'
  /**
   *  The index to create. The name and state fields are output only and will be
   *  ignored. Single property indexes cannot be created or deleted.
   */
  // const index = {}

  // Imports the Admin library
  const {DatastoreAdminClient} = require('@google-cloud/datastore-admin').v1;

  // Instantiates a client
  const adminClient = new DatastoreAdminClient();

  async function callCreateIndex() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await adminClient.createIndex(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateIndex();

(async) checkDeleteIndexProgress(name) → {Promise}

Check the status of the long running operation returned by deleteIndex().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID against which to make the request.
   */
  // const projectId = 'abc123'
  /**
   *  The resource ID of the index to delete.
   */
  // const indexId = 'abc123'

  // Imports the Admin library
  const {DatastoreAdminClient} = require('@google-cloud/datastore-admin').v1;

  // Instantiates a client
  const adminClient = new DatastoreAdminClient();

  async function callDeleteIndex() {
    // Construct request
    const request = {
    };

    // Run request
    const [operation] = await adminClient.deleteIndex(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteIndex();

(async) checkExportEntitiesProgress(name) → {Promise}

Check the status of the long running operation returned by exportEntities().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Project ID against which to make the request.
   */
  // const projectId = 'abc123'
  /**
   *  Client-assigned labels.
   */
  // const labels = [1,2,3,4]
  /**
   *  Description of what data from the project is included in the export.
   */
  // const entityFilter = {}
  /**
   *  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 (https://cloud.google.com/storage/docs/naming#object-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 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.
   */
  // const outputUrlPrefix = 'abc123'

  // Imports the Admin library
  const {DatastoreAdminClient} = require('@google-cloud/datastore-admin').v1;

  // Instantiates a client
  const adminClient = new DatastoreAdminClient();

  async function callExportEntities() {
    // Construct request
    const request = {
      projectId,
      outputUrlPrefix,
    };

    // Run request
    const [operation] = await adminClient.exportEntities(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportEntities();

(async) checkImportEntitiesProgress(name) → {Promise}

Check the status of the long running operation returned by importEntities().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Project ID against which to make the request.
   */
  // const projectId = 'abc123'
  /**
   *  Client-assigned labels.
   */
  // const labels = [1,2,3,4]
  /**
   *  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 (https://cloud.google.com/storage/docs/naming#object-considerations).
   *  For more information, see
   *  google.datastore.admin.v1.ExportEntitiesResponse.output_url google.datastore.admin.v1.ExportEntitiesResponse.output_url.
   */
  // const inputUrl = 'abc123'
  /**
   *  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.
   */
  // const entityFilter = {}

  // Imports the Admin library
  const {DatastoreAdminClient} = require('@google-cloud/datastore-admin').v1;

  // Instantiates a client
  const adminClient = new DatastoreAdminClient();

  async function callImportEntities() {
    // Construct request
    const request = {
      projectId,
      inputUrl,
    };

    // Run request
    const [operation] = await adminClient.importEntities(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportEntities();

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listIndexesAsync(request, optionsopt) → {Object}

Equivalent to listIndexes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Project ID against which to make the request.
filter string
pageSize number

The maximum number of items to return. If zero, then all results will be returned.
pageToken string

The next_page_token value returned from a previous List request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Index. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Project ID against which to make the request.
   */
  // const projectId = 'abc123'
  /**
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of items to return.  If zero, then all results will be
   *  returned.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {DatastoreAdminClient} = require('@google-cloud/datastore-admin').v1;

  // Instantiates a client
  const adminClient = new DatastoreAdminClient();

  async function callListIndexes() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = adminClient.listIndexesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListIndexes();

listIndexesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Project ID against which to make the request.
filter string
pageSize number

The maximum number of items to return. If zero, then all results will be returned.
pageToken string

The next_page_token value returned from a previous List request, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Index on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listIndexesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

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.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```