REST Resource: projects.databases

Risorsa: database

Un database Cloud Firestore.

Rappresentazione 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
}
Campi
name

string

Il nome della risorsa del database. Formato: projects/{project}/databases/{database}
uid

string

Solo output. L'UUID4 generato dal sistema per questo database.
createTime

string (Timestamp format)

Solo output. Il timestamp in cui è stato creato il database. I database creati prima del 2016 non popolano createTime.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Solo output. Il timestamp in cui il database è stato aggiornato più di recente. Tieni presente che sono inclusi solo gli aggiornamenti della risorsa di database e non i dati contenuti dal database.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
locationId

string

La posizione del database. Le località disponibili sono elencate all'indirizzo https://cloud.google.com/firestore/docs/locations.
type

enum (DatabaseType)

Il tipo di database. Consulta https://cloud.google.com/datastore/docs/firestore-or-datastore per informazioni su come scegliere.
concurrencyMode

enum (ConcurrencyMode)

La modalità di controllo della contemporaneità da utilizzare per questo database.
versionRetentionPeriod

string (Duration format)

Solo output. Il periodo durante il quale le versioni precedenti dei dati vengono conservate nel database.

Qualsiasi read o query può specificare un readTime all'interno di questa finestra e leggerà lo stato del database in quel momento.

Se la funzionalità PITR è abilitata, il periodo di conservazione è di 7 giorni. In caso contrario, il periodo di conservazione è di 1 ora.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
earliestVersionTime

string (Timestamp format)

Solo output. Il timestamp più recente in cui è possibile leggere dal database le versioni precedenti dei dati. Vedi [versionFidelizzazionePeriod] in alto. Questo campo viene compilato con il valore now - versionRetentionPeriod.

Questo valore viene aggiornato continuamente e diventa inattivo nel momento in cui viene eseguita la query. Se utilizzi questo valore per recuperare i dati, assicurati di tenere conto del tempo compreso tra il momento in cui viene eseguita la query sul valore e quello in cui avvii il recupero.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Indica se abilitare la funzionalità PITR in questo database.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

La modalità di integrazione di App Engine da utilizzare per questo database.
keyPrefix

string

Solo output. Il prefisso per questo database. Questo prefisso viene utilizzato, in combinazione con l'ID progetto ("~") per creare l'ID applicazione restituito dalle API Cloud Datastore nei runtime di prima generazione di Google App Engine.

Questo valore può essere vuoto. In questo caso l'appid da utilizzare per le chiavi con codifica URL è projectId (ad esempio: foo anziché v~foo).
deleteProtectionState

enum (DeleteProtectionState)

Stato della protezione da eliminazione per il database.
etag

string

Questo checksum viene calcolato dal server in base al valore di altri campi e può essere inviato in caso di richieste di aggiornamento ed eliminazione per garantire che il client abbia un valore aggiornato prima di procedere.

DatabaseType

Il tipo di database. Consulta https://cloud.google.com/datastore/docs/firestore-or-datastore per informazioni su come scegliere.

Le modifiche alla modalità sono consentite solo se il database è vuoto.

Enum
DATABASE_TYPE_UNSPECIFIED Il valore predefinito. Questo valore viene utilizzato se il tipo di database viene omesso.
FIRESTORE_NATIVE Modalità Native Firestore
DATASTORE_MODE Firestore in modalità Datastore.

ConcurrencyMode

Il tipo di modalità di controllo della contemporaneità per le transazioni.

Enum
CONCURRENCY_MODE_UNSPECIFIED Non utilizzato.
OPTIMISTIC Utilizza il controllo ottimistico della contemporaneità per impostazione predefinita. Questa modalità è disponibile per i database Cloud Firestore.
PESSIMISTIC

Utilizza il controllo della contemporaneità pessimistica per impostazione predefinita. Questa modalità è disponibile per i database Cloud Firestore.

Questa è l'impostazione predefinita per Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Utilizza il controllo ottimistico della contemporaneità con i gruppi di entità per impostazione predefinita.

Questa è l'unica modalità disponibile per Cloud Datastore.

Questa modalità è disponibile anche per Cloud Firestore con la modalità Datastore, ma non è consigliata.

PointInTimeRecoveryEnablement

Attivazione della funzionalità di recupero point-in-time.

Enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Non utilizzato.
POINT_IN_TIME_RECOVERY_ENABLED

Le letture sono supportate su versioni selezionate dei dati degli ultimi 7 giorni:

  • Legge in base a qualsiasi timestamp dell'ultima ora
  • Lettura in base a istantanee di 1 minuto per oltre 1 ora ed entro 7 giorni

Per determinare le versioni supportate puoi utilizzare versionRetentionPeriod e earliestVersionTime.
POINT_IN_TIME_RECOVERY_DISABLED Le letture sono supportate su qualsiasi versione dei dati entro l'ultima ora.

AppEngineIntegrationMode

Il tipo di modalità di integrazione di App Engine.

Enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Non utilizzato.
ENABLED Se un'applicazione App Engine esiste nella stessa regione di questo database, la configurazione di App Engine influirà su questo database. Ciò include la disattivazione dell'applicazione e del database e la disabilitazione delle scritture sul database.
DISABLED

App Engine non influisce sulla capacità di questo database di gestire le richieste.

Questa è l'impostazione predefinita per i database creati con l'API Firestore.

DeleteProtectionState

Lo stato della protezione Elimina del database.

Enum
DELETE_PROTECTION_STATE_UNSPECIFIED Il valore predefinito. Il tipo di protezione Elimina non è specificato
DELETE_PROTECTION_DISABLED L'eliminazione della protezione è disabilitata
DELETE_PROTECTION_ENABLED L'eliminazione della protezione è abilitata

Metodi

create

 Creare un database.

delete

 Elimina un database.

exportDocuments

 Esporta una copia di tutti i documenti o di un sottoinsieme di documenti da Google Cloud Firestore a un altro sistema di archiviazione, come Google Cloud Storage.

get

 Recupera le informazioni su un database.

importDocuments

 Importa i documenti in Google Cloud Firestore.

list

 Elenca tutti i database nel progetto.

patch

 Aggiorna un database.

restore

 Crea un nuovo database ripristinando un backup esistente.