---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_firestore_database{% #gcp_firestore_database %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `app_engine_integration_mode`{% #app_engine_integration_mode %}

**Type**: `STRING`**Provider name**: `appEngineIntegrationMode`**Description**: The App Engine integration mode to use for this database.**Possible values**:

- `APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED` - Not used.
- `ENABLED` - If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.
- `DISABLED` - App Engine has no effect on the ability of this database to serve requests. This is the default setting for databases created with the Firestore API.

## `cmek_config`{% #cmek_config %}

**Type**: `STRUCT`**Provider name**: `cmekConfig`**Description**: Optional. Presence indicates CMEK is enabled for this database.

- `active_key_version`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `activeKeyVersion`**Description**: Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
- `kms_key_name`**Type**: `STRING`**Provider name**: `kmsKeyName`**Description**: Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See [https://cloud.google.com/kms/docs/locations](https://cloud.google.com/kms/docs/locations). The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

## `concurrency_mode`{% #concurrency_mode %}

**Type**: `STRING`**Provider name**: `concurrencyMode`**Description**: The concurrency control mode to use for this database.**Possible values**:

- `CONCURRENCY_MODE_UNSPECIFIED` - Not used.
- `OPTIMISTIC` - Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.
- `PESSIMISTIC` - Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.
- `OPTIMISTIC_WITH_ENTITY_GROUPS` - Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended.

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.

## `delete_protection_state`{% #delete_protection_state %}

**Type**: `STRING`**Provider name**: `deleteProtectionState`**Description**: State of delete protection for the database.**Possible values**:

- `DELETE_PROTECTION_STATE_UNSPECIFIED` - The default value. Delete protection type is not specified
- `DELETE_PROTECTION_DISABLED` - Delete protection is disabled
- `DELETE_PROTECTION_ENABLED` - Delete protection is enabled

## `delete_time`{% #delete_time %}

**Type**: `TIMESTAMP`**Provider name**: `deleteTime`**Description**: Output only. The timestamp at which this database was deleted. Only set if the database has been deleted.

## `earliest_version_time`{% #earliest_version_time %}

**Type**: `TIMESTAMP`**Provider name**: `earliestVersionTime`**Description**: Output 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.

## `etag`{% #etag %}

**Type**: `STRING`**Provider name**: `etag`**Description**: This 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_prefix`{% #key_prefix %}

**Type**: `STRING`**Provider name**: `keyPrefix`**Description**: Output 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 vfoo).

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `location_id`{% #location_id %}

**Type**: `STRING`**Provider name**: `locationId`**Description**: The location of the database. Available locations are listed at [https://cloud.google.com/firestore/docs/locations](https://cloud.google.com/firestore/docs/locations).

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: The resource name of the Database. Format: `projects/{project}/databases/{database}`

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `point_in_time_recovery_enablement`{% #point_in_time_recovery_enablement %}

**Type**: `STRING`**Provider name**: `pointInTimeRecoveryEnablement`**Description**: Whether to enable the PITR feature on this database.**Possible values**:

- `POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED` - Not used.
- `POINT_IN_TIME_RECOVERY_ENABLED` - Reads are supported on selected versions of the data from within the past 7 days: * Reads against any timestamp within the past hour * Reads against 1-minute snapshots beyond 1 hour and within 7 days `version_retention_period` and `earliest_version_time` can be used to determine the supported versions.
- `POINT_IN_TIME_RECOVERY_DISABLED` - Reads are supported on any version of the data from within the past 1 hour.

## `previous_id`{% #previous_id %}

**Type**: `STRING`**Provider name**: `previousId`**Description**: Output only. The database resource's prior database ID. This field is only populated for deleted databases.

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `source_info`{% #source_info %}

**Type**: `STRUCT`**Provider name**: `sourceInfo`**Description**: Output only. Information about the provenance of this database.

- `backup`**Type**: `STRUCT`**Provider name**: `backup`**Description**: If set, this database was restored from the specified backup (or a snapshot thereof).
  - `backup`**Type**: `STRING`**Provider name**: `backup`**Description**: The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`.
- `operation`**Type**: `STRING`**Provider name**: `operation`**Description**: The associated long-running operation. This field may not be set after the operation has completed. Format: `projects/{project}/databases/{database}/operations/{operation}`.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `type`{% #type %}

**Type**: `STRING`**Provider name**: `type`**Description**: The type of the database. See [https://cloud.google.com/datastore/docs/firestore-or-datastore](https://cloud.google.com/datastore/docs/firestore-or-datastore) for information about how to choose.**Possible values**:

- `DATABASE_TYPE_UNSPECIFIED` - Not used.
- `FIRESTORE_NATIVE` - Firestore Native Mode
- `DATASTORE_MODE` - Firestore in Datastore Mode.

## `uid`{% #uid %}

**Type**: `STRING`**Provider name**: `uid`**Description**: Output only. The system-generated UUID4 for this Database.

## `update_time`{% #update_time %}

**Type**: `TIMESTAMP`**Provider name**: `updateTime`**Description**: Output 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_period`{% #version_retention_period %}

**Type**: `STRING`**Provider name**: `versionRetentionPeriod`**Description**: Output 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_id`{% #zone_id %}

**Type**: `STRING`