REST Resource: projects.databases.documents

Ресурс: Документ

Документ Firestore.

Не должен превышать 1 МБ — 4 байта.

JSON-представление 
{
  "name": string,
  "fields": {
    string: {
      object (Value)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Поля
name

string

Имя ресурса документа, например projects/{projectId}/databases/{databaseId}/documents/{document_path} .

fields

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

Только вывод. Время создания документа.

Это значение монотонно увеличивается, когда документ удаляется, а затем создается заново. Его также можно сравнить со значениями из других документов и readTime запроса.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Только вывод. Время последнего изменения документа.

Первоначально для этого значения установлено createTime а затем монотонно увеличивается с каждым изменением документа. Его также можно сравнить со значениями из других документов и readTime запроса.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

Методы

batchGet

 Получает несколько документов.

batchWrite

 Применяет пакет операций записи.

beginTransaction

 Начинает новую транзакцию.

commit

 Фиксирует транзакцию, при необходимости обновляя документы.

createDocument

 Создает новый документ.

delete

 Удаляет документ.

get

 Получает один документ.

list

 Перечисляет документы.

listCollectionIds

 Перечисляет все идентификаторы коллекций под документом.

listDocuments

 Перечисляет документы.

partitionQuery

 Разделяет запрос, возвращая курсоры разделов, которые можно использовать для параллельного выполнения запроса.

patch

 Обновляет или вставляет документ.

rollback

 Откатывает транзакцию.

runAggregationQuery

 Запускает запрос агрегирования.

runQuery

 Выполняет запрос.