firestore library

Classes

BackupSchedule
A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
BackupScheduleArgs
The set of arguments for BackupSchedule. The set of arguments for BackupSchedule.
BackupScheduleState
Input properties used for looking up and filtering BackupSchedule resources.
BackupScheduleWeeklyRecurrence
ChangeStream
A change stream resource for a Cloud Firestore Database. Change streams enable real-time tracking of document changes (creates, updates, deletes) across collections within a Cloud Firestore database.
ChangeStreamArgs
The set of arguments for ChangeStream. The set of arguments for ChangeStream.
ChangeStreamCollectionGroupScope
ChangeStreamState
Input properties used for looking up and filtering ChangeStream resources.
Database
A Cloud Firestore Database.
DatabaseArgs
The set of arguments for Database. The set of arguments for Database.
DatabaseCmekConfig
DatabaseState
Input properties used for looking up and filtering Database resources.
Document
In Cloud Firestore, the unit of storage is the document. A document is a lightweight record that contains fields, which map to values. Each document is identified by a name.
DocumentArgs
The set of arguments for Document. The set of arguments for Document.
DocumentState
Input properties used for looking up and filtering Document resources.
Field
Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
FieldArgs
The set of arguments for Field. The set of arguments for Field.
FieldIndexConfig
FieldIndexConfigIndex
FieldState
Input properties used for looking up and filtering Field resources.
FieldTtlConfig
GetDocumentArgs
Arguments for getDocument. Arguments for getDocument.
GetDocumentResult
Result data returned by getDocument.
Index
Cloud Firestore indexes enable simple and complex queries against documents in a database. Firestore Native, Firestore with MongoDB compatibility and Datastore Mode indexes are all supported. In Enterprise edition databases, this resource manages both single field and composite indexes. In Standard edition databases, single field indexes are managed using the gcp.firestore.Field resource instead.
IndexArgs
The set of arguments for Index. The set of arguments for Index.
IndexField
IndexFieldSearchConfig
IndexFieldSearchConfigGeoSpec
IndexFieldSearchConfigTextSpec
IndexFieldSearchConfigTextSpecIndexSpec
IndexFieldVectorConfig
IndexState
Input properties used for looking up and filtering Index resources.
UserCreds
User credentials for a Cloud Firestore with MongoDB compatibility database. The resource is owned by the database and is deleted along with the database.
UserCredsArgs
The set of arguments for UserCreds. The set of arguments for UserCreds.
UserCredsResourceIdentity
UserCredsState
Input properties used for looking up and filtering UserCreds resources.

Functions

getDocument(GetDocumentArgs args, {InvokeOptions? options}) → Future<GetDocumentResult>
Reads a document from a Firestore database. See the official documentation and API.
getDocumentOutput(GetDocumentArgs args, {InvokeOutputOptions? options}) → Output<GetDocumentResult>