Cloud Firestore V1 Client - Class FirestoreClient (1.34.0)

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

Service Description: The Cloud Firestore service.

This class is currently experimental and may be subject to changes.

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.

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`

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 Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

beginTransaction

Starts a new transaction.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

commit

Commits a transaction, while optionally updating documents.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

createDocument

Creates a new document.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

deleteDocument

Deletes a document.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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.

getDocument

Gets a single document.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

listCollectionIds

Lists all the collection IDs underneath a document.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

listDocuments

Lists documents.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

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`

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 Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

rollback

Rolls back a transaction.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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.

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`

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`

updateDocument

Updates or inserts a document.

The async variant is Google\Cloud\Firestore\V1\Client\BaseClient\self::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`

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`

batchWriteAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

beginTransactionAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

commitAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createDocumentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDocumentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDocumentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listCollectionIdsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDocumentsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

partitionQueryAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

rollbackAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDocumentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`