Reference documentation and code samples for the Cloud Firestore V1 Client class FirestoreAdminClient.
Service Description: The Cloud Firestore Admin API.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Firestore \ Admin \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
createDatabase
Create a database.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::createDatabaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\CreateDatabaseRequest
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\OperationResponse |
createIndex
Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::createIndexAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\CreateIndexRequest
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\OperationResponse |
deleteIndex
Deletes a composite index.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::deleteIndexAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\DeleteIndexRequest
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. |
exportDocuments
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::exportDocumentsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ExportDocumentsRequest
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\OperationResponse |
getDatabase
Gets information about a database.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::getDatabaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\GetDatabaseRequest
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\Admin\V1\Database |
getField
Gets the metadata and configuration for a Field.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::getFieldAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\GetFieldRequest
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\Admin\V1\Field |
getIndex
Gets a composite index.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::getIndexAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\GetIndexRequest
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\Admin\V1\Index |
importDocuments
Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::importDocumentsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ImportDocumentsRequest
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\OperationResponse |
listDatabases
List all the databases in the project.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::listDatabasesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ListDatabasesRequest
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\Admin\V1\ListDatabasesResponse |
listFields
Lists the field configuration and metadata for this database.
Currently,
FirestoreAdmin.ListFields
only supports listing fields that have been explicitly overridden. To issue
this query, call
FirestoreAdmin.ListFields
with the filter set to indexConfig.usesAncestorConfig:false
.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::listFieldsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ListFieldsRequest
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 |
listIndexes
Lists composite indexes.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::listIndexesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ListIndexesRequest
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 |
updateDatabase
Updates a database.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::updateDatabaseAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\UpdateDatabaseRequest
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\OperationResponse |
updateField
Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
FirestoreAdmin.UpdateField
should provide a field mask to avoid changing any configuration that the
caller isn't aware of. The field mask should be specified as: { paths:
"index_config" }
.
This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata.
To configure the default field settings for the database, use
the special Field
with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*
.
The async variant is Google\Cloud\Firestore\Admin\V1\Client\BaseClient\self::updateFieldAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\UpdateFieldRequest
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\OperationResponse |
createDatabaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\CreateDatabaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
createIndexAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\CreateIndexRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteIndexAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\DeleteIndexRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
exportDocumentsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ExportDocumentsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getDatabaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\GetDatabaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getFieldAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\GetFieldRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getIndexAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\GetIndexRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
importDocumentsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ImportDocumentsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listDatabasesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ListDatabasesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listFieldsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ListFieldsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listIndexesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\ListIndexesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateDatabaseAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\UpdateDatabaseRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateFieldAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Firestore\Admin\V1\UpdateFieldRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::collectionGroupName
Formats a string containing the fully-qualified path to represent a collection_group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
collection |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted collection_group resource. |
static::databaseName
Formats a string containing the fully-qualified path to represent a database resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted database resource. |
static::fieldName
Formats a string containing the fully-qualified path to represent a field resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
collection |
string
|
field |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted field resource. |
static::indexName
Formats a string containing the fully-qualified path to represent a index resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
collection |
string
|
index |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted index resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project resource. |
static::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
- collectionGroup: projects/{project}/databases/{database}/collectionGroups/{collection}
- database: projects/{project}/databases/{database}
- field: projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}
- index: projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}
- project: projects/{project}
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 | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |