REST Resource: projects.databases.documents

Referensi: Dokumen

Dokumen Firestore.

Tidak boleh melebihi 1 MiB - 4 byte.

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

string

Nama resource dokumen, misalnya projects/{projectId}/databases/{databaseId}/documents/{document_path}.

fields

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

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Hanya output. Waktu saat dokumen dibuat.

Nilai ini meningkat secara monoton saat dokumen dihapus lalu dibuat ulang. Nilai ini juga dapat dibandingkan dengan nilai dari dokumen lain dan readTime kueri.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Hanya output. Waktu saat dokumen terakhir diubah.

Nilai ini awalnya ditetapkan ke createTime, lalu meningkat secara monoton dengan setiap perubahan pada dokumen. Nilai ini juga dapat dibandingkan dengan nilai dari dokumen lain dan readTime kueri.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Metode

batchGet

Mendapatkan beberapa dokumen.

batchWrite

Menerapkan sekumpulan operasi tulis.

beginTransaction

Memulai transaksi baru.

commit

Melakukan transaksi, sekaligus memperbarui dokumen secara opsional.

createDocument

Membuat dokumen baru.

delete

Menghapus dokumen.

get

Mendapatkan satu dokumen.

list

Mencantumkan dokumen.

listCollectionIds

Mencantumkan semua ID koleksi di bawah dokumen.

listDocuments

Mencantumkan dokumen.

partitionQuery

Mempartisi kueri dengan menampilkan kursor partisi yang dapat digunakan untuk menjalankan kueri secara paralel.

patch

Memperbarui atau menyisipkan dokumen.

rollback

Me-roll back transaksi.

runAggregationQuery

Menjalankan kueri agregasi.

runQuery

Menjalankan kueri.