Package Methods (2.21.0)
Summary of entries of Methods for firestore.
google.cloud.firestore_v1.async_transaction.async_transactional
async_transactional(to_wrap:typing.Callable[[google.cloud.firestore_v1.async_transaction.AsyncTransaction],typing.Any],)->google.cloud.firestore_v1.async_transaction._AsyncTransactionalDecorate a callable so that it runs in a transaction.
See more:google.cloud.firestore_v1.async_transaction.async_transactional
google.cloud.firestore_v1.field_path.get_field_path
get_field_path(field_names:typing.Iterable[str])Create afield path from a list of nested field names.
See more:google.cloud.firestore_v1.field_path.get_field_path
google.cloud.firestore_v1.field_path.get_nested_value
get_nested_value(field_path:str,data:dict)Get a (potentially nested) value from a dictionary.
See more:google.cloud.firestore_v1.field_path.get_nested_value
google.cloud.firestore_v1.field_path.parse_field_path
parse_field_path(api_repr:str)Parse afield path from into a list of nested field names.
See more:google.cloud.firestore_v1.field_path.parse_field_path
google.cloud.firestore_v1.field_path.render_field_path
render_field_path(field_names:typing.Iterable[str])Create afield path from a list of nested field names.
See more:google.cloud.firestore_v1.field_path.render_field_path
google.cloud.firestore_v1.field_path.split_field_path
split_field_path(path:str|None)Split a field path into valid elements (without dots).
See more:google.cloud.firestore_v1.field_path.split_field_path
google.cloud.firestore_v1.transaction.transactional
transactional(to_wrap:typing.Callable,)->google.cloud.firestore_v1.transaction._TransactionalDecorate a callable so that it runs in a transaction.
See more:google.cloud.firestore_v1.transaction.transactional
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient
FirestoreAdminClient(*,credentials:typing.Optional[google.auth.credentials.Credentials]=None,transport:typing.Optional[typing.Union[str,google.cloud.firestore_admin_v1.services.firestore_admin.transports.base.FirestoreAdminTransport,typing.Callable[[...],google.cloud.firestore_admin_v1.services.firestore_admin.transports.base.FirestoreAdminTransport]]]=None,client_options:typing.Optional[typing.Union[google.api_core.client_options.ClientOptions,dict]]=None,client_info:google.api_core.gapic_v1.client_info.ClientInfo=Instantiates the firestore admin client.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.__exit__
__exit__(type,value,traceback)Releases underlying transport's resources.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.exit
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.backup_path
backup_path(project:str,location:str,backup:str)->strReturns a fully-qualified backup string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.backup_path
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.backup_schedule_path
backup_schedule_path(project:str,database:str,backup_schedule:str)->strReturns a fully-qualified backup_schedule string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.bulk_delete_documents
bulk_delete_documents(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.BulkDeleteDocumentsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationBulk deletes a subset of documents from Google CloudFirestore.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.cancel_operation
cancel_operation(request:typing.Optional[google.longrunning.operations_pb2.CancelOperationRequest]=None,*,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->NoneStarts asynchronous cancellation on a long-running operation.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.collection_group_path
collection_group_path(project:str,database:str,collection:str)->strReturns a fully-qualified collection_group string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.common_billing_account_path
common_billing_account_path(billing_account:str)->strReturns a fully-qualified billing_account string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.common_folder_path
common_folder_path(folder:str)->strReturns a fully-qualified folder string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.common_location_path
common_location_path(project:str,location:str)->strReturns a fully-qualified location string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.common_organization_path
common_organization_path(organization:str)->strReturns a fully-qualified organization string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.common_project_path
common_project_path(project:str)->strReturns a fully-qualified project string.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.create_backup_schedule
create_backup_schedule(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.CreateBackupScheduleRequest,dict,]]=None,*,parent:typing.Optional[str]=None,backup_schedule:typing.Optional[google.cloud.firestore_admin_v1.types.schedule.BackupSchedule]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.schedule.BackupScheduleCreates a backup schedule on a database.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.create_database
create_database(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.CreateDatabaseRequest,dict,]]=None,*,parent:typing.Optional[str]=None,database:typing.Optional[google.cloud.firestore_admin_v1.types.database.Database]=None,database_id:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationCreate a database.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.create_database
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.create_index
create_index(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.CreateIndexRequest,dict,]]=None,*,parent:typing.Optional[str]=None,index:typing.Optional[google.cloud.firestore_admin_v1.types.index.Index]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationCreates a composite index.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.create_index
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.create_user_creds
create_user_creds(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.CreateUserCredsRequest,dict,]]=None,*,parent:typing.Optional[str]=None,user_creds:typing.Optional[google.cloud.firestore_admin_v1.types.user_creds.UserCreds]=None,user_creds_id:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.user_creds.UserCredsCreate a user creds.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.database_path
database_path(project:str,database:str)->strReturns a fully-qualified database string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.database_path
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_backup
delete_backup(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteBackupRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->NoneDeletes a backup.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_backup
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_backup_schedule
delete_backup_schedule(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteBackupScheduleRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->NoneDeletes a backup schedule.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_database
delete_database(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteDatabaseRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationDeletes a database.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_database
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_index
delete_index(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteIndexRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->NoneDeletes a composite index.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_index
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_operation
delete_operation(request:typing.Optional[google.longrunning.operations_pb2.DeleteOperationRequest]=None,*,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->NoneDeletes a long-running operation.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.delete_user_creds
delete_user_creds(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.DeleteUserCredsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->NoneDeletes a user creds.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.disable_user_creds
disable_user_creds(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.DisableUserCredsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.user_creds.UserCredsDisables a user creds.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.enable_user_creds
enable_user_creds(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.EnableUserCredsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.user_creds.UserCredsEnables a user creds.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.export_documents
export_documents(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ExportDocumentsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationExports a copy of all or a subset of documents fromGoogle Cloud Firestore to another storage system, suchas Google Cloud Storage.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.field_path
field_path(project:str,database:str,collection:str,field:str)->strReturns a fully-qualified field string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.field_path
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.from_service_account_file
from_service_account_file(filename:str,*args,**kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.from_service_account_info
from_service_account_info(info:dict,*args,**kwargs)Creates an instance of this client using the provided credentials info.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.from_service_account_json
from_service_account_json(filename:str,*args,**kwargs)Creates an instance of this client using the provided credentials file.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_backup
get_backup(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetBackupRequest,dict]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.backup.BackupGets information about a backup.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_backup
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_backup_schedule
get_backup_schedule(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetBackupScheduleRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.schedule.BackupScheduleGets information about a backup schedule.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_database
get_database(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetDatabaseRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.database.DatabaseGets information about a database.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_database
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_field
get_field(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetFieldRequest,dict]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.field.FieldGets the metadata and configuration for a Field.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_field
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_index
get_index(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetIndexRequest,dict]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.index.IndexGets a composite index.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_index
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(client_options:typing.Optional[google.api_core.client_options.ClientOptions]=None,)Deprecated.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_operation
get_operation(request:typing.Optional[google.longrunning.operations_pb2.GetOperationRequest]=None,*,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.longrunning.operations_pb2.OperationGets the latest state of a long-running operation.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_operation
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_user_creds
get_user_creds(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.GetUserCredsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.user_creds.UserCredsGets a user creds resource.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.get_user_creds
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.import_documents
import_documents(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ImportDocumentsRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationImports documents into Google Cloud Firestore.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.index_path
index_path(project:str,database:str,collection:str,index:str)->strReturns a fully-qualified index string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.index_path
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_backup_schedules
list_backup_schedules(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListBackupSchedulesRequest,dict,]]=None,*,parent:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.firestore_admin.ListBackupSchedulesResponseList backup schedules.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_backups
list_backups(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListBackupsRequest,dict,]]=None,*,parent:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.firestore_admin.ListBackupsResponseLists all the backups.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_backups
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_databases
list_databases(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListDatabasesRequest,dict,]]=None,*,parent:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.firestore_admin.ListDatabasesResponseList all the databases in the project.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_databases
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_fields
list_fields(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListFieldsRequest,dict,]]=None,*,parent:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListFieldsPagerLists the field configuration and metadata for this database.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_fields
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_indexes
list_indexes(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListIndexesRequest,dict,]]=None,*,parent:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.services.firestore_admin.pagers.ListIndexesPagerLists composite indexes.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_indexes
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_operations
list_operations(request:typing.Optional[google.longrunning.operations_pb2.ListOperationsRequest]=None,*,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.longrunning.operations_pb2.ListOperationsResponseLists operations that match the specified filter in the request.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_operations
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_user_creds
list_user_creds(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ListUserCredsRequest,dict,]]=None,*,parent:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.firestore_admin.ListUserCredsResponseList all user creds in the database.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.list_user_creds
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.location_path
location_path(project:str,location:str)->strReturns a fully-qualified location string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.location_path
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.operation_path
operation_path(project:str,database:str,operation:str)->strReturns a fully-qualified operation string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.operation_path
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_backup_path
parse_backup_path(path:str)->typing.Dict[str,str]Parses a backup path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_backup_schedule_path
parse_backup_schedule_path(path:str)->typing.Dict[str,str]Parses a backup_schedule path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_collection_group_path
parse_collection_group_path(path:str)->typing.Dict[str,str]Parses a collection_group path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path:str)->typing.Dict[str,str]Parse a billing_account path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_common_folder_path
parse_common_folder_path(path:str)->typing.Dict[str,str]Parse a folder path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_common_location_path
parse_common_location_path(path:str)->typing.Dict[str,str]Parse a location path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_common_organization_path
parse_common_organization_path(path:str)->typing.Dict[str,str]Parse a organization path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_common_project_path
parse_common_project_path(path:str)->typing.Dict[str,str]Parse a project path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_database_path
parse_database_path(path:str)->typing.Dict[str,str]Parses a database path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_field_path
parse_field_path(path:str)->typing.Dict[str,str]Parses a field path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_index_path
parse_index_path(path:str)->typing.Dict[str,str]Parses a index path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_location_path
parse_location_path(path:str)->typing.Dict[str,str]Parses a location path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_operation_path
parse_operation_path(path:str)->typing.Dict[str,str]Parses a operation path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.parse_user_creds_path
parse_user_creds_path(path:str)->typing.Dict[str,str]Parses a user_creds path into its component segments.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.reset_user_password
reset_user_password(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.ResetUserPasswordRequest,dict,]]=None,*,name:typing.Optional[str]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.user_creds.UserCredsResets the password of a user creds.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.restore_database
restore_database(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.RestoreDatabaseRequest,dict,]]=None,*,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationCreates a new database by restoring from an existing backup.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.update_backup_schedule
update_backup_schedule(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.UpdateBackupScheduleRequest,dict,]]=None,*,backup_schedule:typing.Optional[google.cloud.firestore_admin_v1.types.schedule.BackupSchedule]=None,update_mask:typing.Optional[google.protobuf.field_mask_pb2.FieldMask]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.cloud.firestore_admin_v1.types.schedule.BackupScheduleUpdates a backup schedule.
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.update_database
update_database(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.UpdateDatabaseRequest,dict,]]=None,*,database:typing.Optional[google.cloud.firestore_admin_v1.types.database.Database]=None,update_mask:typing.Optional[google.protobuf.field_mask_pb2.FieldMask]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationUpdates a database.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.update_database
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.update_field
update_field(request:typing.Optional[typing.Union[google.cloud.firestore_admin_v1.types.firestore_admin.UpdateFieldRequest,dict,]]=None,*,field:typing.Optional[google.cloud.firestore_admin_v1.types.field.Field]=None,retry:typing.Optional[typing.Union[google.api_core.retry.retry_unary.Retry,google.api_core.gapic_v1.method._MethodDefault,]]=_MethodDefault._DEFAULT_VALUE,timeout:typing.Union[float,object]=_MethodDefault._DEFAULT_VALUE,metadata:typing.Sequence[typing.Tuple[str,typing.Union[str,bytes]]]=())->google.api_core.operation.OperationUpdates a field configuration.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.update_field
google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.user_creds_path
user_creds_path(project:str,database:str,user_creds:str)->strReturns a fully-qualified user_creds string.
See more:google.cloud.firestore_admin_v1.services.firestore_admin.client.FirestoreAdminClient.user_creds_path
google.cloud.firestore_bundle.bundle.FirestoreBundle.add_document
add_document(snapshot:google.cloud.firestore_v1.base_document.DocumentSnapshot,)->google.cloud.firestore_bundle.bundle.FirestoreBundleAdds a document to the bundle.
See more:google.cloud.firestore_bundle.bundle.FirestoreBundle.add_document
google.cloud.firestore_bundle.bundle.FirestoreBundle.add_named_query
add_named_query(name:str,query:google.cloud.firestore_v1.base_query.BaseQuery)->google.cloud.firestore_bundle.bundle.FirestoreBundleAdds a query to the bundle, referenced by the provided name.
See more:google.cloud.firestore_bundle.bundle.FirestoreBundle.add_named_query
google.cloud.firestore_bundle.bundle.FirestoreBundle.build
build()->strIterates over the bundle's stored documents and queries and producesa single length-prefixed json string suitable for long-term storage.
See more:google.cloud.firestore_bundle.bundle.FirestoreBundle.build
google.cloud.firestore_v1.aggregation.AggregationQuery.get
get(transaction=None,retry:Union[retries.Retry,None,object]=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,*,explain_options:Optional[ExplainOptions]=None)->QueryResultsList[AggregationResult]Runs the aggregation query.
See more:google.cloud.firestore_v1.aggregation.AggregationQuery.get
google.cloud.firestore_v1.aggregation.AggregationQuery.stream
stream(transaction:Optional["transaction.Transaction"]=None,retry:Union[retries.Retry,None,object]=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->StreamGenerator[List[AggregationResult]]Runs the aggregation query.
See more:google.cloud.firestore_v1.aggregation.AggregationQuery.stream
google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery.get
get(transaction=None,retry:Union[retries.AsyncRetry,None,object]=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,*,explain_options:Optional[ExplainOptions]=None)->QueryResultsList[List[AggregationResult]]Runs the aggregation query.
See more:google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery.get
google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery.stream
stream(transaction:Optional[transaction.Transaction]=None,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->AsyncStreamGenerator[List[AggregationResult]]Runs the aggregation query.
See more:google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery.stream
google.cloud.firestore_v1.async_batch.AsyncWriteBatch.commit
commit(retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->listCommit the changes accumulated in this batch.
See more:google.cloud.firestore_v1.async_batch.AsyncWriteBatch.commit
google.cloud.firestore_v1.async_client.AsyncClient.batch
batch()->google.cloud.firestore_v1.async_batch.AsyncWriteBatchGet a batch instance from this client.
See more:google.cloud.firestore_v1.async_client.AsyncClient.batch
google.cloud.firestore_v1.async_client.AsyncClient.collection
collection(*collection_path:str,)->google.cloud.firestore_v1.async_collection.AsyncCollectionReferenceGet a reference to a collection.
See more:google.cloud.firestore_v1.async_client.AsyncClient.collection
google.cloud.firestore_v1.async_client.AsyncClient.collection_group
collection_group(collection_id:str,)->google.cloud.firestore_v1.async_query.AsyncCollectionGroupCreates and returns a new AsyncQuery that includes all documents in thedatabase that are contained in a collection or subcollection with thegiven collection_id.
See more:google.cloud.firestore_v1.async_client.AsyncClient.collection_group
google.cloud.firestore_v1.async_client.AsyncClient.collections
collections(retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.AsyncGenerator[google.cloud.firestore_v1.async_collection.AsyncCollectionReference,typing.Any]List top-level collections of the client's database.
See more:google.cloud.firestore_v1.async_client.AsyncClient.collections
google.cloud.firestore_v1.async_client.AsyncClient.document
document(*document_path:str,)->google.cloud.firestore_v1.async_document.AsyncDocumentReferenceGet a reference to a document in a collection.
See more:google.cloud.firestore_v1.async_client.AsyncClient.document
google.cloud.firestore_v1.async_client.AsyncClient.get_all
get_all(references:typing.List[google.cloud.firestore_v1.async_document.AsyncDocumentReference],field_paths:typing.Optional[typing.Iterable[str]]=None,transaction:typing.Optional[google.cloud.firestore_v1.async_transaction.AsyncTransaction]=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.AsyncGenerator[google.cloud.firestore_v1.base_document.DocumentSnapshot,typing.Any]Retrieve a batch of documents.
See more:google.cloud.firestore_v1.async_client.AsyncClient.get_all
google.cloud.firestore_v1.async_client.AsyncClient.recursive_delete
recursive_delete(reference:Union[AsyncCollectionReference,AsyncDocumentReference],*,bulk_writer:Optional["BulkWriter"]=None,chunk_size:int=5000)->intDeletes documents and their subcollections, regardless of collectionname.
See more:google.cloud.firestore_v1.async_client.AsyncClient.recursive_delete
google.cloud.firestore_v1.async_client.AsyncClient.transaction
transaction(**kwargs,)->google.cloud.firestore_v1.async_transaction.AsyncTransactionGet a transaction that uses this client.
See more:google.cloud.firestore_v1.async_client.AsyncClient.transaction
google.cloud.firestore_v1.async_collection.AsyncCollectionReference.add
add(document_data:dict,document_id:typing.Optional[str]=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Tuple[typing.Any,typing.Any]Create a document in the Firestore database with the provided data.
See more:google.cloud.firestore_v1.async_collection.AsyncCollectionReference.add
google.cloud.firestore_v1.async_collection.AsyncCollectionReference.document
document(document_id:typing.Optional[str]=None,)->google.cloud.firestore_v1.async_document.AsyncDocumentReferenceCreate a sub-document underneath the current collection.
See more:google.cloud.firestore_v1.async_collection.AsyncCollectionReference.document
google.cloud.firestore_v1.async_collection.AsyncCollectionReference.get
get(transaction:Optional[transaction.Transaction]=None,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->QueryResultsList[DocumentSnapshot]Read the documents in this collection.
See more:google.cloud.firestore_v1.async_collection.AsyncCollectionReference.get
google.cloud.firestore_v1.async_collection.AsyncCollectionReference.list_documents
list_documents(page_size:typing.Optional[int]=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.AsyncGenerator[google.cloud.firestore_v1.document.DocumentReference,None]List all subdocuments of the current collection.
See more:google.cloud.firestore_v1.async_collection.AsyncCollectionReference.list_documents
google.cloud.firestore_v1.async_collection.AsyncCollectionReference.stream
stream(transaction:Optional[transaction.Transaction]=None,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->AsyncStreamGenerator[DocumentSnapshot]Read the documents in this collection.
See more:google.cloud.firestore_v1.async_collection.AsyncCollectionReference.stream
google.cloud.firestore_v1.async_document.AsyncDocumentReference.collections
collections(page_size:typing.Optional[int]=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.AsyncGeneratorList subcollections of the current document.
See more:google.cloud.firestore_v1.async_document.AsyncDocumentReference.collections
google.cloud.firestore_v1.async_document.AsyncDocumentReference.create
create(document_data:dict,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.types.write.WriteResultCreate the current document in the Firestore database.
See more:google.cloud.firestore_v1.async_document.AsyncDocumentReference.create
google.cloud.firestore_v1.async_document.AsyncDocumentReference.delete
delete(option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.protobuf.timestamp_pb2.TimestampDelete the current document in the Firestore database.
See more:google.cloud.firestore_v1.async_document.AsyncDocumentReference.delete
google.cloud.firestore_v1.async_document.AsyncDocumentReference.get
get(field_paths:typing.Optional[typing.Iterable[str]]=None,transaction=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.base_document.DocumentSnapshotRetrieve a snapshot of the current document.
See more:google.cloud.firestore_v1.async_document.AsyncDocumentReference.get
google.cloud.firestore_v1.async_document.AsyncDocumentReference.set
set(document_data:dict,merge:bool=False,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.types.write.WriteResultReplace the current document in the Firestore database.
See more:google.cloud.firestore_v1.async_document.AsyncDocumentReference.set
google.cloud.firestore_v1.async_document.AsyncDocumentReference.update
update(field_updates:dict,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.types.write.WriteResultUpdate an existing document in the Firestore database.
See more:google.cloud.firestore_v1.async_document.AsyncDocumentReference.update
google.cloud.firestore_v1.async_query.AsyncCollectionGroup.get_partitions
get_partitions(partition_count,retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.AsyncGenerator[google.cloud.firestore_v1.base_query.QueryPartition,None]Partition a query for parallelization.
See more:google.cloud.firestore_v1.async_query.AsyncCollectionGroup.get_partitions
google.cloud.firestore_v1.async_query.AsyncQuery.avg
avg(field_ref:str|FieldPath,alias:str|None=None)->Type["firestore_v1.async_aggregation.AsyncAggregationQuery"]Adds an avg over the nested query.
See more:google.cloud.firestore_v1.async_query.AsyncQuery.avg
google.cloud.firestore_v1.async_query.AsyncQuery.count
count(alias:typing.Optional[str]=None,)->typing.Type[google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery]Adds a count over the nested query.
See more:google.cloud.firestore_v1.async_query.AsyncQuery.count
google.cloud.firestore_v1.async_query.AsyncQuery.find_nearest
find_nearest(vector_field:str,query_vector:Vector,limit:int,distance_measure:DistanceMeasure,*,distance_result_field:Optional[str]=None,distance_threshold:Optional[float]=None)->AsyncVectorQueryFinds the closest vector embeddings to the given query vector.
See more:google.cloud.firestore_v1.async_query.AsyncQuery.find_nearest
google.cloud.firestore_v1.async_query.AsyncQuery.get
get(transaction:Optional[AsyncTransaction]=None,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->QueryResultsList[DocumentSnapshot]Read the documents in the collection that match this query.
See more:google.cloud.firestore_v1.async_query.AsyncQuery.get
google.cloud.firestore_v1.async_query.AsyncQuery.stream
stream(transaction:Optional[AsyncTransaction]=None,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->AsyncStreamGenerator[DocumentSnapshot]Read the documents in the collection that match this query.
See more:google.cloud.firestore_v1.async_query.AsyncQuery.stream
google.cloud.firestore_v1.async_query.AsyncQuery.sum
sum(field_ref:str|FieldPath,alias:str|None=None)->Type["firestore_v1.async_aggregation.AsyncAggregationQuery"]Adds a sum over the nested query.
See more:google.cloud.firestore_v1.async_query.AsyncQuery.sum
google.cloud.firestore_v1.async_transaction.AsyncTransaction.commit
commit(retry:(google.api_core.retry.retry_unary_async.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->listCommit the changes accumulated in this batch.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.commit
google.cloud.firestore_v1.async_transaction.AsyncTransaction.create
create(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:dict,)->NoneAdd a "change" to this batch to create a document.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.create
google.cloud.firestore_v1.async_transaction.AsyncTransaction.delete
delete(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,)->NoneAdd a "change" to delete a document.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.delete
google.cloud.firestore_v1.async_transaction.AsyncTransaction.get
get(ref_or_query:AsyncDocumentReference|AsyncQuery,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->AsyncGenerator[DocumentSnapshot,Any]|AsyncStreamGenerator[DocumentSnapshot]Retrieve a document or a query result from the database.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.get
google.cloud.firestore_v1.async_transaction.AsyncTransaction.get_all
get_all(references:list,retry:retries.AsyncRetry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,)->AsyncGenerator[DocumentSnapshot,Any]Retrieves multiple documents from Firestore.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.get_all
google.cloud.firestore_v1.async_transaction.AsyncTransaction.set
set(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:dict,merge:typing.Union[bool,list]=False,)->NoneAdd a "change" to replace a document.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.set
google.cloud.firestore_v1.async_transaction.AsyncTransaction.update
update(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,field_updates:dict,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,)->NoneAdd a "change" to update a document.
See more:google.cloud.firestore_v1.async_transaction.AsyncTransaction.update
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.add_aggregation
add_aggregation(aggregation:google.cloud.firestore_v1.base_aggregation.BaseAggregation,)->NoneAdds an aggregation operation to the nested query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.add_aggregation
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.add_aggregations
add_aggregations(aggregations:typing.List[google.cloud.firestore_v1.base_aggregation.BaseAggregation],)->NoneAdds a list of aggregations to the nested query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.add_aggregations
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.avg
avg(field_ref:str|google.cloud.firestore_v1.field_path.FieldPath,alias:typing.Optional[str]=None,)Adds an avg over the nested query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.avg
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.count
count(alias:typing.Optional[str]=None)Adds a count over the nested query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.count
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.get
get(transaction=None,retry:Union[retries.Retry,retries.AsyncRetry,None,object]=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,*,explain_options:Optional[ExplainOptions]=None)->(QueryResultsList[AggregationResult]|Coroutine[Any,Any,List[List[AggregationResult]]])Runs the aggregation query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.get
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.stream
stream(transaction:Optional[transaction.Transaction]=None,retry:(retries.Retry|retries.AsyncRetry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->(StreamGenerator[List[AggregationResult]]|AsyncStreamGenerator[List[AggregationResult]])Runs the aggregation query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.stream
google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.sum
sum(field_ref:str|google.cloud.firestore_v1.field_path.FieldPath,alias:typing.Optional[str]=None,)Adds a sum over the nested query.
See more:google.cloud.firestore_v1.base_aggregation.BaseAggregationQuery.sum
google.cloud.firestore_v1.base_batch.BaseBatch.commit
commit()Sends all accumulated write operations to the server.
See more:google.cloud.firestore_v1.base_batch.BaseBatch.commit
google.cloud.firestore_v1.base_batch.BaseBatch.create
create(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:dict,)->NoneAdd a "change" to this batch to create a document.
See more:google.cloud.firestore_v1.base_batch.BaseBatch.create
google.cloud.firestore_v1.base_batch.BaseBatch.delete
delete(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,)->NoneAdd a "change" to delete a document.
See more:google.cloud.firestore_v1.base_batch.BaseBatch.delete
google.cloud.firestore_v1.base_batch.BaseBatch.set
set(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:dict,merge:typing.Union[bool,list]=False,)->NoneAdd a "change" to replace a document.
google.cloud.firestore_v1.base_batch.BaseBatch.update
update(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,field_updates:dict,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,)->NoneAdd a "change" to update a document.
See more:google.cloud.firestore_v1.base_batch.BaseBatch.update
google.cloud.firestore_v1.base_client.BaseClient.bulk_writer
bulk_writer(options:typing.Optional[google.cloud.firestore_v1.bulk_writer.BulkWriterOptions]=None,)->google.cloud.firestore_v1.bulk_writer.BulkWriterGet a BulkWriter instance from this client.
See more:google.cloud.firestore_v1.base_client.BaseClient.bulk_writer
google.cloud.firestore_v1.base_client.BaseClient.field_path
field_path(*field_names:str)->strCreate afield path from a list of nested field names.
See more:google.cloud.firestore_v1.base_client.BaseClient.field_path
google.cloud.firestore_v1.base_client.BaseClient.write_option
write_option(**kwargs,)->typing.Union[google.cloud.firestore_v1._helpers.ExistsOption,google.cloud.firestore_v1._helpers.LastUpdateOption,]Create a write option for write operations.
See more:google.cloud.firestore_v1.base_client.BaseClient.write_option
google.cloud.firestore_v1.base_collection.BaseCollectionReference.avg
avg(field_ref:str|FieldPath,alias=None)Adds an avg over the nested query.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.avg
google.cloud.firestore_v1.base_collection.BaseCollectionReference.count
count(alias=None)Adds a count over the nested query.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.count
google.cloud.firestore_v1.base_collection.BaseCollectionReference.document
document(document_id:Optional[str]=None)->DocumentReferenceCreate a sub-document underneath the current collection.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.document
google.cloud.firestore_v1.base_collection.BaseCollectionReference.end_at
end_at(document_fields:Union[DocumentSnapshot,dict,list,tuple])->QueryTypeEnd query at a cursor with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.end_at
google.cloud.firestore_v1.base_collection.BaseCollectionReference.end_before
end_before(document_fields:Union[DocumentSnapshot,dict,list,tuple],)->QueryTypeEnd query before a cursor with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.end_before
google.cloud.firestore_v1.base_collection.BaseCollectionReference.find_nearest
find_nearest(vector_field:str,query_vector:Union[Vector,Sequence[float]],limit:int,distance_measure:DistanceMeasure,*,distance_result_field:Optional[str]=None,distance_threshold:Optional[float]=None)->VectorQueryFinds the closest vector embeddings to the given query vector.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.find_nearest
google.cloud.firestore_v1.base_collection.BaseCollectionReference.limit
limit(count:int)->google.cloud.firestore_v1.base_query.QueryTypeCreate a limited query with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.limit
google.cloud.firestore_v1.base_collection.BaseCollectionReference.limit_to_last
limit_to_last(count:int)Create a limited to last query with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.limit_to_last
google.cloud.firestore_v1.base_collection.BaseCollectionReference.offset
offset(num_to_skip:int)->google.cloud.firestore_v1.base_query.QueryTypeSkip to an offset in a query with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.offset
google.cloud.firestore_v1.base_collection.BaseCollectionReference.order_by
order_by(field_path:str,**kwargs)->google.cloud.firestore_v1.base_query.QueryTypeCreate an "order by" query with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.order_by
google.cloud.firestore_v1.base_collection.BaseCollectionReference.select
select(field_paths:typing.Iterable[str],)->google.cloud.firestore_v1.base_query.QueryTypeCreate a "select" query with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.select
google.cloud.firestore_v1.base_collection.BaseCollectionReference.start_after
start_after(document_fields:Union[DocumentSnapshot,dict,list,tuple],)->QueryTypeStart query after a cursor with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.start_after
google.cloud.firestore_v1.base_collection.BaseCollectionReference.start_at
start_at(document_fields:Union[DocumentSnapshot,dict,list,tuple])->QueryTypeStart query at a cursor with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.start_at
google.cloud.firestore_v1.base_collection.BaseCollectionReference.sum
sum(field_ref:str|FieldPath,alias=None)Adds a sum over the nested query.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.sum
google.cloud.firestore_v1.base_collection.BaseCollectionReference.where
where(field_path:typing.Optional[str]=None,op_string:typing.Optional[str]=None,value=None,*,filter=None)->google.cloud.firestore_v1.base_query.QueryTypeCreate a "where" query with this collection as parent.
See more:google.cloud.firestore_v1.base_collection.BaseCollectionReference.where
google.cloud.firestore_v1.base_document.BaseDocumentReference.__copy__
__copy__()Shallow copy the instance.
See more:google.cloud.firestore_v1.base_document.BaseDocumentReference.copy
google.cloud.firestore_v1.base_document.BaseDocumentReference.__deepcopy__
__deepcopy__(unused_memo)Deep copy the instance.
See more:google.cloud.firestore_v1.base_document.BaseDocumentReference.deepcopy
google.cloud.firestore_v1.base_document.BaseDocumentReference.__eq__
__eq__(other)Equality check against another instance.
See more:google.cloud.firestore_v1.base_document.BaseDocumentReference.eq
google.cloud.firestore_v1.base_document.BaseDocumentReference.__ne__
__ne__(other)Inequality check against another instance.
See more:google.cloud.firestore_v1.base_document.BaseDocumentReference.ne
google.cloud.firestore_v1.base_document.BaseDocumentReference.collection
collection(collection_id:str)Create a sub-collection underneath the current document.
See more:google.cloud.firestore_v1.base_document.BaseDocumentReference.collection
google.cloud.firestore_v1.base_document.DocumentSnapshot.get
get(field_path:str)->typing.AnyGet a value from the snapshot data.
See more:google.cloud.firestore_v1.base_document.DocumentSnapshot.get
google.cloud.firestore_v1.base_document.DocumentSnapshot.to_dict
to_dict()->typing.Optional[typing.Dict[str,typing.Any]]Retrieve the data contained in this snapshot.
See more:google.cloud.firestore_v1.base_document.DocumentSnapshot.to_dict
google.cloud.firestore_v1.base_query.BaseQuery.end_at
end_at(document_fields_or_snapshot:typing.Optional[typing.Union[google.cloud.firestore_v1.base_document.DocumentSnapshot,dict,list,tuple]],)->google.cloud.firestore_v1.base_query.QueryTypeEnd query results at a particular document value.
See more:google.cloud.firestore_v1.base_query.BaseQuery.end_at
google.cloud.firestore_v1.base_query.BaseQuery.end_before
end_before(document_fields_or_snapshot:typing.Optional[typing.Union[google.cloud.firestore_v1.base_document.DocumentSnapshot,dict,list,tuple]],)->google.cloud.firestore_v1.base_query.QueryTypeEnd query results before a particular document value.
See more:google.cloud.firestore_v1.base_query.BaseQuery.end_before
google.cloud.firestore_v1.base_query.BaseQuery.limit
limit(count:int)->google.cloud.firestore_v1.base_query.QueryTypeLimit a query to return at mostcount matching results.
See more:google.cloud.firestore_v1.base_query.BaseQuery.limit
google.cloud.firestore_v1.base_query.BaseQuery.limit_to_last
limit_to_last(count:int)->google.cloud.firestore_v1.base_query.QueryTypeLimit a query to return the lastcount matching results.
See more:google.cloud.firestore_v1.base_query.BaseQuery.limit_to_last
google.cloud.firestore_v1.base_query.BaseQuery.offset
offset(num_to_skip:int)->google.cloud.firestore_v1.base_query.QueryTypeSkip to an offset in a query.
See more:google.cloud.firestore_v1.base_query.BaseQuery.offset
google.cloud.firestore_v1.base_query.BaseQuery.order_by
order_by(field_path:str,direction:str="ASCENDING")->google.cloud.firestore_v1.base_query.QueryTypeModify the query to add an order clause on a specific field.
See more:google.cloud.firestore_v1.base_query.BaseQuery.order_by
google.cloud.firestore_v1.base_query.BaseQuery.recursive
recursive()->google.cloud.firestore_v1.base_query.QueryTypeReturns a copy of this query whose iterator will yield all matchingdocuments as well as each of their descendent subcollections and documents.
See more:google.cloud.firestore_v1.base_query.BaseQuery.recursive
google.cloud.firestore_v1.base_query.BaseQuery.select
select(field_paths:typing.Iterable[str],)->google.cloud.firestore_v1.base_query.QueryTypeProject documents matching query to a limited set of fields.
See more:google.cloud.firestore_v1.base_query.BaseQuery.select
google.cloud.firestore_v1.base_query.BaseQuery.start_after
start_after(document_fields_or_snapshot:typing.Optional[typing.Union[google.cloud.firestore_v1.base_document.DocumentSnapshot,dict,list,tuple]],)->google.cloud.firestore_v1.base_query.QueryTypeStart query results after a particular document value.
See more:google.cloud.firestore_v1.base_query.BaseQuery.start_after
google.cloud.firestore_v1.base_query.BaseQuery.start_at
start_at(document_fields_or_snapshot:typing.Optional[typing.Union[google.cloud.firestore_v1.base_document.DocumentSnapshot,dict,list,tuple]],)->google.cloud.firestore_v1.base_query.QueryTypeStart query results at a particular document value.
See more:google.cloud.firestore_v1.base_query.BaseQuery.start_at
google.cloud.firestore_v1.base_query.BaseQuery.where
where(field_path:typing.Optional[str]=None,op_string:typing.Optional[str]=None,value=None,*,filter=None)->google.cloud.firestore_v1.base_query.QueryTypeFilter the query on a field.
See more:google.cloud.firestore_v1.base_query.BaseQuery.where
google.cloud.firestore_v1.base_query.QueryPartition.query
query()Generate a new query using this partition's bounds.
See more:google.cloud.firestore_v1.base_query.QueryPartition.query
google.cloud.firestore_v1.batch.WriteBatch.commit
commit(retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->listCommit the changes accumulated in this batch.
google.cloud.firestore_v1.bulk_writer.BulkWriter.close
close()Block until all pooled write operations are complete and then rejectany further write operations.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.close
google.cloud.firestore_v1.bulk_writer.BulkWriter.create
create(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:typing.Dict,attempts:int=0,)->NoneAdds acreate pb to the in-progress batch.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.create
google.cloud.firestore_v1.bulk_writer.BulkWriter.delete
delete(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,attempts:int=0,)->NoneAdds adelete pb to the in-progress batch.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.delete
google.cloud.firestore_v1.bulk_writer.BulkWriter.flush
flush()Block until all pooled write operations are complete and then resumeaccepting new write operations.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.flush
google.cloud.firestore_v1.bulk_writer.BulkWriter.on_batch_result
on_batch_result(callback:typing.Optional[typing.Callable[[google.cloud.firestore_v1.bulk_batch.BulkWriteBatch,google.cloud.firestore_v1.types.firestore.BatchWriteResponse,google.cloud.firestore_v1.bulk_writer.BulkWriter,],None,]],)->NoneSets a callback that will be invoked once for every successful batch.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.on_batch_result
google.cloud.firestore_v1.bulk_writer.BulkWriter.on_write_error
on_write_error(callback:typing.Optional[typing.Callable[[google.cloud.firestore_v1.bulk_writer.BulkWriteFailure,google.cloud.firestore_v1.bulk_writer.BulkWriter,],bool,]],)->NoneSets a callback that will be invoked once for every batch that containsan error.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.on_write_error
google.cloud.firestore_v1.bulk_writer.BulkWriter.on_write_result
on_write_result(callback:typing.Optional[typing.Callable[[google.cloud.firestore_v1.base_document.BaseDocumentReference,google.cloud.firestore_v1.types.write.WriteResult,google.cloud.firestore_v1.bulk_writer.BulkWriter,],None,]],)->NoneSets a callback that will be invoked once for every successful operation.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.on_write_result
google.cloud.firestore_v1.bulk_writer.BulkWriter.set
set(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:typing.Dict,merge:typing.Union[bool,list]=False,attempts:int=0,)->NoneAdds aset pb to the in-progress batch.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.set
google.cloud.firestore_v1.bulk_writer.BulkWriter.update
update(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,field_updates:dict,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,attempts:int=0,)->NoneAdds anupdate pb to the in-progress batch.
See more:google.cloud.firestore_v1.bulk_writer.BulkWriter.update
google.cloud.firestore_v1.client.Client.batch
batch()->google.cloud.firestore_v1.batch.WriteBatchGet a batch instance from this client.
google.cloud.firestore_v1.client.Client.collection
collection(*collection_path:str,)->google.cloud.firestore_v1.collection.CollectionReferenceGet a reference to a collection.
google.cloud.firestore_v1.client.Client.collection_group
collection_group(collection_id:str,)->google.cloud.firestore_v1.query.CollectionGroupCreates and returns a new Query that includes all documents in thedatabase that are contained in a collection or subcollection with thegiven collection_id.
See more:google.cloud.firestore_v1.client.Client.collection_group
google.cloud.firestore_v1.client.Client.collections
collections(retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Generator[typing.Any,typing.Any,None]List top-level collections of the client's database.
See more:google.cloud.firestore_v1.client.Client.collections
google.cloud.firestore_v1.client.Client.document
document(*document_path:str,)->google.cloud.firestore_v1.document.DocumentReferenceGet a reference to a document in a collection.
google.cloud.firestore_v1.client.Client.get_all
get_all(references:list,field_paths:typing.Optional[typing.Iterable[str]]=None,transaction:typing.Optional[google.cloud.firestore_v1.transaction.Transaction]=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Generator[google.cloud.firestore_v1.base_document.DocumentSnapshot,typing.Any,None]Retrieve a batch of documents.
google.cloud.firestore_v1.client.Client.recursive_delete
recursive_delete(reference:Union[CollectionReference,DocumentReference],*,bulk_writer:Optional["BulkWriter"]=None,chunk_size:int=5000)->intDeletes documents and their subcollections, regardless of collectionname.
See more:google.cloud.firestore_v1.client.Client.recursive_delete
google.cloud.firestore_v1.client.Client.transaction
transaction(**kwargs)->google.cloud.firestore_v1.transaction.TransactionGet a transaction that uses this client.
See more:google.cloud.firestore_v1.client.Client.transaction
google.cloud.firestore_v1.collection.CollectionReference.add
add(document_data:dict,document_id:typing.Optional[str]=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Tuple[typing.Any,typing.Any]Create a document in the Firestore database with the provided data.
See more:google.cloud.firestore_v1.collection.CollectionReference.add
google.cloud.firestore_v1.collection.CollectionReference.get
get(transaction:Union[transaction.Transaction,None]=None,retry:retries.Retry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Union[float,None]=None,*,explain_options:Optional[ExplainOptions]=None)->QueryResultsList[DocumentSnapshot]Read the documents in this collection.
See more:google.cloud.firestore_v1.collection.CollectionReference.get
google.cloud.firestore_v1.collection.CollectionReference.list_documents
list_documents(page_size:typing.Optional[int]=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Generator[typing.Any,typing.Any,None]List all subdocuments of the current collection.
See more:google.cloud.firestore_v1.collection.CollectionReference.list_documents
google.cloud.firestore_v1.collection.CollectionReference.on_snapshot
on_snapshot(callback:typing.Callable)->google.cloud.firestore_v1.watch.WatchMonitor the documents in this collection.
See more:google.cloud.firestore_v1.collection.CollectionReference.on_snapshot
google.cloud.firestore_v1.collection.CollectionReference.stream
stream(transaction:Optional[transaction.Transaction]=None,retry:retries.Retry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->StreamGenerator[DocumentSnapshot]Read the documents in this collection.
See more:google.cloud.firestore_v1.collection.CollectionReference.stream
google.cloud.firestore_v1.document.DocumentReference.collections
collections(page_size:typing.Optional[int]=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Generator[typing.Any,typing.Any,None]List subcollections of the current document.
See more:google.cloud.firestore_v1.document.DocumentReference.collections
google.cloud.firestore_v1.document.DocumentReference.create
create(document_data:dict,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.types.write.WriteResultCreate a document in the Firestore database.
See more:google.cloud.firestore_v1.document.DocumentReference.create
google.cloud.firestore_v1.document.DocumentReference.delete
delete(option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.protobuf.timestamp_pb2.TimestampDelete the current document in the Firestore database.
See more:google.cloud.firestore_v1.document.DocumentReference.delete
google.cloud.firestore_v1.document.DocumentReference.get
get(field_paths:typing.Optional[typing.Iterable[str]]=None,transaction=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.base_document.DocumentSnapshotRetrieve a snapshot of the current document.
See more:google.cloud.firestore_v1.document.DocumentReference.get
google.cloud.firestore_v1.document.DocumentReference.on_snapshot
on_snapshot(callback:typing.Callable)->google.cloud.firestore_v1.watch.WatchWatch this document.
See more:google.cloud.firestore_v1.document.DocumentReference.on_snapshot
google.cloud.firestore_v1.document.DocumentReference.set
set(document_data:dict,merge:bool=False,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.types.write.WriteResultCreate / replace / merge a document in the Firestore database.
See more:google.cloud.firestore_v1.document.DocumentReference.set
google.cloud.firestore_v1.document.DocumentReference.update
update(field_updates:dict,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->google.cloud.firestore_v1.types.write.WriteResultUpdate an existing document in the Firestore database.
See more:google.cloud.firestore_v1.document.DocumentReference.update
google.cloud.firestore_v1.field_path.FieldPath.__add__
__add__(other)Addsother field path to end of this field path.
google.cloud.firestore_v1.field_path.FieldPath.document_id
document_id()A special FieldPath value to refer to the ID of a document.
See more:google.cloud.firestore_v1.field_path.FieldPath.document_id
google.cloud.firestore_v1.field_path.FieldPath.eq_or_parent
eq_or_parent(other)Check whetherother is an ancestor.
See more:google.cloud.firestore_v1.field_path.FieldPath.eq_or_parent
google.cloud.firestore_v1.field_path.FieldPath.from_api_repr
from_api_repr(api_repr:str)Factory: create a FieldPath from the string formatted per the API.
See more:google.cloud.firestore_v1.field_path.FieldPath.from_api_repr
google.cloud.firestore_v1.field_path.FieldPath.from_string
from_string(path_string:str)Factory: create a FieldPath from a unicode string representation.
See more:google.cloud.firestore_v1.field_path.FieldPath.from_string
google.cloud.firestore_v1.field_path.FieldPath.lineage
lineage()Return field paths for all parents.
See more:google.cloud.firestore_v1.field_path.FieldPath.lineage
google.cloud.firestore_v1.field_path.FieldPath.to_api_repr
to_api_repr()Render a quoted string representation of the FieldPath.
See more:google.cloud.firestore_v1.field_path.FieldPath.to_api_repr
google.cloud.firestore_v1.query.CollectionGroup.get_partitions
get_partitions(partition_count,retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->typing.Generator[google.cloud.firestore_v1.base_query.QueryPartition,None,None]Partition a query for parallelization.
See more:google.cloud.firestore_v1.query.CollectionGroup.get_partitions
google.cloud.firestore_v1.query.Query.avg
avg(field_ref:str|FieldPath,alias:str|None=None)->Type["firestore_v1.aggregation.AggregationQuery"]Adds an avg over the query.
google.cloud.firestore_v1.query.Query.count
count(alias:typing.Optional[str]=None,)->typing.Type[google.cloud.firestore_v1.aggregation.AggregationQuery]Adds a count over the query.
google.cloud.firestore_v1.query.Query.find_nearest
find_nearest(vector_field:str,query_vector:Union[Vector,Sequence[float]],limit:int,distance_measure:DistanceMeasure,*,distance_result_field:Optional[str]=None,distance_threshold:Optional[float]=None)->Type["firestore_v1.vector_query.VectorQuery"]Finds the closest vector embeddings to the given query vector.
google.cloud.firestore_v1.query.Query.get
get(transaction=None,retry:retries.Retry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->QueryResultsList[DocumentSnapshot]Read the documents in the collection that match this query.
google.cloud.firestore_v1.query.Query.on_snapshot
on_snapshot(callback:typing.Callable)->google.cloud.firestore_v1.watch.WatchMonitor the documents in this collection that match this query.
google.cloud.firestore_v1.query.Query.stream
stream(transaction:transaction.Transaction|None=None,retry:retries.Retry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,*,explain_options:Optional[ExplainOptions]=None)->StreamGenerator[DocumentSnapshot]Read the documents in the collection that match this query.
google.cloud.firestore_v1.query.Query.sum
sum(field_ref:str|FieldPath,alias:str|None=None)->Type["firestore_v1.aggregation.AggregationQuery"]Adds a sum over the query.
google.cloud.firestore_v1.transaction.Transaction.commit
commit(retry:(google.api_core.retry.retry_unary.Retry|object|None)=_MethodDefault._DEFAULT_VALUE,timeout:typing.Optional[float]=None,)->listCommit the changes accumulated in this batch.
See more:google.cloud.firestore_v1.transaction.Transaction.commit
google.cloud.firestore_v1.transaction.Transaction.create
create(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:dict,)->NoneAdd a "change" to this batch to create a document.
See more:google.cloud.firestore_v1.transaction.Transaction.create
google.cloud.firestore_v1.transaction.Transaction.delete
delete(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,)->NoneAdd a "change" to delete a document.
See more:google.cloud.firestore_v1.transaction.Transaction.delete
google.cloud.firestore_v1.transaction.Transaction.get
get(ref_or_query:DocumentReference|Query,retry:retries.Retry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:Optional[float]=None,*,explain_options:Optional[ExplainOptions]=None)->StreamGenerator[DocumentSnapshot]|Generator[DocumentSnapshot,Any,None]Retrieve a document or a query result from the database.
See more:google.cloud.firestore_v1.transaction.Transaction.get
google.cloud.firestore_v1.transaction.Transaction.get_all
get_all(references:list,retry:retries.Retry|object|None=_MethodDefault._DEFAULT_VALUE,timeout:float|None=None,)->Generator[DocumentSnapshot,Any,None]Retrieves multiple documents from Firestore.
See more:google.cloud.firestore_v1.transaction.Transaction.get_all
google.cloud.firestore_v1.transaction.Transaction.set
set(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,document_data:dict,merge:typing.Union[bool,list]=False,)->NoneAdd a "change" to replace a document.
See more:google.cloud.firestore_v1.transaction.Transaction.set
google.cloud.firestore_v1.transaction.Transaction.update
update(reference:google.cloud.firestore_v1.base_document.BaseDocumentReference,field_updates:dict,option:typing.Optional[google.cloud.firestore_v1._helpers.WriteOption]=None,)->NoneAdd a "change" to update a document.
See more:google.cloud.firestore_v1.transaction.Transaction.update
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.