REST Resource: projects.databases

Recurso: Base de datos

Una base de datos de Cloud Firestore.

Representación JSON
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "etag": string
}
Campos
name

string

El nombre del recurso de la base de datos. Formato: projects/{project}/databases/{database}

uid

string

Sólo salida. El UUID4 generado por el sistema para esta base de datos.

createTime

string ( Timestamp format)

Sólo salida. La marca de tiempo en la que se creó esta base de datos. Las bases de datos creadas antes de 2016 no completan createTime.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Sólo salida. La marca de tiempo en la que se actualizó esta base de datos por última vez. Tenga en cuenta que esto solo incluye actualizaciones del recurso de la base de datos y no los datos contenidos en la base de datos.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

locationId

string

La ubicación de la base de datos. Las ubicaciones disponibles se enumeran en https://cloud.google.com/firestore/docs/locations .

type

enum ( DatabaseType )

El tipo de base de datos. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obtener información sobre cómo elegir.

concurrencyMode

enum ( ConcurrencyMode )

El modo de control de simultaneidad que se utilizará para esta base de datos.

versionRetentionPeriod

string ( Duration format)

Sólo salida. El período durante el cual se conservan en la base de datos las versiones anteriores de los datos.

Cualquier read o query puede especificar un readTime dentro de esta ventana y leerá el estado de la base de datos en ese momento.

Si la función PITR está habilitada, el período de retención es de 7 días. En caso contrario, el periodo de retención es de 1 hora.

Una duración en segundos con hasta nueve dígitos fraccionarios, que termina en ' s '. Ejemplo: "3.5s" .

earliestVersionTime

string ( Timestamp format)

Sólo salida. La marca de tiempo más temprana en la que se pueden leer versiones anteriores de los datos de la base de datos. Consulte [versionRetentionPeriod] arriba; este campo se completa con now - versionRetentionPeriod .

Este valor se actualiza continuamente y queda obsoleto en el momento en que se consulta. Si está utilizando este valor para recuperar datos, asegúrese de tener en cuenta el tiempo desde el momento en que se consulta el valor hasta el momento en que inicia la recuperación.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

pointInTimeRecoveryEnablement

enum ( PointInTimeRecoveryEnablement )

Si se debe habilitar la función PITR en esta base de datos.

appEngineIntegrationMode

enum ( AppEngineIntegrationMode )

El modo de integración de App Engine que se utilizará para esta base de datos.

keyPrefix

string

Sólo salida. El keyPrefix para esta base de datos. Este keyPrefix se utiliza en combinación con la identificación del proyecto (" ~ ") para construir la identificación de la aplicación que se devuelve desde las API de Cloud Datastore en los tiempos de ejecución de primera generación de Google App Engine.

Este valor puede estar vacío, en cuyo caso el appid que se utilizará para las claves codificadas en URL es el projectId (por ejemplo: foo en lugar de v~foo).

deleteProtectionState

enum ( DeleteProtectionState )

Estado de protección contra eliminación de la base de datos.

etag

string

El servidor calcula esta suma de verificación en función del valor de otros campos y puede enviarse en solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar.

Tipo de base de datos

El tipo de base de datos. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obtener información sobre cómo elegir.

Los cambios de modo sólo se permiten si la base de datos está vacía.

Enumeraciones
DATABASE_TYPE_UNSPECIFIED El valor predeterminado. Este valor se utiliza si se omite el tipo de base de datos.
FIRESTORE_NATIVE Modo nativo de Firestore
DATASTORE_MODE Firestore en modo almacén de datos.

Modo de simultaneidad

El tipo de modo de control de simultaneidad para transacciones.

Enumeraciones
CONCURRENCY_MODE_UNSPECIFIED No utilizado.
OPTIMISTIC Utilice el control de concurrencia optimista de forma predeterminada. Este modo está disponible para las bases de datos de Cloud Firestore.
PESSIMISTIC

Utilice el control de concurrencia pesimista de forma predeterminada. Este modo está disponible para las bases de datos de Cloud Firestore.

Esta es la configuración predeterminada para Cloud Firestore.

OPTIMISTIC_WITH_ENTITY_GROUPS

Utilice el control de simultaneidad optimista con grupos de entidades de forma predeterminada.

Este es el único modo disponible para Cloud Datastore.

Este modo también está disponible para Cloud Firestore con modo Datastore, pero no se recomienda.

Habilitación de recuperación de PointInTime

Habilitación de la función de recuperación puntual.

Enumeraciones
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED No utilizado.
POINT_IN_TIME_RECOVERY_ENABLED

Se admiten lecturas en versiones seleccionadas de los datos de los últimos 7 días:

  • Lee contra cualquier marca de tiempo dentro de la última hora
  • Lee en instantáneas de 1 minuto más allá de 1 hora y dentro de 7 días

versionRetentionPeriod y earliestVersionTime se pueden utilizar para determinar las versiones admitidas.

POINT_IN_TIME_RECOVERY_DISABLED Las lecturas se admiten en cualquier versión de los datos de la última hora.

Modo de integración de App Engine

El tipo de modo de integración de App Engine.

Enumeraciones
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED No utilizado.
ENABLED Si existe una aplicación de App Engine en la misma región que esta base de datos, la configuración de App Engine afectará esta base de datos. Esto incluye la desactivación de la aplicación y la base de datos, así como la desactivación de las escrituras en la base de datos.
DISABLED

App Engine no tiene ningún efecto sobre la capacidad de esta base de datos para atender solicitudes.

Esta es la configuración predeterminada para las bases de datos creadas con la API de Firestore.

Eliminar estado de protección

El estado de protección contra eliminación de la base de datos.

Enumeraciones
DELETE_PROTECTION_STATE_UNSPECIFIED El valor predeterminado. El tipo de protección contra eliminación no está especificado
DELETE_PROTECTION_DISABLED La protección contra eliminación está deshabilitada
DELETE_PROTECTION_ENABLED La protección contra eliminación está habilitada

Métodos

create

Crea una base de datos.

delete

Elimina una base de datos.

exportDocuments

Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage.

get

Obtiene información sobre una base de datos.

importDocuments

Importa documentos a Google Cloud Firestore.

list

Enumere todas las bases de datos del proyecto.

patch

Actualiza una base de datos.

restore

Crea una nueva base de datos restaurando desde una copia de seguridad existente.