Cloud Firestore V1 Client - Class FirestoreClient (1.47.2)

Reference documentation and code samples for the Cloud Firestore V1 Client class FirestoreClient.

Service Description: The Cloud Firestore service.

Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform accelerate building truly serverless apps.

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

Namespace

Google \ Cloud \ Firestore \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

batchGetDocuments

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\BatchGetDocumentsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\ServerStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Firestore\V1\BatchGetDocumentsRequest;
use Google\Cloud\Firestore\V1\BatchGetDocumentsResponse;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;

/**
 * @param string $database         The database name. In the format:
 *                                 `projects/{project_id}/databases/{database_id}`.
 * @param string $documentsElement The names of the documents to retrieve. In the format:
 *                                 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 *                                 The request will fail if any of the document is not a child resource of the
 *                                 given `database`. Duplicate names will be elided.
 */
function batch_get_documents_sample(string $database, string $documentsElement): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $documents = [$documentsElement,];
    $request = (new BatchGetDocumentsRequest())
        ->setDatabase($database)
        ->setDocuments($documents);

    // Call the API and handle any network failures.
    try {
        /** @var ServerStream $stream */
        $stream = $firestoreClient->batchGetDocuments($request);

        /** @var BatchGetDocumentsResponse $element */
        foreach ($stream->readAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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
{
    $database = '[DATABASE]';
    $documentsElement = '[DOCUMENTS]';

    batch_get_documents_sample($database, $documentsElement);
}

batchWrite

Applies a batch of write operations.

The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write.

If you require an atomically applied set of writes, use Commit instead.

The async variant is FirestoreClient::batchWriteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\BatchWriteRequest` 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
Type	Description
`Google\Cloud\Firestore\V1\BatchWriteResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\BatchWriteRequest;
use Google\Cloud\Firestore\V1\BatchWriteResponse;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;

/**
 * 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 batch_write_sample(): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = new BatchWriteRequest();

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

beginTransaction

Starts a new transaction.

The async variant is FirestoreClient::beginTransactionAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\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
Type	Description
`Google\Cloud\Firestore\V1\BeginTransactionResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\BeginTransactionRequest;
use Google\Cloud\Firestore\V1\BeginTransactionResponse;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;

/**
 * @param string $database The database name. In the format:
 *                         `projects/{project_id}/databases/{database_id}`.
 */
function begin_transaction_sample(string $database): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new BeginTransactionRequest())
        ->setDatabase($database);

    // Call the API and handle any network failures.
    try {
        /** @var BeginTransactionResponse $response */
        $response = $firestoreClient->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
{
    $database = '[DATABASE]';

    begin_transaction_sample($database);
}

commit

Commits a transaction, while optionally updating documents.

The async variant is FirestoreClient::commitAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\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
Type	Description
`Google\Cloud\Firestore\V1\CommitResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\CommitRequest;
use Google\Cloud\Firestore\V1\CommitResponse;
use Google\Cloud\Firestore\V1\Write;

/**
 * @param string $database The database name. In the format:
 *                         `projects/{project_id}/databases/{database_id}`.
 */
function commit_sample(string $database): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $writes = [new Write()];
    $request = (new CommitRequest())
        ->setDatabase($database)
        ->setWrites($writes);

    // Call the API and handle any network failures.
    try {
        /** @var CommitResponse $response */
        $response = $firestoreClient->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
{
    $database = '[DATABASE]';

    commit_sample($database);
}

createDocument

Creates a new document.

The async variant is FirestoreClient::createDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\CreateDocumentRequest` 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
Type	Description
`Google\Cloud\Firestore\V1\Document`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\CreateDocumentRequest;
use Google\Cloud\Firestore\V1\Document;

/**
 * @param string $parent       The parent resource. For example:
 *                             `projects/{project_id}/databases/{database_id}/documents` or
 *                             `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
 * @param string $collectionId The collection ID, relative to `parent`, to list. For example:
 *                             `chatrooms`.
 * @param string $documentId   The client-assigned document ID to use for this document.
 *
 *                             Optional. If not specified, an ID will be assigned by the service.
 */
function create_document_sample(string $parent, string $collectionId, string $documentId): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new CreateDocumentRequest())
        ->setParent($parent)
        ->setCollectionId($collectionId)
        ->setDocumentId($documentId)
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $firestoreClient->createDocument($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
{
    $parent = '[PARENT]';
    $collectionId = '[COLLECTION_ID]';
    $documentId = '[DOCUMENT_ID]';

    create_document_sample($parent, $collectionId, $documentId);
}

deleteDocument

Deletes a document.

The async variant is FirestoreClient::deleteDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\DeleteDocumentRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\DeleteDocumentRequest;

/**
 * @param string $name The resource name of the Document to delete. In the format:
 *                     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 */
function delete_document_sample(string $name): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new DeleteDocumentRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        $firestoreClient->deleteDocument($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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
{
    $name = '[NAME]';

    delete_document_sample($name);
}

getDocument

Gets a single document.

The async variant is FirestoreClient::getDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\GetDocumentRequest` 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
Type	Description
`Google\Cloud\Firestore\V1\Document`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\GetDocumentRequest;

/**
 * @param string $name The resource name of the Document to get. In the format:
 *                     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 */
function get_document_sample(string $name): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new GetDocumentRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $firestoreClient->getDocument($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
{
    $name = '[NAME]';

    get_document_sample($name);
}

listCollectionIds

Lists all the collection IDs underneath a document.

The async variant is FirestoreClient::listCollectionIdsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\ListCollectionIdsRequest` 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
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\ListCollectionIdsRequest;

/**
 * @param string $parent The parent document. In the format:
 *                       `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 *                       For example:
 *                       `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
 */
function list_collection_ids_sample(string $parent): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new ListCollectionIdsRequest())
        ->setParent($parent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $firestoreClient->listCollectionIds($request);

        /** @var string $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element);
        }
    } 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
{
    $parent = '[PARENT]';

    list_collection_ids_sample($parent);
}

listDocuments

Lists documents.

The async variant is FirestoreClient::listDocumentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\ListDocumentsRequest` 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
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\ListDocumentsRequest;

/**
 * @param string $parent       The parent resource name. In the format:
 *                             `projects/{project_id}/databases/{database_id}/documents` or
 *                             `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 *
 *                             For example:
 *                             `projects/my-project/databases/my-database/documents` or
 *                             `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
 * @param string $collectionId Optional. The collection ID, relative to `parent`, to list.
 *
 *                             For example: `chatrooms` or `messages`.
 *
 *                             This is optional, and when not provided, Firestore will list documents
 *                             from all collections under the provided `parent`.
 */
function list_documents_sample(string $parent, string $collectionId): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new ListDocumentsRequest())
        ->setParent($parent)
        ->setCollectionId($collectionId);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $firestoreClient->listDocuments($request);

        /** @var Document $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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
{
    $parent = '[PARENT]';
    $collectionId = '[COLLECTION_ID]';

    list_documents_sample($parent, $collectionId);
}

listen

Listens to changes. This method is only available via gRPC or WebChannel (not REST).

Parameters
Name	Description
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\ListenRequest;
use Google\Cloud\Firestore\V1\ListenResponse;

/**
 * @param string $database The database name. In the format:
 *                         `projects/{project_id}/databases/{database_id}`.
 */
function listen_sample(string $database): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new ListenRequest())
        ->setDatabase($database);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $firestoreClient->listen();
        $stream->writeAll([$request,]);

        /** @var ListenResponse $element */
        foreach ($stream->closeWriteAndReadAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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
{
    $database = '[DATABASE]';

    listen_sample($database);
}

partitionQuery

Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.

The async variant is FirestoreClient::partitionQueryAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\PartitionQueryRequest` 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
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\Cursor;
use Google\Cloud\Firestore\V1\PartitionQueryRequest;

/**
 * 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 partition_query_sample(): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = new PartitionQueryRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $firestoreClient->partitionQuery($request);

        /** @var Cursor $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

rollback

Rolls back a transaction.

The async variant is FirestoreClient::rollbackAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\RollbackRequest;

/**
 * @param string $database    The database name. In the format:
 *                            `projects/{project_id}/databases/{database_id}`.
 * @param string $transaction The transaction to roll back.
 */
function rollback_sample(string $database, string $transaction): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

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

    // Call the API and handle any network failures.
    try {
        $firestoreClient->rollback($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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
{
    $database = '[DATABASE]';
    $transaction = '...';

    rollback_sample($database, $transaction);
}

runAggregationQuery

Runs an aggregation query.

Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side.

High-Level Example:

-- Return the number of documents in table given a filter.
SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\RunAggregationQueryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\ServerStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\RunAggregationQueryRequest;
use Google\Cloud\Firestore\V1\RunAggregationQueryResponse;

/**
 * @param string $parent The parent resource name. In the format:
 *                       `projects/{project_id}/databases/{database_id}/documents` or
 *                       `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 *                       For example:
 *                       `projects/my-project/databases/my-database/documents` or
 *                       `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
 */
function run_aggregation_query_sample(string $parent): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new RunAggregationQueryRequest())
        ->setParent($parent);

    // Call the API and handle any network failures.
    try {
        /** @var ServerStream $stream */
        $stream = $firestoreClient->runAggregationQuery($request);

        /** @var RunAggregationQueryResponse $element */
        foreach ($stream->readAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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
{
    $parent = '[PARENT]';

    run_aggregation_query_sample($parent);
}

runQuery

Runs a query.

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\RunQueryRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\ServerStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\RunQueryRequest;
use Google\Cloud\Firestore\V1\RunQueryResponse;

/**
 * @param string $parent The parent resource name. In the format:
 *                       `projects/{project_id}/databases/{database_id}/documents` or
 *                       `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
 *                       For example:
 *                       `projects/my-project/databases/my-database/documents` or
 *                       `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
 */
function run_query_sample(string $parent): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new RunQueryRequest())
        ->setParent($parent);

    // Call the API and handle any network failures.
    try {
        /** @var ServerStream $stream */
        $stream = $firestoreClient->runQuery($request);

        /** @var RunQueryResponse $element */
        foreach ($stream->readAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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
{
    $parent = '[PARENT]';

    run_query_sample($parent);
}

updateDocument

Updates or inserts a document.

The async variant is FirestoreClient::updateDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\UpdateDocumentRequest` 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
Type	Description
`Google\Cloud\Firestore\V1\Document`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\DocumentMask;
use Google\Cloud\Firestore\V1\UpdateDocumentRequest;

/**
 * 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 update_document_sample(): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $document = new Document();
    $updateMask = new DocumentMask();
    $request = (new UpdateDocumentRequest())
        ->setDocument($document)
        ->setUpdateMask($updateMask);

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

write

Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

Parameters
Name	Description
`callOptions`	`array` Optional.
`↳ timeoutMillis`	`int` Timeout to use for this call.

Returns
Type	Description
`Google\ApiCore\BidiStream`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Firestore\V1\Client\FirestoreClient;
use Google\Cloud\Firestore\V1\WriteRequest;
use Google\Cloud\Firestore\V1\WriteResponse;

/**
 * @param string $database The database name. In the format:
 *                         `projects/{project_id}/databases/{database_id}`.
 *                         This is only required in the first message.
 */
function write_sample(string $database): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare the request message.
    $request = (new WriteRequest())
        ->setDatabase($database);

    // Call the API and handle any network failures.
    try {
        /** @var BidiStream $stream */
        $stream = $firestoreClient->write();
        $stream->writeAll([$request,]);

        /** @var WriteResponse $element */
        foreach ($stream->closeWriteAndReadAll() as $element) {
            printf('Element data: %s' . PHP_EOL, $element->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
{
    $database = '[DATABASE]';

    write_sample($database);
}

batchWriteAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\BatchWriteRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Firestore\V1\BatchWriteResponse>`

beginTransactionAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\BeginTransactionRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Firestore\V1\BeginTransactionResponse>`

commitAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\CommitRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Firestore\V1\CommitResponse>`

createDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\CreateDocumentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Firestore\V1\Document>`

deleteDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\DeleteDocumentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

getDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\GetDocumentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Firestore\V1\Document>`

listCollectionIdsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\ListCollectionIdsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

listDocumentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\ListDocumentsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

partitionQueryAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\PartitionQueryRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

rollbackAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\RollbackRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

updateDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Firestore\V1\UpdateDocumentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Firestore\V1\Document>`