Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

REST Resource: projects.databases.documents

Sumber daya: Dokumen

Dokumen Firestore.

Tidak boleh melebihi 1 MiB - 4 byte.

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

string

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

fields

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

Bidang dokumen.

Kunci peta mewakili nama bidang.

Nama kolom sederhana hanya berisi karakter a hingga z , A hingga Z , 0 hingga 9 , atau _ , dan tidak boleh dimulai dengan 0 hingga 9 . Misalnya, foo_bar_17 .

Nama bidang yang cocok dengan ekspresi reguler __.*__ sudah dipesan. Nama bidang yang dicadangkan dilarang kecuali dalam konteks terdokumentasi tertentu. Kunci peta, direpresentasikan sebagai UTF-8, tidak boleh melebihi 1.500 byte dan tidak boleh kosong.

Jalur bidang dapat digunakan dalam konteks lain untuk merujuk ke bidang terstruktur yang ditentukan di sini. Untuk mapValue , jalur bidang diwakili oleh nama bidang sederhana atau dikutip dari bidang penampung, dipisahkan oleh . . Misalnya, bidang terstruktur "foo" : { mapValue: { "x&y" : { stringValue: "hello" }}} akan diwakili oleh jalur bidang foo.x&y .

Dalam jalur bidang, nama bidang yang dikutip dimulai dan diakhiri dengan ` dan mungkin berisi karakter apa pun. Beberapa karakter, termasuk ` , harus di-escape menggunakan \ . Misalnya, `x&y` melambangkan x&y `bak\`tik` melambangkan bak`tik .

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

createTime

string ( Timestamp format)

Output saja. Waktu pembuatan dokumen.

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

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

updateTime

string ( Timestamp format)

Output saja. Waktu terakhir kali dokumen diubah.

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

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

Metode

batchGet

Mendapat banyak dokumen.

batchWrite

Menerapkan sekumpulan operasi tulis.

beginTransaction

Memulai transaksi baru.

commit

Melakukan transaksi, sambil memperbarui dokumen secara opsional.

createDocument

Membuat dokumen baru.

delete

Menghapus dokumen.

get

Mendapat satu dokumen.

list

Mendaftar dokumen.

listCollectionIds

Mencantumkan semua ID koleksi di bawah dokumen.

partitionQuery

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

patch

Memperbarui atau menyisipkan dokumen.

rollback

Mengembalikan transaksi.

runQuery

Menjalankan kueri.