Class FirestoreAdminClient

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

Inheritance

builtins.object > FirestoreAdminClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
FirestoreAdminTransportThe transport used by the client instance.

Methods

collection_group_path

collection_group_path(project: str, database: str, collection: str)

Returns a fully-qualified collection_group string.

Parameters
NameDescription
project str
database str
collection str

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

create_index

create_index(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.CreateIndexRequest, dict]] = None, *, parent: Optional[str] = None, index: Optional[google.cloud.firestore_admin_v1.types.index.Index] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a composite index. This returns a google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.CreateIndexRequest, dict]

The request object. The request for FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

parent str

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

index google.cloud.firestore_admin_v1.types.Index

Required. The composite index to create. This corresponds to the index field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Index Cloud Firestore indexes enable simple and complex queries against documents in a database.

database_path

database_path(project: str, database: str)

Returns a fully-qualified database string.

Parameters
NameDescription
project str
database str

delete_index

delete_index(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteIndexRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a composite index.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.DeleteIndexRequest, dict]

The request object. The request for FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].

name str

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

export_documents

export_documents(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ExportDocumentsRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.ExportDocumentsRequest, dict]

The request object. The request for FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

name str

Required. Database to export. Should be of the form: projects/{project_id}/databases/{database_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ExportDocumentsResponse Returned in the `google.longrunning.Operation][google.longrunning.Operation]` response field.

field_path

field_path(project: str, database: str, collection: str, field: str)

Returns a fully-qualified field string.

Parameters
NameDescription
project str
database str
collection str
field str

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
FirestoreAdminClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameters
NameDescription
info dict

The service account private key info.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
FirestoreAdminClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameters
NameDescription
filename str

The path to the service account private key json file.

args

Additional arguments to pass to the constructor.

kwargs

Additional arguments to pass to the constructor.

Returns
TypeDescription
FirestoreAdminClientThe constructed client.

get_field

get_field(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetFieldRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the metadata and configuration for a Field.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.GetFieldRequest, dict]

The request object. The request for FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].

name str

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.firestore_admin_v1.types.FieldRepresents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

get_index

get_index(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetIndexRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a composite index.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.GetIndexRequest, dict]

The request object. The request for FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].

name str

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.firestore_admin_v1.types.IndexCloud Firestore indexes enable simple and complex queries against documents in a database.

import_documents

import_documents(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ImportDocumentsRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.ImportDocumentsRequest, dict]

The request object. The request for FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].

name str

Required. Database to import into. Should be of the form: projects/{project_id}/databases/{database_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

index_path

index_path(project: str, database: str, collection: str, index: str)

Returns a fully-qualified index string.

Parameters
NameDescription
project str
database str
collection str
index str

list_fields

list_fields(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListFieldsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the field configuration and metadata for this database.

Currently, FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to indexConfig.usesAncestorConfig:false.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.ListFieldsRequest, dict]

The request object. The request for FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].

parent str

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListFieldsPagerThe response for `FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields]`. Iterating over this object will yield results and resolve additional pages automatically.

list_indexes

list_indexes(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListIndexesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists composite indexes.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.ListIndexesRequest, dict]

The request object. The request for FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].

parent str

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListIndexesPagerThe response for `FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes]`. Iterating over this object will yield results and resolve additional pages automatically.

parse_collection_group_path

parse_collection_group_path(path: str)

Parses a collection_group path into its component segments.

Parameter
NameDescription
path str

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_database_path

parse_database_path(path: str)

Parses a database path into its component segments.

Parameter
NameDescription
path str

parse_field_path

parse_field_path(path: str)

Parses a field path into its component segments.

Parameter
NameDescription
path str

parse_index_path

parse_index_path(path: str)

Parses a index path into its component segments.

Parameter
NameDescription
path str

update_field

update_field(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.UpdateFieldRequest, dict]] = None, *, field: Optional[google.cloud.firestore_admin_v1.types.field.Field] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField][google.firestore.admin.v1.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][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][google.firestore.admin.v1.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/*.

Parameters
NameDescription
request Union[google.cloud.firestore_admin_v1.types.UpdateFieldRequest, dict]

The request object. The request for FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

field google.cloud.firestore_admin_v1.types.Field

Required. The field to be updated. This corresponds to the field field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Field Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.