REST Resource: projects.databases.documents

Zasób: Document

Dokument Firestore.

Maksymalny rozmiar to 1 MiB–4 bajty.

Zapis JSON
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Pola
name

string

Nazwa zasobu dokumentu, na przykład projects/{projectId}/databases/{databaseId}/documents/{document_path}.

fields

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

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia dokumentu.

Ta wartość zwiększa się monotonicznie, gdy dokument jest usuwany, a następnie odtworzony. Można je też porównywać z wartościami z innych dokumentów i elementem readTime zapytania.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej modyfikacji dokumentu.

Początkowo ta wartość jest ustawiona na createTime, a następnie monotonicznie zwiększa się z każdą zmianą w dokumencie. Można je też porównywać z wartościami z innych dokumentów i elementem readTime zapytania.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Metody

batchGet

Pobiera wiele dokumentów.

batchWrite

Stosuje grupę operacji zapisu.

beginTransaction

rozpoczyna nową transakcję;

commit

Potwierdza transakcję i opcjonalnie aktualizują dokumenty.

createDocument

Tworzy nowy dokument.

delete

Usuwa dokument.

get

Pobiera jeden dokument.

list

Wyświetla listę dokumentów.

listCollectionIds

Zawiera listę wszystkich identyfikatorów kolekcji pod dokumentem.

listDocuments

Wyświetla listę dokumentów.

partitionQuery

Partycjonuje zapytanie, zwracając kursory partycji, których można używać do równoległego uruchamiania zapytania.

patch

Aktualizuje lub wstawia dokument.

rollback

Wycofuje transakcję.

runAggregationQuery

Uruchamia zapytanie agregacji.

runQuery

Uruchamia zapytanie.