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

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

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

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

v1.FirestoreClient

The Cloud Firestore service.

Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform accelerate building truly serverless apps. v1

v1beta1.FirestoreClient

The Cloud Firestore service.

Variables

_default

_default: {
    v1: typeof v1;
    v1beta1: typeof v1beta1;
    FirestoreClient: typeof v1beta1.FirestoreClient;
}

FirestoreClient

FirestoreClient: typeof v1beta1.FirestoreClient

Type Aliases

FirestoreClient

type FirestoreClient = v1beta1.FirestoreClient;

protos.google.firestore.admin.v1.FirestoreAdmin.BulkDeleteDocumentsCallback

type BulkDeleteDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.CloneDatabaseCallback

type CloneDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.CreateBackupScheduleCallback

type CreateBackupScheduleCallback = (error: (Error|null), response?: google.firestore.admin.v1.BackupSchedule) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.CreateDatabaseCallback

type CreateDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.CreateIndexCallback

type CreateIndexCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.CreateUserCredsCallback

type CreateUserCredsCallback = (error: (Error|null), response?: google.firestore.admin.v1.UserCreds) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.DeleteBackupCallback

type DeleteBackupCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.DeleteBackupScheduleCallback

type DeleteBackupScheduleCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.DeleteDatabaseCallback

type DeleteDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.DeleteIndexCallback

type DeleteIndexCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.DeleteUserCredsCallback

type DeleteUserCredsCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.DisableUserCredsCallback

type DisableUserCredsCallback = (error: (Error|null), response?: google.firestore.admin.v1.UserCreds) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.EnableUserCredsCallback

type EnableUserCredsCallback = (error: (Error|null), response?: google.firestore.admin.v1.UserCreds) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ExportDocumentsCallback

type ExportDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.GetBackupCallback

type GetBackupCallback = (error: (Error|null), response?: google.firestore.admin.v1.Backup) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.GetBackupScheduleCallback

type GetBackupScheduleCallback = (error: (Error|null), response?: google.firestore.admin.v1.BackupSchedule) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.GetDatabaseCallback

type GetDatabaseCallback = (error: (Error|null), response?: google.firestore.admin.v1.Database) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.GetFieldCallback

type GetFieldCallback = (error: (Error|null), response?: google.firestore.admin.v1.Field) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.GetIndexCallback

type GetIndexCallback = (error: (Error|null), response?: google.firestore.admin.v1.Index) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.GetUserCredsCallback

type GetUserCredsCallback = (error: (Error|null), response?: google.firestore.admin.v1.UserCreds) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ImportDocumentsCallback

type ImportDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ListBackupsCallback

type ListBackupsCallback = (error: (Error|null), response?: google.firestore.admin.v1.ListBackupsResponse) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedulesCallback

type ListBackupSchedulesCallback = (error: (Error|null), response?: google.firestore.admin.v1.ListBackupSchedulesResponse) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ListDatabasesCallback

type ListDatabasesCallback = (error: (Error|null), response?: google.firestore.admin.v1.ListDatabasesResponse) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ListFieldsCallback

type ListFieldsCallback = (error: (Error|null), response?: google.firestore.admin.v1.ListFieldsResponse) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ListIndexesCallback

type ListIndexesCallback = (error: (Error|null), response?: google.firestore.admin.v1.ListIndexesResponse) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ListUserCredsCallback

type ListUserCredsCallback = (error: (Error|null), response?: google.firestore.admin.v1.ListUserCredsResponse) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.ResetUserPasswordCallback

type ResetUserPasswordCallback = (error: (Error|null), response?: google.firestore.admin.v1.UserCreds) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.RestoreDatabaseCallback

type RestoreDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.UpdateBackupScheduleCallback

type UpdateBackupScheduleCallback = (error: (Error|null), response?: google.firestore.admin.v1.BackupSchedule) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.UpdateDatabaseCallback

type UpdateDatabaseCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.admin.v1.FirestoreAdmin.UpdateFieldCallback

type UpdateFieldCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.BatchGetDocumentsCallback

