Firestore Admin Client

class google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.firestore_admin_v1.services.firestore_admin.transports.base.FirestoreAdminTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Bases: object

The Cloud Firestore Admin API.

This API provides several administrative services for Cloud Firestore.

Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.

Operation: An Operation represents work being performed in the background.

The index service manages Cloud Firestore indexes.

Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.

The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.

An Operation that is done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.

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

Instantiates the firestore admin client.

  • Parameters

    • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

    • transport (Union[str, **FirestoreAdminTransport]) – The transport to use. If set to None, a transport is chosen automatically.

    • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

    • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

  • Raises

    google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

_exit_(type, value, traceback)

Releases underlying transport’s resources.

WARNING: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

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

Returns a fully-qualified collection_group string.

static common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)

Returns a fully-qualified location string.

static common_organization_path(organization: str)

Returns a fully-qualified organization string.

static common_project_path(project: str)

Returns a fully-qualified project string.

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

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

from google.cloud import firestore_admin_v1

def sample_create_index():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.CreateIndexRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_index(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

  • Parameters

    • request (Union[google.cloud.firestore_admin_v1.types.CreateIndexRequest, *[dict](https://python.readthedocs.io/en/latest/library/stdtypes.html#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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.

  • Returns

    An object representing a long-running operation.

    The result type for the operation will be google.cloud.firestore_admin_v1.types.Index Cloud Firestore indexes enable simple and complex queries against

      documents in a database.

  • Return type

    google.api_core.operation.Operation

static database_path(project: str, database: str)

Returns a fully-qualified database string.

delete_index(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteIndexRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

Deletes a composite index.

from google.cloud import firestore_admin_v1

def sample_delete_index():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.DeleteIndexRequest(
        name="name_value",
    )

    # Make the request
    client.delete_index(request=request)

  • Parameters

    • request (Union[google.cloud.firestore_admin_v1.types.DeleteIndexRequest, *[dict](https://python.readthedocs.io/en/latest/library/stdtypes.html#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](https://python.readthedocs.io/en/latest/library/stdtypes.html#str)]*]) – Strings which should be sent along with the request as metadata.

export_documents(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ExportDocumentsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

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

from google.cloud import firestore_admin_v1

def sample_export_documents():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.ExportDocumentsRequest(
        name="name_value",
    )

    # Make the request
    operation = client.export_documents(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

  • Parameters

  • Returns

    An object representing a long-running operation.

    The result type for the operation will be google.cloud.firestore_admin_v1.types.ExportDocumentsResponse Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.

  • Return type

    google.api_core.operation.Operation

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

Returns a fully-qualified field string.

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

Creates an instance of this client using the provided credentials

file.

  • Parameters

    • 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

    The constructed client.

  • Return type

    FirestoreAdminClient

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

Creates an instance of this client using the provided credentials

info.

  • Parameters

    • 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

    The constructed client.

  • Return type

    FirestoreAdminClient

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

Creates an instance of this client using the provided credentials

file.

  • Parameters

    • 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

    The constructed client.

  • Return type

    FirestoreAdminClient

get_database(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetDatabaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

Gets information about a database.

from google.cloud import firestore_admin_v1

def sample_get_database():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.GetDatabaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_database(request=request)

    # Handle the response
    print(response)

  • Parameters

  • Returns

    A Cloud Firestore Database.

      Currently only one database is allowed per cloud
  project; this database must have a database_id of
  ‘(default)’.

  • Return type

    google.cloud.firestore_admin_v1.types.Database

get_field(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetFieldRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

Gets the metadata and configuration for a Field.

from google.cloud import firestore_admin_v1

def sample_get_field():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.GetFieldRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_field(request=request)

    # Handle the response
    print(response)

  • Parameters

  • Returns

    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.

  • Return type

    google.cloud.firestore_admin_v1.types.Field

get_index(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetIndexRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

Gets a composite index.

from google.cloud import firestore_admin_v1

def sample_get_index():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.GetIndexRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_index(request=request)

    # Handle the response
    print(response)

  • Parameters

  • Returns

    Cloud Firestore indexes enable simple and complex queries against documents in a database.

  • Return type

    google.cloud.firestore_admin_v1.types.Index

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variabel is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

import_documents(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ImportDocumentsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

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.

from google.cloud import firestore_admin_v1

def sample_import_documents():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.ImportDocumentsRequest(
        name="name_value",
    )

    # Make the request
    operation = client.import_documents(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

  • Parameters

  • Returns

    An 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 {}.

  • Return type

    google.api_core.operation.Operation

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

Returns a fully-qualified index string.

list_databases(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListDatabasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

List all the databases in the project.

from google.cloud import firestore_admin_v1

def sample_list_databases():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.ListDatabasesRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_databases(request=request)

    # Handle the response
    print(response)

  • Parameters

  • Returns

    The list of databases for a project.

  • Return type

    google.cloud.firestore_admin_v1.types.ListDatabasesResponse

list_fields(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListFieldsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

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 .

from google.cloud import firestore_admin_v1

def sample_list_fields():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.ListFieldsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_fields(request=request)

    # Handle the response
    for response in page_result:
        print(response)

  • Parameters

  • Returns

    The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].

    Iterating over this object will yield results and resolve additional pages automatically.

  • Return type

    google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListFieldsPager

list_indexes(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListIndexesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

Lists composite indexes.

from google.cloud import firestore_admin_v1

def sample_list_indexes():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.ListIndexesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_indexes(request=request)

    # Handle the response
    for response in page_result:
        print(response)

  • Parameters

  • Returns

    The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].

    Iterating over this object will yield results and resolve additional pages automatically.

  • Return type

    google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListIndexesPager

static parse_collection_group_path(path: str)

Parses a collection_group path into its component segments.

static parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)

Parse a folder path into its component segments.

static parse_common_location_path(path: str)

Parse a location path into its component segments.

static parse_common_organization_path(path: str)

Parse a organization path into its component segments.

static parse_common_project_path(path: str)

Parse a project path into its component segments.

static parse_database_path(path: str)

Parses a database path into its component segments.

static parse_field_path(path: str)

Parses a field path into its component segments.

static parse_index_path(path: str)

Parses a index path into its component segments.

property transport(: google.cloud.firestore_admin_v1.services.firestore_admin.transports.base.FirestoreAdminTranspor )

Returns the transport used by the client instance.

  • Returns

    The transport used by the client

      instance.

  • Return type

    FirestoreAdminTransport

update_database(request: Optional[Union[google.cloud.firestore_admin_v1.types.firestore_admin.UpdateDatabaseRequest, dict]] = None, *, database: Optional[google.cloud.firestore_admin_v1.types.database.Database] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

Updates a database.

from google.cloud import firestore_admin_v1

def sample_update_database():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    request = firestore_admin_v1.UpdateDatabaseRequest(
    )

    # Make the request
    operation = client.update_database(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

  • Parameters

  • Returns

    An object representing a long-running operation.

    The result type for the operation will be google.cloud.firestore_admin_v1.types.Database A Cloud Firestore Database.

      Currently only one database is allowed per cloud
  project; this database must have a database_id of
  ‘(default)’.

  • Return type

    google.api_core.operation.Operation

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE:

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

from google.cloud import firestore_admin_v1

def sample_update_field():
    # Create a client
    client = firestore_admin_v1.FirestoreAdminClient()

    # Initialize request argument(s)
    field = firestore_admin_v1.Field()
    field.name = "name_value"

    request = firestore_admin_v1.UpdateFieldRequest(
        field=field,
    )

    # Make the request
    operation = client.update_field(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

  • Parameters

  • Returns

    An object representing a long-running operation.

    The result type for the operation will be google.cloud.firestore_admin_v1.types.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.

  • Return type

    google.api_core.operation.Operation