REST Resource: projects.databases

Ressource: Datenbank

Eine Cloud Firestore-Datenbank.

JSON-Darstellung
{
  "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
}
Felder
name

string

Der Ressourcenname der Datenbank. Format: projects/{project}/databases/{database}

uid

string

Nur Ausgabe Die vom System generierte UUID4 für diese Datenbank.

createTime

string (Timestamp format)

Nur Ausgabe Der Zeitstempel, zu dem diese Datenbank erstellt wurde. Datenbanken, die vor 2016 erstellt wurden, werden nicht in createTime aufgenommen.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Nur Ausgabe Der Zeitstempel, zu dem diese Datenbank zuletzt aktualisiert wurde. Dies gilt nur für Aktualisierungen der Datenbankressource und nicht für Daten, die in der Datenbank enthalten sind.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

locationId

string

Der Speicherort der Datenbank. Verfügbare Standorte sind unter https://cloud.google.com/firestore/docs/locations aufgeführt.

type

enum (DatabaseType)

Der Typ der Datenbank. Informationen zur Auswahl finden Sie unter https://cloud.google.com/datastore/docs/firestore-or-datastore.

concurrencyMode

enum (ConcurrencyMode)

Der für diese Datenbank zu verwendende Nebenläufigkeitsmodus.

versionRetentionPeriod

string (Duration format)

Nur Ausgabe Der Zeitraum, in dem frühere Versionen von Daten in der Datenbank aufbewahrt werden.

Jeder read oder query kann einen readTime in diesem Fenster angeben und liest zu diesem Zeitpunkt den Status der Datenbank.

Wenn die PITR-Funktion aktiviert ist, beträgt die Aufbewahrungsdauer 7 Tage. Andernfalls beträgt die Aufbewahrungsdauer 1 Stunde.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

earliestVersionTime

string (Timestamp format)

Nur Ausgabe Der früheste Zeitstempel, zu dem ältere Versionen der Daten aus der Datenbank gelesen werden können. Siehe [versionRetentionPeriod] oben. Dieses Feld enthält now - versionRetentionPeriod.

Dieser Wert wird kontinuierlich aktualisiert und verfällt, sobald er abgefragt wird. Wenn Sie diesen Wert zur Wiederherstellung von Daten verwenden, müssen Sie die Zeit in dem Moment berücksichtigen, in dem der Wert abgefragt wird, bis zu dem Zeitpunkt, an dem Sie die Wiederherstellung initiieren.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Gibt an, ob die PITR-Funktion für diese Datenbank aktiviert wird.

appEngineIntegrationMode

enum (AppEngineIntegrationMode)

Der App Engine-Integrationsmodus, der für diese Datenbank verwendet werden soll.

keyPrefix

string

Nur Ausgabe Das keyPräfix für diese Datenbank. Dieses keyPräfix wird zusammen mit der Projekt-ID ("~") verwendet, um die Anwendungs-ID zu erstellen, die von den Cloud Datastore APIs in Laufzeiten der ersten Generation von Google App Engine zurückgegeben wird.

Dieser Wert kann leer sein. In diesem Fall ist die für URL-codierte Schlüssel zu verwendende appid die Projekt-ID (z. B. foo statt v~foo).

deleteProtectionState

enum (DeleteProtectionState)

Status des Löschschutzes für die Datenbank.

etag

string

Diese Prüfsumme wird vom Server basierend auf dem Wert anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren über einen aktuellen Wert verfügt.

DatabaseType

Der Typ der Datenbank. Informationen zur Auswahl finden Sie unter https://cloud.google.com/datastore/docs/firestore-or-datastore.

Modusänderungen sind nur zulässig, wenn die Datenbank leer ist.

Enums
DATABASE_TYPE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Datenbanktyp weggelassen wird.
FIRESTORE_NATIVE Nativer Firestore-Modus
DATASTORE_MODE Firestore im Datastore-Modus

ConcurrencyMode

Der Typ des Nebenläufigkeitskontrollmodus für Transaktionen.

Enums
CONCURRENCY_MODE_UNSPECIFIED Nicht verwendet.
OPTIMISTIC Verwenden Sie standardmäßig eine optimistische Gleichzeitigkeitserkennung. Dieser Modus ist für Cloud Firestore-Datenbanken verfügbar.
PESSIMISTIC

Verwenden Sie standardmäßig die pessimistische Gleichzeitigkeitserkennung. Dieser Modus ist für Cloud Firestore-Datenbanken verfügbar.

Dies ist die Standardeinstellung für Cloud Firestore.

OPTIMISTIC_WITH_ENTITY_GROUPS

Verwenden Sie standardmäßig optimistische Gleichzeitigkeitserkennung mit Entitätsgruppen.

Dies ist der einzige verfügbare Modus für Cloud Datastore.

Dieser Modus ist auch für Cloud Firestore mit Datastore-Modus verfügbar, wird aber nicht empfohlen.

PointInTimeRecoveryEnablement

Aktivierung der Funktion zur Wiederherstellung zu einem bestimmten Zeitpunkt.

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Nicht verwendet.
POINT_IN_TIME_RECOVERY_ENABLED

Lesevorgänge werden für ausgewählte Versionen der Daten der letzten 7 Tage unterstützt:

  • Liest aus einem beliebigen Zeitstempel innerhalb der letzten Stunde
  • Liest aus 1-minütigen Snapshots mehr als eine Stunde und innerhalb von 7 Tagen

Mit versionRetentionPeriod und earliestVersionTime können Sie die unterstützten Versionen ermitteln.

POINT_IN_TIME_RECOVERY_DISABLED Lesevorgänge werden für jede Version der Daten innerhalb der letzten Stunde unterstützt.

AppEngineIntegrationMode

Der Typ des App Engine-Integrationsmodus.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Nicht verwendet.
ENABLED Wenn eine App Engine-Anwendung in derselben Region wie diese Datenbank vorhanden ist, wirkt sich die App Engine-Konfiguration auf diese Datenbank aus. Dazu gehört das Deaktivieren der Anwendung und Datenbank sowie das Deaktivieren von Schreibvorgängen in die Datenbank.
DISABLED

App Engine hat keine Auswirkungen auf die Fähigkeit dieser Datenbank, Anfragen zu verarbeiten.

Dies ist die Standardeinstellung für Datenbanken, die mit der Firestore API erstellt wurden.

DeleteProtectionState

Der Löschschutzstatus der Datenbank.

Enums
DELETE_PROTECTION_STATE_UNSPECIFIED Der Standardwert. Löschschutztyp ist nicht angegeben
DELETE_PROTECTION_DISABLED Löschschutz ist deaktiviert
DELETE_PROTECTION_ENABLED Löschschutz ist aktiviert

Methoden

create

Datenbank erstellen

delete

Löscht eine Datenbank.

exportDocuments

Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage.

get

Ruft Informationen zu einer Datenbank ab.

importDocuments

Importiert Dokumente in Google Cloud Firestore.

list

Alle Datenbanken im Projekt auflisten.

patch

Aktualisiert eine Datenbank.

restore

Erstellt eine neue Datenbank durch Wiederherstellung aus einer vorhandenen Sicherung.