REST Resource: projects.databases.documents

Zasób: Document

Dokument Firestore.

Nie może przekraczać 1 MiB do 4 bajtów.

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. Godzina utworzenia dokumentu.

Ta wartość rośnie monotonicznie, gdy dokument zostanie usunięty, a następnie ponownie utworzony. Można ją też porównywać z wartościami z innych dokumentów i z readTime zapytania.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC 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. Godzina ostatniej modyfikacji dokumentu.

Początkowo ustawiana jest wartość createTime, a następnie rośnie monotonicznie z każdą zmianą w dokumencie. Można ją też porównywać z wartościami z innych dokumentów i z readTime zapytania.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC 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

 Zatwierdzanie transakcji i opcjonalne aktualizowanie dokumentów.

createDocument

 Tworzy nowy dokument.

delete

 Usuwa dokument.

get

 Pobiera pojedynczy dokument.

list

 Wyświetla listę dokumentów.

listCollectionIds

 Wyświetla listę wszystkich identyfikatorów kolekcji pod dokumentem.

listDocuments

 Wyświetla listę dokumentów.

partitionQuery

 Partycjonuje zapytanie przez zwrócenie kursorów partycji, których można używać do równoległego wykonywania zapytania.

patch

 Aktualizuje lub wstawia dokument.

rollback

 Wycofuje transakcję.

runAggregationQuery

 Uruchamia zapytanie agregacji.

runQuery

 Uruchamia zapytanie.