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

 เรียกใช้การค้นหา