REST Resource: projects.databases.documents

แหล่งข้อมูล: เอกสาร

เอกสาร Firestore

ต้องไม่เกิน 1 MiB - 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 "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่เอกสารมีการเปลี่ยนแปลงล่าสุด

ค่านี้จะตั้งเป็น createTime ในตอนแรก จากนั้นจะเพิ่มขึ้นซ้ำๆ เมื่อมีการเปลี่ยนแปลงเอกสารแต่ละครั้ง และยังเปรียบเทียบค่าจากเอกสารอื่นๆ และ readTime ของการค้นหาได้ด้วย

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "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

 ทำการค้นหา