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, zum Beispiel 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. Es kann auch mit Werten aus anderen Dokumenten und der readTime einer Abfrage verglichen werden.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format 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 zunächst auf createTime festgelegt und erhöht sich dann monoton mit jeder Änderung am Dokument. Es kann auch mit Werten aus anderen Dokumenten und der readTime einer Abfrage verglichen werden.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format 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 Stapel von Schreibvorgängen an.

beginTransaction

Startet eine neue Transaktion.

commit

Übernimmt eine Transaktion 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, indem Partitionscursor zurückgegeben werden, die zum parallelen Ausführen der Abfrage verwendet werden können.

patch

Aktualisiert oder fügt ein Dokument ein.

rollback

Setzt eine Transaktion zurück.

runAggregationQuery

Führt eine Aggregationsabfrage aus.

runQuery

Führt eine Abfrage aus.