Save the date - Google I/O returns May 18-20. Register to get the most out of the digital experience: Build your schedule, reserve space, participate in Q&As, earn Google Developer profile badges, and more. Register now
Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

REST Resource: projects.databases.documents

Ressource: Dokument

Ein Firestore-Dokument.

Darf 1 MiB - 4 Bytes nicht überschreiten.

JSON-Darstellung
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Felder
name

string

Der Ressourcenname des Dokuments, z. B. projects/{project_id}/databases/{databaseId}/documents/{document_path} .

fields

map (key: string, value: object ( Value ))

Die Felder des Dokuments.

Die Kartenschlüssel repräsentieren Feldnamen.

Ein einfacher Feldname enthält nur die Zeichen a bis z , A bis Z , 0 bis 9 oder _ und darf nicht mit 0 bis 9 . Zum Beispiel foo_bar_17 .

Feldnamen, die dem regulären Ausdruck __.*__ sind reserviert. Reservierte Feldnamen sind außer in bestimmten dokumentierten Kontexten verboten. Die als UTF-8 dargestellten Zuordnungsschlüssel dürfen 1.500 Byte nicht überschreiten und dürfen nicht leer sein.

Feldpfade können in anderen Kontexten verwendet werden, um auf hier definierte strukturierte Felder zu verweisen. Bei mapValue wird der mapValue durch die einfachen oder in Anführungszeichen gesetzten Feldnamen der enthaltenen Felder dargestellt, die durch begrenzt sind . . Beispielsweise würde das strukturierte Feld "foo" : { mapValue: { "x&y" : { stringValue: "hello" }}} durch den foo.x&y .

Innerhalb eines Feldpfads beginnt und endet ein in Anführungszeichen stehender Feldname mit ` und kann ein beliebiges Zeichen enthalten. Einige Zeichen, einschließlich ` , müssen mit einem \ ` werden. Zum Beispiel steht `x&y` für x&y und `bak\`tik` für " bak`tik .

Ein Objekt, das eine Liste von "key": value Wertepaaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem das Dokument erstellt wurde.

Dieser Wert steigt monoton an, wenn ein Dokument gelöscht und dann neu erstellt wird. Es kann auch mit Werten aus anderen Dokumenten und der readTime einer Abfrage verglichen werden.

Ein Zeitstempel im RFC3339 UTC "Zulu" -Format mit einer Auflösung von Nanosekunden und bis zu neun Bruchstellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem das Dokument zuletzt geändert wurde.

Dieser Wert wird zunächst auf createTime gesetzt und createTime dann mit jeder Änderung am Dokument monoton an. Es kann auch mit Werten aus anderen Dokumenten und der readTime einer Abfrage verglichen werden.

Ein Zeitstempel im RFC3339 UTC "Zulu" -Format mit einer Auflösung von Nanosekunden und bis zu neun Bruchstellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

Methoden

batchGet

Ruft mehrere Dokumente ab.

batchWrite

Wendet eine Reihe von Schreibvorgängen an.

beginTransaction

Startet eine neue Transaktion.

commit

Übernimmt eine Transaktion, während Dokumente optional aktualisiert werden.

createDocument

Erstellt ein neues Dokument.

delete

Löscht ein Dokument.

get

Ruft ein einzelnes Dokument ab.

list

Listet Dokumente auf.

listCollectionIds

Listet alle Sammlungs-IDs unter einem Dokument auf.

partitionQuery

Partitioniert eine Abfrage, indem Partitionscursor zurückgegeben werden, mit denen die Abfrage parallel ausgeführt werden kann.

patch

Aktualisiert oder fügt ein Dokument ein.

rollback

Rollt eine Transaktion zurück.

runQuery

Führt eine Abfrage aus.