Cloud Firestore V1 Client - Class FirestoreClient (1.28.0)

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. Sample code to get started:

$firestoreClient = new FirestoreClient();
try {
    $database = 'database';
    $documents = [];
    // Read all responses until the stream is complete
    $stream = $firestoreClient->batchGetDocuments($database, $documents);
    foreach ($stream->readAll() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $firestoreClient->close();
}

Methods

partitionQuery

Parameter
NameDescription
optionalArgs array
Returns
TypeDescription
Google\Cloud\Firestore\V1\PartitionQueryResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Firestore\V1\Cursor;
use Google\Cloud\Firestore\V1\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 partition_query_sample(): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

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

        /** @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());
    }
}

anyPathName

Formats a string containing the fully-qualified path to represent a any_path resource.

Parameters
NameDescription
project string
database string
document string
anyPath string
Returns
TypeDescription
stringThe formatted any_path resource.

databaseRootName

Formats a string containing the fully-qualified path to represent a database_root resource.

Parameters
NameDescription
project string
database string
Returns
TypeDescription
stringThe formatted database_root resource.

documentPathName

Formats a string containing the fully-qualified path to represent a document_path resource.

Parameters
NameDescription
project string
database string
documentPath string
Returns
TypeDescription
stringThe formatted document_path resource.

documentRootName

Formats a string containing the fully-qualified path to represent a document_root resource.

Parameters
NameDescription
project string
database string
Returns
TypeDescription
stringThe formatted document_root resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • anyPath: projects/{project}/databases/{database}/documents/{document}/{any_path=**}
  • databaseRoot: projects/{project}/databases/{database}
  • documentPath: projects/{project}/databases/{database}/documents/{document_path=**}
  • documentRoot: projects/{project}/databases/{database}/documents.

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

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

batchGetDocuments

Gets multiple documents.

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

Parameters
NameDescription
database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

documents string[]

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.

optionalArgs array

Optional.

↳ mask DocumentMask

The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.

↳ transaction string

Reads documents in a transaction.

↳ newTransaction TransactionOptions

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

↳ readTime Timestamp

Reads documents as they were at the given time. This may not be older than 270 seconds.

↳ timeoutMillis int

Timeout to use for this call.

Returns
TypeDescription
Google\ApiCore\ServerStream
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Firestore\V1\BatchGetDocumentsResponse;
use Google\Cloud\Firestore\V1\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 any non-scalar elements to be passed along with the request.
    $documents = [$documentsElement,];

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

        /** @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());
    }
}

/**
 * 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.

Parameters
NameDescription
optionalArgs array

Optional.

↳ database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

↳ writes Write[]

The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

↳ labels array

Labels associated with this batch write.

↳ 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\Firestore\V1\BatchWriteResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\BatchWriteResponse;
use Google\Cloud\Firestore\V1\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();

    // Call the API and handle any network failures.
    try {
        /** @var BatchWriteResponse $response */
        $response = $firestoreClient->batchWrite();
        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.

Parameters
NameDescription
database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

optionalArgs array

Optional.

↳ options TransactionOptions

The options for the transaction. Defaults to a read-write transaction.

↳ 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\Firestore\V1\BeginTransactionResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\BeginTransactionResponse;
use Google\Cloud\Firestore\V1\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();

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

/**
 * 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.

Parameters
NameDescription
database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

writes array<Google\Cloud\Firestore\V1\Write>

The writes to apply.

Always executed atomically and in order.

optionalArgs array

Optional.

↳ transaction string

If set, applies all writes in this transaction, and commits it.

↳ 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\Firestore\V1\CommitResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\CommitResponse;
use Google\Cloud\Firestore\V1\FirestoreClient;
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 any non-scalar elements to be passed along with the request.
    $writes = [new Write()];

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

/**
 * 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.

Parameters
NameDescription
parent string

Required. The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

collectionId string

Required. The collection ID, relative to parent, to list. For example: chatrooms.

documentId string

The client-assigned document ID to use for this document.

Optional. If not specified, an ID will be assigned by the service.

document Google\Cloud\Firestore\V1\Document

Required. The document to create. name must not be set.

optionalArgs array

Optional.

↳ mask DocumentMask

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

↳ 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\Firestore\V1\Document
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\FirestoreClient;

/**
 * @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 any non-scalar elements to be passed along with the request.
    $document = new Document();

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

/**
 * 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.

Parameters
NameDescription
name string

Required. The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

optionalArgs array

Optional.

↳ currentDocument Precondition

An optional precondition on the document. The request will fail if this is set and not met by the target document.

↳ 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\FirestoreClient;

/**
 * @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();

    // Call the API and handle any network failures.
    try {
        $firestoreClient->deleteDocument($name);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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.

Parameters
NameDescription
name string

Required. The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

optionalArgs array

Optional.

↳ mask DocumentMask

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

↳ transaction string

Reads the document in a transaction.

↳ readTime Timestamp

Reads the version of the document at the given time. This may not be older than 270 seconds.

↳ 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\Firestore\V1\Document
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\FirestoreClient;

/**
 * @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();

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

/**
 * 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.

Parameters
NameDescription
parent string

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

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ readTime Timestamp

Reads documents as they were at the given time. This may not be older than 270 seconds.

↳ 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\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Firestore\V1\FirestoreClient;

/**
 * @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();

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

        /** @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());
    }
}

/**
 * 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.

Parameters
NameDescription
parent string

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

collectionId string

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.

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ orderBy string

Optional. The optional ordering of the documents to return. For example: priority desc, __name__ desc. This mirrors the ORDER BY used in Firestore queries but in a string representation. When absent, documents are ordered based on __name__ ASC.

↳ mask DocumentMask

Optional. The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.

↳ transaction string

Perform the read as part of an already active transaction.

↳ readTime Timestamp

Perform the read at the provided time. This may not be older than 270 seconds.

↳ showMissing bool

If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, create_time, or update_time set. Requests with show_missing may not specify where or order_by.

↳ 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\ApiCore\PagedListResponse
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\FirestoreClient;

/**
 * @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();

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

        /** @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());
    }
}

/**
 * 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 the gRPC API (not REST).

Parameters
NameDescription
optionalArgs array

Optional.

↳ timeoutMillis int

Timeout to use for this call.

Returns
TypeDescription
Google\ApiCore\BidiStream
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Firestore\V1\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 any non-scalar elements to be passed along with the request.
    $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());
    }
}

/**
 * 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);
}

partitionQueryPaginated

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.

Sample code:

$firestoreClient = new FirestoreClient();
try {
    // Iterate over pages of elements
    $pagedResponse = $firestoreClient->partitionQueryPaginated();
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $firestoreClient->partitionQueryPaginated();
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $firestoreClient->close();
}
Parameters
NameDescription
optionalArgs array

Optional.

↳ parent string

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents. Document resource names are not supported; only database resource names can be specified.

↳ structuredQuery StructuredQuery

A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.

↳ partitionCount int

The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ readTime Timestamp

Reads documents as they were at the given time. This may not be older than 270 seconds.

↳ 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\ApiCore\PagedListResponse

rollback

Rolls back a transaction.

Parameters
NameDescription
database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

transaction string

Required. The transaction to roll back.

optionalArgs 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\FirestoreClient;

/**
 * @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();

    // Call the API and handle any network failures.
    try {
        $firestoreClient->rollback($database, $transaction);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 );

Sample code:

$firestoreClient = new FirestoreClient();
try {
    $parent = 'parent';
    // Read all responses until the stream is complete
    $stream = $firestoreClient->runAggregationQuery($parent);
    foreach ($stream->readAll() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $firestoreClient->close();
}
Parameters
NameDescription
parent string

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

optionalArgs array

Optional.

↳ structuredAggregationQuery StructuredAggregationQuery

An aggregation query.

↳ transaction string

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

↳ newTransaction TransactionOptions

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

↳ readTime Timestamp

Executes the query at the given timestamp. Requires: * Cannot be more than 270 seconds in the past.

↳ timeoutMillis int

Timeout to use for this call.

Returns
TypeDescription
Google\ApiCore\ServerStream
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Firestore\V1\FirestoreClient;
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();

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

        /** @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());
    }
}

/**
 * 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
NameDescription
parent string

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

optionalArgs array

Optional.

↳ structuredQuery StructuredQuery

A structured query.

↳ transaction string

Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.

↳ newTransaction TransactionOptions

Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

↳ readTime Timestamp

Reads documents as they were at the given time. This may not be older than 270 seconds.

↳ timeoutMillis int

Timeout to use for this call.

Returns
TypeDescription
Google\ApiCore\ServerStream
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\ServerStream;
use Google\Cloud\Firestore\V1\FirestoreClient;
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();

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

        /** @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());
    }
}

/**
 * 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.

Parameters
NameDescription
document Google\Cloud\Firestore\V1\Document

Required. The updated document. Creates the document if it does not already exist.

updateMask Google\Cloud\Firestore\V1\DocumentMask

The fields to update. None of the field paths in the mask may contain a reserved name.

If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server.

optionalArgs array

Optional.

↳ mask DocumentMask

The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response.

↳ currentDocument Precondition

An optional precondition on the document. The request will fail if this is set and not met by the target document.

↳ 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\Firestore\V1\Document
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Firestore\V1\Document;
use Google\Cloud\Firestore\V1\DocumentMask;
use Google\Cloud\Firestore\V1\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 update_document_sample(): void
{
    // Create a client.
    $firestoreClient = new FirestoreClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $document = new Document();
    $updateMask = new DocumentMask();

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $firestoreClient->updateDocument($document, $updateMask);
        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 the gRPC API (not REST).

Parameters
NameDescription
optionalArgs array

Optional.

↳ timeoutMillis int

Timeout to use for this call.

Returns
TypeDescription
Google\ApiCore\BidiStream
Example 
use Google\ApiCore\ApiException;
use Google\ApiCore\BidiStream;
use Google\Cloud\Firestore\V1\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 any non-scalar elements to be passed along with the request.
    $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());
    }
}

/**
 * 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);
}

Constants

SERVICE_NAME

Value: 'google.firestore.v1.Firestore'

The name of the service.

SERVICE_ADDRESS

Value: 'firestore.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.