REST Resource: projects.databases

Ressource : Database

Base de données Cloud Firestore

Représentation 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
}
Champs
name

string

Nom de ressource de la base de données. Format : projects/{project}/databases/{database}
uid

string

Uniquement en sortie. UUID4 généré par le système pour cette base de données.
createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la création de cette base de données. Les bases de données créées avant 2016 ne renseignent pas createTime.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de cette base de données. Notez que cela n'inclut que les mises à jour de la ressource de base de données, et non les données contenues dans la base de données.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
locationId

string

Emplacement de la base de données. La liste des emplacements disponibles est indiquée à l'adresse https://cloud.google.com/firestore/docs/locations.
type

enum (DatabaseType)

Type de base de données. Consultez https://cloud.google.com/datastore/docs/firestore-or-datastore pour savoir comment faire votre choix.
concurrencyMode

enum (ConcurrencyMode)

Mode de contrôle de simultanéité à utiliser pour cette base de données.
versionRetentionPeriod

string (Duration format)

Uniquement en sortie. Période pendant laquelle les versions antérieures des données sont conservées dans la base de données.

Tout read ou query peut spécifier un readTime dans cette fenêtre et lirea l'état de la base de données à ce moment-là.

Si la fonctionnalité PITR est activée, la période de conservation est de sept jours. Sinon, la durée de conservation est d'une heure.

Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par "s". Exemple: "3.5s".
earliestVersionTime

string (Timestamp format)

Uniquement en sortie. Horodatage le plus ancien auquel les anciennes versions des données peuvent être lues à partir de la base de données. Voir [versionConservationPeriod] ci-dessus. Ce champ est renseigné avec now - versionRetentionPeriod.

Cette valeur est mise à jour en continu et devient obsolète au moment de la requête. Si vous utilisez cette valeur pour récupérer des données, veillez à tenir compte du moment où la valeur est interrogée jusqu'au moment où vous lancez la récupération.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Activer ou non la fonctionnalité PITR sur cette base de données.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

Mode d'intégration App Engine à utiliser pour cette base de données.
keyPrefix

string

Uniquement en sortie. KeyPrefix pour cette base de données. Utilisé en combinaison avec l'ID de projet ("~"), l'ID d'application (keyPrefix) est utilisé pour la construction de l'ID application renvoyé par les API Cloud Datastore dans les environnements d'exécution de première génération Google App Engine.

Cette valeur peut être vide, auquel cas l'identifiant de l'application à utiliser pour les clés encodées au format URL est le projectId (par exemple, foo au lieu de v~foo).
deleteProtectionState

enum (DeleteProtectionState)

État de la protection contre la suppression pour la base de données.
etag

string

Cette somme de contrôle est calculée par le serveur en fonction de la valeur d'autres champs. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de poursuivre.

DatabaseType

Type de base de données. Consultez https://cloud.google.com/datastore/docs/firestore-or-datastore pour savoir comment faire votre choix.

Les changements de mode ne sont autorisés que si la base de données est vide.

Enums
DATABASE_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si le type de base de données est omis.
FIRESTORE_NATIVE Firestore en mode natif
DATASTORE_MODE Firestore en mode Datastore.

ConcurrencyMode

Type de mode de contrôle de simultanéité pour les transactions.

Enums
CONCURRENCY_MODE_UNSPECIFIED Non utilisé.
OPTIMISTIC Utilisez le contrôle de simultanéité optimiste par défaut. Ce mode est disponible pour les bases de données Cloud Firestore.
PESSIMISTIC

Utilisez un contrôle de simultanéité pessimiste par défaut. Ce mode est disponible pour les bases de données Cloud Firestore.

Il s'agit du paramètre par défaut pour Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Utilisez un contrôle de simultanéité optimiste avec les groupes d'entités par défaut.

Il s'agit du seul mode disponible pour Cloud Datastore.

Ce mode est également disponible pour Cloud Firestore en mode Datastore, mais il n'est pas recommandé.

PointInTimeRecoveryEnablement

Activation de la fonctionnalité de récupération à un moment précis.

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Non utilisé.
POINT_IN_TIME_RECOVERY_ENABLED

Les lectures sont prises en charge sur les versions sélectionnées des données au cours des sept derniers jours:

  • Lit en fonction de n'importe quel horodatage au cours de la dernière heure
  • Mesure des instantanés par rapport à des instantanés d'une minute au-delà d'une heure et dans les sept jours

versionRetentionPeriod et earliestVersionTime permettent de déterminer les versions compatibles.
POINT_IN_TIME_RECOVERY_DISABLED Les lectures sont possibles sur toutes les versions des données enregistrées au cours de la dernière heure.

AppEngineIntegrationMode

Type de mode d'intégration App Engine.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Non utilisé.
ENABLED Si une application App Engine existe dans la même région que cette base de données, la configuration d'App Engine aura une incidence sur cette base de données. Cela inclut la désactivation de l'application et de la base de données, ainsi que la désactivation des écritures dans la base de données.
DISABLED

App Engine n'a aucune incidence sur la capacité de cette base de données à traiter les requêtes.

Il s'agit du paramètre par défaut pour les bases de données créées avec l'API Firestore.

DeleteProtectionState

État de protection contre la suppression de la base de données.

Enums
DELETE_PROTECTION_STATE_UNSPECIFIED Valeur par défaut. Le type de protection contre la suppression n'est pas spécifié
DELETE_PROTECTION_DISABLED La protection contre la suppression est désactivée
DELETE_PROTECTION_ENABLED La protection contre la suppression est activée

Méthodes

create

 Créer une base de données

delete

 Supprime une base de données.

exportDocuments

 Exporte une copie de tout ou d'un sous-ensemble des documents de Google Cloud Firestore vers un autre système de stockage, tel que Google Cloud Storage.

get

 Récupère des informations sur une base de données.

importDocuments

 Importe des documents dans Google Cloud Firestore.

list

 Listez toutes les bases de données du projet.

patch

 Met à jour une base de données.

restore

 Crée une base de données en restaurant à partir d'une sauvegarde existante.