Upgrading google-cloud-firestore 1 to 2
Breaking1.9.2 → 2.34.1Platform4New12Changed7Fixed11Other4
BreakingUpgrade verdict
4 platform requirement changes.
In plain terms
- This version no longer works on Python 3.7, 3.8 or 3.9, so you need a newer Python to use it.
- The package now officially supports Python 3.15.
- This version needs a newer version of the Protobuf library to work.
- The package now officially supports Python 3.15.
Must act Top 3 of 4 that need code or config changes
Python requirement changed in 2.28.0: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.* → >=3.10.
Adds google-auth !=2.24.0,!=2.25.0,<3.0.0,>=2.14.1, grpcio <2.0.0,>=1.75.1, proto-plus <2.0.0,>=1.26.1.
Drops pytz.
What you must change
Platform4
Drops Python 3.7-3.9 support and regenerates the library.
Declares support for Python 3.15.
Requires Protobuf 6.33.5 or later.
Declares support for Python 3.15.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- removed:
export __version__ - removed:
export enums - added:
export And - added:
export AsyncClient - added:
export AsyncCollectionReference - added:
export AsyncDocumentReference - added:
export AsyncPipeline - added:
export AsyncPipelineStream - added:
export AsyncQuery - added:
export AsyncTransaction - added:
export AsyncWriteBatch - added:
export BSONBinary - added:
export BSONDecimal128 - added:
export BSONInt32 - added:
export BSONMaxKey - added:
export BSONMinKey - added:
export BSONObjectId - added:
export BSONRegex - added:
export BSONTimestamp - added:
export BSONType - added:
export CollectionGroup - added:
export CountAggregation - added:
export DocumentTransform - added:
export ExplainOptions - added:
export FieldFilter - added:
export FindNearestOptions - added:
export Or - added:
export Ordering - added:
export Pipeline - added:
export PipelineDataType - added:
export PipelineExplainOptions - added:
export PipelineResult - added:
export PipelineSnapshot - added:
export PipelineSource - added:
export PipelineStream - added:
export SampleOptions - added:
export SearchOptions - added:
export SubPipeline - added:
export TimeGranularity - added:
export TimePart - added:
export TimeUnit - added:
export UnnestOptions - added:
export async_transactional - added:
variable __version__
- added:
export CreateIndexRequest - added:
export DeleteIndexRequest - added:
export ExportDocumentsMetadata - added:
export ExportDocumentsRequest - added:
export ExportDocumentsResponse - added:
export Field - added:
export FieldOperationMetadata - added:
export FirestoreAdminClient - added:
export GetFieldRequest - added:
export GetIndexRequest - added:
export ImportDocumentsMetadata - added:
export ImportDocumentsRequest - added:
export Index - added:
export IndexOperationMetadata - added:
export ListFieldsRequest - added:
export ListFieldsResponse - added:
export ListIndexesRequest - added:
export ListIndexesResponse - added:
export LocationMetadata - added:
export OperationState - added:
export Progress - added:
export UpdateFieldRequest
- removed:
class FirestoreAdminClient(firestore_admin_client.FirestoreAdminClient) - removed:
export enums - removed:
export types - removed:
field FirestoreAdminClient.enums - added:
export CreateIndexRequest - added:
export DeleteIndexRequest - added:
export ExportDocumentsMetadata - added:
export ExportDocumentsRequest - added:
export ExportDocumentsResponse - added:
export Field - added:
export FieldOperationMetadata - added:
export FirestoreAdminClient - added:
export GetFieldRequest - added:
export GetIndexRequest - added:
export ImportDocumentsMetadata - added:
export ImportDocumentsRequest - added:
export Index - added:
export IndexOperationMetadata - added:
export ListFieldsRequest - added:
export ListFieldsResponse - added:
export ListIndexesRequest - added:
export ListIndexesResponse - added:
export LocationMetadata - added:
export OperationState - added:
export Progress - added:
export UpdateFieldRequest
- removed:
class FieldOperationMetadata(object) - removed:
class FieldOperationMetadata.IndexConfigDelta(object) - removed:
class FieldOperationMetadata.IndexConfigDelta.ChangeType(enum.IntEnum) - removed:
class Index(object) - removed:
class Index.IndexField(object) - removed:
class Index.IndexField.ArrayConfig(enum.IntEnum) - removed:
class Index.IndexField.Order(enum.IntEnum) - removed:
class Index.QueryScope(enum.IntEnum) - removed:
class Index.State(enum.IntEnum) - removed:
class OperationState(enum.IntEnum) - removed:
field FieldOperationMetadata.IndexConfigDelta.ChangeType.ADD - removed:
field FieldOperationMetadata.IndexConfigDelta.ChangeType.CHANGE_TYPE_UNSPECIFIED - removed:
field FieldOperationMetadata.IndexConfigDelta.ChangeType.REMOVE - removed:
field Index.IndexField.ArrayConfig.ARRAY_CONFIG_UNSPECIFIED - removed:
field Index.IndexField.ArrayConfig.CONTAINS - removed:
field Index.IndexField.Order.ASCENDING - removed:
field Index.IndexField.Order.DESCENDING - removed:
field Index.IndexField.Order.ORDER_UNSPECIFIED - removed:
field Index.QueryScope.COLLECTION - removed:
field Index.QueryScope.COLLECTION_GROUP - removed:
field Index.QueryScope.QUERY_SCOPE_UNSPECIFIED - removed:
field Index.State.CREATING - removed:
field Index.State.NEEDS_REPAIR - removed:
field Index.State.READY - removed:
field Index.State.STATE_UNSPECIFIED - removed:
field OperationState.CANCELLED - removed:
field OperationState.CANCELLING - removed:
field OperationState.FAILED - removed:
field OperationState.FINALIZING - removed:
field OperationState.INITIALIZING - removed:
field OperationState.OPERATION_STATE_UNSPECIFIED - removed:
field OperationState.PROCESSING - removed:
field OperationState.SUCCESSFUL
- removed:
class FirestoreAdminClient(object) - removed:
constructor FirestoreAdminClient(transport=…, channel=…, credentials=…, client_config=…, client_info=…, client_options=…) - removed:
field FirestoreAdminClient.SERVICE_ADDRESS - removed:
field FirestoreAdminClient.from_service_account_json - removed:
method FirestoreAdminClient.create_index(parent, index, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.delete_index(name, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.export_documents(name, collection_ids=…, output_uri_prefix=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.get_field(name, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.get_index(name, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.import_documents(name, collection_ids=…, input_uri_prefix=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.list_fields(parent, filter_=…, page_size=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.list_indexes(parent, filter_=…, page_size=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreAdminClient.update_field(field, update_mask=…, retry=…, timeout=…, metadata=…) - removed:
static method FirestoreAdminClient.collection_group_path(project, database, collection) - removed:
static method FirestoreAdminClient.database_path(project, database) - removed:
static method FirestoreAdminClient.field_path(project, database, collection, field) - removed:
static method FirestoreAdminClient.from_service_account_file(filename, *args, **kwargs) - removed:
static method FirestoreAdminClient.index_path(project, database, collection, index) - removed:
static method FirestoreAdminClient.parent_path(project, database, collection_id)
- removed:
variable config
- removed:
class FirestoreAdminGrpcTransport(object) - removed:
constructor FirestoreAdminGrpcTransport(channel=…, credentials=…, address=…) - removed:
property FirestoreAdminGrpcTransport.channel - removed:
property FirestoreAdminGrpcTransport.create_index - removed:
property FirestoreAdminGrpcTransport.delete_index - removed:
property FirestoreAdminGrpcTransport.export_documents - removed:
property FirestoreAdminGrpcTransport.get_field - removed:
property FirestoreAdminGrpcTransport.get_index - removed:
property FirestoreAdminGrpcTransport.import_documents - removed:
property FirestoreAdminGrpcTransport.list_fields - removed:
property FirestoreAdminGrpcTransport.list_indexes - removed:
property FirestoreAdminGrpcTransport.update_field - removed:
static method FirestoreAdminGrpcTransport.create_channel(address=…, credentials=…, **kwargs)
- removed:
variable DESCRIPTOR - removed:
variable Field
- removed:
variable CreateIndexRequest - removed:
variable DESCRIPTOR - removed:
variable DeleteIndexRequest - removed:
variable ExportDocumentsRequest - removed:
variable GetFieldRequest - removed:
variable GetIndexRequest - removed:
variable ImportDocumentsRequest - removed:
variable ListFieldsRequest - removed:
variable ListFieldsResponse - removed:
variable ListIndexesRequest - removed:
variable ListIndexesResponse - removed:
variable UpdateFieldRequest
- removed:
class FirestoreAdmin(object) - removed:
class FirestoreAdminServicer(object) - removed:
class FirestoreAdminStub(object) - removed:
constructor FirestoreAdminStub(channel) - removed:
function add_FirestoreAdminServicer_to_server(servicer, server) - removed:
method FirestoreAdminServicer.CreateIndex(request, context) - removed:
method FirestoreAdminServicer.DeleteIndex(request, context) - removed:
method FirestoreAdminServicer.ExportDocuments(request, context) - removed:
method FirestoreAdminServicer.GetField(request, context) - removed:
method FirestoreAdminServicer.GetIndex(request, context) - removed:
method FirestoreAdminServicer.ImportDocuments(request, context) - removed:
method FirestoreAdminServicer.ListFields(request, context) - removed:
method FirestoreAdminServicer.ListIndexes(request, context) - removed:
method FirestoreAdminServicer.UpdateField(request, context) - removed:
static method FirestoreAdmin.CreateIndex(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.DeleteIndex(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.ExportDocuments(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.GetField(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.GetIndex(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.ImportDocuments(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.ListFields(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.ListIndexes(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method FirestoreAdmin.UpdateField(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…)
- removed:
variable DESCRIPTOR - removed:
variable Index
- removed:
variable DESCRIPTOR - removed:
variable LocationMetadata
- removed:
variable CANCELLED - removed:
variable CANCELLING - removed:
variable DESCRIPTOR - removed:
variable ExportDocumentsMetadata - removed:
variable ExportDocumentsResponse - removed:
variable FAILED - removed:
variable FINALIZING - removed:
variable FieldOperationMetadata - removed:
variable INITIALIZING - removed:
variable ImportDocumentsMetadata - removed:
variable IndexOperationMetadata - removed:
variable OPERATION_STATE_UNSPECIFIED - removed:
variable OperationState - removed:
variable PROCESSING - removed:
variable Progress - removed:
variable SUCCESSFUL
- added:
export FirestoreAdminAsyncClient - added:
export FirestoreAdminClient
- added:
async method FirestoreAdminAsyncClient.bulk_delete_documents(request: Optional[Union[firestore_admin.BulkDeleteDocumentsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.cancel_operation(request: Optional[Union[operations_pb2.CancelOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAdminAsyncClient.clone_database(request: Optional[Union[firestore_admin.CloneDatabaseRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.create_backup_schedule(request: Optional[Union[firestore_admin.CreateBackupScheduleRequest, dict]]=…, *, parent: Optional[str]=…, backup_schedule: Optional[schedule.BackupSchedule]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> schedule.BackupSchedule - added:
async method FirestoreAdminAsyncClient.create_database(request: Optional[Union[firestore_admin.CreateDatabaseRequest, dict]]=…, *, parent: Optional[str]=…, database: Optional[gfa_database.Database]=…, database_id: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.create_index(request: Optional[Union[firestore_admin.CreateIndexRequest, dict]]=…, *, parent: Optional[str]=…, index: Optional[gfa_index.Index]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.create_user_creds(request: Optional[Union[firestore_admin.CreateUserCredsRequest, dict]]=…, *, parent: Optional[str]=…, user_creds: Optional[gfa_user_creds.UserCreds]=…, user_creds_id: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gfa_user_creds.UserCreds - added:
async method FirestoreAdminAsyncClient.delete_backup(request: Optional[Union[firestore_admin.DeleteBackupRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAdminAsyncClient.delete_backup_schedule(request: Optional[Union[firestore_admin.DeleteBackupScheduleRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAdminAsyncClient.delete_database(request: Optional[Union[firestore_admin.DeleteDatabaseRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.delete_index(request: Optional[Union[firestore_admin.DeleteIndexRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAdminAsyncClient.delete_operation(request: Optional[Union[operations_pb2.DeleteOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAdminAsyncClient.delete_user_creds(request: Optional[Union[firestore_admin.DeleteUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAdminAsyncClient.disable_user_creds(request: Optional[Union[firestore_admin.DisableUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
async method FirestoreAdminAsyncClient.enable_user_creds(request: Optional[Union[firestore_admin.EnableUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
async method FirestoreAdminAsyncClient.export_documents(request: Optional[Union[firestore_admin.ExportDocumentsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.get_backup(request: Optional[Union[firestore_admin.GetBackupRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> backup.Backup - added:
async method FirestoreAdminAsyncClient.get_backup_schedule(request: Optional[Union[firestore_admin.GetBackupScheduleRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> schedule.BackupSchedule - added:
async method FirestoreAdminAsyncClient.get_database(request: Optional[Union[firestore_admin.GetDatabaseRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> database.Database - added:
async method FirestoreAdminAsyncClient.get_field(request: Optional[Union[firestore_admin.GetFieldRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> field.Field - added:
async method FirestoreAdminAsyncClient.get_index(request: Optional[Union[firestore_admin.GetIndexRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> index.Index - added:
async method FirestoreAdminAsyncClient.get_operation(request: Optional[Union[operations_pb2.GetOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.Operation - added:
async method FirestoreAdminAsyncClient.get_user_creds(request: Optional[Union[firestore_admin.GetUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
async method FirestoreAdminAsyncClient.import_documents(request: Optional[Union[firestore_admin.ImportDocumentsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.list_backup_schedules(request: Optional[Union[firestore_admin.ListBackupSchedulesRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListBackupSchedulesResponse - added:
async method FirestoreAdminAsyncClient.list_backups(request: Optional[Union[firestore_admin.ListBackupsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListBackupsResponse - added:
async method FirestoreAdminAsyncClient.list_databases(request: Optional[Union[firestore_admin.ListDatabasesRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListDatabasesResponse - added:
async method FirestoreAdminAsyncClient.list_fields(request: Optional[Union[firestore_admin.ListFieldsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListFieldsAsyncPager - added:
async method FirestoreAdminAsyncClient.list_indexes(request: Optional[Union[firestore_admin.ListIndexesRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListIndexesAsyncPager - added:
async method FirestoreAdminAsyncClient.list_operations(request: Optional[Union[operations_pb2.ListOperationsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.ListOperationsResponse - added:
async method FirestoreAdminAsyncClient.list_user_creds(request: Optional[Union[firestore_admin.ListUserCredsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListUserCredsResponse - added:
async method FirestoreAdminAsyncClient.reset_user_password(request: Optional[Union[firestore_admin.ResetUserPasswordRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
async method FirestoreAdminAsyncClient.restore_database(request: Optional[Union[firestore_admin.RestoreDatabaseRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.update_backup_schedule(request: Optional[Union[firestore_admin.UpdateBackupScheduleRequest, dict]]=…, *, backup_schedule: Optional[schedule.BackupSchedule]=…, update_mask: Optional[field_mask_pb2.FieldMask]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> schedule.BackupSchedule - added:
async method FirestoreAdminAsyncClient.update_database(request: Optional[Union[firestore_admin.UpdateDatabaseRequest, dict]]=…, *, database: Optional[gfa_database.Database]=…, update_mask: Optional[field_mask_pb2.FieldMask]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
async method FirestoreAdminAsyncClient.update_field(request: Optional[Union[firestore_admin.UpdateFieldRequest, dict]]=…, *, field: Optional[gfa_field.Field]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operation_async.AsyncOperation - added:
class FirestoreAdminAsyncClient - added:
constructor FirestoreAdminAsyncClient(*, credentials: Optional[ga_credentials.Credentials]=…, transport: Optional[Union[str, FirestoreAdminTransport, Callable[..., FirestoreAdminTransport]]]=…, client_options: Optional[ClientOptions]=…, client_info: gapic_v1.client_info.ClientInfo=…) -> None - added:
field FirestoreAdminAsyncClient.DEFAULT_ENDPOINT - added:
field FirestoreAdminAsyncClient.DEFAULT_MTLS_ENDPOINT - added:
field FirestoreAdminAsyncClient.backup_path - added:
field FirestoreAdminAsyncClient.backup_schedule_path - added:
field FirestoreAdminAsyncClient.collection_group_path - added:
field FirestoreAdminAsyncClient.common_billing_account_path - added:
field FirestoreAdminAsyncClient.common_folder_path - added:
field FirestoreAdminAsyncClient.common_location_path - added:
field FirestoreAdminAsyncClient.common_organization_path - added:
field FirestoreAdminAsyncClient.common_project_path - added:
field FirestoreAdminAsyncClient.database_path - added:
field FirestoreAdminAsyncClient.field_path - added:
field FirestoreAdminAsyncClient.from_service_account_json - added:
field FirestoreAdminAsyncClient.get_transport_class - added:
field FirestoreAdminAsyncClient.index_path - added:
field FirestoreAdminAsyncClient.location_path - added:
field FirestoreAdminAsyncClient.operation_path - added:
field FirestoreAdminAsyncClient.parse_backup_path - added:
field FirestoreAdminAsyncClient.parse_backup_schedule_path - added:
field FirestoreAdminAsyncClient.parse_collection_group_path - added:
field FirestoreAdminAsyncClient.parse_common_billing_account_path - added:
field FirestoreAdminAsyncClient.parse_common_folder_path - added:
field FirestoreAdminAsyncClient.parse_common_location_path - added:
field FirestoreAdminAsyncClient.parse_common_organization_path - added:
field FirestoreAdminAsyncClient.parse_common_project_path - added:
field FirestoreAdminAsyncClient.parse_database_path - added:
field FirestoreAdminAsyncClient.parse_field_path - added:
field FirestoreAdminAsyncClient.parse_index_path - added:
field FirestoreAdminAsyncClient.parse_location_path - added:
field FirestoreAdminAsyncClient.parse_operation_path - added:
field FirestoreAdminAsyncClient.parse_user_creds_path - added:
field FirestoreAdminAsyncClient.user_creds_path - added:
property FirestoreAdminAsyncClient.api_endpoint -> str - added:
property FirestoreAdminAsyncClient.transport -> FirestoreAdminTransport - added:
property FirestoreAdminAsyncClient.universe_domain -> str - added:
static method FirestoreAdminAsyncClient.from_service_account_file(filename: str, *args, **kwargs) - added:
static method FirestoreAdminAsyncClient.from_service_account_info(info: dict, *args, **kwargs) - added:
static method FirestoreAdminAsyncClient.get_mtls_endpoint_and_cert_source(client_options: Optional[ClientOptions]=…)
- added:
class FirestoreAdminClient - added:
constructor FirestoreAdminClient(*, credentials: Optional[ga_credentials.Credentials]=…, transport: Optional[Union[str, FirestoreAdminTransport, Callable[..., FirestoreAdminTransport]]]=…, client_options: Optional[Union[client_options_lib.ClientOptions, dict]]=…, client_info: gapic_v1.client_info.ClientInfo=…) -> None - added:
field FirestoreAdminClient.DEFAULT_ENDPOINT - added:
field FirestoreAdminClient.DEFAULT_MTLS_ENDPOINT - added:
field FirestoreAdminClient.from_service_account_json - added:
method FirestoreAdminClient.bulk_delete_documents(request: Optional[Union[firestore_admin.BulkDeleteDocumentsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.cancel_operation(request: Optional[Union[operations_pb2.CancelOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreAdminClient.clone_database(request: Optional[Union[firestore_admin.CloneDatabaseRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.create_backup_schedule(request: Optional[Union[firestore_admin.CreateBackupScheduleRequest, dict]]=…, *, parent: Optional[str]=…, backup_schedule: Optional[schedule.BackupSchedule]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> schedule.BackupSchedule - added:
method FirestoreAdminClient.create_database(request: Optional[Union[firestore_admin.CreateDatabaseRequest, dict]]=…, *, parent: Optional[str]=…, database: Optional[gfa_database.Database]=…, database_id: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.create_index(request: Optional[Union[firestore_admin.CreateIndexRequest, dict]]=…, *, parent: Optional[str]=…, index: Optional[gfa_index.Index]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.create_user_creds(request: Optional[Union[firestore_admin.CreateUserCredsRequest, dict]]=…, *, parent: Optional[str]=…, user_creds: Optional[gfa_user_creds.UserCreds]=…, user_creds_id: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gfa_user_creds.UserCreds - added:
method FirestoreAdminClient.delete_backup(request: Optional[Union[firestore_admin.DeleteBackupRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreAdminClient.delete_backup_schedule(request: Optional[Union[firestore_admin.DeleteBackupScheduleRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreAdminClient.delete_database(request: Optional[Union[firestore_admin.DeleteDatabaseRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.delete_index(request: Optional[Union[firestore_admin.DeleteIndexRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreAdminClient.delete_operation(request: Optional[Union[operations_pb2.DeleteOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreAdminClient.delete_user_creds(request: Optional[Union[firestore_admin.DeleteUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreAdminClient.disable_user_creds(request: Optional[Union[firestore_admin.DisableUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
method FirestoreAdminClient.enable_user_creds(request: Optional[Union[firestore_admin.EnableUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
method FirestoreAdminClient.export_documents(request: Optional[Union[firestore_admin.ExportDocumentsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.get_backup(request: Optional[Union[firestore_admin.GetBackupRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> backup.Backup - added:
method FirestoreAdminClient.get_backup_schedule(request: Optional[Union[firestore_admin.GetBackupScheduleRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> schedule.BackupSchedule - added:
method FirestoreAdminClient.get_database(request: Optional[Union[firestore_admin.GetDatabaseRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> database.Database - added:
method FirestoreAdminClient.get_field(request: Optional[Union[firestore_admin.GetFieldRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> field.Field - added:
method FirestoreAdminClient.get_index(request: Optional[Union[firestore_admin.GetIndexRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> index.Index - added:
method FirestoreAdminClient.get_operation(request: Optional[Union[operations_pb2.GetOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.Operation - added:
method FirestoreAdminClient.get_user_creds(request: Optional[Union[firestore_admin.GetUserCredsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
method FirestoreAdminClient.import_documents(request: Optional[Union[firestore_admin.ImportDocumentsRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.list_backup_schedules(request: Optional[Union[firestore_admin.ListBackupSchedulesRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListBackupSchedulesResponse - added:
method FirestoreAdminClient.list_backups(request: Optional[Union[firestore_admin.ListBackupsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListBackupsResponse - added:
method FirestoreAdminClient.list_databases(request: Optional[Union[firestore_admin.ListDatabasesRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListDatabasesResponse - added:
method FirestoreAdminClient.list_fields(request: Optional[Union[firestore_admin.ListFieldsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListFieldsPager - added:
method FirestoreAdminClient.list_indexes(request: Optional[Union[firestore_admin.ListIndexesRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListIndexesPager - added:
method FirestoreAdminClient.list_operations(request: Optional[Union[operations_pb2.ListOperationsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.ListOperationsResponse - added:
method FirestoreAdminClient.list_user_creds(request: Optional[Union[firestore_admin.ListUserCredsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore_admin.ListUserCredsResponse - added:
method FirestoreAdminClient.reset_user_password(request: Optional[Union[firestore_admin.ResetUserPasswordRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> user_creds.UserCreds - added:
method FirestoreAdminClient.restore_database(request: Optional[Union[firestore_admin.RestoreDatabaseRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.update_backup_schedule(request: Optional[Union[firestore_admin.UpdateBackupScheduleRequest, dict]]=…, *, backup_schedule: Optional[schedule.BackupSchedule]=…, update_mask: Optional[field_mask_pb2.FieldMask]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> schedule.BackupSchedule - added:
method FirestoreAdminClient.update_database(request: Optional[Union[firestore_admin.UpdateDatabaseRequest, dict]]=…, *, database: Optional[gfa_database.Database]=…, update_mask: Optional[field_mask_pb2.FieldMask]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
method FirestoreAdminClient.update_field(request: Optional[Union[firestore_admin.UpdateFieldRequest, dict]]=…, *, field: Optional[gfa_field.Field]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gac_operation.Operation - added:
property FirestoreAdminClient.api_endpoint -> str - added:
property FirestoreAdminClient.transport -> FirestoreAdminTransport - added:
property FirestoreAdminClient.universe_domain -> str - added:
static method FirestoreAdminClient.backup_path(project: str, location: str, backup: str) -> str - added:
static method FirestoreAdminClient.backup_schedule_path(project: str, database: str, backup_schedule: str) -> str - added:
static method FirestoreAdminClient.collection_group_path(project: str, database: str, collection: str) -> str - added:
static method FirestoreAdminClient.common_billing_account_path(billing_account: str) -> str - added:
static method FirestoreAdminClient.common_folder_path(folder: str) -> str - added:
static method FirestoreAdminClient.common_location_path(project: str, location: str) -> str - added:
static method FirestoreAdminClient.common_organization_path(organization: str) -> str - added:
static method FirestoreAdminClient.common_project_path(project: str) -> str - added:
static method FirestoreAdminClient.database_path(project: str, database: str) -> str - added:
static method FirestoreAdminClient.field_path(project: str, database: str, collection: str, field: str) -> str - added:
static method FirestoreAdminClient.from_service_account_file(filename: str, *args, **kwargs) - added:
static method FirestoreAdminClient.from_service_account_info(info: dict, *args, **kwargs) - added:
static method FirestoreAdminClient.get_mtls_endpoint_and_cert_source(client_options: Optional[client_options_lib.ClientOptions]=…) - added:
static method FirestoreAdminClient.index_path(project: str, database: str, collection: str, index: str) -> str - added:
static method FirestoreAdminClient.location_path(project: str, location: str) -> str - added:
static method FirestoreAdminClient.operation_path(project: str, database: str, operation: str) -> str - added:
static method FirestoreAdminClient.parse_backup_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_backup_schedule_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_collection_group_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_common_billing_account_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_common_folder_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_common_location_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_common_organization_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_common_project_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_database_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_field_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_index_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_location_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_operation_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.parse_user_creds_path(path: str) -> Dict[str, str] - added:
static method FirestoreAdminClient.user_creds_path(project: str, database: str, user_creds: str) -> str
- added:
class ListFieldsAsyncPager - added:
class ListFieldsPager - added:
class ListIndexesAsyncPager - added:
class ListIndexesPager - added:
constructor ListFieldsAsyncPager(method: Callable[..., Awaitable[firestore_admin.ListFieldsResponse]], request: firestore_admin.ListFieldsRequest, response: firestore_admin.ListFieldsResponse, *, retry: OptionalAsyncRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor ListFieldsPager(method: Callable[..., firestore_admin.ListFieldsResponse], request: firestore_admin.ListFieldsRequest, response: firestore_admin.ListFieldsResponse, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor ListIndexesAsyncPager(method: Callable[..., Awaitable[firestore_admin.ListIndexesResponse]], request: firestore_admin.ListIndexesRequest, response: firestore_admin.ListIndexesResponse, *, retry: OptionalAsyncRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor ListIndexesPager(method: Callable[..., firestore_admin.ListIndexesResponse], request: firestore_admin.ListIndexesRequest, response: firestore_admin.ListIndexesResponse, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
property ListFieldsAsyncPager.pages -> AsyncIterator[firestore_admin.ListFieldsResponse] - added:
property ListFieldsPager.pages -> Iterator[firestore_admin.ListFieldsResponse] - added:
property ListIndexesAsyncPager.pages -> AsyncIterator[firestore_admin.ListIndexesResponse] - added:
property ListIndexesPager.pages -> Iterator[firestore_admin.ListIndexesResponse] - added:
variable OptionalAsyncRetry - added:
variable OptionalRetry
- added:
export FirestoreAdminGrpcAsyncIOTransport - added:
export FirestoreAdminGrpcTransport - added:
export FirestoreAdminRestInterceptor - added:
export FirestoreAdminRestTransport - added:
export FirestoreAdminTransport
- added:
class FirestoreAdminTransport(abc.ABC) - added:
constructor FirestoreAdminTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, quota_project_id: Optional[str]=…, client_info: gapic_v1.client_info.ClientInfo=…, always_use_jwt_access: Optional[bool]=…, api_audience: Optional[str]=…, **kwargs) -> None - added:
field FirestoreAdminTransport.AUTH_SCOPES - added:
field FirestoreAdminTransport.DEFAULT_HOST: str - added:
method FirestoreAdminTransport.close() - added:
property FirestoreAdminTransport.bulk_delete_documents -> Callable[[firestore_admin.BulkDeleteDocumentsRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.cancel_operation -> Callable[[operations_pb2.CancelOperationRequest], None] - added:
property FirestoreAdminTransport.clone_database -> Callable[[firestore_admin.CloneDatabaseRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.create_backup_schedule -> Callable[[firestore_admin.CreateBackupScheduleRequest], Union[schedule.BackupSchedule, Awaitable[schedule.BackupSchedule]]] - added:
property FirestoreAdminTransport.create_database -> Callable[[firestore_admin.CreateDatabaseRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.create_index -> Callable[[firestore_admin.CreateIndexRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.create_user_creds -> Callable[[firestore_admin.CreateUserCredsRequest], Union[gfa_user_creds.UserCreds, Awaitable[gfa_user_creds.UserCreds]]] - added:
property FirestoreAdminTransport.delete_backup -> Callable[[firestore_admin.DeleteBackupRequest], Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]]] - added:
property FirestoreAdminTransport.delete_backup_schedule -> Callable[[firestore_admin.DeleteBackupScheduleRequest], Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]]] - added:
property FirestoreAdminTransport.delete_database -> Callable[[firestore_admin.DeleteDatabaseRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.delete_index -> Callable[[firestore_admin.DeleteIndexRequest], Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]]] - added:
property FirestoreAdminTransport.delete_operation -> Callable[[operations_pb2.DeleteOperationRequest], None] - added:
property FirestoreAdminTransport.delete_user_creds -> Callable[[firestore_admin.DeleteUserCredsRequest], Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]]] - added:
property FirestoreAdminTransport.disable_user_creds -> Callable[[firestore_admin.DisableUserCredsRequest], Union[user_creds.UserCreds, Awaitable[user_creds.UserCreds]]] - added:
property FirestoreAdminTransport.enable_user_creds -> Callable[[firestore_admin.EnableUserCredsRequest], Union[user_creds.UserCreds, Awaitable[user_creds.UserCreds]]] - added:
property FirestoreAdminTransport.export_documents -> Callable[[firestore_admin.ExportDocumentsRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.get_backup -> Callable[[firestore_admin.GetBackupRequest], Union[backup.Backup, Awaitable[backup.Backup]]] - added:
property FirestoreAdminTransport.get_backup_schedule -> Callable[[firestore_admin.GetBackupScheduleRequest], Union[schedule.BackupSchedule, Awaitable[schedule.BackupSchedule]]] - added:
property FirestoreAdminTransport.get_database -> Callable[[firestore_admin.GetDatabaseRequest], Union[database.Database, Awaitable[database.Database]]] - added:
property FirestoreAdminTransport.get_field -> Callable[[firestore_admin.GetFieldRequest], Union[field.Field, Awaitable[field.Field]]] - added:
property FirestoreAdminTransport.get_index -> Callable[[firestore_admin.GetIndexRequest], Union[index.Index, Awaitable[index.Index]]] - added:
property FirestoreAdminTransport.get_operation -> Callable[[operations_pb2.GetOperationRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.get_user_creds -> Callable[[firestore_admin.GetUserCredsRequest], Union[user_creds.UserCreds, Awaitable[user_creds.UserCreds]]] - added:
property FirestoreAdminTransport.host - added:
property FirestoreAdminTransport.import_documents -> Callable[[firestore_admin.ImportDocumentsRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.kind -> str - added:
property FirestoreAdminTransport.list_backup_schedules -> Callable[[firestore_admin.ListBackupSchedulesRequest], Union[firestore_admin.ListBackupSchedulesResponse, Awaitable[firestore_admin.ListBackupSchedulesResponse]]] - added:
property FirestoreAdminTransport.list_backups -> Callable[[firestore_admin.ListBackupsRequest], Union[firestore_admin.ListBackupsResponse, Awaitable[firestore_admin.ListBackupsResponse]]] - added:
property FirestoreAdminTransport.list_databases -> Callable[[firestore_admin.ListDatabasesRequest], Union[firestore_admin.ListDatabasesResponse, Awaitable[firestore_admin.ListDatabasesResponse]]] - added:
property FirestoreAdminTransport.list_fields -> Callable[[firestore_admin.ListFieldsRequest], Union[firestore_admin.ListFieldsResponse, Awaitable[firestore_admin.ListFieldsResponse]]] - added:
property FirestoreAdminTransport.list_indexes -> Callable[[firestore_admin.ListIndexesRequest], Union[firestore_admin.ListIndexesResponse, Awaitable[firestore_admin.ListIndexesResponse]]] - added:
property FirestoreAdminTransport.list_operations -> Callable[[operations_pb2.ListOperationsRequest], Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]]] - added:
property FirestoreAdminTransport.list_user_creds -> Callable[[firestore_admin.ListUserCredsRequest], Union[firestore_admin.ListUserCredsResponse, Awaitable[firestore_admin.ListUserCredsResponse]]] - added:
property FirestoreAdminTransport.operations_client - added:
property FirestoreAdminTransport.reset_user_password -> Callable[[firestore_admin.ResetUserPasswordRequest], Union[user_creds.UserCreds, Awaitable[user_creds.UserCreds]]] - added:
property FirestoreAdminTransport.restore_database -> Callable[[firestore_admin.RestoreDatabaseRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.update_backup_schedule -> Callable[[firestore_admin.UpdateBackupScheduleRequest], Union[schedule.BackupSchedule, Awaitable[schedule.BackupSchedule]]] - added:
property FirestoreAdminTransport.update_database -> Callable[[firestore_admin.UpdateDatabaseRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreAdminTransport.update_field -> Callable[[firestore_admin.UpdateFieldRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]]
- added:
class FirestoreAdminGrpcTransport(FirestoreAdminTransport) - added:
constructor FirestoreAdminGrpcTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]=…, api_mtls_endpoint: Optional[str]=…, client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]]=…, ssl_channel_credentials: Optional[grpc.Channel… - added:
method FirestoreAdminGrpcTransport.close() - added:
property FirestoreAdminGrpcTransport.bulk_delete_documents -> Callable[[firestore_admin.BulkDeleteDocumentsRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.cancel_operation -> Callable[[operations_pb2.CancelOperationRequest], None] - added:
property FirestoreAdminGrpcTransport.clone_database -> Callable[[firestore_admin.CloneDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.create_backup_schedule -> Callable[[firestore_admin.CreateBackupScheduleRequest], schedule.BackupSchedule] - added:
property FirestoreAdminGrpcTransport.create_database -> Callable[[firestore_admin.CreateDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.create_index -> Callable[[firestore_admin.CreateIndexRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.create_user_creds -> Callable[[firestore_admin.CreateUserCredsRequest], gfa_user_creds.UserCreds] - added:
property FirestoreAdminGrpcTransport.delete_backup -> Callable[[firestore_admin.DeleteBackupRequest], empty_pb2.Empty] - added:
property FirestoreAdminGrpcTransport.delete_backup_schedule -> Callable[[firestore_admin.DeleteBackupScheduleRequest], empty_pb2.Empty] - added:
property FirestoreAdminGrpcTransport.delete_database -> Callable[[firestore_admin.DeleteDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.delete_index -> Callable[[firestore_admin.DeleteIndexRequest], empty_pb2.Empty] - added:
property FirestoreAdminGrpcTransport.delete_operation -> Callable[[operations_pb2.DeleteOperationRequest], None] - added:
property FirestoreAdminGrpcTransport.delete_user_creds -> Callable[[firestore_admin.DeleteUserCredsRequest], empty_pb2.Empty] - added:
property FirestoreAdminGrpcTransport.disable_user_creds -> Callable[[firestore_admin.DisableUserCredsRequest], user_creds.UserCreds] - added:
property FirestoreAdminGrpcTransport.enable_user_creds -> Callable[[firestore_admin.EnableUserCredsRequest], user_creds.UserCreds] - added:
property FirestoreAdminGrpcTransport.export_documents -> Callable[[firestore_admin.ExportDocumentsRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.get_backup -> Callable[[firestore_admin.GetBackupRequest], backup.Backup] - added:
property FirestoreAdminGrpcTransport.get_backup_schedule -> Callable[[firestore_admin.GetBackupScheduleRequest], schedule.BackupSchedule] - added:
property FirestoreAdminGrpcTransport.get_database -> Callable[[firestore_admin.GetDatabaseRequest], database.Database] - added:
property FirestoreAdminGrpcTransport.get_field -> Callable[[firestore_admin.GetFieldRequest], field.Field] - added:
property FirestoreAdminGrpcTransport.get_index -> Callable[[firestore_admin.GetIndexRequest], index.Index] - added:
property FirestoreAdminGrpcTransport.get_operation -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.get_user_creds -> Callable[[firestore_admin.GetUserCredsRequest], user_creds.UserCreds] - added:
property FirestoreAdminGrpcTransport.grpc_channel -> grpc.Channel - added:
property FirestoreAdminGrpcTransport.import_documents -> Callable[[firestore_admin.ImportDocumentsRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.kind -> str - added:
property FirestoreAdminGrpcTransport.list_backup_schedules -> Callable[[firestore_admin.ListBackupSchedulesRequest], firestore_admin.ListBackupSchedulesResponse] - added:
property FirestoreAdminGrpcTransport.list_backups -> Callable[[firestore_admin.ListBackupsRequest], firestore_admin.ListBackupsResponse] - added:
property FirestoreAdminGrpcTransport.list_databases -> Callable[[firestore_admin.ListDatabasesRequest], firestore_admin.ListDatabasesResponse] - added:
property FirestoreAdminGrpcTransport.list_fields -> Callable[[firestore_admin.ListFieldsRequest], firestore_admin.ListFieldsResponse] - added:
property FirestoreAdminGrpcTransport.list_indexes -> Callable[[firestore_admin.ListIndexesRequest], firestore_admin.ListIndexesResponse] - added:
property FirestoreAdminGrpcTransport.list_operations -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse] - added:
property FirestoreAdminGrpcTransport.list_user_creds -> Callable[[firestore_admin.ListUserCredsRequest], firestore_admin.ListUserCredsResponse] - added:
property FirestoreAdminGrpcTransport.operations_client -> operations_v1.OperationsClient - added:
property FirestoreAdminGrpcTransport.reset_user_password -> Callable[[firestore_admin.ResetUserPasswordRequest], user_creds.UserCreds] - added:
property FirestoreAdminGrpcTransport.restore_database -> Callable[[firestore_admin.RestoreDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.update_backup_schedule -> Callable[[firestore_admin.UpdateBackupScheduleRequest], schedule.BackupSchedule] - added:
property FirestoreAdminGrpcTransport.update_database -> Callable[[firestore_admin.UpdateDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcTransport.update_field -> Callable[[firestore_admin.UpdateFieldRequest], operations_pb2.Operation] - added:
static method FirestoreAdminGrpcTransport.create_channel(host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, quota_project_id: Optional[str]=…, **kwargs) -> grpc.Channel
- added:
class FirestoreAdminGrpcAsyncIOTransport(FirestoreAdminTransport) - added:
constructor FirestoreAdminGrpcAsyncIOTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]]=…, api_mtls_endpoint: Optional[str]=…, client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]]=…, ssl_channel_credentials: Optional[grpc.Ch… - added:
method FirestoreAdminGrpcAsyncIOTransport.close() - added:
property FirestoreAdminGrpcAsyncIOTransport.bulk_delete_documents -> Callable[[firestore_admin.BulkDeleteDocumentsRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.cancel_operation -> Callable[[operations_pb2.CancelOperationRequest], None] - added:
property FirestoreAdminGrpcAsyncIOTransport.clone_database -> Callable[[firestore_admin.CloneDatabaseRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.create_backup_schedule -> Callable[[firestore_admin.CreateBackupScheduleRequest], Awaitable[schedule.BackupSchedule]] - added:
property FirestoreAdminGrpcAsyncIOTransport.create_database -> Callable[[firestore_admin.CreateDatabaseRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.create_index -> Callable[[firestore_admin.CreateIndexRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.create_user_creds -> Callable[[firestore_admin.CreateUserCredsRequest], Awaitable[gfa_user_creds.UserCreds]] - added:
property FirestoreAdminGrpcAsyncIOTransport.delete_backup -> Callable[[firestore_admin.DeleteBackupRequest], Awaitable[empty_pb2.Empty]] - added:
property FirestoreAdminGrpcAsyncIOTransport.delete_backup_schedule -> Callable[[firestore_admin.DeleteBackupScheduleRequest], Awaitable[empty_pb2.Empty]] - added:
property FirestoreAdminGrpcAsyncIOTransport.delete_database -> Callable[[firestore_admin.DeleteDatabaseRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.delete_index -> Callable[[firestore_admin.DeleteIndexRequest], Awaitable[empty_pb2.Empty]] - added:
property FirestoreAdminGrpcAsyncIOTransport.delete_operation -> Callable[[operations_pb2.DeleteOperationRequest], None] - added:
property FirestoreAdminGrpcAsyncIOTransport.delete_user_creds -> Callable[[firestore_admin.DeleteUserCredsRequest], Awaitable[empty_pb2.Empty]] - added:
property FirestoreAdminGrpcAsyncIOTransport.disable_user_creds -> Callable[[firestore_admin.DisableUserCredsRequest], Awaitable[user_creds.UserCreds]] - added:
property FirestoreAdminGrpcAsyncIOTransport.enable_user_creds -> Callable[[firestore_admin.EnableUserCredsRequest], Awaitable[user_creds.UserCreds]] - added:
property FirestoreAdminGrpcAsyncIOTransport.export_documents -> Callable[[firestore_admin.ExportDocumentsRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_backup -> Callable[[firestore_admin.GetBackupRequest], Awaitable[backup.Backup]] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_backup_schedule -> Callable[[firestore_admin.GetBackupScheduleRequest], Awaitable[schedule.BackupSchedule]] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_database -> Callable[[firestore_admin.GetDatabaseRequest], Awaitable[database.Database]] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_field -> Callable[[firestore_admin.GetFieldRequest], Awaitable[field.Field]] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_index -> Callable[[firestore_admin.GetIndexRequest], Awaitable[index.Index]] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_operation -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation] - added:
property FirestoreAdminGrpcAsyncIOTransport.get_user_creds -> Callable[[firestore_admin.GetUserCredsRequest], Awaitable[user_creds.UserCreds]] - added:
property FirestoreAdminGrpcAsyncIOTransport.grpc_channel -> aio.Channel - added:
property FirestoreAdminGrpcAsyncIOTransport.import_documents -> Callable[[firestore_admin.ImportDocumentsRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.kind -> str - added:
property FirestoreAdminGrpcAsyncIOTransport.list_backup_schedules -> Callable[[firestore_admin.ListBackupSchedulesRequest], Awaitable[firestore_admin.ListBackupSchedulesResponse]] - added:
property FirestoreAdminGrpcAsyncIOTransport.list_backups -> Callable[[firestore_admin.ListBackupsRequest], Awaitable[firestore_admin.ListBackupsResponse]] - added:
property FirestoreAdminGrpcAsyncIOTransport.list_databases -> Callable[[firestore_admin.ListDatabasesRequest], Awaitable[firestore_admin.ListDatabasesResponse]] - added:
property FirestoreAdminGrpcAsyncIOTransport.list_fields -> Callable[[firestore_admin.ListFieldsRequest], Awaitable[firestore_admin.ListFieldsResponse]] - added:
property FirestoreAdminGrpcAsyncIOTransport.list_indexes -> Callable[[firestore_admin.ListIndexesRequest], Awaitable[firestore_admin.ListIndexesResponse]] - added:
property FirestoreAdminGrpcAsyncIOTransport.list_operations -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse] - added:
property FirestoreAdminGrpcAsyncIOTransport.list_user_creds -> Callable[[firestore_admin.ListUserCredsRequest], Awaitable[firestore_admin.ListUserCredsResponse]] - added:
property FirestoreAdminGrpcAsyncIOTransport.operations_client -> operations_v1.OperationsAsyncClient - added:
property FirestoreAdminGrpcAsyncIOTransport.reset_user_password -> Callable[[firestore_admin.ResetUserPasswordRequest], Awaitable[user_creds.UserCreds]] - added:
property FirestoreAdminGrpcAsyncIOTransport.restore_database -> Callable[[firestore_admin.RestoreDatabaseRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.update_backup_schedule -> Callable[[firestore_admin.UpdateBackupScheduleRequest], Awaitable[schedule.BackupSchedule]] - added:
property FirestoreAdminGrpcAsyncIOTransport.update_database -> Callable[[firestore_admin.UpdateDatabaseRequest], Awaitable[operations_pb2.Operation]] - added:
property FirestoreAdminGrpcAsyncIOTransport.update_field -> Callable[[firestore_admin.UpdateFieldRequest], Awaitable[operations_pb2.Operation]] - added:
static method FirestoreAdminGrpcAsyncIOTransport.create_channel(host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, quota_project_id: Optional[str]=…, **kwargs) -> aio.Channel
- added:
class FirestoreAdminRestTransport(_BaseFirestoreAdminRestTransport) - added:
constructor FirestoreAdminRestTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]]=…, quota_project_id: Optional[str]=…, client_info: gapic_v1.client_info.ClientInfo=…, always_use_jwt_access: Optional[bool]=…, url_scheme: str=…, i… - added:
method FirestoreAdminRestTransport.close() - added:
property FirestoreAdminRestTransport.bulk_delete_documents -> Callable[[firestore_admin.BulkDeleteDocumentsRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.cancel_operation - added:
property FirestoreAdminRestTransport.clone_database -> Callable[[firestore_admin.CloneDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.create_backup_schedule -> Callable[[firestore_admin.CreateBackupScheduleRequest], schedule.BackupSchedule] - added:
property FirestoreAdminRestTransport.create_database -> Callable[[firestore_admin.CreateDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.create_index -> Callable[[firestore_admin.CreateIndexRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.create_user_creds -> Callable[[firestore_admin.CreateUserCredsRequest], gfa_user_creds.UserCreds] - added:
property FirestoreAdminRestTransport.delete_backup -> Callable[[firestore_admin.DeleteBackupRequest], empty_pb2.Empty] - added:
property FirestoreAdminRestTransport.delete_backup_schedule -> Callable[[firestore_admin.DeleteBackupScheduleRequest], empty_pb2.Empty] - added:
property FirestoreAdminRestTransport.delete_database -> Callable[[firestore_admin.DeleteDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.delete_index -> Callable[[firestore_admin.DeleteIndexRequest], empty_pb2.Empty] - added:
property FirestoreAdminRestTransport.delete_operation - added:
property FirestoreAdminRestTransport.delete_user_creds -> Callable[[firestore_admin.DeleteUserCredsRequest], empty_pb2.Empty] - added:
property FirestoreAdminRestTransport.disable_user_creds -> Callable[[firestore_admin.DisableUserCredsRequest], user_creds.UserCreds] - added:
property FirestoreAdminRestTransport.enable_user_creds -> Callable[[firestore_admin.EnableUserCredsRequest], user_creds.UserCreds] - added:
property FirestoreAdminRestTransport.export_documents -> Callable[[firestore_admin.ExportDocumentsRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.get_backup -> Callable[[firestore_admin.GetBackupRequest], backup.Backup] - added:
property FirestoreAdminRestTransport.get_backup_schedule -> Callable[[firestore_admin.GetBackupScheduleRequest], schedule.BackupSchedule] - added:
property FirestoreAdminRestTransport.get_database -> Callable[[firestore_admin.GetDatabaseRequest], database.Database] - added:
property FirestoreAdminRestTransport.get_field -> Callable[[firestore_admin.GetFieldRequest], field.Field] - added:
property FirestoreAdminRestTransport.get_index -> Callable[[firestore_admin.GetIndexRequest], index.Index] - added:
property FirestoreAdminRestTransport.get_operation - added:
property FirestoreAdminRestTransport.get_user_creds -> Callable[[firestore_admin.GetUserCredsRequest], user_creds.UserCreds] - added:
property FirestoreAdminRestTransport.import_documents -> Callable[[firestore_admin.ImportDocumentsRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.kind -> str - added:
property FirestoreAdminRestTransport.list_backup_schedules -> Callable[[firestore_admin.ListBackupSchedulesRequest], firestore_admin.ListBackupSchedulesResponse] - added:
property FirestoreAdminRestTransport.list_backups -> Callable[[firestore_admin.ListBackupsRequest], firestore_admin.ListBackupsResponse] - added:
property FirestoreAdminRestTransport.list_databases -> Callable[[firestore_admin.ListDatabasesRequest], firestore_admin.ListDatabasesResponse] - added:
property FirestoreAdminRestTransport.list_fields -> Callable[[firestore_admin.ListFieldsRequest], firestore_admin.ListFieldsResponse] - added:
property FirestoreAdminRestTransport.list_indexes -> Callable[[firestore_admin.ListIndexesRequest], firestore_admin.ListIndexesResponse] - added:
property FirestoreAdminRestTransport.list_operations - added:
property FirestoreAdminRestTransport.list_user_creds -> Callable[[firestore_admin.ListUserCredsRequest], firestore_admin.ListUserCredsResponse] - added:
property FirestoreAdminRestTransport.operations_client -> operations_v1.AbstractOperationsClient - added:
property FirestoreAdminRestTransport.reset_user_password -> Callable[[firestore_admin.ResetUserPasswordRequest], user_creds.UserCreds] - added:
property FirestoreAdminRestTransport.restore_database -> Callable[[firestore_admin.RestoreDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.update_backup_schedule -> Callable[[firestore_admin.UpdateBackupScheduleRequest], schedule.BackupSchedule] - added:
property FirestoreAdminRestTransport.update_database -> Callable[[firestore_admin.UpdateDatabaseRequest], operations_pb2.Operation] - added:
property FirestoreAdminRestTransport.update_field -> Callable[[firestore_admin.UpdateFieldRequest], operations_pb2.Operation]
- added:
class _BaseFirestoreAdminRestTransport(FirestoreAdminTransport) - added:
constructor _BaseFirestoreAdminRestTransport(*, host: str=…, credentials: Optional[Any]=…, client_info: gapic_v1.client_info.ClientInfo=…, always_use_jwt_access: Optional[bool]=…, url_scheme: str=…, api_audience: Optional[str]=…) -> None
- removed:
variable names - added:
export Backup - added:
export BackupSchedule - added:
export BulkDeleteDocumentsMetadata - added:
export BulkDeleteDocumentsRequest - added:
export BulkDeleteDocumentsResponse - added:
export CloneDatabaseMetadata - added:
export CloneDatabaseRequest - added:
export CreateBackupScheduleRequest - added:
export CreateDatabaseMetadata - added:
export CreateDatabaseRequest - added:
export CreateIndexRequest - added:
export CreateUserCredsRequest - added:
export DailyRecurrence - added:
export Database - added:
export DeleteBackupRequest - added:
export DeleteBackupScheduleRequest - added:
export DeleteDatabaseMetadata - added:
export DeleteDatabaseRequest - added:
export DeleteIndexRequest - added:
export DeleteUserCredsRequest - added:
export DisableUserCredsRequest - added:
export EnableUserCredsRequest - added:
export ExportDocumentsMetadata - added:
export ExportDocumentsRequest - added:
export ExportDocumentsResponse - added:
export Field - added:
export FieldOperationMetadata - added:
export GetBackupRequest - added:
export GetBackupScheduleRequest - added:
export GetDatabaseRequest - added:
export GetFieldRequest - added:
export GetIndexRequest - added:
export GetUserCredsRequest - added:
export ImportDocumentsMetadata - added:
export ImportDocumentsRequest - added:
export Index - added:
export IndexOperationMetadata - added:
export ListBackupSchedulesRequest - added:
export ListBackupSchedulesResponse - added:
export ListBackupsRequest - added:
export ListBackupsResponse - added:
export ListDatabasesRequest - added:
export ListDatabasesResponse - added:
export ListFieldsRequest - added:
export ListFieldsResponse - added:
export ListIndexesRequest - added:
export ListIndexesResponse - added:
export ListUserCredsRequest - added:
export ListUserCredsResponse - added:
export LocationMetadata - added:
export OperationState - added:
export PitrSnapshot - added:
export Progress - added:
export RealtimeUpdatesMode - added:
export ResetUserPasswordRequest - added:
export RestoreDatabaseMetadata - added:
export RestoreDatabaseRequest - added:
export UpdateBackupScheduleRequest - added:
export UpdateDatabaseMetadata - added:
export UpdateDatabaseRequest - added:
export UpdateFieldRequest - added:
export UserCreds - added:
export WeeklyRecurrence
- added:
class Backup(proto.Message) - added:
class Backup.State(proto.Enum) - added:
class Backup.Stats(proto.Message) - added:
field Backup.State.CREATING - added:
field Backup.State.NOT_AVAILABLE - added:
field Backup.State.READY - added:
field Backup.State.STATE_UNSPECIFIED - added:
field Backup.Stats.document_count: int - added:
field Backup.Stats.index_count: int - added:
field Backup.Stats.size_bytes: int - added:
field Backup.database: str - added:
field Backup.database_uid: str - added:
field Backup.expire_time: timestamp_pb2.Timestamp - added:
field Backup.name: str - added:
field Backup.snapshot_time: timestamp_pb2.Timestamp - added:
field Backup.state: State - added:
field Backup.stats: Stats
- added:
class Database(proto.Message) - added:
class Database.AppEngineIntegrationMode(proto.Enum) - added:
class Database.CmekConfig(proto.Message) - added:
class Database.ConcurrencyMode(proto.Enum) - added:
class Database.DataAccessMode(proto.Enum) - added:
class Database.DatabaseEdition(proto.Enum) - added:
class Database.DatabaseType(proto.Enum) - added:
class Database.DeleteProtectionState(proto.Enum) - added:
class Database.EncryptionConfig(proto.Message) - added:
class Database.EncryptionConfig.CustomerManagedEncryptionOptions(proto.Message) - added:
class Database.EncryptionConfig.GoogleDefaultEncryptionOptions(proto.Message) - added:
class Database.EncryptionConfig.SourceEncryptionOptions(proto.Message) - added:
class Database.PointInTimeRecoveryEnablement(proto.Enum) - added:
class Database.SourceInfo(proto.Message) - added:
class Database.SourceInfo.BackupSource(proto.Message) - added:
field Database.AppEngineIntegrationMode.APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED - added:
field Database.AppEngineIntegrationMode.DISABLED - added:
field Database.AppEngineIntegrationMode.ENABLED - added:
field Database.CmekConfig.active_key_version: MutableSequence[str] - added:
field Database.CmekConfig.kms_key_name: str - added:
field Database.ConcurrencyMode.CONCURRENCY_MODE_UNSPECIFIED - added:
field Database.ConcurrencyMode.OPTIMISTIC - added:
field Database.ConcurrencyMode.OPTIMISTIC_WITH_ENTITY_GROUPS - added:
field Database.ConcurrencyMode.PESSIMISTIC - added:
field Database.DataAccessMode.DATA_ACCESS_MODE_DISABLED - added:
field Database.DataAccessMode.DATA_ACCESS_MODE_ENABLED - added:
field Database.DataAccessMode.DATA_ACCESS_MODE_UNSPECIFIED - added:
field Database.DatabaseEdition.DATABASE_EDITION_UNSPECIFIED - added:
field Database.DatabaseEdition.ENTERPRISE - added:
field Database.DatabaseEdition.STANDARD - added:
field Database.DatabaseType.DATABASE_TYPE_UNSPECIFIED - added:
field Database.DatabaseType.DATASTORE_MODE - added:
field Database.DatabaseType.FIRESTORE_NATIVE - added:
field Database.DeleteProtectionState.DELETE_PROTECTION_DISABLED - added:
field Database.DeleteProtectionState.DELETE_PROTECTION_ENABLED - added:
field Database.DeleteProtectionState.DELETE_PROTECTION_STATE_UNSPECIFIED - added:
field Database.EncryptionConfig.CustomerManagedEncryptionOptions.kms_key_name: str - added:
field Database.EncryptionConfig.customer_managed_encryption: Database.EncryptionConfig.CustomerManagedEncryptionOptions - added:
field Database.EncryptionConfig.google_default_encryption: Database.EncryptionConfig.GoogleDefaultEncryptionOptions - added:
field Database.EncryptionConfig.use_source_encryption: Database.EncryptionConfig.SourceEncryptionOptions - added:
field Database.PointInTimeRecoveryEnablement.POINT_IN_TIME_RECOVERY_DISABLED - added:
field Database.PointInTimeRecoveryEnablement.POINT_IN_TIME_RECOVERY_ENABLED - added:
field Database.PointInTimeRecoveryEnablement.POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED - added:
field Database.SourceInfo.BackupSource.backup: str - added:
field Database.SourceInfo.backup: Database.SourceInfo.BackupSource - added:
field Database.SourceInfo.operation: str - added:
field Database.app_engine_integration_mode: AppEngineIntegrationMode - added:
field Database.cmek_config: CmekConfig - added:
field Database.concurrency_mode: ConcurrencyMode - added:
field Database.create_time: timestamp_pb2.Timestamp - added:
field Database.database_edition: DatabaseEdition - added:
field Database.delete_protection_state: DeleteProtectionState - added:
field Database.delete_time: timestamp_pb2.Timestamp - added:
field Database.earliest_version_time: timestamp_pb2.Timestamp - added:
field Database.etag: str - added:
field Database.firestore_data_access_mode: DataAccessMode - added:
field Database.free_tier: bool - added:
field Database.key_prefix: str - added:
field Database.location_id: str - added:
field Database.mongodb_compatible_data_access_mode: DataAccessMode - added:
field Database.name: str - added:
field Database.point_in_time_recovery_enablement: PointInTimeRecoveryEnablement - added:
field Database.previous_id: str - added:
field Database.realtime_updates_mode: realtime_updates.RealtimeUpdatesMode - added:
field Database.source_info: SourceInfo - added:
field Database.tags: MutableMapping[str, str] - added:
field Database.type_: DatabaseType - added:
field Database.uid: str - added:
field Database.update_time: timestamp_pb2.Timestamp - added:
field Database.version_retention_period: duration_pb2.Duration
- added:
class Field(proto.Message) - added:
class Field.IndexConfig(proto.Message) - added:
class Field.TtlConfig(proto.Message) - added:
class Field.TtlConfig.State(proto.Enum) - added:
field Field.IndexConfig.ancestor_field: str - added:
field Field.IndexConfig.indexes: MutableSequence[index.Index] - added:
field Field.IndexConfig.reverting: bool - added:
field Field.IndexConfig.uses_ancestor_config: bool - added:
field Field.TtlConfig.State.ACTIVE - added:
field Field.TtlConfig.State.CREATING - added:
field Field.TtlConfig.State.NEEDS_REPAIR - added:
field Field.TtlConfig.State.STATE_UNSPECIFIED - added:
field Field.TtlConfig.expiration_offset: duration_pb2.Duration - added:
field Field.TtlConfig.state: Field.TtlConfig.State - added:
field Field.index_config: IndexConfig - added:
field Field.name: str - added:
field Field.ttl_config: TtlConfig
- added:
class BulkDeleteDocumentsRequest(proto.Message) - added:
class BulkDeleteDocumentsResponse(proto.Message) - added:
class CloneDatabaseRequest(proto.Message) - added:
class CreateBackupScheduleRequest(proto.Message) - added:
class CreateDatabaseMetadata(proto.Message) - added:
class CreateDatabaseRequest(proto.Message) - added:
class CreateIndexRequest(proto.Message) - added:
class CreateUserCredsRequest(proto.Message) - added:
class DeleteBackupRequest(proto.Message) - added:
class DeleteBackupScheduleRequest(proto.Message) - added:
class DeleteDatabaseMetadata(proto.Message) - added:
class DeleteDatabaseRequest(proto.Message) - added:
class DeleteIndexRequest(proto.Message) - added:
class DeleteUserCredsRequest(proto.Message) - added:
class DisableUserCredsRequest(proto.Message) - added:
class EnableUserCredsRequest(proto.Message) - added:
class ExportDocumentsRequest(proto.Message) - added:
class GetBackupRequest(proto.Message) - added:
class GetBackupScheduleRequest(proto.Message) - added:
class GetDatabaseRequest(proto.Message) - added:
class GetFieldRequest(proto.Message) - added:
class GetIndexRequest(proto.Message) - added:
class GetUserCredsRequest(proto.Message) - added:
class ImportDocumentsRequest(proto.Message) - added:
class ListBackupSchedulesRequest(proto.Message) - added:
class ListBackupSchedulesResponse(proto.Message) - added:
class ListBackupsRequest(proto.Message) - added:
class ListBackupsResponse(proto.Message) - added:
class ListDatabasesRequest(proto.Message) - added:
class ListDatabasesResponse(proto.Message) - added:
class ListFieldsRequest(proto.Message) - added:
class ListFieldsResponse(proto.Message) - added:
class ListIndexesRequest(proto.Message) - added:
class ListIndexesResponse(proto.Message) - added:
class ListUserCredsRequest(proto.Message) - added:
class ListUserCredsResponse(proto.Message) - added:
class ResetUserPasswordRequest(proto.Message) - added:
class RestoreDatabaseRequest(proto.Message) - added:
class UpdateBackupScheduleRequest(proto.Message) - added:
class UpdateDatabaseMetadata(proto.Message) - added:
class UpdateDatabaseRequest(proto.Message) - added:
class UpdateFieldRequest(proto.Message) - added:
field BulkDeleteDocumentsRequest.collection_ids: MutableSequence[str] - added:
field BulkDeleteDocumentsRequest.name: str - added:
field BulkDeleteDocumentsRequest.namespace_ids: MutableSequence[str] - added:
field CloneDatabaseRequest.database_id: str - added:
field CloneDatabaseRequest.encryption_config: gfa_database.Database.EncryptionConfig - added:
field CloneDatabaseRequest.parent: str - added:
field CloneDatabaseRequest.pitr_snapshot: snapshot.PitrSnapshot - added:
field CloneDatabaseRequest.tags: MutableMapping[str, str] - added:
field CreateBackupScheduleRequest.backup_schedule: schedule.BackupSchedule - added:
field CreateBackupScheduleRequest.parent: str - added:
field CreateDatabaseRequest.database: gfa_database.Database - added:
field CreateDatabaseRequest.database_id: str - added:
field CreateDatabaseRequest.parent: str - added:
field CreateIndexRequest.index: gfa_index.Index - added:
field CreateIndexRequest.parent: str - added:
field CreateUserCredsRequest.parent: str - added:
field CreateUserCredsRequest.user_creds: gfa_user_creds.UserCreds - added:
field CreateUserCredsRequest.user_creds_id: str - added:
field DeleteBackupRequest.name: str - added:
field DeleteBackupScheduleRequest.name: str - added:
field DeleteDatabaseRequest.etag: str - added:
field DeleteDatabaseRequest.name: str - added:
field DeleteIndexRequest.name: str - added:
field DeleteUserCredsRequest.name: str - added:
field DisableUserCredsRequest.name: str - added:
field EnableUserCredsRequest.name: str - added:
field ExportDocumentsRequest.collection_ids: MutableSequence[str] - added:
field ExportDocumentsRequest.name: str - added:
field ExportDocumentsRequest.namespace_ids: MutableSequence[str] - added:
field ExportDocumentsRequest.output_uri_prefix: str - added:
field ExportDocumentsRequest.snapshot_time: timestamp_pb2.Timestamp - added:
field GetBackupRequest.name: str - added:
field GetBackupScheduleRequest.name: str - added:
field GetDatabaseRequest.name: str - added:
field GetFieldRequest.name: str - added:
field GetIndexRequest.name: str - added:
field GetUserCredsRequest.name: str - added:
field ImportDocumentsRequest.collection_ids: MutableSequence[str] - added:
field ImportDocumentsRequest.input_uri_prefix: str - added:
field ImportDocumentsRequest.name: str - added:
field ImportDocumentsRequest.namespace_ids: MutableSequence[str] - added:
field ListBackupSchedulesRequest.parent: str - added:
field ListBackupSchedulesResponse.backup_schedules: MutableSequence[schedule.BackupSchedule] - added:
field ListBackupsRequest.filter: str - added:
field ListBackupsRequest.parent: str - added:
field ListBackupsResponse.backups: MutableSequence[gfa_backup.Backup] - added:
field ListBackupsResponse.unreachable: MutableSequence[str] - added:
field ListDatabasesRequest.parent: str - added:
field ListDatabasesRequest.show_deleted: bool - added:
field ListDatabasesResponse.databases: MutableSequence[gfa_database.Database] - added:
field ListDatabasesResponse.unreachable: MutableSequence[str] - added:
field ListFieldsRequest.filter: str - added:
field ListFieldsRequest.page_size: int - added:
field ListFieldsRequest.page_token: str - added:
field ListFieldsRequest.parent: str - added:
field ListFieldsResponse.fields: MutableSequence[gfa_field.Field] - added:
field ListFieldsResponse.next_page_token: str - added:
field ListIndexesRequest.filter: str - added:
field ListIndexesRequest.page_size: int - added:
field ListIndexesRequest.page_token: str - added:
field ListIndexesRequest.parent: str - added:
field ListIndexesResponse.indexes: MutableSequence[gfa_index.Index] - added:
field ListIndexesResponse.next_page_token: str - added:
field ListUserCredsRequest.parent: str - added:
field ListUserCredsResponse.user_creds: MutableSequence[gfa_user_creds.UserCreds] - added:
field ResetUserPasswordRequest.name: str - added:
field RestoreDatabaseRequest.backup: str - added:
field RestoreDatabaseRequest.database_id: str - added:
field RestoreDatabaseRequest.encryption_config: gfa_database.Database.EncryptionConfig - added:
field RestoreDatabaseRequest.parent: str - added:
field RestoreDatabaseRequest.tags: MutableMapping[str, str] - added:
field UpdateBackupScheduleRequest.backup_schedule: schedule.BackupSchedule - added:
field UpdateBackupScheduleRequest.update_mask: field_mask_pb2.FieldMask - added:
field UpdateDatabaseRequest.database: gfa_database.Database - added:
field UpdateDatabaseRequest.update_mask: field_mask_pb2.FieldMask - added:
field UpdateFieldRequest.field: gfa_field.Field - added:
field UpdateFieldRequest.update_mask: field_mask_pb2.FieldMask - added:
property ListFieldsResponse.raw_page - added:
property ListIndexesResponse.raw_page
- added:
class Index(proto.Message) - added:
class Index.ApiScope(proto.Enum) - added:
class Index.Density(proto.Enum) - added:
class Index.IndexField(proto.Message) - added:
class Index.IndexField.ArrayConfig(proto.Enum) - added:
class Index.IndexField.Order(proto.Enum) - added:
class Index.IndexField.SearchConfig(proto.Message) - added:
class Index.IndexField.SearchConfig.SearchGeoSpec(proto.Message) - added:
class Index.IndexField.SearchConfig.SearchTextIndexSpec(proto.Message) - added:
class Index.IndexField.SearchConfig.SearchTextSpec(proto.Message) - added:
class Index.IndexField.SearchConfig.TextIndexType(proto.Enum) - added:
class Index.IndexField.SearchConfig.TextMatchType(proto.Enum) - added:
class Index.IndexField.VectorConfig(proto.Message) - added:
class Index.IndexField.VectorConfig.FlatIndex(proto.Message) - added:
class Index.QueryScope(proto.Enum) - added:
class Index.SearchIndexOptions(proto.Message) - added:
class Index.State(proto.Enum) - added:
field Index.ApiScope.ANY_API - added:
field Index.ApiScope.DATASTORE_MODE_API - added:
field Index.ApiScope.MONGODB_COMPATIBLE_API - added:
field Index.Density.DENSE - added:
field Index.Density.DENSITY_UNSPECIFIED - added:
field Index.Density.SPARSE_ALL - added:
field Index.Density.SPARSE_ANY - added:
field Index.IndexField.ArrayConfig.ARRAY_CONFIG_UNSPECIFIED - added:
field Index.IndexField.ArrayConfig.CONTAINS - added:
field Index.IndexField.Order.ASCENDING - added:
field Index.IndexField.Order.DESCENDING - added:
field Index.IndexField.Order.ORDER_UNSPECIFIED - added:
field Index.IndexField.SearchConfig.SearchGeoSpec.geo_json_indexing_disabled: bool - added:
field Index.IndexField.SearchConfig.SearchTextIndexSpec.index_type: Index.IndexField.SearchConfig.TextIndexType - added:
field Index.IndexField.SearchConfig.SearchTextIndexSpec.match_type: Index.IndexField.SearchConfig.TextMatchType - added:
field Index.IndexField.SearchConfig.SearchTextSpec.index_specs: MutableSequence[Index.IndexField.SearchConfig.SearchTextIndexSpec] - added:
field Index.IndexField.SearchConfig.TextIndexType.TEXT_INDEX_TYPE_UNSPECIFIED - added:
field Index.IndexField.SearchConfig.TextIndexType.TOKENIZED - added:
field Index.IndexField.SearchConfig.TextMatchType.MATCH_GLOBALLY - added:
field Index.IndexField.SearchConfig.TextMatchType.TEXT_MATCH_TYPE_UNSPECIFIED - added:
field Index.IndexField.SearchConfig.geo_spec: Index.IndexField.SearchConfig.SearchGeoSpec - added:
field Index.IndexField.SearchConfig.text_spec: Index.IndexField.SearchConfig.SearchTextSpec - added:
field Index.IndexField.VectorConfig.dimension: int - added:
field Index.IndexField.VectorConfig.flat: Index.IndexField.VectorConfig.FlatIndex - added:
field Index.IndexField.array_config: Index.IndexField.ArrayConfig - added:
field Index.IndexField.field_path: str - added:
field Index.IndexField.order: Index.IndexField.Order - added:
field Index.IndexField.search_config: Index.IndexField.SearchConfig - added:
field Index.IndexField.vector_config: Index.IndexField.VectorConfig - added:
field Index.QueryScope.COLLECTION - added:
field Index.QueryScope.COLLECTION_GROUP - added:
field Index.QueryScope.COLLECTION_RECURSIVE - added:
field Index.QueryScope.QUERY_SCOPE_UNSPECIFIED - added:
field Index.SearchIndexOptions.text_language: str - added:
field Index.SearchIndexOptions.text_language_override_field_path: str - added:
field Index.State.CREATING - added:
field Index.State.NEEDS_REPAIR - added:
field Index.State.READY - added:
field Index.State.STATE_UNSPECIFIED - added:
field Index.api_scope: ApiScope - added:
field Index.density: Density - added:
field Index.fields: MutableSequence[IndexField] - added:
field Index.multikey: bool - added:
field Index.name: str - added:
field Index.query_scope: QueryScope - added:
field Index.search_index_options: SearchIndexOptions - added:
field Index.shard_count: int - added:
field Index.state: State - added:
field Index.unique: bool
- added:
class LocationMetadata(proto.Message)
- added:
class BulkDeleteDocumentsMetadata(proto.Message) - added:
class CloneDatabaseMetadata(proto.Message) - added:
class ExportDocumentsMetadata(proto.Message) - added:
class ExportDocumentsResponse(proto.Message) - added:
class FieldOperationMetadata(proto.Message) - added:
class FieldOperationMetadata.IndexConfigDelta(proto.Message) - added:
class FieldOperationMetadata.IndexConfigDelta.ChangeType(proto.Enum) - added:
class FieldOperationMetadata.TtlConfigDelta(proto.Message) - added:
class FieldOperationMetadata.TtlConfigDelta.ChangeType(proto.Enum) - added:
class ImportDocumentsMetadata(proto.Message) - added:
class IndexOperationMetadata(proto.Message) - added:
class OperationState(proto.Enum) - added:
class Progress(proto.Message) - added:
class RestoreDatabaseMetadata(proto.Message) - added:
field BulkDeleteDocumentsMetadata.collection_ids: MutableSequence[str] - added:
field BulkDeleteDocumentsMetadata.end_time: timestamp_pb2.Timestamp - added:
field BulkDeleteDocumentsMetadata.namespace_ids: MutableSequence[str] - added:
field BulkDeleteDocumentsMetadata.operation_state: OperationState - added:
field BulkDeleteDocumentsMetadata.progress_bytes: Progress - added:
field BulkDeleteDocumentsMetadata.progress_documents: Progress - added:
field BulkDeleteDocumentsMetadata.snapshot_time: timestamp_pb2.Timestamp - added:
field BulkDeleteDocumentsMetadata.start_time: timestamp_pb2.Timestamp - added:
field CloneDatabaseMetadata.database: str - added:
field CloneDatabaseMetadata.end_time: timestamp_pb2.Timestamp - added:
field CloneDatabaseMetadata.operation_state: OperationState - added:
field CloneDatabaseMetadata.pitr_snapshot: snapshot.PitrSnapshot - added:
field CloneDatabaseMetadata.progress_percentage: Progress - added:
field CloneDatabaseMetadata.start_time: timestamp_pb2.Timestamp - added:
field ExportDocumentsMetadata.collection_ids: MutableSequence[str] - added:
field ExportDocumentsMetadata.end_time: timestamp_pb2.Timestamp - added:
field ExportDocumentsMetadata.namespace_ids: MutableSequence[str] - added:
field ExportDocumentsMetadata.operation_state: OperationState - added:
field ExportDocumentsMetadata.output_uri_prefix: str - added:
field ExportDocumentsMetadata.progress_bytes: Progress - added:
field ExportDocumentsMetadata.progress_documents: Progress - added:
field ExportDocumentsMetadata.snapshot_time: timestamp_pb2.Timestamp - added:
field ExportDocumentsMetadata.start_time: timestamp_pb2.Timestamp - added:
field ExportDocumentsResponse.output_uri_prefix: str - added:
field FieldOperationMetadata.IndexConfigDelta.ChangeType.ADD - added:
field FieldOperationMetadata.IndexConfigDelta.ChangeType.CHANGE_TYPE_UNSPECIFIED - added:
field FieldOperationMetadata.IndexConfigDelta.ChangeType.REMOVE - added:
field FieldOperationMetadata.IndexConfigDelta.change_type: FieldOperationMetadata.IndexConfigDelta.ChangeType - added:
field FieldOperationMetadata.IndexConfigDelta.index: gfa_index.Index - added:
field FieldOperationMetadata.TtlConfigDelta.ChangeType.ADD - added:
field FieldOperationMetadata.TtlConfigDelta.ChangeType.CHANGE_TYPE_UNSPECIFIED - added:
field FieldOperationMetadata.TtlConfigDelta.ChangeType.REMOVE - added:
field FieldOperationMetadata.TtlConfigDelta.change_type: FieldOperationMetadata.TtlConfigDelta.ChangeType - added:
field FieldOperationMetadata.TtlConfigDelta.expiration_offset: duration_pb2.Duration - added:
field FieldOperationMetadata.end_time: timestamp_pb2.Timestamp - added:
field FieldOperationMetadata.field: str - added:
field FieldOperationMetadata.index_config_deltas: MutableSequence[IndexConfigDelta] - added:
field FieldOperationMetadata.progress_bytes: Progress - added:
field FieldOperationMetadata.progress_documents: Progress - added:
field FieldOperationMetadata.start_time: timestamp_pb2.Timestamp - added:
field FieldOperationMetadata.state: OperationState - added:
field FieldOperationMetadata.ttl_config_delta: TtlConfigDelta - added:
field ImportDocumentsMetadata.collection_ids: MutableSequence[str] - added:
field ImportDocumentsMetadata.end_time: timestamp_pb2.Timestamp - added:
field ImportDocumentsMetadata.input_uri_prefix: str - added:
field ImportDocumentsMetadata.namespace_ids: MutableSequence[str] - added:
field ImportDocumentsMetadata.operation_state: OperationState - added:
field ImportDocumentsMetadata.progress_bytes: Progress - added:
field ImportDocumentsMetadata.progress_documents: Progress - added:
field ImportDocumentsMetadata.start_time: timestamp_pb2.Timestamp - added:
field IndexOperationMetadata.end_time: timestamp_pb2.Timestamp - added:
field IndexOperationMetadata.index: str - added:
field IndexOperationMetadata.progress_bytes: Progress - added:
field IndexOperationMetadata.progress_documents: Progress - added:
field IndexOperationMetadata.start_time: timestamp_pb2.Timestamp - added:
field IndexOperationMetadata.state: OperationState - added:
field OperationState.CANCELLED - added:
field OperationState.CANCELLING - added:
field OperationState.FAILED - added:
field OperationState.FINALIZING - added:
field OperationState.INITIALIZING - added:
field OperationState.OPERATION_STATE_UNSPECIFIED - added:
field OperationState.PROCESSING - added:
field OperationState.SUCCESSFUL - added:
field Progress.completed_work: int - added:
field Progress.estimated_work: int - added:
field RestoreDatabaseMetadata.backup: str - added:
field RestoreDatabaseMetadata.database: str - added:
field RestoreDatabaseMetadata.end_time: timestamp_pb2.Timestamp - added:
field RestoreDatabaseMetadata.operation_state: OperationState - added:
field RestoreDatabaseMetadata.progress_percentage: Progress - added:
field RestoreDatabaseMetadata.start_time: timestamp_pb2.Timestamp
- added:
class RealtimeUpdatesMode(proto.Enum) - added:
field RealtimeUpdatesMode.REALTIME_UPDATES_MODE_DISABLED - added:
field RealtimeUpdatesMode.REALTIME_UPDATES_MODE_ENABLED - added:
field RealtimeUpdatesMode.REALTIME_UPDATES_MODE_UNSPECIFIED
- added:
class BackupSchedule(proto.Message) - added:
class DailyRecurrence(proto.Message) - added:
class WeeklyRecurrence(proto.Message) - added:
field BackupSchedule.create_time: timestamp_pb2.Timestamp - added:
field BackupSchedule.daily_recurrence: DailyRecurrence - added:
field BackupSchedule.name: str - added:
field BackupSchedule.retention: duration_pb2.Duration - added:
field BackupSchedule.update_time: timestamp_pb2.Timestamp - added:
field BackupSchedule.weekly_recurrence: WeeklyRecurrence - added:
field WeeklyRecurrence.day: dayofweek_pb2.DayOfWeek
- added:
class PitrSnapshot(proto.Message) - added:
field PitrSnapshot.database: str - added:
field PitrSnapshot.database_uid: bytes - added:
field PitrSnapshot.snapshot_time: timestamp_pb2.Timestamp
- added:
class UserCreds(proto.Message) - added:
class UserCreds.ResourceIdentity(proto.Message) - added:
class UserCreds.State(proto.Enum) - added:
field UserCreds.ResourceIdentity.principal: str - added:
field UserCreds.State.DISABLED - added:
field UserCreds.State.ENABLED - added:
field UserCreds.State.STATE_UNSPECIFIED - added:
field UserCreds.create_time: timestamp_pb2.Timestamp - added:
field UserCreds.name: str - added:
field UserCreds.resource_identity: ResourceIdentity - added:
field UserCreds.secure_password: str - added:
field UserCreds.state: State - added:
field UserCreds.update_time: timestamp_pb2.Timestamp
- added:
export BundleElement - added:
export BundleMetadata - added:
export BundledDocumentMetadata - added:
export BundledQuery - added:
export FirestoreBundle - added:
export NamedQuery
- added:
class FirestoreBundle - added:
constructor FirestoreBundle(name: str) -> None - added:
field FirestoreBundle.BUNDLE_SCHEMA_VERSION: int - added:
method FirestoreBundle.add_document(snapshot: DocumentSnapshot) -> FirestoreBundle - added:
method FirestoreBundle.add_named_query(name: str, query: BaseQuery) -> FirestoreBundle - added:
method FirestoreBundle.build() -> str
- added:
export BundleElement - added:
export BundleMetadata - added:
export BundledDocumentMetadata - added:
export BundledQuery - added:
export NamedQuery
- added:
class BundleElement(proto.Message) - added:
class BundleMetadata(proto.Message) - added:
class BundledDocumentMetadata(proto.Message) - added:
class BundledQuery(proto.Message) - added:
class BundledQuery.LimitType(proto.Enum) - added:
class NamedQuery(proto.Message) - added:
field BundleElement.document: document_pb2.Document - added:
field BundleElement.document_metadata: BundledDocumentMetadata - added:
field BundleElement.metadata: BundleMetadata - added:
field BundleElement.named_query: NamedQuery - added:
field BundleMetadata.create_time: timestamp_pb2.Timestamp - added:
field BundleMetadata.id: str - added:
field BundleMetadata.total_bytes: int - added:
field BundleMetadata.total_documents: int - added:
field BundleMetadata.version: int - added:
field BundledDocumentMetadata.exists: bool - added:
field BundledDocumentMetadata.name: str - added:
field BundledDocumentMetadata.queries: MutableSequence[str] - added:
field BundledDocumentMetadata.read_time: timestamp_pb2.Timestamp - added:
field BundledQuery.LimitType.FIRST - added:
field BundledQuery.LimitType.LAST - added:
field BundledQuery.limit_type: LimitType - added:
field BundledQuery.parent: str - added:
field BundledQuery.structured_query: query_pb2.StructuredQuery - added:
field NamedQuery.bundled_query: BundledQuery - added:
field NamedQuery.name: str - added:
field NamedQuery.read_time: timestamp_pb2.Timestamp
- removed:
export enums - changed:
variable __version__ → variable __version__: str - added:
export And - added:
export AsyncClient - added:
export AsyncCollectionReference - added:
export AsyncDocumentReference - added:
export AsyncPipeline - added:
export AsyncPipelineStream - added:
export AsyncQuery - added:
export AsyncTransaction - added:
export AsyncWriteBatch - added:
export BSONBinary - added:
export BSONDecimal128 - added:
export BSONInt32 - added:
export BSONMaxKey - added:
export BSONMinKey - added:
export BSONObjectId - added:
export BSONRegex - added:
export BSONTimestamp - added:
export BSONType - added:
export CollectionGroup - added:
export CountAggregation - added:
export DocumentTransform - added:
export ExplainOptions - added:
export FieldFilter - added:
export FindNearestOptions - added:
export Or - added:
export Ordering - added:
export Pipeline - added:
export PipelineDataType - added:
export PipelineExplainOptions - added:
export PipelineResult - added:
export PipelineSnapshot - added:
export PipelineSource - added:
export PipelineStream - added:
export SampleOptions - added:
export SearchOptions - added:
export SubPipeline - added:
export TimeGranularity - added:
export TimePart - added:
export TimeUnit - added:
export UnnestOptions - added:
export async_transactional
- added:
class AggregationQuery(BaseAggregationQuery) - added:
constructor AggregationQuery(nested_query) -> None - added:
method AggregationQuery.get(transaction=…, retry: Union[retries.Retry, None, object]=…, timeout: float | None=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[AggregationResult] - added:
method AggregationQuery.stream(transaction: Optional[transaction.Transaction]=…, retry: Union[retries.Retry, None, object]=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[List[AggregationResult]]
- added:
async method AsyncAggregationQuery.get(transaction=…, retry: Union[retries.AsyncRetry, None, object]=…, timeout: float | None=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[List[AggregationResult]] - added:
class AsyncAggregationQuery(BaseAggregationQuery) - added:
constructor AsyncAggregationQuery(nested_query) -> None - added:
method AsyncAggregationQuery.stream(transaction: Optional[transaction.Transaction]=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> AsyncStreamGenerator[List[AggregationResult]]
- added:
async method AsyncWriteBatch.commit(retry: retries.AsyncRetry | object | None=…, timeout: float | None=…) -> list[WriteResult] - added:
class AsyncWriteBatch(BaseWriteBatch) - added:
constructor AsyncWriteBatch(client) -> None
- added:
async method AsyncClient.collections(retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> AsyncGenerator[AsyncCollectionReference, Any] - added:
async method AsyncClient.get_all(references: List[AsyncDocumentReference], field_paths: Iterable[str] | None=…, transaction: AsyncTransaction | None=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> AsyncGenerator[DocumentSnapshot[AsyncDocumentReference], Any] - added:
async method AsyncClient.recursive_delete(reference: Union[AsyncCollectionReference, AsyncDocumentReference], *, bulk_writer: Optional[BulkWriter]=…, chunk_size: int=…) -> int - added:
class AsyncClient(BaseClient) - added:
constructor AsyncClient(project=…, credentials=…, database=…, client_info=…, client_options=…) -> None - added:
method AsyncClient.batch() -> AsyncWriteBatch - added:
method AsyncClient.collection(*collection_path: str) -> AsyncCollectionReference - added:
method AsyncClient.collection_group(collection_id: str) -> AsyncCollectionGroup - added:
method AsyncClient.document(*document_path: str) -> AsyncDocumentReference - added:
method AsyncClient.pipeline() -> PipelineSource - added:
method AsyncClient.transaction(max_attempts: int=…, read_only: bool=…) -> AsyncTransaction
- added:
async method AsyncCollectionReference.add(document_data: dict, document_id: str | None=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…) -> Tuple[Any, Any] - added:
async method AsyncCollectionReference.get(transaction: Optional[transaction.Transaction]=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[DocumentSnapshot[AsyncDocumentReference]] - added:
async method AsyncCollectionReference.list_documents(page_size: int | None=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> AsyncGenerator[AsyncDocumentReference, None] - added:
class AsyncCollectionReference(BaseCollectionReference[async_query.AsyncQuery]) - added:
constructor AsyncCollectionReference(*path, **kwargs) -> None - added:
method AsyncCollectionReference.document(document_id: str | None=…) -> AsyncDocumentReference - added:
method AsyncCollectionReference.stream(transaction: Optional[transaction.Transaction]=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> AsyncStreamGenerator[DocumentSnapshot[AsyncDocumentReference]]
- added:
async method AsyncDocumentReference.collections(page_size: int | None=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> AsyncGenerator - added:
async method AsyncDocumentReference.create(document_data: dict, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…) -> write.WriteResult - added:
async method AsyncDocumentReference.delete(option: _helpers.WriteOption | None=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…) -> Timestamp - added:
async method AsyncDocumentReference.get(field_paths: Iterable[str] | None=…, transaction=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> DocumentSnapshot[AsyncDocumentReference] - added:
async method AsyncDocumentReference.set(document_data: dict, merge: bool=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…) -> write.WriteResult - added:
async method AsyncDocumentReference.update(field_updates: dict, option: _helpers.WriteOption | None=…, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…) -> write.WriteResult - added:
class AsyncDocumentReference(BaseDocumentReference) - added:
constructor AsyncDocumentReference(*path, **kwargs) -> None - added:
variable logger
- added:
async method AsyncPipeline.execute(*, transaction: AsyncTransaction | None=…, read_time: datetime.datetime | None=…, explain_options: PipelineExplainOptions | None=…, additional_options: dict[str, Value | Constant]=…) -> PipelineSnapshot[PipelineResult] - added:
class AsyncPipeline(_BasePipeline) - added:
constructor AsyncPipeline(client: AsyncClient, *stages: stages.Stage) - added:
method AsyncPipeline.stream(*, read_time: datetime.datetime | None=…, transaction: AsyncTransaction | None=…, explain_options: PipelineExplainOptions | None=…, additional_options: dict[str, Value | Constant]=…) -> AsyncPipelineStream[PipelineResult]
- added:
async method AsyncCollectionGroup.get_partitions(partition_count, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: Optional[datetime.datetime]=…) -> AsyncGenerator[QueryPartition, None] - added:
async method AsyncQuery.get(transaction: Optional[AsyncTransaction]=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[DocumentSnapshot[AsyncDocumentReference]] - added:
class AsyncCollectionGroup(AsyncQuery, BaseCollectionGroup) - added:
class AsyncQuery(BaseQuery) - added:
constructor AsyncCollectionGroup(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…, recursive=…) -> None - added:
constructor AsyncQuery(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…, recursive=…) -> None - added:
method AsyncQuery.avg(field_ref: str | FieldPath, alias: str | None=…) -> Type[firestore_v1.async_aggregation.AsyncAggregationQuery] - added:
method AsyncQuery.count(alias: str | None=…) -> Type[firestore_v1.async_aggregation.AsyncAggregationQuery] - added:
method AsyncQuery.find_nearest(vector_field: str, query_vector: Union[Vector, Sequence[float]], limit: int, distance_measure: DistanceMeasure, *, distance_result_field: Optional[str]=…, distance_threshold: Optional[float]=…) -> AsyncVectorQuery - added:
method AsyncQuery.stream(transaction: Optional[AsyncTransaction]=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> AsyncStreamGenerator[DocumentSnapshot[AsyncDocumentReference]] - added:
method AsyncQuery.sum(field_ref: str | FieldPath, alias: str | None=…) -> Type[firestore_v1.async_aggregation.AsyncAggregationQuery]
- added:
async method AsyncStreamGenerator.get_explain_metrics() -> ExplainMetrics - added:
class AsyncStreamGenerator(AsyncGenerator[T, Any]) - added:
constructor AsyncStreamGenerator(response_generator: AsyncGenerator[T | query_profile_pb.ExplainMetrics, Any], explain_options: Optional[ExplainOptions]=…) - added:
method AsyncStreamGenerator.aclose() - added:
method AsyncStreamGenerator.asend(value: Any=…) -> Coroutine[Any, Any, T] - added:
method AsyncStreamGenerator.athrow(*args, **kwargs) -> Coroutine[Any, Any, T] - added:
property AsyncStreamGenerator.explain_options -> ExplainOptions | None - added:
variable T
- added:
async method AsyncTransaction.get(ref_or_query: AsyncDocumentReference | AsyncQuery, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> AsyncGenerator[DocumentSnapshot[AsyncDocumentReference], Any] | AsyncStreamGenerator[DocumentSnapshot[AsyncDocumentReference]] - added:
async method AsyncTransaction.get_all(references: list, retry: retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> AsyncGenerator[DocumentSnapshot[AsyncDocumentReference], Any] - added:
class AsyncTransaction(async_batch.AsyncWriteBatch, BaseTransaction) - added:
constructor AsyncTransaction(client, max_attempts=…, read_only=…) -> None - added:
function async_transactional(to_wrap: Callable[Concatenate[AsyncTransaction, P], Awaitable[T]]) -> Callable[Concatenate[AsyncTransaction, P], Awaitable[T]] - added:
variable P - added:
variable T
- added:
async method AsyncVectorQuery.get(transaction=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…) -> QueryResultsList[DocumentSnapshot[AsyncDocumentReference]] - added:
class AsyncVectorQuery(BaseVectorQuery) - added:
constructor AsyncVectorQuery(nested_query: Union[BaseQuery, TAsyncVectorQuery]) -> None - added:
method AsyncVectorQuery.stream(transaction=…, retry: retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…) -> AsyncStreamGenerator[DocumentSnapshot[AsyncDocumentReference]] - added:
variable TAsyncVectorQuery
- added:
class AggregationResult(object) - added:
class AvgAggregation(BaseAggregation) - added:
class BaseAggregation(ABC) - added:
class BaseAggregationQuery(ABC) - added:
class CountAggregation(BaseAggregation) - added:
class SumAggregation(BaseAggregation) - added:
constructor AggregationResult(alias: str, value: float, read_time=…) - added:
constructor AvgAggregation(field_ref: str | FieldPath, alias: str | None=…) - added:
constructor BaseAggregation(alias: str | None=…) - added:
constructor BaseAggregationQuery(nested_query, alias: str | None=…) -> None - added:
constructor CountAggregation(alias: str | None=…) - added:
constructor SumAggregation(field_ref: str | FieldPath, alias: str | None=…) - added:
method BaseAggregationQuery.add_aggregation(aggregation: BaseAggregation) -> None - added:
method BaseAggregationQuery.add_aggregations(aggregations: List[BaseAggregation]) -> None - added:
method BaseAggregationQuery.avg(field_ref: str | FieldPath, alias: str | None=…) - added:
method BaseAggregationQuery.count(alias: str | None=…) - added:
method BaseAggregationQuery.get(transaction=…, retry: Union[retries.Retry, retries.AsyncRetry, None, object]=…, timeout: float | None=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[AggregationResult] | Coroutine[Any, Any, List[List[AggregationResult]]] - added:
method BaseAggregationQuery.stream(transaction: Optional[transaction.Transaction]=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[List[AggregationResult]] | AsyncStreamGenerator[List[AggregationResult]] - added:
method BaseAggregationQuery.sum(field_ref: str | FieldPath, alias: str | None=…)
- added:
class BaseBatch - added:
class BaseWriteBatch(BaseBatch) - added:
constructor BaseBatch(client) -> None - added:
method BaseBatch.commit() - added:
method BaseBatch.create(reference: BaseDocumentReference, document_data: dict[str, Any]) -> None - added:
method BaseBatch.delete(reference: BaseDocumentReference, option: _helpers.WriteOption | None=…) -> None - added:
method BaseBatch.set(reference: BaseDocumentReference, document_data: dict, merge: Union[bool, list]=…) -> None - added:
method BaseBatch.update(reference: BaseDocumentReference, field_updates: dict[str, Any], option: _helpers.WriteOption | None=…) -> None
- added:
class BaseClient(ClientWithProject) - added:
constructor BaseClient(project=…, credentials=…, database=…, client_info=…, client_options=…) -> None - added:
field BaseClient.SCOPE - added:
method BaseClient.batch() -> BaseWriteBatch - added:
method BaseClient.bulk_writer(options: Optional[BulkWriterOptions]=…) -> BulkWriter - added:
method BaseClient.collection(*collection_path) -> BaseCollectionReference - added:
method BaseClient.collection_group(collection_id: str) -> BaseQuery - added:
method BaseClient.collections(retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) - added:
method BaseClient.document(*document_path) -> BaseDocumentReference - added:
method BaseClient.get_all(references: list, field_paths: Iterable[str] | None=…, transaction=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> Union[AsyncGenerator[DocumentSnapshot, Any], Generator[DocumentSnapshot, Any, Any]] - added:
method BaseClient.pipeline() -> PipelineSource - added:
method BaseClient.recursive_delete(reference, *, bulk_writer: Optional[BulkWriter]=…, chunk_size: int=…) -> int | Awaitable[int] - added:
method BaseClient.transaction(max_attempts: int=…, read_only: bool=…) -> BaseTransaction - added:
static method BaseClient.field_path(*field_names: str) -> str - added:
static method BaseClient.write_option(**kwargs) -> Union[_helpers.ExistsOption, _helpers.LastUpdateOption] - added:
variable DEFAULT_DATABASE
- added:
class BaseCollectionReference(Generic[QueryType]) - added:
constructor BaseCollectionReference(*path, **kwargs) -> None - added:
method BaseCollectionReference.add(document_data: dict, document_id: Optional[str]=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…) -> Union[Tuple[Any, Any], Coroutine[Any, Any, Tuple[Any, Any]]] - added:
method BaseCollectionReference.avg(field_ref: str | FieldPath, alias=…) - added:
method BaseCollectionReference.count(alias=…) - added:
method BaseCollectionReference.document(document_id: Optional[str]=…) -> BaseDocumentReference - added:
method BaseCollectionReference.end_at(document_fields: Union[DocumentSnapshot, dict, list, tuple]) -> QueryType - added:
method BaseCollectionReference.end_before(document_fields: Union[DocumentSnapshot, dict, list, tuple]) -> QueryType - added:
method BaseCollectionReference.find_nearest(vector_field: str, query_vector: Union[Vector, Sequence[float]], limit: int, distance_measure: DistanceMeasure, *, distance_result_field: Optional[str]=…, distance_threshold: Optional[float]=…) -> VectorQuery - added:
method BaseCollectionReference.get(transaction: Optional[Transaction]=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[DocumentSnapshot] | Coroutine[Any, Any, QueryResultsList[DocumentSnapshot]] - added:
method BaseCollectionReference.limit(count: int) -> QueryType - added:
method BaseCollectionReference.limit_to_last(count: int) - added:
method BaseCollectionReference.list_documents(page_size: Optional[int]=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, read_time: Optional[datetime.datetime]=…) -> Union[Generator[DocumentReference, Any, Any], AsyncGenerator[AsyncDocumentReference, Any]] - added:
method BaseCollectionReference.offset(num_to_skip: int) -> QueryType - added:
method BaseCollectionReference.on_snapshot(callback) - added:
method BaseCollectionReference.order_by(field_path: str, **kwargs) -> QueryType - added:
method BaseCollectionReference.recursive() -> QueryType - added:
method BaseCollectionReference.select(field_paths: Iterable[str]) -> QueryType - added:
method BaseCollectionReference.start_after(document_fields: Union[DocumentSnapshot, dict, list, tuple]) -> QueryType - added:
method BaseCollectionReference.start_at(document_fields: Union[DocumentSnapshot, dict, list, tuple]) -> QueryType - added:
method BaseCollectionReference.stream(transaction: Optional[Transaction]=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[DocumentSnapshot] | AsyncIterator[DocumentSnapshot] - added:
method BaseCollectionReference.sum(field_ref: str | FieldPath, alias=…) - added:
method BaseCollectionReference.where(field_path: Optional[str]=…, op_string: Optional[str]=…, value=…, *, filter=…) -> QueryType - added:
property BaseCollectionReference.id - added:
property BaseCollectionReference.parent - added:
variable system_random
- added:
class BaseDocumentReference(object) - added:
class DocumentSnapshot(Generic[DocRefType]) - added:
constructor BaseDocumentReference(*path, **kwargs) -> None - added:
constructor DocumentSnapshot(reference: DocRefType, data, exists, read_time, create_time, update_time) -> None - added:
method BaseDocumentReference.collection(collection_id: str) - added:
method BaseDocumentReference.collections(page_size: int | None=…, retry: retries.Retry | retries.AsyncRetry | None | object=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) - added:
method BaseDocumentReference.create(document_data: dict, retry: retries.Retry | retries.AsyncRetry | None | object=…, timeout: float | None=…) -> write.WriteResult | Awaitable[write.WriteResult] - added:
method BaseDocumentReference.delete(option: _helpers.WriteOption | None=…, retry: retries.Retry | retries.AsyncRetry | None | object=…, timeout: float | None=…) - added:
method BaseDocumentReference.get(field_paths: Iterable[str] | None=…, transaction=…, retry: retries.Retry | retries.AsyncRetry | None | object=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> DocumentSnapshot | Awaitable[DocumentSnapshot] - added:
method BaseDocumentReference.on_snapshot(callback) - added:
method BaseDocumentReference.set(document_data: dict, merge: bool=…, retry: retries.Retry | retries.AsyncRetry | None | object=…, timeout: float | None=…) - added:
method BaseDocumentReference.update(field_updates: dict, option: _helpers.WriteOption | None=…, retry: retries.Retry | retries.AsyncRetry | None | object=…, timeout: float | None=…) - added:
method DocumentSnapshot.get(field_path: str) -> Any - added:
method DocumentSnapshot.to_dict() -> Union[Dict[str, Any], None] - added:
property BaseDocumentReference.id - added:
property BaseDocumentReference.parent - added:
property BaseDocumentReference.path - added:
property DocumentSnapshot.exists -> bool - added:
property DocumentSnapshot.id -> str - added:
property DocumentSnapshot.reference -> DocRefType - added:
variable DocRefType
- added:
class SubPipeline(_BasePipeline) - added:
method SubPipeline.execute(*args, **kwargs) - added:
method SubPipeline.stream(*args, **kwargs)
- added:
class And(BaseCompositeFilter) - added:
class BaseCollectionGroup(BaseQuery) - added:
class BaseCompositeFilter(BaseFilter) - added:
class BaseFilter(abc.ABC) - added:
class BaseQuery(object) - added:
class FieldFilter(BaseFilter) - added:
class Or(BaseCompositeFilter) - added:
class QueryPartition - added:
constructor And(filters: list[BaseFilter]) - added:
constructor BaseCollectionGroup(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…, recursive=…) -> None - added:
constructor BaseCompositeFilter(operator: int=…, filters: list[BaseFilter] | None=…) - added:
constructor BaseQuery(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…, recursive=…) -> None - added:
constructor FieldFilter(field_path: str, op_string: str, value: Any | None=…) - added:
constructor Or(filters: list[BaseFilter]) - added:
constructor QueryPartition(query, start_at, end_at) - added:
field BaseQuery.ASCENDING - added:
field BaseQuery.DESCENDING - added:
method BaseCollectionGroup.get_partitions(partition_count, retry: Optional[retries.Retry]=…, timeout: Optional[float]=…, *, read_time: Optional[datetime.datetime]=…) - added:
method BaseQuery.avg(field_ref: str | FieldPath, alias: str | None=…) -> Type[firestore_v1.base_aggregation.BaseAggregationQuery] - added:
method BaseQuery.count(alias: str | None=…) -> Type[firestore_v1.base_aggregation.BaseAggregationQuery] - added:
method BaseQuery.end_at(document_fields_or_snapshot: Union[DocumentSnapshot, dict, list, tuple, None]) -> QueryType - added:
method BaseQuery.end_before(document_fields_or_snapshot: Union[DocumentSnapshot, dict, list, tuple, None]) -> QueryType - added:
method BaseQuery.find_nearest(vector_field: str, query_vector: Union[Vector, Sequence[float]], limit: int, distance_measure: DistanceMeasure, *, distance_result_field: Optional[str]=…, distance_threshold: Optional[float]=…) - added:
method BaseQuery.get(transaction=…, retry: Optional[retries.Retry]=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[DocumentSnapshot] | Coroutine[Any, Any, QueryResultsList[DocumentSnapshot]] - added:
method BaseQuery.limit(count: int) -> QueryType - added:
method BaseQuery.limit_to_last(count: int) -> QueryType - added:
method BaseQuery.offset(num_to_skip: int) -> QueryType - added:
method BaseQuery.on_snapshot(callback) - added:
method BaseQuery.order_by(field_path: str, direction: str=…) -> QueryType - added:
method BaseQuery.recursive() -> QueryType - added:
method BaseQuery.select(field_paths: Iterable[str]) -> QueryType - added:
method BaseQuery.start_after(document_fields_or_snapshot: Union[DocumentSnapshot, dict, list, tuple, None]) -> QueryType - added:
method BaseQuery.start_at(document_fields_or_snapshot: Union[DocumentSnapshot, dict, list, tuple, None]) -> QueryType - added:
method BaseQuery.stream(transaction=…, retry: Optional[retries.Retry]=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[document.DocumentSnapshot] | AsyncStreamGenerator[DocumentSnapshot] - added:
method BaseQuery.sum(field_ref: str | FieldPath, alias: str | None=…) -> Type[firestore_v1.base_aggregation.BaseAggregationQuery] - added:
method BaseQuery.where(field_path: Optional[str]=…, op_string: Optional[str]=…, value=…, *, filter=…) -> QueryType - added:
method QueryPartition.query() - added:
property QueryPartition.end_at - added:
property QueryPartition.start_at - added:
variable QueryType
- added:
class BaseTransaction(object) - added:
constructor BaseTransaction(max_attempts=…, read_only=…) -> None - added:
method BaseTransaction.get(ref_or_query, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: float | None=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None] | Coroutine[Any, Any, AsyncGenerator[DocumentSnapshot, Any]] | Coroutine[Any, Any, AsyncStreamGenerator[… - added:
method BaseTransaction.get_all(references: list, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> Generator[DocumentSnapshot, Any, None] | Coroutine[Any, Any, AsyncGenerator[DocumentSnapshot, Any]] - added:
property BaseTransaction.id - added:
property BaseTransaction.in_progress - added:
variable MAX_ATTEMPTS
- added:
class BaseVectorQuery(ABC) - added:
class DistanceMeasure(Enum) - added:
constructor BaseVectorQuery(nested_query) -> None - added:
field DistanceMeasure.COSINE - added:
field DistanceMeasure.DOT_PRODUCT - added:
field DistanceMeasure.EUCLIDEAN - added:
method BaseVectorQuery.find_nearest(vector_field: str, query_vector: Union[Vector, Sequence[float]], limit: int, distance_measure: DistanceMeasure, *, distance_result_field: Optional[str]=…, distance_threshold: Optional[float]=…) - added:
method BaseVectorQuery.get(transaction=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…) -> QueryResultsList[DocumentSnapshot] | Coroutine[Any, Any, QueryResultsList[DocumentSnapshot]] - added:
method BaseVectorQuery.stream(transaction=…, retry: retries.Retry | retries.AsyncRetry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…) -> StreamGenerator[DocumentSnapshot] | AsyncStreamGenerator[DocumentSnapshot]
- removed:
method WriteBatch.create(reference, document_data) - removed:
method WriteBatch.delete(reference, option=…) - removed:
method WriteBatch.set(reference, document_data, merge=…) - removed:
method WriteBatch.update(reference, field_updates, option=…) - changed:
class WriteBatch(object) → class WriteBatch(BaseWriteBatch) - changed:
constructor WriteBatch(client) → constructor WriteBatch(client) -> None - changed:
method WriteBatch.commit() → method WriteBatch.commit(retry: retries.Retry | object | None=…, timeout: float | None=…) -> list
- added:
class BSONBinary(BSONType) - added:
class BSONDecimal128(BSONType) - added:
class BSONInt32(BSONType) - added:
class BSONMaxKey(BSONType) - added:
class BSONMinKey(BSONType) - added:
class BSONObjectId(BSONType) - added:
class BSONRegex(BSONType) - added:
class BSONTimestamp(BSONType) - added:
class BSONType(abc.ABC) - added:
constructor BSONBinary(data: Union[bytes, bytearray], subtype: int) - added:
constructor BSONDecimal128(value: Union[str, int, decimal.Decimal, BSONDecimal128]) - added:
constructor BSONInt32(value: int) - added:
constructor BSONObjectId(value: Union[str, bytes]) - added:
constructor BSONRegex(pattern: str, options: str=…) - added:
constructor BSONTimestamp(seconds: int, increment: int) - added:
method BSONDecimal128.to_decimal() -> decimal.Decimal - added:
property BSONBinary.data -> bytes - added:
property BSONBinary.subtype -> int - added:
property BSONDecimal128.value -> str - added:
property BSONInt32.value -> int - added:
property BSONObjectId.value -> str - added:
property BSONRegex.options -> str - added:
property BSONRegex.pattern -> str - added:
property BSONTimestamp.increment -> int - added:
property BSONTimestamp.seconds -> int
- added:
class BulkWriteBatch(BaseBatch) - added:
constructor BulkWriteBatch(client) -> None - added:
method BulkWriteBatch.commit(retry: retries.Retry | object | None=…, timeout: float | None=…) -> BatchWriteResponse
- added:
class AsyncBulkWriterMixin - added:
class BaseOperationRetry - added:
class BulkRetry(enum.Enum) - added:
class BulkWriteFailure - added:
class BulkWriter(AsyncBulkWriterMixin) - added:
class BulkWriterCreateOperation(BulkWriterOperation) - added:
class BulkWriterDeleteOperation(BulkWriterOperation) - added:
class BulkWriterOperation - added:
class BulkWriterOptions - added:
class BulkWriterSetOperation(BulkWriterOperation) - added:
class BulkWriterUpdateOperation(BulkWriterOperation) - added:
class OperationRetry(BaseOperationRetry) - added:
class SendMode(enum.Enum) - added:
constructor BulkWriter(client: Optional[BaseClient]=…, options: Optional[BulkWriterOptions]=…) - added:
constructor BulkWriterOperation(attempts: int=…) - added:
field BulkRetry.exponential - added:
field BulkRetry.immediate - added:
field BulkRetry.linear - added:
field BulkWriteFailure.code: int - added:
field BulkWriteFailure.message: str - added:
field BulkWriteFailure.operation: BulkWriterOperation - added:
field BulkWriter.batch_size: int - added:
field BulkWriterCreateOperation.attempts: int - added:
field BulkWriterCreateOperation.document_data: Dict - added:
field BulkWriterCreateOperation.reference: BaseDocumentReference - added:
field BulkWriterDeleteOperation.attempts: int - added:
field BulkWriterDeleteOperation.option: Optional[_helpers.WriteOption] - added:
field BulkWriterDeleteOperation.reference: BaseDocumentReference - added:
field BulkWriterOptions.initial_ops_per_second: int - added:
field BulkWriterOptions.max_ops_per_second: int - added:
field BulkWriterOptions.mode: SendMode - added:
field BulkWriterOptions.retry: BulkRetry - added:
field BulkWriterSetOperation.attempts: int - added:
field BulkWriterSetOperation.document_data: Dict - added:
field BulkWriterSetOperation.merge: Union[bool, list] - added:
field BulkWriterSetOperation.reference: BaseDocumentReference - added:
field BulkWriterUpdateOperation.attempts: int - added:
field BulkWriterUpdateOperation.field_updates: Dict - added:
field BulkWriterUpdateOperation.option: Optional[_helpers.WriteOption] - added:
field BulkWriterUpdateOperation.reference: BaseDocumentReference - added:
field OperationRetry.operation: BulkWriterOperation - added:
field OperationRetry.run_at: datetime.datetime - added:
field SendMode.parallel - added:
field SendMode.serial - added:
method BaseOperationRetry.retry(bulk_writer: BulkWriter) -> None - added:
method BulkWriter.close() - added:
method BulkWriter.create(reference: BaseDocumentReference, document_data: Dict, attempts: int=…) -> None - added:
method BulkWriter.delete(reference: BaseDocumentReference, option: Optional[_helpers.WriteOption]=…, attempts: int=…) -> None - added:
method BulkWriter.flush() - added:
method BulkWriter.on_batch_result(callback: Optional[Callable[[BulkWriteBatch, BatchWriteResponse, BulkWriter], None]]) -> None - added:
method BulkWriter.on_write_error(callback: Optional[Callable[[BulkWriteFailure, BulkWriter], bool]]) -> None - added:
method BulkWriter.on_write_result(callback: Optional[Callable[[BaseDocumentReference, WriteResult, BulkWriter], None]]) -> None - added:
method BulkWriter.set(reference: BaseDocumentReference, document_data: Dict, merge: Union[bool, list]=…, attempts: int=…) -> None - added:
method BulkWriter.update(reference: BaseDocumentReference, field_updates: dict, option: Optional[_helpers.WriteOption]=…, attempts: int=…) -> None - added:
method BulkWriterOperation.add_to_batch(batch: BulkWriteBatch) - added:
property BulkWriteFailure.attempts -> int - added:
variable logger
- removed:
field Client.SCOPE - removed:
static method Client.field_path(*field_names) - removed:
static method Client.write_option(**kwargs) - removed:
variable DEFAULT_DATABASE - changed:
class Client(ClientWithProject) → class Client(BaseClient) - changed:
constructor Client(project=…, credentials=…, database=…, client_info=…, client_options=…) → constructor Client(project=…, credentials=…, database=…, client_info=…, client_options=…) -> None - changed:
method Client.batch() → method Client.batch() -> WriteBatch - changed:
method Client.collection(*collection_path) → method Client.collection(*collection_path: str) -> CollectionReference - changed:
method Client.collection_group(collection_id) → method Client.collection_group(collection_id: str) -> CollectionGroup - changed:
method Client.collections() → method Client.collections(retry: retries.Retry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> Generator[Any, Any, None] - changed:
method Client.document(*document_path) → method Client.document(*document_path: str) -> DocumentReference - changed:
method Client.get_all(references, field_paths=…, transaction=…) → method Client.get_all(references: list, field_paths: Iterable[str] | None=…, transaction: Transaction | None=…, retry: retries.Retry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> Generator[DocumentSnapshot[DocumentReference], Any, None] - changed:
method Client.transaction(**kwargs) → method Client.transaction(max_attempts: int=…, read_only: bool=…) -> Transaction - added:
method Client.pipeline() -> PipelineSource - added:
method Client.recursive_delete(reference: Union[CollectionReference, DocumentReference], *, bulk_writer: Optional[BulkWriter]=…, chunk_size: int=…) -> int
- removed:
method CollectionReference.end_at(document_fields) - removed:
method CollectionReference.end_before(document_fields) - removed:
method CollectionReference.limit(count) - removed:
method CollectionReference.limit_to_last(count) - removed:
method CollectionReference.offset(num_to_skip) - removed:
method CollectionReference.order_by(field_path, **kwargs) - removed:
method CollectionReference.select(field_paths) - removed:
method CollectionReference.start_after(document_fields) - removed:
method CollectionReference.start_at(document_fields) - removed:
method CollectionReference.where(field_path, op_string, value) - removed:
property CollectionReference.id - removed:
property CollectionReference.parent - changed:
class CollectionReference(object) → class CollectionReference(BaseCollectionReference[query_mod.Query]) - changed:
constructor CollectionReference(*path, **kwargs) → constructor CollectionReference(*path, **kwargs) -> None - changed:
method CollectionReference.add(document_data, document_id=…) → method CollectionReference.add(document_data: dict, document_id: Union[str, None]=…, retry: retries.Retry | object | None=…, timeout: Union[float, None]=…) -> Tuple[Any, Any] - changed:
method CollectionReference.document(document_id=…) → method CollectionReference.document(document_id: Union[str, None]=…) -> DocumentReference - changed:
method CollectionReference.get(transaction=…) → method CollectionReference.get(transaction: Union[transaction.Transaction, None]=…, retry: retries.Retry | object | None=…, timeout: Union[float, None]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[DocumentSnapshot[DocumentReference]] - changed:
method CollectionReference.list_documents(page_size=…) → method CollectionReference.list_documents(page_size: Union[int, None]=…, retry: retries.Retry | object | None=…, timeout: Union[float, None]=…, *, read_time: Optional[datetime.datetime]=…) -> Generator[Any, Any, None] - changed:
method CollectionReference.on_snapshot(callback) → method CollectionReference.on_snapshot(callback: Callable) -> Watch - changed:
method CollectionReference.stream(transaction=…) → method CollectionReference.stream(transaction: Optional[transaction.Transaction]=…, retry: retries.Retry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[DocumentSnapshot[DocumentReference]]
- removed:
class DocumentSnapshot(object) - removed:
constructor DocumentSnapshot(reference, data, exists, read_time, create_time, update_time) - removed:
method DocumentReference.collection(collection_id) - removed:
method DocumentSnapshot.get(field_path) - removed:
method DocumentSnapshot.to_dict() - removed:
property DocumentReference.id - removed:
property DocumentReference.parent - removed:
property DocumentReference.path - removed:
property DocumentSnapshot.exists - removed:
property DocumentSnapshot.id - removed:
property DocumentSnapshot.reference - changed:
class DocumentReference(object) → class DocumentReference(BaseDocumentReference) - changed:
constructor DocumentReference(*path, **kwargs) → constructor DocumentReference(*path, **kwargs) -> None - changed:
method DocumentReference.collections(page_size=…) → method DocumentReference.collections(page_size: int | None=…, retry: retries.Retry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> Generator[Any, Any, None] - changed:
method DocumentReference.create(document_data) → method DocumentReference.create(document_data: dict, retry: retries.Retry | object | None=…, timeout: float | None=…) -> write.WriteResult - changed:
method DocumentReference.delete(option=…) → method DocumentReference.delete(option: _helpers.WriteOption | None=…, retry: retries.Retry | object | None=…, timeout: float | None=…) -> Timestamp - changed:
method DocumentReference.get(field_paths=…, transaction=…) → method DocumentReference.get(field_paths: Iterable[str] | None=…, transaction=…, retry: retries.Retry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> DocumentSnapshot[DocumentReference] - changed:
method DocumentReference.on_snapshot(callback) → method DocumentReference.on_snapshot(callback: Callable) -> Watch - changed:
method DocumentReference.set(document_data, merge=…) → method DocumentReference.set(document_data: dict, merge: bool=…, retry: retries.Retry | object | None=…, timeout: float | None=…) -> write.WriteResult - changed:
method DocumentReference.update(field_updates, option=…) → method DocumentReference.update(field_updates: dict[str, Any], option: _helpers.WriteOption | None=…, retry: retries.Retry | object | None=…, timeout: float | None=…) -> write.WriteResult - added:
variable logger
- changed:
constructor FieldPath(*parts) → constructor FieldPath(*parts: str) - changed:
function get_nested_value(field_path, data) → function get_nested_value(field_path: str, data: MutableMapping[str, Any]) - changed:
function parse_field_path(api_repr) → function parse_field_path(api_repr: str) - changed:
function render_field_path(field_names) → function render_field_path(field_names: Iterable[str]) - changed:
function split_field_path(path) → function split_field_path(path: str | None) - changed:
method FieldPath.eq_or_parent(other) → method FieldPath.eq_or_parent(other) -> bool - changed:
method FieldPath.lineage() → method FieldPath.lineage() -> set[FieldPath] - changed:
method FieldPath.to_api_repr() → method FieldPath.to_api_repr() -> str - changed:
static method FieldPath.document_id() → static method FieldPath.document_id() -> str - changed:
static method FieldPath.from_api_repr(api_repr) → static method FieldPath.from_api_repr(api_repr: str) -> FieldPath - changed:
static method FieldPath.from_string(path_string) → static method FieldPath.from_string(path_string: str) -> FieldPath
- removed:
class DocumentTransform(object) - removed:
class DocumentTransform.FieldTransform(object) - removed:
class DocumentTransform.FieldTransform.ServerValue(enum.IntEnum) - removed:
class NullValue(enum.IntEnum) - removed:
class StructuredQuery(object) - removed:
class StructuredQuery.CompositeFilter(object) - removed:
class StructuredQuery.CompositeFilter.Operator(enum.IntEnum) - removed:
class StructuredQuery.Direction(enum.IntEnum) - removed:
class StructuredQuery.FieldFilter(object) - removed:
class StructuredQuery.FieldFilter.Operator(enum.IntEnum) - removed:
class StructuredQuery.UnaryFilter(object) - removed:
class StructuredQuery.UnaryFilter.Operator(enum.IntEnum) - removed:
class TargetChange(object) - removed:
class TargetChange.TargetChangeType(enum.IntEnum) - removed:
field DocumentTransform.FieldTransform.ServerValue.REQUEST_TIME - removed:
field DocumentTransform.FieldTransform.ServerValue.SERVER_VALUE_UNSPECIFIED - removed:
field NullValue.NULL_VALUE - removed:
field StructuredQuery.CompositeFilter.Operator.AND - removed:
field StructuredQuery.CompositeFilter.Operator.OPERATOR_UNSPECIFIED - removed:
field StructuredQuery.Direction.ASCENDING - removed:
field StructuredQuery.Direction.DESCENDING - removed:
field StructuredQuery.Direction.DIRECTION_UNSPECIFIED - removed:
field StructuredQuery.FieldFilter.Operator.ARRAY_CONTAINS - removed:
field StructuredQuery.FieldFilter.Operator.ARRAY_CONTAINS_ANY - removed:
field StructuredQuery.FieldFilter.Operator.EQUAL - removed:
field StructuredQuery.FieldFilter.Operator.GREATER_THAN - removed:
field StructuredQuery.FieldFilter.Operator.GREATER_THAN_OR_EQUAL - removed:
field StructuredQuery.FieldFilter.Operator.IN - removed:
field StructuredQuery.FieldFilter.Operator.LESS_THAN - removed:
field StructuredQuery.FieldFilter.Operator.LESS_THAN_OR_EQUAL - removed:
field StructuredQuery.FieldFilter.Operator.OPERATOR_UNSPECIFIED - removed:
field StructuredQuery.UnaryFilter.Operator.IS_NAN - removed:
field StructuredQuery.UnaryFilter.Operator.IS_NULL - removed:
field StructuredQuery.UnaryFilter.Operator.OPERATOR_UNSPECIFIED - removed:
field TargetChange.TargetChangeType.ADD - removed:
field TargetChange.TargetChangeType.CURRENT - removed:
field TargetChange.TargetChangeType.NO_CHANGE - removed:
field TargetChange.TargetChangeType.REMOVE - removed:
field TargetChange.TargetChangeType.RESET
- removed:
class FirestoreClient(object) - removed:
constructor FirestoreClient(transport=…, channel=…, credentials=…, client_config=…, client_info=…, client_options=…) - removed:
field FirestoreClient.SERVICE_ADDRESS - removed:
field FirestoreClient.from_service_account_json - removed:
method FirestoreClient.batch_get_documents(database, documents=…, mask=…, transaction=…, new_transaction=…, read_time=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.batch_write(database, writes=…, labels=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.begin_transaction(database, options_=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.commit(database, writes=…, transaction=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.create_document(parent, collection_id, document_id, document, mask=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.delete_document(name, current_document=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.get_document(name, mask=…, transaction=…, read_time=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.list_collection_ids(parent, page_size=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.list_documents(parent, collection_id, page_size=…, order_by=…, mask=…, transaction=…, read_time=…, show_missing=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.listen(requests, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.partition_query(parent, structured_query=…, partition_count=…, page_size=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.rollback(database, transaction, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.run_query(parent, structured_query=…, transaction=…, new_transaction=…, read_time=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.update_document(document, update_mask=…, mask=…, current_document=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.write(requests, retry=…, timeout=…, metadata=…) - removed:
static method FirestoreClient.any_path_path(project, database, document, any_path) - removed:
static method FirestoreClient.database_root_path(project, database) - removed:
static method FirestoreClient.document_path_path(project, database, document_path) - removed:
static method FirestoreClient.document_root_path(project, database) - removed:
static method FirestoreClient.from_service_account_file(filename, *args, **kwargs)
- removed:
variable config
- removed:
class FirestoreGrpcTransport(object) - removed:
constructor FirestoreGrpcTransport(channel=…, credentials=…, address=…) - removed:
property FirestoreGrpcTransport.batch_get_documents - removed:
property FirestoreGrpcTransport.batch_write - removed:
property FirestoreGrpcTransport.begin_transaction - removed:
property FirestoreGrpcTransport.channel - removed:
property FirestoreGrpcTransport.commit - removed:
property FirestoreGrpcTransport.create_document - removed:
property FirestoreGrpcTransport.delete_document - removed:
property FirestoreGrpcTransport.get_document - removed:
property FirestoreGrpcTransport.list_collection_ids - removed:
property FirestoreGrpcTransport.list_documents - removed:
property FirestoreGrpcTransport.listen - removed:
property FirestoreGrpcTransport.partition_query - removed:
property FirestoreGrpcTransport.rollback - removed:
property FirestoreGrpcTransport.run_query - removed:
property FirestoreGrpcTransport.update_document - removed:
property FirestoreGrpcTransport.write - removed:
static method FirestoreGrpcTransport.create_channel(address=…, credentials=…, **kwargs)
- changed:
static method Order.compare(left, right) → static method Order.compare(left, right) -> int - changed:
static method Order.compare_arrays(left, right) → static method Order.compare_arrays(left, right) -> int - changed:
static method Order.compare_blobs(left, right) → static method Order.compare_blobs(left, right) -> int - changed:
static method Order.compare_doubles(left, right) → static method Order.compare_doubles(left, right) -> int - changed:
static method Order.compare_geo_points(left, right) → static method Order.compare_geo_points(left, right) -> Any - changed:
static method Order.compare_numbers(left, right) → static method Order.compare_numbers(left, right) -> int - changed:
static method Order.compare_objects(left, right) → static method Order.compare_objects(left, right) -> int - changed:
static method Order.compare_resource_paths(left, right) → static method Order.compare_resource_paths(left, right) -> int - changed:
static method Order.compare_timestamps(left, right) → static method Order.compare_timestamps(left, right) -> Any - changed:
static method TypeOrder.from_value(value) → static method TypeOrder.from_value(value) -> Any - added:
field TypeOrder.BSON_BINARY - added:
field TypeOrder.BSON_MAX_KEY - added:
field TypeOrder.BSON_MIN_KEY - added:
field TypeOrder.BSON_OBJECT_ID - added:
field TypeOrder.BSON_REGEX - added:
field TypeOrder.BSON_TIMESTAMP - added:
field TypeOrder.VECTOR - added:
static method Order.compare_bson_binaries(left, right) -> int - added:
static method Order.compare_bson_object_ids(left, right) -> int - added:
static method Order.compare_bson_regexes(left, right) -> int - added:
static method Order.compare_bson_timestamps(left, right) -> Any - added:
static method Order.compare_vectors(left, right) -> int
- added:
class Pipeline(_BasePipeline) - added:
constructor Pipeline(client: Client, *stages: stages.Stage) - added:
method Pipeline.execute(*, transaction: Transaction | None=…, read_time: datetime.datetime | None=…, explain_options: PipelineExplainOptions | None=…, additional_options: dict[str, Value | Constant]=…) -> PipelineSnapshot[PipelineResult] - added:
method Pipeline.stream(*, transaction: Transaction | None=…, read_time: datetime.datetime | None=…, explain_options: PipelineExplainOptions | None=…, additional_options: dict[str, Value | Constant]=…) -> PipelineStream[PipelineResult]
- added:
class AggregateFunction(FunctionExpression) - added:
class AliasedExpression(Selectable, Generic[T]) - added:
class And(BooleanExpression) - added:
class Array(FunctionExpression) - added:
class BooleanExpression(FunctionExpression) - added:
class Conditional(BooleanExpression) - added:
class Constant(Expression, Generic[CONSTANT_TYPE]) - added:
class Count(AggregateFunction) - added:
class CurrentDocument(FunctionExpression) - added:
class CurrentTimestamp(FunctionExpression) - added:
class DocumentMatches(BooleanExpression) - added:
class Expression(ABC) - added:
class Expression.expose_as_static - added:
class Field(Selectable) - added:
class FunctionExpression(Expression) - added:
class Map(FunctionExpression) - added:
class Nor(BooleanExpression) - added:
class Not(BooleanExpression) - added:
class Or(BooleanExpression) - added:
class Rand(FunctionExpression) - added:
class Score(FunctionExpression) - added:
class Selectable(Expression) - added:
class Variable(Expression) - added:
class Xor(BooleanExpression) - added:
constructor AliasedExpression(expr: T, alias: str) - added:
constructor And(*conditions: BooleanExpression) - added:
constructor Array(elements: list[Expression | CONSTANT_TYPE]) - added:
constructor Conditional(condition: BooleanExpression, then_expr: Expression, else_expr: Expression) - added:
constructor Constant(value: CONSTANT_TYPE) - added:
constructor Count(expression: Expression | None=…) - added:
constructor CurrentDocument() - added:
constructor CurrentTimestamp() - added:
constructor DocumentMatches(query: Expression | str) - added:
constructor Expression.expose_as_static(instance_func) - added:
constructor Field(path: str) - added:
constructor FunctionExpression(name: str, params: Sequence[Expression], *, repr_function: Callable[[FunctionExpression], str] | None=…) - added:
constructor Map(elements: dict[str | Constant[str], Expression | CONSTANT_TYPE]) - added:
constructor Nor(*conditions: BooleanExpression) - added:
constructor Not(condition: BooleanExpression) - added:
constructor Or(*conditions: BooleanExpression) - added:
constructor Rand() - added:
constructor Score() - added:
constructor Variable(name: str) - added:
constructor Xor(conditions: Sequence[BooleanExpression]) - added:
field Field.DOCUMENT_ID - added:
method AliasedExpression.as_(alias: str) -> AliasedExpression - added:
method Expression.abs() -> Expression - added:
method Expression.add(other: Expression | float) -> Expression - added:
method Expression.array_agg() -> Expression - added:
method Expression.array_agg_distinct() -> Expression - added:
method Expression.array_concat(*other_arrays: Array | list[Expression | CONSTANT_TYPE] | Expression) -> Expression - added:
method Expression.array_contains(element: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.array_contains_all(elements: Array | list[Expression | CONSTANT_TYPE] | Expression) -> BooleanExpression - added:
method Expression.array_contains_any(elements: Array | list[Expression | CONSTANT_TYPE] | Expression) -> BooleanExpression - added:
method Expression.array_filter(filter_expr: BooleanExpression, element_alias: str | Constant[str]) -> Expression - added:
method Expression.array_first() -> Expression - added:
method Expression.array_first_n(n: int | Expression) -> Expression - added:
method Expression.array_get(offset: Expression | int) -> FunctionExpression - added:
method Expression.array_index_of(search: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.array_index_of_all(search: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.array_last() -> Expression - added:
method Expression.array_last_n(n: int | Expression) -> Expression - added:
method Expression.array_length() -> Expression - added:
method Expression.array_maximum() -> Expression - added:
method Expression.array_maximum_n(n: int | Expression) -> Expression - added:
method Expression.array_minimum() -> Expression - added:
method Expression.array_minimum_n(n: int | Expression) -> Expression - added:
method Expression.array_reverse() -> Expression - added:
method Expression.array_slice(offset: int | Expression, length: int | Expression | None=…) -> Expression - added:
method Expression.array_transform(transform_expr: Expression, element_alias: str | Constant[str], index_alias: str | Constant[str] | None=…) -> Expression - added:
method Expression.as_(alias: str) -> AliasedExpression - added:
method Expression.ascending() -> Ordering - added:
method Expression.average() -> Expression - added:
method Expression.between(lower: Expression | float, upper: Expression | float) -> BooleanExpression - added:
method Expression.byte_length() -> Expression - added:
method Expression.ceil() -> Expression - added:
method Expression.char_length() -> Expression - added:
method Expression.cmp(other: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.coalesce(*others: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.collection_id() - added:
method Expression.concat(*others: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.cosine_distance(other: Expression | list[float] | Vector) -> Expression - added:
method Expression.count() -> Expression - added:
method Expression.count_distinct() -> Expression - added:
method Expression.count_if() -> Expression - added:
method Expression.descending() -> Ordering - added:
method Expression.divide(other: Expression | float) -> Expression - added:
method Expression.document_id() - added:
method Expression.dot_product(other: Expression | list[float] | Vector) -> Expression - added:
method Expression.ends_with(postfix: Expression | str) -> BooleanExpression - added:
method Expression.equal(other: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.equal_any(array: Array | Sequence[Expression | CONSTANT_TYPE] | Expression) -> BooleanExpression - added:
method Expression.euclidean_distance(other: Expression | list[float] | Vector) -> Expression - added:
method Expression.exists() -> BooleanExpression - added:
method Expression.exp() -> Expression - added:
method Expression.expose_as_static.static_func(first_arg, *other_args, **kwargs) - added:
method Expression.first() -> Expression - added:
method Expression.floor() -> Expression - added:
method Expression.geo_distance(other: Expression | GeoPoint | tuple[float, float]) -> FunctionExpression - added:
method Expression.get_field(key: Expression | str) -> Expression - added:
method Expression.greater_than(other: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.greater_than_or_equal(other: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.if_absent(default_value: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.if_error(then_value: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.if_null(*others: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.is_absent() -> BooleanExpression - added:
method Expression.is_error() - added:
method Expression.is_type(type_val: PipelineDataType | str | Expression) -> BooleanExpression - added:
method Expression.join(delimeter: Expression | str) -> Expression - added:
method Expression.last() -> Expression - added:
method Expression.length() -> Expression - added:
method Expression.less_than(other: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.less_than_or_equal(other: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.like(pattern: Expression | str) -> BooleanExpression - added:
method Expression.ln() -> Expression - added:
method Expression.log(base: Expression | float) -> Expression - added:
method Expression.log10() -> Expression - added:
method Expression.logical_maximum(*others: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.logical_minimum(*others: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.ltrim(chars: str | bytes | Constant[str] | Constant[bytes] | Expression | None=…) -> Expression - added:
method Expression.map_entries() -> Expression - added:
method Expression.map_get(key: str | Constant[str]) -> Expression - added:
method Expression.map_keys() -> Expression - added:
method Expression.map_merge(*other_maps: Map | dict[str | Constant[str], Expression | CONSTANT_TYPE] | Expression) -> Expression - added:
method Expression.map_remove(key: str | Constant[str]) -> Expression - added:
method Expression.map_set(key: str | Constant[str], value: Any) -> Expression - added:
method Expression.map_values() -> Expression - added:
method Expression.maximum() -> Expression - added:
method Expression.minimum() -> Expression - added:
method Expression.mod(other: Expression | float) -> Expression - added:
method Expression.multiply(other: Expression | float) -> Expression - added:
method Expression.not_equal(other: Expression | CONSTANT_TYPE) -> BooleanExpression - added:
method Expression.not_equal_any(array: Array | list[Expression | CONSTANT_TYPE] | Expression) -> BooleanExpression - added:
method Expression.offset(offset: Expression | int) -> FunctionExpression - added:
method Expression.pow(exponent: Expression | float) -> Expression - added:
method Expression.regex_contains(regex: Expression | str) -> BooleanExpression - added:
method Expression.regex_find(pattern: str | Constant[str] | Expression) -> Expression - added:
method Expression.regex_find_all(pattern: str | Constant[str] | Expression) -> Expression - added:
method Expression.regex_match(regex: Expression | str) -> BooleanExpression - added:
method Expression.round() -> Expression - added:
method Expression.rtrim(chars: str | bytes | Constant[str] | Constant[bytes] | Expression | None=…) -> Expression - added:
method Expression.split(delimiter: str | Constant[str] | Expression) -> Expression - added:
method Expression.sqrt() -> Expression - added:
method Expression.starts_with(prefix: Expression | str) -> BooleanExpression - added:
method Expression.storage_size() -> Expression - added:
method Expression.string_concat(*elements: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.string_contains(substring: Expression | str) -> BooleanExpression - added:
method Expression.string_index_of(search: str | bytes | Constant[str] | Constant[bytes] | Expression) -> Expression - added:
method Expression.string_repeat(repetitions: int | Expression) -> Expression - added:
method Expression.string_replace_all(find: str | bytes | Constant[str] | Constant[bytes] | Expression, replacement: str | bytes | Constant[str] | Constant[bytes] | Expression) -> Expression - added:
method Expression.string_replace_one(find: str | bytes | Constant[str] | Constant[bytes] | Expression, replacement: str | bytes | Constant[str] | Constant[bytes] | Expression) -> Expression - added:
method Expression.string_reverse() -> Expression - added:
method Expression.substring(position: Expression | int, length: Expression | int | None=…) -> Expression - added:
method Expression.subtract(other: Expression | float) -> Expression - added:
method Expression.sum() -> Expression - added:
method Expression.switch_on(result: Expression | CONSTANT_TYPE, *others: Expression | CONSTANT_TYPE) -> Expression - added:
method Expression.timestamp_add(unit: TimeUnit | str | Expression, amount: Expression | float) -> Expression - added:
method Expression.timestamp_diff(start: Expression | datetime.datetime, unit: TimeUnit | str | Expression) -> Expression - added:
method Expression.timestamp_extract(part: TimePart | str | Expression, timezone: str | Expression | None=…) -> Expression - added:
method Expression.timestamp_subtract(unit: TimeUnit | str | Expression, amount: Expression | float) -> Expression - added:
method Expression.timestamp_to_unix_micros() -> Expression - added:
method Expression.timestamp_to_unix_millis() -> Expression - added:
method Expression.timestamp_to_unix_seconds() -> Expression - added:
method Expression.timestamp_trunc(granularity: TimeGranularity | Expression | str, timezone: Expression | str | None=…) -> Expression - added:
method Expression.to_lower() -> Expression - added:
method Expression.to_upper() -> Expression - added:
method Expression.trim() -> Expression - added:
method Expression.trunc(places: Expression | int | None=…) -> Expression - added:
method Expression.type() -> Expression - added:
method Expression.unix_micros_to_timestamp() -> Expression - added:
method Expression.unix_millis_to_timestamp() -> Expression - added:
method Expression.unix_seconds_to_timestamp() -> Expression - added:
method Expression.vector_length() -> Expression - added:
static method Constant.of(value: CONSTANT_TYPE) -> Constant[CONSTANT_TYPE] - added:
static method Field.of(path: str) - added:
variable CONSTANT_TYPE - added:
variable T
- added:
class AsyncPipelineStream(_PipelineResultContainer[T], AsyncIterable[T]) - added:
class PipelineResult - added:
class PipelineSnapshot(_PipelineResultContainer[T], List[T]) - added:
class PipelineStream(_PipelineResultContainer[T], Iterable[T]) - added:
constructor PipelineResult(client: BaseClient, fields_pb: MutableMapping[str, ValueProto], ref: BaseDocumentReference | None=…, execution_time: Timestamp | None=…, create_time: Timestamp | None=…, update_time: Timestamp | None=…) - added:
constructor PipelineSnapshot(results_list: List[T], source: _PipelineResultContainer[T]) - added:
method PipelineResult.data() -> dict | Vector | BSONType | bytes | None - added:
method PipelineResult.get(field_path: str | FieldPath) -> Any - added:
property PipelineResult.create_time -> Timestamp | None - added:
property PipelineResult.execution_time -> Timestamp - added:
property PipelineResult.id -> str | None - added:
property PipelineResult.ref -> BaseDocumentReference | None - added:
property PipelineResult.update_time -> Timestamp | None - added:
variable T
- added:
class PipelineSource(Generic[PipelineType]) - added:
constructor PipelineSource(client: Client | AsyncClient) - added:
method PipelineSource.collection(path: str | tuple[str]) -> PipelineType - added:
method PipelineSource.collection_group(collection_id: str) -> PipelineType - added:
method PipelineSource.create_from(query: BaseQuery | BaseAggregationQuery | BaseCollectionReference) -> PipelineType - added:
method PipelineSource.database() -> PipelineType - added:
method PipelineSource.documents(*docs: BaseDocumentReference) -> PipelineType - added:
method PipelineSource.literals(*documents: dict[str, Expression | CONSTANT_TYPE]) -> PipelineType - added:
static method PipelineSource.subcollection(path: str) -> SubPipeline - added:
variable PipelineType
- added:
class AddFields(Stage) - added:
class Aggregate(Stage) - added:
class Collection(Stage) - added:
class CollectionGroup(Stage) - added:
class Database(Stage) - added:
class Define(Stage) - added:
class Delete(Stage) - added:
class Distinct(Stage) - added:
class Documents(Stage) - added:
class FindNearest(Stage) - added:
class Limit(Stage) - added:
class Literals(Stage) - added:
class Offset(Stage) - added:
class RawStage(Stage) - added:
class RemoveFields(Stage) - added:
class ReplaceWith(Stage) - added:
class Sample(Stage) - added:
class Search(Stage) - added:
class Select(Stage) - added:
class Sort(Stage) - added:
class Stage(ABC) - added:
class Subcollection(Stage) - added:
class Union(Stage) - added:
class Unnest(Stage) - added:
class Update(Stage) - added:
class Where(Stage) - added:
constructor AddFields(*fields: Selectable) - added:
constructor Aggregate(*args: AliasedExpression[AggregateFunction], accumulators: Sequence[AliasedExpression[AggregateFunction]]=…, groups: Sequence[str | Selectable]=…) - added:
constructor Collection(path: str) - added:
constructor CollectionGroup(collection_id: str) - added:
constructor Database() - added:
constructor Define(*expressions: AliasedExpression) - added:
constructor Delete() - added:
constructor Distinct(*fields: str | Selectable) - added:
constructor Documents(*paths: str) - added:
constructor FindNearest(field: str | Expression, vector: Sequence[float] | Vector, distance_measure: DistanceMeasure | str, options: Optional[FindNearestOptions]=…) - added:
constructor Limit(limit: int) - added:
constructor Literals(*documents: dict[str, Expression | CONSTANT_TYPE]) - added:
constructor Offset(offset: int) - added:
constructor RawStage(name: str, *params: Expression | Value, options: dict[str, Expression | Value]=…) - added:
constructor RemoveFields(*fields: str | Field) - added:
constructor ReplaceWith(field: Selectable) - added:
constructor Sample(limit_or_options: int | SampleOptions) - added:
constructor Search(query_or_options: str | BooleanExpression | SearchOptions) - added:
constructor Select(*selections: str | Selectable) - added:
constructor Sort(*orders: Ordering) - added:
constructor Stage(custom_name: Optional[str]=…) - added:
constructor Subcollection(path: str) - added:
constructor Union(other: _BasePipeline) - added:
constructor Unnest(field: Selectable | str, alias: Field | str | None=…, options: UnnestOptions | None=…) - added:
constructor Update(*transformed_fields: Selectable) - added:
constructor Where(condition: BooleanExpression) - added:
static method Documents.of(*documents: BaseDocumentReference) -> Documents
- added:
class FindNearestOptions - added:
class Ordering - added:
class Ordering.Direction(Enum) - added:
class PipelineDataType(str, Enum) - added:
class SampleOptions - added:
class SampleOptions.Mode(Enum) - added:
class SearchOptions - added:
class TimeGranularity(str, Enum) - added:
class TimePart(str, Enum) - added:
class TimeUnit(str, Enum) - added:
class UnnestOptions - added:
constructor FindNearestOptions(limit: Optional[int]=…, distance_field: Optional[pipeline_expressions.Field]=…) - added:
constructor Ordering(expr, order_dir: Direction | str=…) - added:
constructor SampleOptions(value: int | float, mode: Mode | str) - added:
constructor SearchOptions(query: str | pipeline_expressions.BooleanExpression, *, limit: Optional[int]=…, retrieval_depth: Optional[int]=…, sort: Optional[Sequence[Ordering] | Ordering]=…, add_fields: Optional[Sequence[pipeline_expressions.Selectable]]=…, offset: Optional[int]=…, language_code: Optional[str]=…) - added:
constructor UnnestOptions(index_field: pipeline_expressions.Field | str) - added:
field Ordering.Direction.ASCENDING - added:
field Ordering.Direction.DESCENDING - added:
field PipelineDataType.ARRAY - added:
field PipelineDataType.BOOLEAN - added:
field PipelineDataType.BYTES - added:
field PipelineDataType.DECIMAL128 - added:
field PipelineDataType.FLOAT64 - added:
field PipelineDataType.GEO_POINT - added:
field PipelineDataType.INT32 - added:
field PipelineDataType.INT64 - added:
field PipelineDataType.MAP - added:
field PipelineDataType.MAX_KEY - added:
field PipelineDataType.MIN_KEY - added:
field PipelineDataType.NULL - added:
field PipelineDataType.NUMBER - added:
field PipelineDataType.OBJECT_ID - added:
field PipelineDataType.REFERENCE - added:
field PipelineDataType.REGEX - added:
field PipelineDataType.REQUEST_TIMESTAMP - added:
field PipelineDataType.STRING - added:
field PipelineDataType.TIMESTAMP - added:
field PipelineDataType.VECTOR - added:
field SampleOptions.Mode.DOCUMENTS - added:
field SampleOptions.Mode.PERCENT - added:
field TimeGranularity.DAY - added:
field TimeGranularity.HOUR - added:
field TimeGranularity.ISOWEEK - added:
field TimeGranularity.ISOYEAR - added:
field TimeGranularity.MICROSECOND - added:
field TimeGranularity.MILLISECOND - added:
field TimeGranularity.MINUTE - added:
field TimeGranularity.MONTH - added:
field TimeGranularity.QUARTER - added:
field TimeGranularity.SECOND - added:
field TimeGranularity.WEEK - added:
field TimeGranularity.WEEK_FRIDAY - added:
field TimeGranularity.WEEK_MONDAY - added:
field TimeGranularity.WEEK_SATURDAY - added:
field TimeGranularity.WEEK_SUNDAY - added:
field TimeGranularity.WEEK_THURSDAY - added:
field TimeGranularity.WEEK_TUESDAY - added:
field TimeGranularity.WEEK_WEDNESDAY - added:
field TimeGranularity.YEAR - added:
field TimePart.DAY - added:
field TimePart.DAY_OF_WEEK - added:
field TimePart.DAY_OF_YEAR - added:
field TimePart.HOUR - added:
field TimePart.ISOWEEK - added:
field TimePart.ISOYEAR - added:
field TimePart.MICROSECOND - added:
field TimePart.MILLISECOND - added:
field TimePart.MINUTE - added:
field TimePart.MONTH - added:
field TimePart.QUARTER - added:
field TimePart.SECOND - added:
field TimePart.WEEK - added:
field TimePart.WEEK_FRIDAY - added:
field TimePart.WEEK_MONDAY - added:
field TimePart.WEEK_SATURDAY - added:
field TimePart.WEEK_SUNDAY - added:
field TimePart.WEEK_THURSDAY - added:
field TimePart.WEEK_TUESDAY - added:
field TimePart.WEEK_WEDNESDAY - added:
field TimePart.YEAR - added:
field TimeUnit.DAY - added:
field TimeUnit.HOUR - added:
field TimeUnit.MICROSECOND - added:
field TimeUnit.MILLISECOND - added:
field TimeUnit.MINUTE - added:
field TimeUnit.SECOND - added:
static method SampleOptions.doc_limit(value: int) - added:
static method SampleOptions.percentage(value: float)
- removed:
variable DESCRIPTOR - removed:
variable DocumentMask - removed:
variable Precondition - removed:
variable TransactionOptions
- removed:
variable ArrayValue - removed:
variable DESCRIPTOR - removed:
variable Document - removed:
variable MapValue - removed:
variable Value
- removed:
variable BatchGetDocumentsRequest - removed:
variable BatchGetDocumentsResponse - removed:
variable BatchWriteRequest - removed:
variable BatchWriteResponse - removed:
variable BeginTransactionRequest - removed:
variable BeginTransactionResponse - removed:
variable CommitRequest - removed:
variable CommitResponse - removed:
variable CreateDocumentRequest - removed:
variable DESCRIPTOR - removed:
variable DeleteDocumentRequest - removed:
variable GetDocumentRequest - removed:
variable ListCollectionIdsRequest - removed:
variable ListCollectionIdsResponse - removed:
variable ListDocumentsRequest - removed:
variable ListDocumentsResponse - removed:
variable ListenRequest - removed:
variable ListenResponse - removed:
variable PartitionQueryRequest - removed:
variable PartitionQueryResponse - removed:
variable RollbackRequest - removed:
variable RunQueryRequest - removed:
variable RunQueryResponse - removed:
variable Target - removed:
variable TargetChange - removed:
variable UpdateDocumentRequest - removed:
variable WriteRequest - removed:
variable WriteResponse
- removed:
class Firestore(object) - removed:
class FirestoreServicer(object) - removed:
class FirestoreStub(object) - removed:
constructor FirestoreStub(channel) - removed:
function add_FirestoreServicer_to_server(servicer, server) - removed:
method FirestoreServicer.BatchGetDocuments(request, context) - removed:
method FirestoreServicer.BatchWrite(request, context) - removed:
method FirestoreServicer.BeginTransaction(request, context) - removed:
method FirestoreServicer.Commit(request, context) - removed:
method FirestoreServicer.CreateDocument(request, context) - removed:
method FirestoreServicer.DeleteDocument(request, context) - removed:
method FirestoreServicer.GetDocument(request, context) - removed:
method FirestoreServicer.ListCollectionIds(request, context) - removed:
method FirestoreServicer.ListDocuments(request, context) - removed:
method FirestoreServicer.Listen(request_iterator, context) - removed:
method FirestoreServicer.PartitionQuery(request, context) - removed:
method FirestoreServicer.Rollback(request, context) - removed:
method FirestoreServicer.RunQuery(request, context) - removed:
method FirestoreServicer.UpdateDocument(request, context) - removed:
method FirestoreServicer.Write(request_iterator, context) - removed:
static method Firestore.BatchGetDocuments(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.BatchWrite(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.BeginTransaction(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Commit(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.CreateDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.DeleteDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.GetDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.ListCollectionIds(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.ListDocuments(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Listen(request_iterator, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.PartitionQuery(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Rollback(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.RunQuery(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.UpdateDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Write(request_iterator, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…)
- removed:
variable Cursor - removed:
variable DESCRIPTOR - removed:
variable StructuredQuery
- removed:
variable Clause - removed:
variable CreateTest - removed:
variable Cursor - removed:
variable DESCRIPTOR - removed:
variable DeleteTest - removed:
variable DocChange - removed:
variable DocSnapshot - removed:
variable FieldPath - removed:
variable GetTest - removed:
variable ListenTest - removed:
variable OrderBy - removed:
variable QueryTest - removed:
variable Select - removed:
variable SetOption - removed:
variable SetTest - removed:
variable Snapshot - removed:
variable Test - removed:
variable TestSuite - removed:
variable UpdatePathsTest - removed:
variable UpdateTest - removed:
variable Where
- removed:
variable Clause - removed:
variable CreateTest - removed:
variable Cursor - removed:
variable DESCRIPTOR - removed:
variable DeleteTest - removed:
variable DocChange - removed:
variable DocSnapshot - removed:
variable FieldPath - removed:
variable GetTest - removed:
variable ListenTest - removed:
variable OrderBy - removed:
variable QueryTest - removed:
variable Select - removed:
variable SetOption - removed:
variable SetTest - removed:
variable Snapshot - removed:
variable Test - removed:
variable TestFile - removed:
variable UpdatePathsTest - removed:
variable UpdateTest - removed:
variable Where
- removed:
variable DESCRIPTOR - removed:
variable DocumentChange - removed:
variable DocumentDelete - removed:
variable DocumentRemove - removed:
variable DocumentTransform - removed:
variable ExistenceFilter - removed:
variable Write - removed:
variable WriteResult
- removed:
field Query.ASCENDING - removed:
field Query.DESCENDING - removed:
method Query.end_at(document_fields_or_snapshot) - removed:
method Query.end_before(document_fields_or_snapshot) - removed:
method Query.limit(count) - removed:
method Query.limit_to_last(count) - removed:
method Query.offset(num_to_skip) - removed:
method Query.order_by(field_path, direction=…) - removed:
method Query.select(field_paths) - removed:
method Query.start_after(document_fields_or_snapshot) - removed:
method Query.start_at(document_fields_or_snapshot) - removed:
method Query.where(field_path, op_string, value) - changed:
class Query(object) → class Query(BaseQuery) - changed:
constructor Query(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…) → constructor Query(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…, recursive=…) -> None - changed:
method Query.get(transaction=…) → method Query.get(transaction=…, retry: retries.Retry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> QueryResultsList[DocumentSnapshot[DocumentReference]] - changed:
method Query.on_snapshot(callback) → method Query.on_snapshot(callback: Callable) -> Watch - changed:
method Query.stream(transaction=…) → method Query.stream(transaction: transaction.Transaction | None=…, retry: retries.Retry | object | None=…, timeout: float | None=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[DocumentSnapshot[DocumentReference]] - added:
class CollectionGroup(Query, BaseCollectionGroup) - added:
constructor CollectionGroup(parent, projection=…, field_filters=…, orders=…, limit=…, limit_to_last=…, offset=…, start_at=…, end_at=…, all_descendants=…, recursive=…) -> None - added:
method CollectionGroup.get_partitions(partition_count, retry: retries.Retry | object | None=…, timeout: float | None=…, *, read_time: Optional[datetime.datetime]=…) -> Generator[QueryPartition, None, None] - added:
method Query.avg(field_ref: str | FieldPath, alias: str | None=…) -> Type[firestore_v1.aggregation.AggregationQuery] - added:
method Query.count(alias: str | None=…) -> Type[firestore_v1.aggregation.AggregationQuery] - added:
method Query.find_nearest(vector_field: str, query_vector: Union[Vector, Sequence[float]], limit: int, distance_measure: DistanceMeasure, *, distance_result_field: Optional[str]=…, distance_threshold: Optional[float]=…) -> Type[firestore_v1.vector_query.VectorQuery] - added:
method Query.sum(field_ref: str | FieldPath, alias: str | None=…) -> Type[firestore_v1.aggregation.AggregationQuery]
- added:
class ExecutionStats - added:
class ExplainMetrics - added:
class ExplainOptions - added:
class ExplainStats - added:
class PipelineExplainOptions - added:
class PlanSummary - added:
class QueryExplainError(Exception) - added:
constructor ExplainStats(stats_pb: ExplainStats_pb) - added:
field ExecutionStats.debug_stats: dict[str, Any] - added:
field ExecutionStats.execution_duration: datetime.timedelta - added:
field ExecutionStats.read_operations: int - added:
field ExecutionStats.results_returned: int - added:
field ExplainMetrics.plan_summary: PlanSummary - added:
field ExplainOptions.analyze: bool - added:
field PipelineExplainOptions.mode: str - added:
field PlanSummary.indexes_used: list[dict[str, Any]] - added:
method ExplainStats.get_raw() -> ExplainStats_pb - added:
method ExplainStats.get_text() -> str - added:
property ExplainMetrics.execution_stats -> ExecutionStats
- added:
class QueryResultsList(List[T]) - added:
constructor QueryResultsList(docs: List, explain_options: Optional[ExplainOptions]=…, explain_metrics: Optional[ExplainMetrics]=…) - added:
method QueryResultsList.get_explain_metrics() -> ExplainMetrics - added:
property QueryResultsList.explain_options -> Optional[ExplainOptions] - added:
variable T
- added:
class RateLimiter - added:
constructor RateLimiter(initial_tokens: int=…, global_max_tokens: Optional[int]=…, phase_length: int=…) - added:
function utcnow() - added:
method RateLimiter.take_tokens(num: int=…, allow_less: bool=…) -> int - added:
variable default_initial_tokens: int - added:
variable default_phase_length: int - added:
variable microseconds_per_second: int
- added:
export FirestoreAsyncClient - added:
export FirestoreClient
- added:
async method FirestoreAsyncClient.batch_write(request: Optional[Union[firestore.BatchWriteRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore.BatchWriteResponse - added:
async method FirestoreAsyncClient.begin_transaction(request: Optional[Union[firestore.BeginTransactionRequest, dict]]=…, *, database: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore.BeginTransactionResponse - added:
async method FirestoreAsyncClient.cancel_operation(request: Optional[Union[operations_pb2.CancelOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAsyncClient.commit(request: Optional[Union[firestore.CommitRequest, dict]]=…, *, database: Optional[str]=…, writes: Optional[MutableSequence[gf_write.Write]]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore.CommitResponse - added:
async method FirestoreAsyncClient.create_document(request: Optional[Union[firestore.CreateDocumentRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> document.Document - added:
async method FirestoreAsyncClient.delete_document(request: Optional[Union[firestore.DeleteDocumentRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAsyncClient.delete_operation(request: Optional[Union[operations_pb2.DeleteOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAsyncClient.get_document(request: Optional[Union[firestore.GetDocumentRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> document.Document - added:
async method FirestoreAsyncClient.get_operation(request: Optional[Union[operations_pb2.GetOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.Operation - added:
async method FirestoreAsyncClient.list_collection_ids(request: Optional[Union[firestore.ListCollectionIdsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListCollectionIdsAsyncPager - added:
async method FirestoreAsyncClient.list_documents(request: Optional[Union[firestore.ListDocumentsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListDocumentsAsyncPager - added:
async method FirestoreAsyncClient.list_operations(request: Optional[Union[operations_pb2.ListOperationsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.ListOperationsResponse - added:
async method FirestoreAsyncClient.partition_query(request: Optional[Union[firestore.PartitionQueryRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.PartitionQueryAsyncPager - added:
async method FirestoreAsyncClient.rollback(request: Optional[Union[firestore.RollbackRequest, dict]]=…, *, database: Optional[str]=…, transaction: Optional[bytes]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
async method FirestoreAsyncClient.update_document(request: Optional[Union[firestore.UpdateDocumentRequest, dict]]=…, *, document: Optional[gf_document.Document]=…, update_mask: Optional[common.DocumentMask]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gf_document.Document - added:
class FirestoreAsyncClient - added:
constructor FirestoreAsyncClient(*, credentials: Optional[ga_credentials.Credentials]=…, transport: Optional[Union[str, FirestoreTransport, Callable[..., FirestoreTransport]]]=…, client_options: Optional[ClientOptions]=…, client_info: gapic_v1.client_info.ClientInfo=…) -> None - added:
field FirestoreAsyncClient.DEFAULT_ENDPOINT - added:
field FirestoreAsyncClient.DEFAULT_MTLS_ENDPOINT - added:
field FirestoreAsyncClient.common_billing_account_path - added:
field FirestoreAsyncClient.common_folder_path - added:
field FirestoreAsyncClient.common_location_path - added:
field FirestoreAsyncClient.common_organization_path - added:
field FirestoreAsyncClient.common_project_path - added:
field FirestoreAsyncClient.from_service_account_json - added:
field FirestoreAsyncClient.get_transport_class - added:
field FirestoreAsyncClient.parse_common_billing_account_path - added:
field FirestoreAsyncClient.parse_common_folder_path - added:
field FirestoreAsyncClient.parse_common_location_path - added:
field FirestoreAsyncClient.parse_common_organization_path - added:
field FirestoreAsyncClient.parse_common_project_path - added:
method FirestoreAsyncClient.batch_get_documents(request: Optional[Union[firestore.BatchGetDocumentsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Awaitable[AsyncIterable[firestore.BatchGetDocumentsResponse]] - added:
method FirestoreAsyncClient.execute_pipeline(request: Optional[Union[firestore.ExecutePipelineRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Awaitable[AsyncIterable[firestore.ExecutePipelineResponse]] - added:
method FirestoreAsyncClient.listen(requests: Optional[AsyncIterator[firestore.ListenRequest]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Awaitable[AsyncIterable[firestore.ListenResponse]] - added:
method FirestoreAsyncClient.run_aggregation_query(request: Optional[Union[firestore.RunAggregationQueryRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Awaitable[AsyncIterable[firestore.RunAggregationQueryResponse]] - added:
method FirestoreAsyncClient.run_query(request: Optional[Union[firestore.RunQueryRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Awaitable[AsyncIterable[firestore.RunQueryResponse]] - added:
method FirestoreAsyncClient.write(requests: Optional[AsyncIterator[firestore.WriteRequest]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Awaitable[AsyncIterable[firestore.WriteResponse]] - added:
property FirestoreAsyncClient.api_endpoint -> str - added:
property FirestoreAsyncClient.transport -> FirestoreTransport - added:
property FirestoreAsyncClient.universe_domain -> str - added:
static method FirestoreAsyncClient.from_service_account_file(filename: str, *args, **kwargs) - added:
static method FirestoreAsyncClient.from_service_account_info(info: dict, *args, **kwargs) - added:
static method FirestoreAsyncClient.get_mtls_endpoint_and_cert_source(client_options: Optional[ClientOptions]=…)
- added:
class FirestoreClient - added:
constructor FirestoreClient(*, credentials: Optional[ga_credentials.Credentials]=…, transport: Optional[Union[str, FirestoreTransport, Callable[..., FirestoreTransport]]]=…, client_options: Optional[Union[client_options_lib.ClientOptions, dict]]=…, client_info: gapic_v1.client_info.ClientInfo=…) -> None - added:
field FirestoreClient.DEFAULT_ENDPOINT - added:
field FirestoreClient.DEFAULT_MTLS_ENDPOINT - added:
field FirestoreClient.from_service_account_json - added:
method FirestoreClient.batch_get_documents(request: Optional[Union[firestore.BatchGetDocumentsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Iterable[firestore.BatchGetDocumentsResponse] - added:
method FirestoreClient.batch_write(request: Optional[Union[firestore.BatchWriteRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore.BatchWriteResponse - added:
method FirestoreClient.begin_transaction(request: Optional[Union[firestore.BeginTransactionRequest, dict]]=…, *, database: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore.BeginTransactionResponse - added:
method FirestoreClient.cancel_operation(request: Optional[Union[operations_pb2.CancelOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreClient.commit(request: Optional[Union[firestore.CommitRequest, dict]]=…, *, database: Optional[str]=…, writes: Optional[MutableSequence[gf_write.Write]]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> firestore.CommitResponse - added:
method FirestoreClient.create_document(request: Optional[Union[firestore.CreateDocumentRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> document.Document - added:
method FirestoreClient.delete_document(request: Optional[Union[firestore.DeleteDocumentRequest, dict]]=…, *, name: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreClient.delete_operation(request: Optional[Union[operations_pb2.DeleteOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreClient.execute_pipeline(request: Optional[Union[firestore.ExecutePipelineRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Iterable[firestore.ExecutePipelineResponse] - added:
method FirestoreClient.get_document(request: Optional[Union[firestore.GetDocumentRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> document.Document - added:
method FirestoreClient.get_operation(request: Optional[Union[operations_pb2.GetOperationRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.Operation - added:
method FirestoreClient.list_collection_ids(request: Optional[Union[firestore.ListCollectionIdsRequest, dict]]=…, *, parent: Optional[str]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListCollectionIdsPager - added:
method FirestoreClient.list_documents(request: Optional[Union[firestore.ListDocumentsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.ListDocumentsPager - added:
method FirestoreClient.list_operations(request: Optional[Union[operations_pb2.ListOperationsRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> operations_pb2.ListOperationsResponse - added:
method FirestoreClient.listen(requests: Optional[Iterator[firestore.ListenRequest]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Iterable[firestore.ListenResponse] - added:
method FirestoreClient.partition_query(request: Optional[Union[firestore.PartitionQueryRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> pagers.PartitionQueryPager - added:
method FirestoreClient.rollback(request: Optional[Union[firestore.RollbackRequest, dict]]=…, *, database: Optional[str]=…, transaction: Optional[bytes]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> None - added:
method FirestoreClient.run_aggregation_query(request: Optional[Union[firestore.RunAggregationQueryRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Iterable[firestore.RunAggregationQueryResponse] - added:
method FirestoreClient.run_query(request: Optional[Union[firestore.RunQueryRequest, dict]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Iterable[firestore.RunQueryResponse] - added:
method FirestoreClient.update_document(request: Optional[Union[firestore.UpdateDocumentRequest, dict]]=…, *, document: Optional[gf_document.Document]=…, update_mask: Optional[common.DocumentMask]=…, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> gf_document.Document - added:
method FirestoreClient.write(requests: Optional[Iterator[firestore.WriteRequest]]=…, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) -> Iterable[firestore.WriteResponse] - added:
property FirestoreClient.api_endpoint -> str - added:
property FirestoreClient.transport -> FirestoreTransport - added:
property FirestoreClient.universe_domain -> str - added:
static method FirestoreClient.common_billing_account_path(billing_account: str) -> str - added:
static method FirestoreClient.common_folder_path(folder: str) -> str - added:
static method FirestoreClient.common_location_path(project: str, location: str) -> str - added:
static method FirestoreClient.common_organization_path(organization: str) -> str - added:
static method FirestoreClient.common_project_path(project: str) -> str - added:
static method FirestoreClient.from_service_account_file(filename: str, *args, **kwargs) - added:
static method FirestoreClient.from_service_account_info(info: dict, *args, **kwargs) - added:
static method FirestoreClient.get_mtls_endpoint_and_cert_source(client_options: Optional[client_options_lib.ClientOptions]=…) - added:
static method FirestoreClient.parse_common_billing_account_path(path: str) -> Dict[str, str] - added:
static method FirestoreClient.parse_common_folder_path(path: str) -> Dict[str, str] - added:
static method FirestoreClient.parse_common_location_path(path: str) -> Dict[str, str] - added:
static method FirestoreClient.parse_common_organization_path(path: str) -> Dict[str, str] - added:
static method FirestoreClient.parse_common_project_path(path: str) -> Dict[str, str]
- added:
class ListCollectionIdsAsyncPager - added:
class ListCollectionIdsPager - added:
class ListDocumentsAsyncPager - added:
class ListDocumentsPager - added:
class PartitionQueryAsyncPager - added:
class PartitionQueryPager - added:
constructor ListCollectionIdsAsyncPager(method: Callable[..., Awaitable[firestore.ListCollectionIdsResponse]], request: firestore.ListCollectionIdsRequest, response: firestore.ListCollectionIdsResponse, *, retry: OptionalAsyncRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor ListCollectionIdsPager(method: Callable[..., firestore.ListCollectionIdsResponse], request: firestore.ListCollectionIdsRequest, response: firestore.ListCollectionIdsResponse, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor ListDocumentsAsyncPager(method: Callable[..., Awaitable[firestore.ListDocumentsResponse]], request: firestore.ListDocumentsRequest, response: firestore.ListDocumentsResponse, *, retry: OptionalAsyncRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor ListDocumentsPager(method: Callable[..., firestore.ListDocumentsResponse], request: firestore.ListDocumentsRequest, response: firestore.ListDocumentsResponse, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor PartitionQueryAsyncPager(method: Callable[..., Awaitable[firestore.PartitionQueryResponse]], request: firestore.PartitionQueryRequest, response: firestore.PartitionQueryResponse, *, retry: OptionalAsyncRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
constructor PartitionQueryPager(method: Callable[..., firestore.PartitionQueryResponse], request: firestore.PartitionQueryRequest, response: firestore.PartitionQueryResponse, *, retry: OptionalRetry=…, timeout: Union[float, object]=…, metadata: Sequence[Tuple[str, Union[str, bytes]]]=…) - added:
property ListCollectionIdsAsyncPager.pages -> AsyncIterator[firestore.ListCollectionIdsResponse] - added:
property ListCollectionIdsPager.pages -> Iterator[firestore.ListCollectionIdsResponse] - added:
property ListDocumentsAsyncPager.pages -> AsyncIterator[firestore.ListDocumentsResponse] - added:
property ListDocumentsPager.pages -> Iterator[firestore.ListDocumentsResponse] - added:
property PartitionQueryAsyncPager.pages -> AsyncIterator[firestore.PartitionQueryResponse] - added:
property PartitionQueryPager.pages -> Iterator[firestore.PartitionQueryResponse] - added:
variable OptionalAsyncRetry - added:
variable OptionalRetry
- added:
export FirestoreGrpcAsyncIOTransport - added:
export FirestoreGrpcTransport - added:
export FirestoreRestInterceptor - added:
export FirestoreRestTransport - added:
export FirestoreTransport
- added:
class FirestoreTransport(abc.ABC) - added:
constructor FirestoreTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, quota_project_id: Optional[str]=…, client_info: gapic_v1.client_info.ClientInfo=…, always_use_jwt_access: Optional[bool]=…, api_audience: Optional[str]=…, **kwargs) -> None - added:
field FirestoreTransport.AUTH_SCOPES - added:
field FirestoreTransport.DEFAULT_HOST: str - added:
method FirestoreTransport.close() - added:
property FirestoreTransport.batch_get_documents -> Callable[[firestore.BatchGetDocumentsRequest], Union[firestore.BatchGetDocumentsResponse, Awaitable[firestore.BatchGetDocumentsResponse]]] - added:
property FirestoreTransport.batch_write -> Callable[[firestore.BatchWriteRequest], Union[firestore.BatchWriteResponse, Awaitable[firestore.BatchWriteResponse]]] - added:
property FirestoreTransport.begin_transaction -> Callable[[firestore.BeginTransactionRequest], Union[firestore.BeginTransactionResponse, Awaitable[firestore.BeginTransactionResponse]]] - added:
property FirestoreTransport.cancel_operation -> Callable[[operations_pb2.CancelOperationRequest], None] - added:
property FirestoreTransport.commit -> Callable[[firestore.CommitRequest], Union[firestore.CommitResponse, Awaitable[firestore.CommitResponse]]] - added:
property FirestoreTransport.create_document -> Callable[[firestore.CreateDocumentRequest], Union[document.Document, Awaitable[document.Document]]] - added:
property FirestoreTransport.delete_document -> Callable[[firestore.DeleteDocumentRequest], Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]]] - added:
property FirestoreTransport.delete_operation -> Callable[[operations_pb2.DeleteOperationRequest], None] - added:
property FirestoreTransport.execute_pipeline -> Callable[[firestore.ExecutePipelineRequest], Union[firestore.ExecutePipelineResponse, Awaitable[firestore.ExecutePipelineResponse]]] - added:
property FirestoreTransport.get_document -> Callable[[firestore.GetDocumentRequest], Union[document.Document, Awaitable[document.Document]]] - added:
property FirestoreTransport.get_operation -> Callable[[operations_pb2.GetOperationRequest], Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]]] - added:
property FirestoreTransport.host - added:
property FirestoreTransport.kind -> str - added:
property FirestoreTransport.list_collection_ids -> Callable[[firestore.ListCollectionIdsRequest], Union[firestore.ListCollectionIdsResponse, Awaitable[firestore.ListCollectionIdsResponse]]] - added:
property FirestoreTransport.list_documents -> Callable[[firestore.ListDocumentsRequest], Union[firestore.ListDocumentsResponse, Awaitable[firestore.ListDocumentsResponse]]] - added:
property FirestoreTransport.list_operations -> Callable[[operations_pb2.ListOperationsRequest], Union[operations_pb2.ListOperationsResponse, Awaitable[operations_pb2.ListOperationsResponse]]] - added:
property FirestoreTransport.listen -> Callable[[firestore.ListenRequest], Union[firestore.ListenResponse, Awaitable[firestore.ListenResponse]]] - added:
property FirestoreTransport.partition_query -> Callable[[firestore.PartitionQueryRequest], Union[firestore.PartitionQueryResponse, Awaitable[firestore.PartitionQueryResponse]]] - added:
property FirestoreTransport.rollback -> Callable[[firestore.RollbackRequest], Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]]] - added:
property FirestoreTransport.run_aggregation_query -> Callable[[firestore.RunAggregationQueryRequest], Union[firestore.RunAggregationQueryResponse, Awaitable[firestore.RunAggregationQueryResponse]]] - added:
property FirestoreTransport.run_query -> Callable[[firestore.RunQueryRequest], Union[firestore.RunQueryResponse, Awaitable[firestore.RunQueryResponse]]] - added:
property FirestoreTransport.update_document -> Callable[[firestore.UpdateDocumentRequest], Union[gf_document.Document, Awaitable[gf_document.Document]]] - added:
property FirestoreTransport.write -> Callable[[firestore.WriteRequest], Union[firestore.WriteResponse, Awaitable[firestore.WriteResponse]]]
- added:
class FirestoreGrpcTransport(FirestoreTransport) - added:
constructor FirestoreGrpcTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]=…, api_mtls_endpoint: Optional[str]=…, client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]]=…, ssl_channel_credentials: Optional[grpc.ChannelCrede… - added:
method FirestoreGrpcTransport.close() - added:
property FirestoreGrpcTransport.batch_get_documents -> Callable[[firestore.BatchGetDocumentsRequest], firestore.BatchGetDocumentsResponse] - added:
property FirestoreGrpcTransport.batch_write -> Callable[[firestore.BatchWriteRequest], firestore.BatchWriteResponse] - added:
property FirestoreGrpcTransport.begin_transaction -> Callable[[firestore.BeginTransactionRequest], firestore.BeginTransactionResponse] - added:
property FirestoreGrpcTransport.cancel_operation -> Callable[[operations_pb2.CancelOperationRequest], None] - added:
property FirestoreGrpcTransport.commit -> Callable[[firestore.CommitRequest], firestore.CommitResponse] - added:
property FirestoreGrpcTransport.create_document -> Callable[[firestore.CreateDocumentRequest], document.Document] - added:
property FirestoreGrpcTransport.delete_document -> Callable[[firestore.DeleteDocumentRequest], empty_pb2.Empty] - added:
property FirestoreGrpcTransport.delete_operation -> Callable[[operations_pb2.DeleteOperationRequest], None] - added:
property FirestoreGrpcTransport.execute_pipeline -> Callable[[firestore.ExecutePipelineRequest], firestore.ExecutePipelineResponse] - added:
property FirestoreGrpcTransport.get_document -> Callable[[firestore.GetDocumentRequest], document.Document] - added:
property FirestoreGrpcTransport.get_operation -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation] - added:
property FirestoreGrpcTransport.grpc_channel -> grpc.Channel - added:
property FirestoreGrpcTransport.kind -> str - added:
property FirestoreGrpcTransport.list_collection_ids -> Callable[[firestore.ListCollectionIdsRequest], firestore.ListCollectionIdsResponse] - added:
property FirestoreGrpcTransport.list_documents -> Callable[[firestore.ListDocumentsRequest], firestore.ListDocumentsResponse] - added:
property FirestoreGrpcTransport.list_operations -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse] - added:
property FirestoreGrpcTransport.listen -> Callable[[firestore.ListenRequest], firestore.ListenResponse] - added:
property FirestoreGrpcTransport.partition_query -> Callable[[firestore.PartitionQueryRequest], firestore.PartitionQueryResponse] - added:
property FirestoreGrpcTransport.rollback -> Callable[[firestore.RollbackRequest], empty_pb2.Empty] - added:
property FirestoreGrpcTransport.run_aggregation_query -> Callable[[firestore.RunAggregationQueryRequest], firestore.RunAggregationQueryResponse] - added:
property FirestoreGrpcTransport.run_query -> Callable[[firestore.RunQueryRequest], firestore.RunQueryResponse] - added:
property FirestoreGrpcTransport.update_document -> Callable[[firestore.UpdateDocumentRequest], gf_document.Document] - added:
property FirestoreGrpcTransport.write -> Callable[[firestore.WriteRequest], firestore.WriteResponse] - added:
static method FirestoreGrpcTransport.create_channel(host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, quota_project_id: Optional[str]=…, **kwargs) -> grpc.Channel
- added:
class FirestoreGrpcAsyncIOTransport(FirestoreTransport) - added:
constructor FirestoreGrpcAsyncIOTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]]=…, api_mtls_endpoint: Optional[str]=…, client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]]=…, ssl_channel_credentials: Optional[grpc.Channel… - added:
method FirestoreGrpcAsyncIOTransport.close() - added:
property FirestoreGrpcAsyncIOTransport.batch_get_documents -> Callable[[firestore.BatchGetDocumentsRequest], Awaitable[firestore.BatchGetDocumentsResponse]] - added:
property FirestoreGrpcAsyncIOTransport.batch_write -> Callable[[firestore.BatchWriteRequest], Awaitable[firestore.BatchWriteResponse]] - added:
property FirestoreGrpcAsyncIOTransport.begin_transaction -> Callable[[firestore.BeginTransactionRequest], Awaitable[firestore.BeginTransactionResponse]] - added:
property FirestoreGrpcAsyncIOTransport.cancel_operation -> Callable[[operations_pb2.CancelOperationRequest], None] - added:
property FirestoreGrpcAsyncIOTransport.commit -> Callable[[firestore.CommitRequest], Awaitable[firestore.CommitResponse]] - added:
property FirestoreGrpcAsyncIOTransport.create_document -> Callable[[firestore.CreateDocumentRequest], Awaitable[document.Document]] - added:
property FirestoreGrpcAsyncIOTransport.delete_document -> Callable[[firestore.DeleteDocumentRequest], Awaitable[empty_pb2.Empty]] - added:
property FirestoreGrpcAsyncIOTransport.delete_operation -> Callable[[operations_pb2.DeleteOperationRequest], None] - added:
property FirestoreGrpcAsyncIOTransport.execute_pipeline -> Callable[[firestore.ExecutePipelineRequest], Awaitable[firestore.ExecutePipelineResponse]] - added:
property FirestoreGrpcAsyncIOTransport.get_document -> Callable[[firestore.GetDocumentRequest], Awaitable[document.Document]] - added:
property FirestoreGrpcAsyncIOTransport.get_operation -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation] - added:
property FirestoreGrpcAsyncIOTransport.grpc_channel -> aio.Channel - added:
property FirestoreGrpcAsyncIOTransport.kind -> str - added:
property FirestoreGrpcAsyncIOTransport.list_collection_ids -> Callable[[firestore.ListCollectionIdsRequest], Awaitable[firestore.ListCollectionIdsResponse]] - added:
property FirestoreGrpcAsyncIOTransport.list_documents -> Callable[[firestore.ListDocumentsRequest], Awaitable[firestore.ListDocumentsResponse]] - added:
property FirestoreGrpcAsyncIOTransport.list_operations -> Callable[[operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse] - added:
property FirestoreGrpcAsyncIOTransport.listen -> Callable[[firestore.ListenRequest], Awaitable[firestore.ListenResponse]] - added:
property FirestoreGrpcAsyncIOTransport.partition_query -> Callable[[firestore.PartitionQueryRequest], Awaitable[firestore.PartitionQueryResponse]] - added:
property FirestoreGrpcAsyncIOTransport.rollback -> Callable[[firestore.RollbackRequest], Awaitable[empty_pb2.Empty]] - added:
property FirestoreGrpcAsyncIOTransport.run_aggregation_query -> Callable[[firestore.RunAggregationQueryRequest], Awaitable[firestore.RunAggregationQueryResponse]] - added:
property FirestoreGrpcAsyncIOTransport.run_query -> Callable[[firestore.RunQueryRequest], Awaitable[firestore.RunQueryResponse]] - added:
property FirestoreGrpcAsyncIOTransport.update_document -> Callable[[firestore.UpdateDocumentRequest], Awaitable[gf_document.Document]] - added:
property FirestoreGrpcAsyncIOTransport.write -> Callable[[firestore.WriteRequest], Awaitable[firestore.WriteResponse]] - added:
static method FirestoreGrpcAsyncIOTransport.create_channel(host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, quota_project_id: Optional[str]=…, **kwargs) -> aio.Channel
- added:
class FirestoreRestTransport(_BaseFirestoreRestTransport) - added:
constructor FirestoreRestTransport(*, host: str=…, credentials: Optional[ga_credentials.Credentials]=…, credentials_file: Optional[str]=…, scopes: Optional[Sequence[str]]=…, client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]]=…, quota_project_id: Optional[str]=…, client_info: gapic_v1.client_info.ClientInfo=…, always_use_jwt_access: Optional[bool]=…, url_scheme: str=…, interc… - added:
method FirestoreRestTransport.close() - added:
property FirestoreRestTransport.batch_get_documents -> Callable[[firestore.BatchGetDocumentsRequest], firestore.BatchGetDocumentsResponse] - added:
property FirestoreRestTransport.batch_write -> Callable[[firestore.BatchWriteRequest], firestore.BatchWriteResponse] - added:
property FirestoreRestTransport.begin_transaction -> Callable[[firestore.BeginTransactionRequest], firestore.BeginTransactionResponse] - added:
property FirestoreRestTransport.cancel_operation - added:
property FirestoreRestTransport.commit -> Callable[[firestore.CommitRequest], firestore.CommitResponse] - added:
property FirestoreRestTransport.create_document -> Callable[[firestore.CreateDocumentRequest], document.Document] - added:
property FirestoreRestTransport.delete_document -> Callable[[firestore.DeleteDocumentRequest], empty_pb2.Empty] - added:
property FirestoreRestTransport.delete_operation - added:
property FirestoreRestTransport.execute_pipeline -> Callable[[firestore.ExecutePipelineRequest], firestore.ExecutePipelineResponse] - added:
property FirestoreRestTransport.get_document -> Callable[[firestore.GetDocumentRequest], document.Document] - added:
property FirestoreRestTransport.get_operation - added:
property FirestoreRestTransport.kind -> str - added:
property FirestoreRestTransport.list_collection_ids -> Callable[[firestore.ListCollectionIdsRequest], firestore.ListCollectionIdsResponse] - added:
property FirestoreRestTransport.list_documents -> Callable[[firestore.ListDocumentsRequest], firestore.ListDocumentsResponse] - added:
property FirestoreRestTransport.list_operations - added:
property FirestoreRestTransport.listen -> Callable[[firestore.ListenRequest], firestore.ListenResponse] - added:
property FirestoreRestTransport.partition_query -> Callable[[firestore.PartitionQueryRequest], firestore.PartitionQueryResponse] - added:
property FirestoreRestTransport.rollback -> Callable[[firestore.RollbackRequest], empty_pb2.Empty] - added:
property FirestoreRestTransport.run_aggregation_query -> Callable[[firestore.RunAggregationQueryRequest], firestore.RunAggregationQueryResponse] - added:
property FirestoreRestTransport.run_query -> Callable[[firestore.RunQueryRequest], firestore.RunQueryResponse] - added:
property FirestoreRestTransport.update_document -> Callable[[firestore.UpdateDocumentRequest], gf_document.Document] - added:
property FirestoreRestTransport.write -> Callable[[firestore.WriteRequest], firestore.WriteResponse]
- added:
class _BaseFirestoreRestTransport(FirestoreTransport) - added:
constructor _BaseFirestoreRestTransport(*, host: str=…, credentials: Optional[Any]=…, client_info: gapic_v1.client_info.ClientInfo=…, always_use_jwt_access: Optional[bool]=…, url_scheme: str=…, api_audience: Optional[str]=…) -> None
- added:
class StreamGenerator(Generator[T, Any, Optional[ExplainMetrics]]) - added:
constructor StreamGenerator(response_generator: Generator[T, Any, Optional[ExplainMetrics]], explain_options: Optional[ExplainOptions]=…) - added:
method StreamGenerator.close() - added:
method StreamGenerator.get_explain_metrics() -> ExplainMetrics - added:
method StreamGenerator.send(value: Any=…) -> T - added:
method StreamGenerator.throw(*args, **kwargs) -> T - added:
property StreamGenerator.explain_options -> ExplainOptions | None - added:
variable T
- removed:
property Transaction.id - removed:
property Transaction.in_progress - removed:
variable MAX_ATTEMPTS - changed:
class Transaction(batch.WriteBatch) → class Transaction(batch.WriteBatch, BaseTransaction) - changed:
constructor Transaction(client, max_attempts=…, read_only=…) → constructor Transaction(client, max_attempts=…, read_only=…) -> None - changed:
function transactional(to_wrap) → function transactional(to_wrap: Callable) -> _Transactional - changed:
method Transaction.get(ref_or_query) → method Transaction.get(ref_or_query: DocumentReference | Query, retry: retries.Retry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…, read_time: Optional[datetime.datetime]=…) -> StreamGenerator[DocumentSnapshot[DocumentReference]] | Generator[DocumentSnapshot[DocumentReference], Any, None] - changed:
method Transaction.get_all(references) → method Transaction.get_all(references: list, retry: retries.Retry | object | None=…, timeout: float | None=…, *, read_time: datetime.datetime | None=…) -> Generator[DocumentSnapshot[DocumentReference], Any, None]
- changed:
constructor Sentinel(description) → constructor Sentinel(description) -> None
- removed:
variable names - added:
export AggregationResult - added:
export ArrayValue - added:
export BatchGetDocumentsRequest - added:
export BatchGetDocumentsResponse - added:
export BatchWriteRequest - added:
export BatchWriteResponse - added:
export BeginTransactionRequest - added:
export BeginTransactionResponse - added:
export BitSequence - added:
export BloomFilter - added:
export CommitRequest - added:
export CommitResponse - added:
export CreateDocumentRequest - added:
export Cursor - added:
export DeleteDocumentRequest - added:
export Document - added:
export DocumentChange - added:
export DocumentDelete - added:
export DocumentMask - added:
export DocumentRemove - added:
export DocumentTransform - added:
export ExecutePipelineRequest - added:
export ExecutePipelineResponse - added:
export ExecutionStats - added:
export ExistenceFilter - added:
export ExplainMetrics - added:
export ExplainOptions - added:
export ExplainStats - added:
export Function - added:
export GetDocumentRequest - added:
export ListCollectionIdsRequest - added:
export ListCollectionIdsResponse - added:
export ListDocumentsRequest - added:
export ListDocumentsResponse - added:
export ListenRequest - added:
export ListenResponse - added:
export MapValue - added:
export PartitionQueryRequest - added:
export PartitionQueryResponse - added:
export Pipeline - added:
export PlanSummary - added:
export Precondition - added:
export RequestOptions - added:
export RollbackRequest - added:
export RunAggregationQueryRequest - added:
export RunAggregationQueryResponse - added:
export RunQueryRequest - added:
export RunQueryResponse - added:
export StructuredAggregationQuery - added:
export StructuredPipeline - added:
export StructuredQuery - added:
export Target - added:
export TargetChange - added:
export TransactionOptions - added:
export UpdateDocumentRequest - added:
export Value - added:
export Write - added:
export WriteRequest - added:
export WriteResponse - added:
export WriteResult
- added:
class AggregationResult(proto.Message) - added:
field AggregationResult.aggregate_fields: MutableMapping[str, document.Value]
- added:
class BitSequence(proto.Message) - added:
class BloomFilter(proto.Message) - added:
field BitSequence.bitmap: bytes - added:
field BitSequence.padding: int - added:
field BloomFilter.bits: BitSequence - added:
field BloomFilter.hash_count: int
- added:
class DocumentMask(proto.Message) - added:
class Precondition(proto.Message) - added:
class RequestOptions(proto.Message) - added:
class TransactionOptions(proto.Message) - added:
class TransactionOptions.ConcurrencyMode(proto.Enum) - added:
class TransactionOptions.ReadOnly(proto.Message) - added:
class TransactionOptions.ReadWrite(proto.Message) - added:
field DocumentMask.field_paths: MutableSequence[str] - added:
field Precondition.exists: bool - added:
field Precondition.update_time: timestamp_pb2.Timestamp - added:
field RequestOptions.request_tags: MutableSequence[str] - added:
field TransactionOptions.ConcurrencyMode.CONCURRENCY_MODE_UNSPECIFIED - added:
field TransactionOptions.ConcurrencyMode.OPTIMISTIC - added:
field TransactionOptions.ConcurrencyMode.PESSIMISTIC - added:
field TransactionOptions.ReadOnly.read_time: timestamp_pb2.Timestamp - added:
field TransactionOptions.ReadWrite.concurrency_mode: TransactionOptions.ConcurrencyMode - added:
field TransactionOptions.ReadWrite.retry_transaction: bytes - added:
field TransactionOptions.read_only: ReadOnly - added:
field TransactionOptions.read_write: ReadWrite
- added:
class ArrayValue(proto.Message) - added:
class Document(proto.Message) - added:
class Function(proto.Message) - added:
class MapValue(proto.Message) - added:
class Pipeline(proto.Message) - added:
class Pipeline.Stage(proto.Message) - added:
class Value(proto.Message) - added:
field ArrayValue.values: MutableSequence[Value] - added:
field Document.create_time: timestamp_pb2.Timestamp - added:
field Document.fields: MutableMapping[str, Value] - added:
field Document.name: str - added:
field Document.update_time: timestamp_pb2.Timestamp - added:
field Function.args: MutableSequence[Value] - added:
field Function.name: str - added:
field Function.options: MutableMapping[str, Value] - added:
field MapValue.fields: MutableMapping[str, Value] - added:
field Pipeline.Stage.args: MutableSequence[Value] - added:
field Pipeline.Stage.name: str - added:
field Pipeline.Stage.options: MutableMapping[str, Value] - added:
field Pipeline.stages: MutableSequence[Stage] - added:
field Value.array_value: ArrayValue - added:
field Value.boolean_value: bool - added:
field Value.bytes_value: bytes - added:
field Value.double_value: float - added:
field Value.field_reference_value: str - added:
field Value.function_value: Function - added:
field Value.geo_point_value: latlng_pb2.LatLng - added:
field Value.integer_value: int - added:
field Value.map_value: MapValue - added:
field Value.null_value: struct_pb2.NullValue - added:
field Value.pipeline_value: Pipeline - added:
field Value.reference_value: str - added:
field Value.string_value: str - added:
field Value.timestamp_value: timestamp_pb2.Timestamp - added:
field Value.variable_reference_value: str
- added:
class ExplainStats(proto.Message) - added:
field ExplainStats.data: any_pb2.Any
- added:
class BatchGetDocumentsRequest(proto.Message) - added:
class BatchGetDocumentsResponse(proto.Message) - added:
class BatchWriteRequest(proto.Message) - added:
class BatchWriteResponse(proto.Message) - added:
class BeginTransactionRequest(proto.Message) - added:
class BeginTransactionResponse(proto.Message) - added:
class CommitRequest(proto.Message) - added:
class CommitResponse(proto.Message) - added:
class CreateDocumentRequest(proto.Message) - added:
class DeleteDocumentRequest(proto.Message) - added:
class ExecutePipelineRequest(proto.Message) - added:
class ExecutePipelineResponse(proto.Message) - added:
class GetDocumentRequest(proto.Message) - added:
class ListCollectionIdsRequest(proto.Message) - added:
class ListCollectionIdsResponse(proto.Message) - added:
class ListDocumentsRequest(proto.Message) - added:
class ListDocumentsResponse(proto.Message) - added:
class ListenRequest(proto.Message) - added:
class ListenResponse(proto.Message) - added:
class PartitionQueryRequest(proto.Message) - added:
class PartitionQueryResponse(proto.Message) - added:
class RollbackRequest(proto.Message) - added:
class RunAggregationQueryRequest(proto.Message) - added:
class RunAggregationQueryResponse(proto.Message) - added:
class RunQueryRequest(proto.Message) - added:
class RunQueryResponse(proto.Message) - added:
class Target(proto.Message) - added:
class Target.DocumentsTarget(proto.Message) - added:
class Target.QueryTarget(proto.Message) - added:
class TargetChange(proto.Message) - added:
class TargetChange.TargetChangeType(proto.Enum) - added:
class UpdateDocumentRequest(proto.Message) - added:
class WriteRequest(proto.Message) - added:
class WriteResponse(proto.Message) - added:
field BatchGetDocumentsRequest.database: str - added:
field BatchGetDocumentsRequest.documents: MutableSequence[str] - added:
field BatchGetDocumentsRequest.mask: common.DocumentMask - added:
field BatchGetDocumentsRequest.new_transaction: common.TransactionOptions - added:
field BatchGetDocumentsRequest.read_time: timestamp_pb2.Timestamp - added:
field BatchGetDocumentsRequest.request_options: common.RequestOptions - added:
field BatchGetDocumentsRequest.transaction: bytes - added:
field BatchGetDocumentsResponse.found: gf_document.Document - added:
field BatchGetDocumentsResponse.missing: str - added:
field BatchGetDocumentsResponse.read_time: timestamp_pb2.Timestamp - added:
field BatchGetDocumentsResponse.transaction: bytes - added:
field BatchWriteRequest.database: str - added:
field BatchWriteRequest.labels: MutableMapping[str, str] - added:
field BatchWriteRequest.request_options: common.RequestOptions - added:
field BatchWriteRequest.writes: MutableSequence[write.Write] - added:
field BatchWriteResponse.status: MutableSequence[status_pb2.Status] - added:
field BatchWriteResponse.write_results: MutableSequence[write.WriteResult] - added:
field BeginTransactionRequest.database: str - added:
field BeginTransactionRequest.options: common.TransactionOptions - added:
field BeginTransactionRequest.request_options: common.RequestOptions - added:
field BeginTransactionResponse.transaction: bytes - added:
field CommitRequest.database: str - added:
field CommitRequest.request_options: common.RequestOptions - added:
field CommitRequest.transaction: bytes - added:
field CommitRequest.writes: MutableSequence[write.Write] - added:
field CommitResponse.commit_time: timestamp_pb2.Timestamp - added:
field CommitResponse.write_results: MutableSequence[write.WriteResult] - added:
field CreateDocumentRequest.collection_id: str - added:
field CreateDocumentRequest.document: gf_document.Document - added:
field CreateDocumentRequest.document_id: str - added:
field CreateDocumentRequest.mask: common.DocumentMask - added:
field CreateDocumentRequest.parent: str - added:
field CreateDocumentRequest.request_options: common.RequestOptions - added:
field DeleteDocumentRequest.current_document: common.Precondition - added:
field DeleteDocumentRequest.name: str - added:
field DeleteDocumentRequest.request_options: common.RequestOptions - added:
field ExecutePipelineRequest.auto_commit_transaction: bool - added:
field ExecutePipelineRequest.database: str - added:
field ExecutePipelineRequest.new_transaction: common.TransactionOptions - added:
field ExecutePipelineRequest.read_time: timestamp_pb2.Timestamp - added:
field ExecutePipelineRequest.request_options: common.RequestOptions - added:
field ExecutePipelineRequest.structured_pipeline: pipeline.StructuredPipeline - added:
field ExecutePipelineRequest.transaction: bytes - added:
field ExecutePipelineResponse.execution_time: timestamp_pb2.Timestamp - added:
field ExecutePipelineResponse.explain_stats: gf_explain_stats.ExplainStats - added:
field ExecutePipelineResponse.results: MutableSequence[gf_document.Document] - added:
field ExecutePipelineResponse.transaction: bytes - added:
field GetDocumentRequest.mask: common.DocumentMask - added:
field GetDocumentRequest.name: str - added:
field GetDocumentRequest.read_time: timestamp_pb2.Timestamp - added:
field GetDocumentRequest.request_options: common.RequestOptions - added:
field GetDocumentRequest.transaction: bytes - added:
field ListCollectionIdsRequest.page_size: int - added:
field ListCollectionIdsRequest.page_token: str - added:
field ListCollectionIdsRequest.parent: str - added:
field ListCollectionIdsRequest.read_time: timestamp_pb2.Timestamp - added:
field ListCollectionIdsRequest.request_options: common.RequestOptions - added:
field ListCollectionIdsResponse.collection_ids: MutableSequence[str] - added:
field ListCollectionIdsResponse.next_page_token: str - added:
field ListDocumentsRequest.collection_id: str - added:
field ListDocumentsRequest.mask: common.DocumentMask - added:
field ListDocumentsRequest.order_by: str - added:
field ListDocumentsRequest.page_size: int - added:
field ListDocumentsRequest.page_token: str - added:
field ListDocumentsRequest.parent: str - added:
field ListDocumentsRequest.read_time: timestamp_pb2.Timestamp - added:
field ListDocumentsRequest.request_options: common.RequestOptions - added:
field ListDocumentsRequest.show_missing: bool - added:
field ListDocumentsRequest.transaction: bytes - added:
field ListDocumentsResponse.documents: MutableSequence[gf_document.Document] - added:
field ListDocumentsResponse.next_page_token: str - added:
field ListenRequest.add_target: Target - added:
field ListenRequest.database: str - added:
field ListenRequest.labels: MutableMapping[str, str] - added:
field ListenRequest.remove_target: int - added:
field ListenRequest.request_options: common.RequestOptions - added:
field ListenResponse.document_change: write.DocumentChange - added:
field ListenResponse.document_delete: write.DocumentDelete - added:
field ListenResponse.document_remove: write.DocumentRemove - added:
field ListenResponse.filter: write.ExistenceFilter - added:
field ListenResponse.target_change: TargetChange - added:
field PartitionQueryRequest.page_size: int - added:
field PartitionQueryRequest.page_token: str - added:
field PartitionQueryRequest.parent: str - added:
field PartitionQueryRequest.partition_count: int - added:
field PartitionQueryRequest.read_time: timestamp_pb2.Timestamp - added:
field PartitionQueryRequest.request_options: common.RequestOptions - added:
field PartitionQueryRequest.structured_query: gf_query.StructuredQuery - added:
field PartitionQueryResponse.next_page_token: str - added:
field PartitionQueryResponse.partitions: MutableSequence[gf_query.Cursor] - added:
field RollbackRequest.database: str - added:
field RollbackRequest.request_options: common.RequestOptions - added:
field RollbackRequest.transaction: bytes - added:
field RunAggregationQueryRequest.explain_options: query_profile.ExplainOptions - added:
field RunAggregationQueryRequest.new_transaction: common.TransactionOptions - added:
field RunAggregationQueryRequest.parent: str - added:
field RunAggregationQueryRequest.read_time: timestamp_pb2.Timestamp - added:
field RunAggregationQueryRequest.request_options: common.RequestOptions - added:
field RunAggregationQueryRequest.structured_aggregation_query: gf_query.StructuredAggregationQuery - added:
field RunAggregationQueryRequest.transaction: bytes - added:
field RunAggregationQueryResponse.explain_metrics: query_profile.ExplainMetrics - added:
field RunAggregationQueryResponse.read_time: timestamp_pb2.Timestamp - added:
field RunAggregationQueryResponse.result: aggregation_result.AggregationResult - added:
field RunAggregationQueryResponse.transaction: bytes - added:
field RunQueryRequest.explain_options: query_profile.ExplainOptions - added:
field RunQueryRequest.new_transaction: common.TransactionOptions - added:
field RunQueryRequest.parent: str - added:
field RunQueryRequest.read_time: timestamp_pb2.Timestamp - added:
field RunQueryRequest.request_options: common.RequestOptions - added:
field RunQueryRequest.structured_query: gf_query.StructuredQuery - added:
field RunQueryRequest.transaction: bytes - added:
field RunQueryResponse.document: gf_document.Document - added:
field RunQueryResponse.done: bool - added:
field RunQueryResponse.explain_metrics: query_profile.ExplainMetrics - added:
field RunQueryResponse.read_time: timestamp_pb2.Timestamp - added:
field RunQueryResponse.skipped_results: int - added:
field RunQueryResponse.transaction: bytes - added:
field Target.DocumentsTarget.documents: MutableSequence[str] - added:
field Target.QueryTarget.parent: str - added:
field Target.QueryTarget.structured_query: gf_query.StructuredQuery - added:
field Target.documents: DocumentsTarget - added:
field Target.expected_count: wrappers_pb2.Int32Value - added:
field Target.once: bool - added:
field Target.query: QueryTarget - added:
field Target.read_time: timestamp_pb2.Timestamp - added:
field Target.resume_token: bytes - added:
field Target.target_id: int - added:
field TargetChange.TargetChangeType.ADD - added:
field TargetChange.TargetChangeType.CURRENT - added:
field TargetChange.TargetChangeType.NO_CHANGE - added:
field TargetChange.TargetChangeType.REMOVE - added:
field TargetChange.TargetChangeType.RESET - added:
field TargetChange.cause: status_pb2.Status - added:
field TargetChange.read_time: timestamp_pb2.Timestamp - added:
field TargetChange.resume_token: bytes - added:
field TargetChange.target_change_type: TargetChangeType - added:
field TargetChange.target_ids: MutableSequence[int] - added:
field UpdateDocumentRequest.current_document: common.Precondition - added:
field UpdateDocumentRequest.document: gf_document.Document - added:
field UpdateDocumentRequest.mask: common.DocumentMask - added:
field UpdateDocumentRequest.request_options: common.RequestOptions - added:
field UpdateDocumentRequest.update_mask: common.DocumentMask - added:
field WriteRequest.database: str - added:
field WriteRequest.labels: MutableMapping[str, str] - added:
field WriteRequest.request_options: common.RequestOptions - added:
field WriteRequest.stream_id: str - added:
field WriteRequest.stream_token: bytes - added:
field WriteRequest.writes: MutableSequence[write.Write] - added:
field WriteResponse.commit_time: timestamp_pb2.Timestamp - added:
field WriteResponse.stream_id: str - added:
field WriteResponse.stream_token: bytes - added:
field WriteResponse.write_results: MutableSequence[write.WriteResult] - added:
property ListCollectionIdsResponse.raw_page - added:
property ListDocumentsResponse.raw_page - added:
property PartitionQueryResponse.raw_page
- added:
class StructuredPipeline(proto.Message) - added:
field StructuredPipeline.options: MutableMapping[str, document.Value] - added:
field StructuredPipeline.pipeline: document.Pipeline
- added:
class Cursor(proto.Message) - added:
class StructuredAggregationQuery(proto.Message) - added:
class StructuredAggregationQuery.Aggregation(proto.Message) - added:
class StructuredAggregationQuery.Aggregation.Avg(proto.Message) - added:
class StructuredAggregationQuery.Aggregation.Count(proto.Message) - added:
class StructuredAggregationQuery.Aggregation.Sum(proto.Message) - added:
class StructuredQuery(proto.Message) - added:
class StructuredQuery.CollectionSelector(proto.Message) - added:
class StructuredQuery.CompositeFilter(proto.Message) - added:
class StructuredQuery.CompositeFilter.Operator(proto.Enum) - added:
class StructuredQuery.Direction(proto.Enum) - added:
class StructuredQuery.FieldFilter(proto.Message) - added:
class StructuredQuery.FieldFilter.Operator(proto.Enum) - added:
class StructuredQuery.FieldReference(proto.Message) - added:
class StructuredQuery.Filter(proto.Message) - added:
class StructuredQuery.FindNearest(proto.Message) - added:
class StructuredQuery.FindNearest.DistanceMeasure(proto.Enum) - added:
class StructuredQuery.Order(proto.Message) - added:
class StructuredQuery.Projection(proto.Message) - added:
class StructuredQuery.UnaryFilter(proto.Message) - added:
class StructuredQuery.UnaryFilter.Operator(proto.Enum) - added:
field Cursor.before: bool - added:
field Cursor.values: MutableSequence[document.Value] - added:
field StructuredAggregationQuery.Aggregation.Avg.field: StructuredQuery.FieldReference - added:
field StructuredAggregationQuery.Aggregation.Count.up_to: wrappers_pb2.Int64Value - added:
field StructuredAggregationQuery.Aggregation.Sum.field: StructuredQuery.FieldReference - added:
field StructuredAggregationQuery.Aggregation.alias: str - added:
field StructuredAggregationQuery.Aggregation.avg: StructuredAggregationQuery.Aggregation.Avg - added:
field StructuredAggregationQuery.Aggregation.count: StructuredAggregationQuery.Aggregation.Count - added:
field StructuredAggregationQuery.Aggregation.sum: StructuredAggregationQuery.Aggregation.Sum - added:
field StructuredAggregationQuery.aggregations: MutableSequence[Aggregation] - added:
field StructuredAggregationQuery.structured_query: StructuredQuery - added:
field StructuredQuery.CollectionSelector.all_descendants: bool - added:
field StructuredQuery.CollectionSelector.collection_id: str - added:
field StructuredQuery.CompositeFilter.Operator.AND - added:
field StructuredQuery.CompositeFilter.Operator.OPERATOR_UNSPECIFIED - added:
field StructuredQuery.CompositeFilter.Operator.OR - added:
field StructuredQuery.CompositeFilter.filters: MutableSequence[StructuredQuery.Filter] - added:
field StructuredQuery.CompositeFilter.op: StructuredQuery.CompositeFilter.Operator - added:
field StructuredQuery.Direction.ASCENDING - added:
field StructuredQuery.Direction.DESCENDING - added:
field StructuredQuery.Direction.DIRECTION_UNSPECIFIED - added:
field StructuredQuery.FieldFilter.Operator.ARRAY_CONTAINS - added:
field StructuredQuery.FieldFilter.Operator.ARRAY_CONTAINS_ANY - added:
field StructuredQuery.FieldFilter.Operator.EQUAL - added:
field StructuredQuery.FieldFilter.Operator.GREATER_THAN - added:
field StructuredQuery.FieldFilter.Operator.GREATER_THAN_OR_EQUAL - added:
field StructuredQuery.FieldFilter.Operator.IN - added:
field StructuredQuery.FieldFilter.Operator.LESS_THAN - added:
field StructuredQuery.FieldFilter.Operator.LESS_THAN_OR_EQUAL - added:
field StructuredQuery.FieldFilter.Operator.NOT_EQUAL - added:
field StructuredQuery.FieldFilter.Operator.NOT_IN - added:
field StructuredQuery.FieldFilter.Operator.OPERATOR_UNSPECIFIED - added:
field StructuredQuery.FieldFilter.field: StructuredQuery.FieldReference - added:
field StructuredQuery.FieldFilter.op: StructuredQuery.FieldFilter.Operator - added:
field StructuredQuery.FieldFilter.value: document.Value - added:
field StructuredQuery.FieldReference.field_path: str - added:
field StructuredQuery.Filter.composite_filter: StructuredQuery.CompositeFilter - added:
field StructuredQuery.Filter.field_filter: StructuredQuery.FieldFilter - added:
field StructuredQuery.Filter.unary_filter: StructuredQuery.UnaryFilter - added:
field StructuredQuery.FindNearest.DistanceMeasure.COSINE - added:
field StructuredQuery.FindNearest.DistanceMeasure.DISTANCE_MEASURE_UNSPECIFIED - added:
field StructuredQuery.FindNearest.DistanceMeasure.DOT_PRODUCT - added:
field StructuredQuery.FindNearest.DistanceMeasure.EUCLIDEAN - added:
field StructuredQuery.FindNearest.distance_measure: StructuredQuery.FindNearest.DistanceMeasure - added:
field StructuredQuery.FindNearest.distance_result_field: str - added:
field StructuredQuery.FindNearest.distance_threshold: wrappers_pb2.DoubleValue - added:
field StructuredQuery.FindNearest.limit: wrappers_pb2.Int32Value - added:
field StructuredQuery.FindNearest.query_vector: document.Value - added:
field StructuredQuery.FindNearest.vector_field: StructuredQuery.FieldReference - added:
field StructuredQuery.Order.direction: StructuredQuery.Direction - added:
field StructuredQuery.Order.field: StructuredQuery.FieldReference - added:
field StructuredQuery.Projection.fields: MutableSequence[StructuredQuery.FieldReference] - added:
field StructuredQuery.UnaryFilter.Operator.IS_NAN - added:
field StructuredQuery.UnaryFilter.Operator.IS_NOT_NAN - added:
field StructuredQuery.UnaryFilter.Operator.IS_NOT_NULL - added:
field StructuredQuery.UnaryFilter.Operator.IS_NULL - added:
field StructuredQuery.UnaryFilter.Operator.OPERATOR_UNSPECIFIED - added:
field StructuredQuery.UnaryFilter.field: StructuredQuery.FieldReference - added:
field StructuredQuery.UnaryFilter.op: StructuredQuery.UnaryFilter.Operator - added:
field StructuredQuery.end_at: Cursor - added:
field StructuredQuery.find_nearest: FindNearest - added:
field StructuredQuery.from_: MutableSequence[CollectionSelector] - added:
field StructuredQuery.limit: wrappers_pb2.Int32Value - added:
field StructuredQuery.offset: int - added:
field StructuredQuery.order_by: MutableSequence[Order] - added:
field StructuredQuery.select: Projection - added:
field StructuredQuery.start_at: Cursor - added:
field StructuredQuery.where: Filter
- added:
class ExecutionStats(proto.Message) - added:
class ExplainMetrics(proto.Message) - added:
class ExplainOptions(proto.Message) - added:
class PlanSummary(proto.Message) - added:
field ExecutionStats.debug_stats: struct_pb2.Struct - added:
field ExecutionStats.execution_duration: duration_pb2.Duration - added:
field ExecutionStats.read_operations: int - added:
field ExecutionStats.results_returned: int - added:
field ExplainMetrics.execution_stats: ExecutionStats - added:
field ExplainMetrics.plan_summary: PlanSummary - added:
field ExplainOptions.analyze: bool - added:
field PlanSummary.indexes_used: MutableSequence[struct_pb2.Struct]
- added:
class DocumentChange(proto.Message) - added:
class DocumentDelete(proto.Message) - added:
class DocumentRemove(proto.Message) - added:
class DocumentTransform(proto.Message) - added:
class DocumentTransform.FieldTransform(proto.Message) - added:
class DocumentTransform.FieldTransform.ServerValue(proto.Enum) - added:
class ExistenceFilter(proto.Message) - added:
class Write(proto.Message) - added:
class WriteResult(proto.Message) - added:
field DocumentChange.document: gf_document.Document - added:
field DocumentChange.removed_target_ids: MutableSequence[int] - added:
field DocumentChange.target_ids: MutableSequence[int] - added:
field DocumentDelete.document: str - added:
field DocumentDelete.read_time: timestamp_pb2.Timestamp - added:
field DocumentDelete.removed_target_ids: MutableSequence[int] - added:
field DocumentRemove.document: str - added:
field DocumentRemove.read_time: timestamp_pb2.Timestamp - added:
field DocumentRemove.removed_target_ids: MutableSequence[int] - added:
field DocumentTransform.FieldTransform.ServerValue.REQUEST_TIME - added:
field DocumentTransform.FieldTransform.ServerValue.SERVER_VALUE_UNSPECIFIED - added:
field DocumentTransform.FieldTransform.append_missing_elements: gf_document.ArrayValue - added:
field DocumentTransform.FieldTransform.field_path: str - added:
field DocumentTransform.FieldTransform.increment: gf_document.Value - added:
field DocumentTransform.FieldTransform.maximum: gf_document.Value - added:
field DocumentTransform.FieldTransform.minimum: gf_document.Value - added:
field DocumentTransform.FieldTransform.remove_all_from_array: gf_document.ArrayValue - added:
field DocumentTransform.FieldTransform.set_to_server_value: DocumentTransform.FieldTransform.ServerValue - added:
field DocumentTransform.document: str - added:
field DocumentTransform.field_transforms: MutableSequence[FieldTransform] - added:
field ExistenceFilter.count: int - added:
field ExistenceFilter.target_id: int - added:
field ExistenceFilter.unchanged_names: bloom_filter.BloomFilter - added:
field Write.current_document: common.Precondition - added:
field Write.delete: str - added:
field Write.transform: DocumentTransform - added:
field Write.update: gf_document.Document - added:
field Write.update_mask: common.DocumentMask - added:
field Write.update_transforms: MutableSequence[DocumentTransform.FieldTransform] - added:
field WriteResult.transform_results: MutableSequence[gf_document.Value] - added:
field WriteResult.update_time: timestamp_pb2.Timestamp
- added:
class Vector(collections.abc.Sequence) - added:
constructor Vector(value: Sequence[float]) - added:
method Vector.to_map_value()
- added:
class VectorQuery(BaseVectorQuery) - added:
constructor VectorQuery(nested_query: Union[BaseQuery, TVectorQuery]) -> None - added:
method VectorQuery.get(transaction=…, retry: retries.Retry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…) -> QueryResultsList[DocumentSnapshot[DocumentReference]] - added:
method VectorQuery.stream(transaction: Optional[transaction.Transaction]=…, retry: retries.Retry | object | None=…, timeout: Optional[float]=…, *, explain_options: Optional[ExplainOptions]=…) -> StreamGenerator[DocumentSnapshot[DocumentReference]] - added:
variable TVectorQuery
- removed:
field Watch.BackgroundConsumer - removed:
field Watch.ResumableBidiRpc - changed:
constructor Watch(document_reference, firestore, target, comparator, snapshot_callback, document_snapshot_cls, document_reference_cls, BackgroundConsumer=…, ResumableBidiRpc=…) → constructor Watch(document_reference, firestore, target, comparator, snapshot_callback, document_snapshot_cls) - changed:
static method Watch.for_document(document_ref, snapshot_callback, snapshot_class_instance, reference_class_instance) → static method Watch.for_document(document_ref, snapshot_callback, document_snapshot_cls) - changed:
static method Watch.for_query(query, snapshot_callback, snapshot_class_instance, reference_class_instance) → static method Watch.for_query(query, snapshot_callback, document_snapshot_cls) - added:
variable TargetChangeType
- removed:
export ArrayRemove - removed:
export ArrayUnion - removed:
export Client - removed:
export CollectionReference - removed:
export DELETE_FIELD - removed:
export DocumentReference - removed:
export DocumentSnapshot - removed:
export ExistsOption - removed:
export GeoPoint - removed:
export LastUpdateOption - removed:
export Query - removed:
export ReadAfterWriteError - removed:
export SERVER_TIMESTAMP - removed:
export Transaction - removed:
export Watch - removed:
export WriteBatch - removed:
export WriteOption - removed:
export enums - removed:
export transactional - removed:
export types - removed:
variable __version__
- removed:
class WriteBatch(object) - removed:
constructor WriteBatch(client) - removed:
method WriteBatch.commit() - removed:
method WriteBatch.create(reference, document_data) - removed:
method WriteBatch.delete(reference, option=…) - removed:
method WriteBatch.set(reference, document_data, merge=…) - removed:
method WriteBatch.update(reference, field_updates, option=…)
- removed:
class Client(ClientWithProject) - removed:
constructor Client(project=…, credentials=…, database=…) - removed:
field Client.SCOPE - removed:
method Client.batch() - removed:
method Client.collection(*collection_path) - removed:
method Client.collections() - removed:
method Client.document(*document_path) - removed:
method Client.get_all(references, field_paths=…, transaction=…) - removed:
method Client.transaction(**kwargs) - removed:
static method Client.field_path(*field_names) - removed:
static method Client.write_option(**kwargs) - removed:
variable DEFAULT_DATABASE
- removed:
class CollectionReference(object) - removed:
constructor CollectionReference(*path, **kwargs) - removed:
method CollectionReference.add(document_data, document_id=…) - removed:
method CollectionReference.document(document_id=…) - removed:
method CollectionReference.end_at(document_fields) - removed:
method CollectionReference.end_before(document_fields) - removed:
method CollectionReference.get(transaction=…) - removed:
method CollectionReference.limit(count) - removed:
method CollectionReference.list_documents(page_size=…) - removed:
method CollectionReference.offset(num_to_skip) - removed:
method CollectionReference.on_snapshot(callback) - removed:
method CollectionReference.order_by(field_path, **kwargs) - removed:
method CollectionReference.select(field_paths) - removed:
method CollectionReference.start_after(document_fields) - removed:
method CollectionReference.start_at(document_fields) - removed:
method CollectionReference.stream(transaction=…) - removed:
method CollectionReference.where(field_path, op_string, value) - removed:
property CollectionReference.id - removed:
property CollectionReference.parent
- removed:
class DocumentReference(object) - removed:
class DocumentSnapshot(object) - removed:
constructor DocumentReference(*path, **kwargs) - removed:
constructor DocumentSnapshot(reference, data, exists, read_time, create_time, update_time) - removed:
method DocumentReference.collection(collection_id) - removed:
method DocumentReference.collections(page_size=…) - removed:
method DocumentReference.create(document_data) - removed:
method DocumentReference.delete(option=…) - removed:
method DocumentReference.get(field_paths=…, transaction=…) - removed:
method DocumentReference.on_snapshot(callback) - removed:
method DocumentReference.set(document_data, merge=…) - removed:
method DocumentReference.update(field_updates, option=…) - removed:
method DocumentSnapshot.get(field_path) - removed:
method DocumentSnapshot.to_dict() - removed:
property DocumentReference.id - removed:
property DocumentReference.parent - removed:
property DocumentReference.path - removed:
property DocumentSnapshot.exists - removed:
property DocumentSnapshot.id - removed:
property DocumentSnapshot.reference
- removed:
class FieldPath(object) - removed:
constructor FieldPath(*parts) - removed:
function get_nested_value(field_path, data) - removed:
function parse_field_path(api_repr) - removed:
function render_field_path(field_names) - removed:
function split_field_path(path) - removed:
method FieldPath.eq_or_parent(other) - removed:
method FieldPath.lineage() - removed:
method FieldPath.to_api_repr() - removed:
static method FieldPath.from_api_repr(api_repr) - removed:
static method FieldPath.from_string(path_string) - removed:
variable PATH_ELEMENT_TOKENS - removed:
variable TOKENS_PATTERN - removed:
variable TOKENS_REGEX - removed:
variable get_field_path
- removed:
class DocumentTransform(object) - removed:
class DocumentTransform.FieldTransform(object) - removed:
class DocumentTransform.FieldTransform.ServerValue(enum.IntEnum) - removed:
class NullValue(enum.IntEnum) - removed:
class StructuredQuery(object) - removed:
class StructuredQuery.CompositeFilter(object) - removed:
class StructuredQuery.CompositeFilter.Operator(enum.IntEnum) - removed:
class StructuredQuery.Direction(enum.IntEnum) - removed:
class StructuredQuery.FieldFilter(object) - removed:
class StructuredQuery.FieldFilter.Operator(enum.IntEnum) - removed:
class StructuredQuery.UnaryFilter(object) - removed:
class StructuredQuery.UnaryFilter.Operator(enum.IntEnum) - removed:
class TargetChange(object) - removed:
class TargetChange.TargetChangeType(enum.IntEnum) - removed:
field DocumentTransform.FieldTransform.ServerValue.REQUEST_TIME - removed:
field DocumentTransform.FieldTransform.ServerValue.SERVER_VALUE_UNSPECIFIED - removed:
field NullValue.NULL_VALUE - removed:
field StructuredQuery.CompositeFilter.Operator.AND - removed:
field StructuredQuery.CompositeFilter.Operator.OPERATOR_UNSPECIFIED - removed:
field StructuredQuery.Direction.ASCENDING - removed:
field StructuredQuery.Direction.DESCENDING - removed:
field StructuredQuery.Direction.DIRECTION_UNSPECIFIED - removed:
field StructuredQuery.FieldFilter.Operator.ARRAY_CONTAINS - removed:
field StructuredQuery.FieldFilter.Operator.ARRAY_CONTAINS_ANY - removed:
field StructuredQuery.FieldFilter.Operator.EQUAL - removed:
field StructuredQuery.FieldFilter.Operator.GREATER_THAN - removed:
field StructuredQuery.FieldFilter.Operator.GREATER_THAN_OR_EQUAL - removed:
field StructuredQuery.FieldFilter.Operator.IN - removed:
field StructuredQuery.FieldFilter.Operator.LESS_THAN - removed:
field StructuredQuery.FieldFilter.Operator.LESS_THAN_OR_EQUAL - removed:
field StructuredQuery.FieldFilter.Operator.OPERATOR_UNSPECIFIED - removed:
field StructuredQuery.UnaryFilter.Operator.IS_NAN - removed:
field StructuredQuery.UnaryFilter.Operator.IS_NULL - removed:
field StructuredQuery.UnaryFilter.Operator.OPERATOR_UNSPECIFIED - removed:
field TargetChange.TargetChangeType.ADD - removed:
field TargetChange.TargetChangeType.CURRENT - removed:
field TargetChange.TargetChangeType.NO_CHANGE - removed:
field TargetChange.TargetChangeType.REMOVE - removed:
field TargetChange.TargetChangeType.RESET
- removed:
class FirestoreClient(object) - removed:
constructor FirestoreClient(transport=…, channel=…, credentials=…, client_config=…, client_info=…, client_options=…) - removed:
field FirestoreClient.SERVICE_ADDRESS - removed:
field FirestoreClient.from_service_account_json - removed:
method FirestoreClient.batch_get_documents(database, documents=…, mask=…, transaction=…, new_transaction=…, read_time=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.begin_transaction(database, options_=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.commit(database, writes=…, transaction=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.create_document(parent, collection_id, document_id, document, mask=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.delete_document(name, current_document=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.get_document(name, mask=…, transaction=…, read_time=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.list_collection_ids(parent, page_size=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.list_documents(parent, collection_id, page_size=…, order_by=…, mask=…, transaction=…, read_time=…, show_missing=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.listen(requests, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.rollback(database, transaction, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.run_query(parent, structured_query=…, transaction=…, new_transaction=…, read_time=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.update_document(document, update_mask=…, mask=…, current_document=…, retry=…, timeout=…, metadata=…) - removed:
method FirestoreClient.write(requests, retry=…, timeout=…, metadata=…) - removed:
static method FirestoreClient.any_path_path(project, database, document, any_path) - removed:
static method FirestoreClient.database_root_path(project, database) - removed:
static method FirestoreClient.document_path_path(project, database, document_path) - removed:
static method FirestoreClient.document_root_path(project, database) - removed:
static method FirestoreClient.from_service_account_file(filename, *args, **kwargs)
- removed:
variable config
- removed:
class FirestoreGrpcTransport(object) - removed:
constructor FirestoreGrpcTransport(channel=…, credentials=…, address=…) - removed:
property FirestoreGrpcTransport.batch_get_documents - removed:
property FirestoreGrpcTransport.begin_transaction - removed:
property FirestoreGrpcTransport.channel - removed:
property FirestoreGrpcTransport.commit - removed:
property FirestoreGrpcTransport.create_document - removed:
property FirestoreGrpcTransport.delete_document - removed:
property FirestoreGrpcTransport.get_document - removed:
property FirestoreGrpcTransport.list_collection_ids - removed:
property FirestoreGrpcTransport.list_documents - removed:
property FirestoreGrpcTransport.listen - removed:
property FirestoreGrpcTransport.rollback - removed:
property FirestoreGrpcTransport.run_query - removed:
property FirestoreGrpcTransport.update_document - removed:
property FirestoreGrpcTransport.write - removed:
static method FirestoreGrpcTransport.create_channel(address=…, credentials=…, **kwargs)
- removed:
class Order(object) - removed:
class TypeOrder(Enum) - removed:
field TypeOrder.ARRAY - removed:
field TypeOrder.BLOB - removed:
field TypeOrder.BOOLEAN - removed:
field TypeOrder.GEO_POINT - removed:
field TypeOrder.NULL - removed:
field TypeOrder.NUMBER - removed:
field TypeOrder.OBJECT - removed:
field TypeOrder.REF - removed:
field TypeOrder.STRING - removed:
field TypeOrder.TIMESTAMP - removed:
static method Order.compare(left, right) - removed:
static method Order.compare_arrays(left, right) - removed:
static method Order.compare_blobs(left, right) - removed:
static method Order.compare_doubles(left, right) - removed:
static method Order.compare_geo_points(left, right) - removed:
static method Order.compare_numbers(left, right) - removed:
static method Order.compare_objects(left, right) - removed:
static method Order.compare_resource_paths(left, right) - removed:
static method Order.compare_timestamps(left, right) - removed:
static method TypeOrder.from_value(value)
- removed:
class BetaFirestoreAdminServicer(object) - removed:
class BetaFirestoreAdminStub(object) - removed:
class FirestoreAdminServicer(object) - removed:
class FirestoreAdminStub(object) - removed:
constructor FirestoreAdminStub(channel) - removed:
function add_FirestoreAdminServicer_to_server(servicer, server) - removed:
function beta_create_FirestoreAdmin_server(servicer, pool=…, pool_size=…, default_timeout=…, maximum_timeout=…) - removed:
function beta_create_FirestoreAdmin_stub(channel, host=…, metadata_transformer=…, pool=…, pool_size=…) - removed:
method BetaFirestoreAdminServicer.CreateIndex(request, context) - removed:
method BetaFirestoreAdminServicer.DeleteIndex(request, context) - removed:
method BetaFirestoreAdminServicer.GetIndex(request, context) - removed:
method BetaFirestoreAdminServicer.ListIndexes(request, context) - removed:
method BetaFirestoreAdminStub.CreateIndex(request, timeout, metadata=…, with_call=…, protocol_options=…) - removed:
method BetaFirestoreAdminStub.DeleteIndex(request, timeout, metadata=…, with_call=…, protocol_options=…) - removed:
method BetaFirestoreAdminStub.GetIndex(request, timeout, metadata=…, with_call=…, protocol_options=…) - removed:
method BetaFirestoreAdminStub.ListIndexes(request, timeout, metadata=…, with_call=…, protocol_options=…) - removed:
method FirestoreAdminServicer.CreateIndex(request, context) - removed:
method FirestoreAdminServicer.DeleteIndex(request, context) - removed:
method FirestoreAdminServicer.GetIndex(request, context) - removed:
method FirestoreAdminServicer.ListIndexes(request, context) - removed:
variable CreateIndexRequest - removed:
variable DESCRIPTOR - removed:
variable DeleteIndexRequest - removed:
variable GetIndexRequest - removed:
variable IndexOperationMetadata - removed:
variable ListIndexesRequest - removed:
variable ListIndexesResponse - removed:
variable Progress
- removed:
class FirestoreAdminServicer(object) - removed:
class FirestoreAdminStub(object) - removed:
constructor FirestoreAdminStub(channel) - removed:
function add_FirestoreAdminServicer_to_server(servicer, server) - removed:
method FirestoreAdminServicer.CreateIndex(request, context) - removed:
method FirestoreAdminServicer.DeleteIndex(request, context) - removed:
method FirestoreAdminServicer.GetIndex(request, context) - removed:
method FirestoreAdminServicer.ListIndexes(request, context)
- removed:
variable DESCRIPTOR - removed:
variable Index - removed:
variable IndexField
- removed:
variable DESCRIPTOR - removed:
variable DocumentMask - removed:
variable Precondition - removed:
variable TransactionOptions
- removed:
variable ArrayValue - removed:
variable DESCRIPTOR - removed:
variable Document - removed:
variable MapValue - removed:
variable Value
- removed:
variable DESCRIPTOR
- removed:
variable BatchGetDocumentsRequest - removed:
variable BatchGetDocumentsResponse - removed:
variable BeginTransactionRequest - removed:
variable BeginTransactionResponse - removed:
variable CommitRequest - removed:
variable CommitResponse - removed:
variable CreateDocumentRequest - removed:
variable DESCRIPTOR - removed:
variable DeleteDocumentRequest - removed:
variable GetDocumentRequest - removed:
variable ListCollectionIdsRequest - removed:
variable ListCollectionIdsResponse - removed:
variable ListDocumentsRequest - removed:
variable ListDocumentsResponse - removed:
variable ListenRequest - removed:
variable ListenResponse - removed:
variable RollbackRequest - removed:
variable RunQueryRequest - removed:
variable RunQueryResponse - removed:
variable Target - removed:
variable TargetChange - removed:
variable UpdateDocumentRequest - removed:
variable WriteRequest - removed:
variable WriteResponse
- removed:
class Firestore(object) - removed:
class FirestoreServicer(object) - removed:
class FirestoreStub(object) - removed:
constructor FirestoreStub(channel) - removed:
function add_FirestoreServicer_to_server(servicer, server) - removed:
method FirestoreServicer.BatchGetDocuments(request, context) - removed:
method FirestoreServicer.BeginTransaction(request, context) - removed:
method FirestoreServicer.Commit(request, context) - removed:
method FirestoreServicer.CreateDocument(request, context) - removed:
method FirestoreServicer.DeleteDocument(request, context) - removed:
method FirestoreServicer.GetDocument(request, context) - removed:
method FirestoreServicer.ListCollectionIds(request, context) - removed:
method FirestoreServicer.ListDocuments(request, context) - removed:
method FirestoreServicer.Listen(request_iterator, context) - removed:
method FirestoreServicer.Rollback(request, context) - removed:
method FirestoreServicer.RunQuery(request, context) - removed:
method FirestoreServicer.UpdateDocument(request, context) - removed:
method FirestoreServicer.Write(request_iterator, context) - removed:
static method Firestore.BatchGetDocuments(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.BeginTransaction(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Commit(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.CreateDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.DeleteDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.GetDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.ListCollectionIds(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.ListDocuments(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Listen(request_iterator, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Rollback(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.RunQuery(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.UpdateDocument(request, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…) - removed:
static method Firestore.Write(request_iterator, target, options=…, channel_credentials=…, call_credentials=…, compression=…, wait_for_ready=…, timeout=…, metadata=…)
- removed:
variable Cursor - removed:
variable DESCRIPTOR - removed:
variable StructuredQuery
- removed:
variable Clause - removed:
variable CreateTest - removed:
variable Cursor - removed:
variable DESCRIPTOR - removed:
variable DeleteTest - removed:
variable DocChange - removed:
variable DocSnapshot - removed:
variable FieldPath - removed:
variable GetTest - removed:
variable ListenTest - removed:
variable OrderBy - removed:
variable QueryTest - removed:
variable Select - removed:
variable SetOption - removed:
variable SetTest - removed:
variable Snapshot - removed:
variable Test - removed:
variable TestSuite - removed:
variable UpdatePathsTest - removed:
variable UpdateTest - removed:
variable Where
- removed:
variable DESCRIPTOR - removed:
variable DocumentChange - removed:
variable DocumentDelete - removed:
variable DocumentRemove - removed:
variable DocumentTransform - removed:
variable ExistenceFilter - removed:
variable Write - removed:
variable WriteResult
- removed:
class Query(object) - removed:
constructor Query(parent, projection=…, field_filters=…, orders=…, limit=…, offset=…, start_at=…, end_at=…) - removed:
field Query.ASCENDING - removed:
field Query.DESCENDING - removed:
method Query.end_at(document_fields) - removed:
method Query.end_before(document_fields) - removed:
method Query.get(transaction=…) - removed:
method Query.limit(count) - removed:
method Query.offset(num_to_skip) - removed:
method Query.on_snapshot(callback) - removed:
method Query.order_by(field_path, direction=…) - removed:
method Query.select(field_paths) - removed:
method Query.start_after(document_fields) - removed:
method Query.start_at(document_fields) - removed:
method Query.stream(transaction=…) - removed:
method Query.where(field_path, op_string, value)
- removed:
class Transaction(batch.WriteBatch) - removed:
constructor Transaction(client, max_attempts=…, read_only=…) - removed:
function transactional(to_wrap) - removed:
property Transaction.id - removed:
property Transaction.in_progress - removed:
variable MAX_ATTEMPTS
- removed:
class ArrayRemove(_ValueList) - removed:
class ArrayUnion(_ValueList) - removed:
class Sentinel(object) - removed:
constructor Sentinel(description) - removed:
variable DELETE_FIELD - removed:
variable SERVER_TIMESTAMP
- removed:
variable names
- removed:
class ChangeType(Enum) - removed:
class DocumentChange(object) - removed:
class Watch(object) - removed:
class WatchDocTree(object) - removed:
class WatchResult(object) - removed:
constructor DocumentChange(type, document, old_index, new_index) - removed:
constructor Watch(document_reference, firestore, target, comparator, snapshot_callback, document_snapshot_cls, document_reference_cls, BackgroundConsumer=…, ResumableBidiRpc=…) - removed:
constructor WatchDocTree() - removed:
constructor WatchResult(snapshot, name, change_type) - removed:
field ChangeType.ADDED - removed:
field ChangeType.MODIFIED - removed:
field ChangeType.REMOVED - removed:
field Watch.BackgroundConsumer - removed:
field Watch.ResumableBidiRpc - removed:
function document_watch_comparator(doc1, doc2) - removed:
method Watch.close(reason=…) - removed:
method Watch.on_snapshot(proto) - removed:
method Watch.push(read_time, next_resume_token) - removed:
method Watch.unsubscribe() - removed:
method WatchDocTree.find(key) - removed:
method WatchDocTree.insert(key, value) - removed:
method WatchDocTree.keys() - removed:
method WatchDocTree.remove(key) - removed:
property Watch.is_active - removed:
static method Watch.for_document(document_ref, snapshot_callback, snapshot_class_instance, reference_class_instance) - removed:
static method Watch.for_query(query, snapshot_callback, snapshot_class_instance, reference_class_instance) - removed:
variable DocTreeEntry - removed:
variable GRPC_STATUS_CODE - removed:
variable WATCH_TARGET_ID