type BatchGetDocumentsCallback = (error: (Error|null), response?: google.firestore.v1.BatchGetDocumentsResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.BatchWriteCallback

type BatchWriteCallback = (error: (Error|null), response?: google.firestore.v1.BatchWriteResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.BeginTransactionCallback

type BeginTransactionCallback = (error: (Error|null), response?: google.firestore.v1.BeginTransactionResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.CommitCallback

type CommitCallback = (error: (Error|null), response?: google.firestore.v1.CommitResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.CreateDocumentCallback

type CreateDocumentCallback = (error: (Error|null), response?: google.firestore.v1.Document) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.DeleteDocumentCallback

type DeleteDocumentCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.ExecutePipelineCallback

type ExecutePipelineCallback = (error: (Error|null), response?: google.firestore.v1.ExecutePipelineResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.GetDocumentCallback

type GetDocumentCallback = (error: (Error|null), response?: google.firestore.v1.Document) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.ListCollectionIdsCallback

type ListCollectionIdsCallback = (error: (Error|null), response?: google.firestore.v1.ListCollectionIdsResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.ListDocumentsCallback

type ListDocumentsCallback = (error: (Error|null), response?: google.firestore.v1.ListDocumentsResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.ListenCallback

type ListenCallback = (error: (Error|null), response?: google.firestore.v1.ListenResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.PartitionQueryCallback

type PartitionQueryCallback = (error: (Error|null), response?: google.firestore.v1.PartitionQueryResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.RollbackCallback

type RollbackCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.RunAggregationQueryCallback

type RunAggregationQueryCallback = (error: (Error|null), response?: google.firestore.v1.RunAggregationQueryResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.RunQueryCallback

type RunQueryCallback = (error: (Error|null), response?: google.firestore.v1.RunQueryResponse) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.UpdateDocumentCallback

type UpdateDocumentCallback = (error: (Error|null), response?: google.firestore.v1.Document) => void;

Callback as used by .

protos.google.firestore.v1.Firestore.WriteCallback

type WriteCallback = (error: (Error|null), response?: google.firestore.v1.WriteResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.BatchGetDocumentsCallback

type BatchGetDocumentsCallback = (error: (Error|null), response?: google.firestore.v1beta1.BatchGetDocumentsResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.BatchWriteCallback

type BatchWriteCallback = (error: (Error|null), response?: google.firestore.v1beta1.BatchWriteResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.BeginTransactionCallback

type BeginTransactionCallback = (error: (Error|null), response?: google.firestore.v1beta1.BeginTransactionResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.CommitCallback

type CommitCallback = (error: (Error|null), response?: google.firestore.v1beta1.CommitResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.CreateDocumentCallback

type CreateDocumentCallback = (error: (Error|null), response?: google.firestore.v1beta1.Document) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.DeleteDocumentCallback

type DeleteDocumentCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.GetDocumentCallback

type GetDocumentCallback = (error: (Error|null), response?: google.firestore.v1beta1.Document) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.ListCollectionIdsCallback

type ListCollectionIdsCallback = (error: (Error|null), response?: google.firestore.v1beta1.ListCollectionIdsResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.ListDocumentsCallback

type ListDocumentsCallback = (error: (Error|null), response?: google.firestore.v1beta1.ListDocumentsResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.ListenCallback

type ListenCallback = (error: (Error|null), response?: google.firestore.v1beta1.ListenResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.PartitionQueryCallback

type PartitionQueryCallback = (error: (Error|null), response?: google.firestore.v1beta1.PartitionQueryResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.RollbackCallback

type RollbackCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.RunQueryCallback

type RunQueryCallback = (error: (Error|null), response?: google.firestore.v1beta1.RunQueryResponse) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.UpdateDocumentCallback

type UpdateDocumentCallback = (error: (Error|null), response?: google.firestore.v1beta1.Document) => void;

Callback as used by .

protos.google.firestore.v1beta1.Firestore.WriteCallback

type WriteCallback = (error: (Error|null), response?: google.firestore.v1beta1.WriteResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.CancelOperationCallback

type CancelOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.DeleteOperationCallback

type DeleteOperationCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.longrunning.Operations.GetOperationCallback

type GetOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

protos.google.longrunning.Operations.ListOperationsCallback

type ListOperationsCallback = (error: (Error|null), response?: google.longrunning.ListOperationsResponse) => void;

Callback as used by .

protos.google.longrunning.Operations.WaitOperationCallback

type WaitOperationCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;

Callback as used by .

Package @google-cloud/firestore-api (0.2.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

Package @google-cloud/firestore-api (0.2.0)