Method: projects.databases.documents.list

แสดงรายการเอกสาร

คำขอ HTTP

GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}

URL ใช้ไวยากรณ์ การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ที่จำเป็น. ชื่อทรัพยากรหลัก ในรูปแบบ: projects/{projectId}/databases/{databaseId}/documents หรือ projects/{projectId}/databases/{databaseId}/documents/{document_path}

ตัวอย่างเช่น: projects/my-project/databases/my-database/documents หรือ projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

collectionId

string

ไม่จำเป็น. รหัสคอลเลกชันที่เกี่ยวข้องกับ parent ที่จะแสดงรายการ

เช่น chatrooms หรือ messages

นี่เป็นทางเลือก และเมื่อไม่ได้ระบุไว้ Firestore จะแสดงรายการเอกสารจากคอลเล็กชันทั้งหมดภายใต้ parent ที่ให้ไว้

พารามิเตอร์แบบสอบถาม

พารามิเตอร์
pageSize

integer

ไม่จำเป็น. จำนวนเอกสารสูงสุดที่จะส่งคืนในการตอบกลับครั้งเดียว

Firestore อาจส่งคืนน้อยกว่าค่านี้

pageToken

string

ไม่จำเป็น. โทเค็นหน้า ได้รับจากการตอบกลับ documents.list ก่อนหน้า

ระบุข้อมูลนี้เพื่อดึงข้อมูลหน้าถัดไป เมื่อแบ่งหน้า พารามิเตอร์อื่นๆ ทั้งหมด (ยกเว้น pageSize ) จะต้องตรงกับค่าที่ตั้งไว้ในคำขอที่สร้างโทเค็นหน้า

orderBy

string

ไม่จำเป็น. ทางเลือกในการสั่งเอกสารเพื่อส่งคืน

ตัวอย่างเช่น: priority desc, __name__ desc

สิ่งนี้จะสะท้อน ORDER BY ที่ใช้ในแบบสอบถาม Firestore แต่ในการแสดงสตริง เมื่อไม่อยู่ เอกสารจะถูกจัดเรียงตาม __name__ ASC

mask

object ( DocumentMask )

ไม่จำเป็น. ฟิลด์ที่จะส่งคืน หากไม่ได้ตั้งค่า จะส่งคืนทุกช่อง

หากเอกสารมีช่องที่ไม่อยู่ในรูปแบบนี้ ช่องนั้นจะไม่ถูกส่งคืนในการตอบกลับ

showMissing

boolean

หากรายการควรแสดงเอกสารที่ขาดหายไป

เอกสารหายไปหากไม่มีอยู่ แต่มีเอกสารย่อยซ้อนอยู่ข้างใต้ เมื่อเป็นจริง เอกสารที่หายไปดังกล่าวจะถูกส่งกลับพร้อมกับคีย์ แต่จะไม่มีฟิลด์ ชุด createTime หรือชุด updateTime

คำขอที่มี showMissing อาจไม่ได้ระบุ where หรือ orderBy

พารามิเตอร์ยูเนี่ยน consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่าไว้ จะมีค่าเริ่มต้นเป็นความสอดคล้องสูง consistency_selector สามารถเป็นได้เพียงอย่างใดอย่างหนึ่งต่อไปนี้:
transaction

string ( bytes format)

ดำเนินการอ่านโดยเป็นส่วนหนึ่งของธุรกรรมที่ใช้งานอยู่แล้ว

สตริงที่เข้ารหัส base64

readTime

string ( Timestamp format)

ดำเนินการอ่านตามเวลาที่กำหนด

นี่จะต้องเป็นการประทับเวลาที่แม่นยำระดับไมโครวินาทีภายในหนึ่งชั่วโมงที่ผ่านมา หรือหากเปิดใช้งานการกู้คืนช่วงเวลา ก็สามารถประทับเวลาเพิ่มเติมเป็นนาทีภายใน 7 วันที่ผ่านมาได้

การประทับเวลาในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและเศษส่วนสูงสุดเก้าหลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

ขอร่างกาย

เนื้อความของคำขอจะต้องว่างเปล่า

ร่างกายตอบสนอง

หากสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ของ ListDocumentsResponse

ขอบเขตการอนุญาต

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

สำหรับข้อมูลเพิ่มเติม โปรดดู ภาพรวมการตรวจสอบสิทธิ์