Cloud Firestore Database

Cloud Firestore Database is a fully managed NoSQL document database from Google Cloud. It stores data in collections of documents, supports real-time synchronization, and scales automatically to handle large workloads. Firestore is ideal for web, mobile, and serverless applications that need flexible data structures and low-latency access.

gcp.firestore_database

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
app_engine_integration_modecorestringThe App Engine integration mode to use for this database.
cmek_configcorejsonOptional. Presence indicates CMEK is enabled for this database.
concurrency_modecorestringThe concurrency control mode to use for this database.
create_timecoretimestampOutput only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
datadog_display_namecorestring
delete_protection_statecorestringState of delete protection for the database.
delete_timecoretimestampOutput only. The timestamp at which this database was deleted. Only set if the database has been deleted.
earliest_version_timecoretimestampOutput only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
etagcorestringThis checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
key_prefixcorestringOutput only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
labelscorearray<string>
location_idcorestringThe location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
namecorestringThe resource name of the Database. Format: `projects/{project}/databases/{database}`
organization_idcorestring
parentcorestring
point_in_time_recovery_enablementcorestringWhether to enable the PITR feature on this database.
previous_idcorestringOutput only. The database resource's prior database ID. This field is only populated for deleted databases.
project_idcorestring
project_numbercorestring
region_idcorestring
resource_namecorestring
source_infocorejsonOutput only. Information about the provenance of this database.
tagscorehstore_csv
typecorestringThe type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
uidcorestringOutput only. The system-generated UUID4 for this Database.
update_timecoretimestampOutput only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
version_retention_periodcorestringOutput only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.
zone_idcorestring