Cloud Datastore V1 Client - Class DatastoreClient (1.26.0)

Reference documentation and code samples for the Cloud Datastore V1 Client class DatastoreClient.

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Cloud \ Datastore \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
options array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false.

↳ clientConfig string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc. Defaults to grpc if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

allocateIds

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

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::allocateIdsAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\AllocateIdsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\AllocateIdsResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\AllocateIdsRequest;
use Google\Cloud\Datastore\V1\AllocateIdsResponse;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\Key;

/**
 * @param string $projectId The ID of the project against which to make the request.
 */
function allocate_ids_sample(string $projectId): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $keys = [new Key()];
    $request = (new AllocateIdsRequest())
        ->setProjectId($projectId)
        ->setKeys($keys);

    // Call the API and handle any network failures.
    try {
        /** @var AllocateIdsResponse $response */
        $response = $datastoreClient->allocateIds($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';

    allocate_ids_sample($projectId);
}

beginTransaction

Begins a new transaction.

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::beginTransactionAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\BeginTransactionRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\BeginTransactionResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\BeginTransactionRequest;
use Google\Cloud\Datastore\V1\BeginTransactionResponse;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;

/**
 * @param string $projectId The ID of the project against which to make the request.
 */
function begin_transaction_sample(string $projectId): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $request = (new BeginTransactionRequest())
        ->setProjectId($projectId);

    // Call the API and handle any network failures.
    try {
        /** @var BeginTransactionResponse $response */
        $response = $datastoreClient->beginTransaction($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';

    begin_transaction_sample($projectId);
}

commit

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

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::commitAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\CommitRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\CommitResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\CommitRequest;
use Google\Cloud\Datastore\V1\CommitRequest\Mode;
use Google\Cloud\Datastore\V1\CommitResponse;
use Google\Cloud\Datastore\V1\Mutation;

/**
 * @param string $projectId The ID of the project against which to make the request.
 * @param int    $mode      The type of commit to perform. Defaults to `TRANSACTIONAL`.
 */
function commit_sample(string $projectId, int $mode): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $mutations = [new Mutation()];
    $request = (new CommitRequest())
        ->setProjectId($projectId)
        ->setMode($mode)
        ->setMutations($mutations);

    // Call the API and handle any network failures.
    try {
        /** @var CommitResponse $response */
        $response = $datastoreClient->commit($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';
    $mode = Mode::MODE_UNSPECIFIED;

    commit_sample($projectId, $mode);
}

lookup

Looks up entities by key.

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::lookupAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\LookupRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\LookupResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\Key;
use Google\Cloud\Datastore\V1\LookupRequest;
use Google\Cloud\Datastore\V1\LookupResponse;

/**
 * @param string $projectId The ID of the project against which to make the request.
 */
function lookup_sample(string $projectId): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $keys = [new Key()];
    $request = (new LookupRequest())
        ->setProjectId($projectId)
        ->setKeys($keys);

    // Call the API and handle any network failures.
    try {
        /** @var LookupResponse $response */
        $response = $datastoreClient->lookup($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';

    lookup_sample($projectId);
}

reserveIds

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

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::reserveIdsAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\ReserveIdsRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\ReserveIdsResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\Key;
use Google\Cloud\Datastore\V1\ReserveIdsRequest;
use Google\Cloud\Datastore\V1\ReserveIdsResponse;

/**
 * @param string $projectId The ID of the project against which to make the request.
 */
function reserve_ids_sample(string $projectId): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $keys = [new Key()];
    $request = (new ReserveIdsRequest())
        ->setProjectId($projectId)
        ->setKeys($keys);

    // Call the API and handle any network failures.
    try {
        /** @var ReserveIdsResponse $response */
        $response = $datastoreClient->reserveIds($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';

    reserve_ids_sample($projectId);
}

rollback

Rolls back a transaction.

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::rollbackAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\RollbackRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\RollbackResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\RollbackRequest;
use Google\Cloud\Datastore\V1\RollbackResponse;

/**
 * @param string $projectId   The ID of the project against which to make the request.
 * @param string $transaction The transaction identifier, returned by a call to
 *                            [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
 */
function rollback_sample(string $projectId, string $transaction): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $request = (new RollbackRequest())
        ->setProjectId($projectId)
        ->setTransaction($transaction);

    // Call the API and handle any network failures.
    try {
        /** @var RollbackResponse $response */
        $response = $datastoreClient->rollback($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';
    $transaction = '...';

    rollback_sample($projectId, $transaction);
}

runAggregationQuery

Runs an aggregation query.

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::runAggregationQueryAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\RunAggregationQueryRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\RunAggregationQueryResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\RunAggregationQueryRequest;
use Google\Cloud\Datastore\V1\RunAggregationQueryResponse;

/**
 * @param string $projectId The ID of the project against which to make the request.
 */
function run_aggregation_query_sample(string $projectId): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $request = (new RunAggregationQueryRequest())
        ->setProjectId($projectId);

    // Call the API and handle any network failures.
    try {
        /** @var RunAggregationQueryResponse $response */
        $response = $datastoreClient->runAggregationQuery($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';

    run_aggregation_query_sample($projectId);
}

runQuery

Queries for entities.

The async variant is Google\Cloud\Datastore\V1\Client\DatastoreClient::runQueryAsync() .

Parameters
NameDescription
request Google\Cloud\Datastore\V1\RunQueryRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Datastore\V1\RunQueryResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Datastore\V1\Client\DatastoreClient;
use Google\Cloud\Datastore\V1\PartitionId;
use Google\Cloud\Datastore\V1\RunQueryRequest;
use Google\Cloud\Datastore\V1\RunQueryResponse;

/**
 * @param string $projectId The ID of the project against which to make the request.
 */
function run_query_sample(string $projectId): void
{
    // Create a client.
    $datastoreClient = new DatastoreClient();

    // Prepare the request message.
    $partitionId = new PartitionId();
    $request = (new RunQueryRequest())
        ->setProjectId($projectId)
        ->setPartitionId($partitionId);

    // Call the API and handle any network failures.
    try {
        /** @var RunQueryResponse $response */
        $response = $datastoreClient->runQuery($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample 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.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $projectId = '[PROJECT_ID]';

    run_query_sample($projectId);
}

allocateIdsAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\AllocateIdsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

beginTransactionAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\BeginTransactionRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

commitAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\CommitRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

lookupAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\LookupRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

reserveIdsAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\ReserveIdsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

rollbackAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\RollbackRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

runAggregationQueryAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\RunAggregationQueryRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

runQueryAsync

Parameters
NameDescription
request Google\Cloud\Datastore\V1\RunQueryRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface