DatastoreClient

DatastoreClient

Each RPC normalizes the partition IDs of the keys in its input entities, and always returns entities with keys with normalized partition IDs. This applies to all keys and entities, including those in values, except keys with both an empty path and an empty or unset partition ID. Normalization of input keys sets the project ID (if not already set) to the project ID from the request.

Constructor

new DatastoreClient(optionsopt, fallback)

Construct an instance of DatastoreClient.

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. TODO(@alexander-fenster): link to gax documentation.

fallback boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

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

allocateIds(request, optionsopt) → {Promise}

Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

keys Array.<number>

Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing AllocateIdsResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.allocateIds(request);

beginTransaction(request, optionsopt) → {Promise}

Begins a new transaction.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

transactionOptions google.datastore.v1.TransactionOptions

Options for a new transaction.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
Example
const [response] = await client.beginTransaction(request);

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.

commit(request, optionsopt) → {Promise}

Commits a transaction, optionally creating, deleting or modifying some entities.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

mode google.datastore.v1.CommitRequest.Mode

The type of commit to perform. Defaults to TRANSACTIONAL.

transaction Buffer

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

mutations Array.<number>

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update

When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing CommitResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.commit(request);

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.

lookup(request, optionsopt) → {Promise}

Looks up entities by key.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

readOptions google.datastore.v1.ReadOptions

The options for this lookup request.

keys Array.<number>

Required. Keys of entities to look up.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing LookupResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.lookup(request);

reserveIds(request, optionsopt) → {Promise}

Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

databaseId string

If not empty, the ID of the database against which to make the request.

keys Array.<number>

Required. A list of keys with complete key paths whose numeric IDs should not be auto-allocated.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing ReserveIdsResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.reserveIds(request);

rollback(request, optionsopt) → {Promise}

Rolls back a transaction.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

transaction Buffer

Required. The transaction identifier, returned by a call to Datastore.BeginTransaction.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing RollbackResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.rollback(request);

runQuery(request, optionsopt) → {Promise}

Queries for entities.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
projectId string

Required. The ID of the project against which to make the request.

partitionId google.datastore.v1.PartitionId

Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.

readOptions google.datastore.v1.ReadOptions

The options for this query.

query google.datastore.v1.Query

The query to run.

gqlQuery google.datastore.v1.GqlQuery

The GQL query to run.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing RunQueryResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.runQuery(request);