REST Resource: projects.databases.documents

Ressource: Document

Ein Firestore-Dokument.

Darf 1 MiB bis 4 Byte nicht überschreiten.

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

string

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

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

Ein Objekt, das eine Liste von "key": value-Paaren 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 erhöht sich monoton, wenn ein Dokument gelöscht und dann neu erstellt wird. Er kann auch mit Werten aus anderen Dokumenten und dem readTime einer Abfrage verglichen werden.

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 Zeitpunkt, zu dem das Dokument zuletzt geändert wurde.

Dieser Wert wird anfangs auf createTime gesetzt und erhöht sich dann bei jeder Änderung am Dokument monoton. Er kann auch mit Werten aus anderen Dokumenten und dem readTime einer Abfrage verglichen werden.

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".

Methoden

batchGet

 Ruft mehrere Dokumente ab.

batchWrite

 Wendet einen Batch von Schreibvorgängen an.

beginTransaction

 Startet eine neue Transaktion.

commit

 Führt ein Commit einer Transaktion durch und aktualisiert optional Dokumente.

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.

listDocuments

 Listet Dokumente auf.

partitionQuery

 Partitioniert eine Abfrage durch Rückgabe von Partitions-Cursorn, mit denen die Abfrage parallel ausgeführt werden kann.

patch

 Aktualisiert oder fügt ein Dokument ein.

rollback

 Führt ein Rollback einer Transaktion durch.

runAggregationQuery

 Führt eine Aggregationsabfrage aus.

runQuery

 Führt eine Abfrage aus.