Query
หมายถึงคำค้นหาที่คุณอ่านหรือฟังได้ นอกจากนี้ คุณยังสร้างออบเจ็กต์ Query
ที่ปรับแต่งเองได้โดยการเพิ่มตัวกรองและเรียงลำดับ
ลายเซ็น:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
ผู้ผลิต
ผู้ผลิต | คีย์ตัวปรับแต่ง | คำอธิบาย |
---|---|---|
(เครื่องมือสร้าง)() | สร้างอินสแตนซ์ใหม่ของคลาส Query |
พร็อพเพอร์ตี้
พร็อพเพอร์ตี้ | คีย์ตัวปรับแต่ง | ประเภท | คำอธิบาย |
---|---|---|---|
ตัวแปลงสัญญาณ | FirestoreDataConverter<AppModelType, DbModelType> | ค่าว่าง | หากระบุ FirestoreDataConverter ที่เชื่อมโยงกับอินสแตนซ์นี้ |
|
Firestore | Firestore | อินสแตนซ์ Firestore สำหรับฐานข้อมูล Firestore (มีประโยชน์สำหรับการทำธุรกรรม ฯลฯ) |
|
ประเภท | "query" | "collection" | ประเภทของการอ้างอิง Firestore นี้ |
เมธอด
วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
---|---|---|
withConverter(ตัวแปลง) | นำตัวแปลงปัจจุบันออก | |
withConverter(ตัวแปลง) | ใช้เครื่องมือแปลงข้อมูลที่กำหนดเองกับการค้นหานี้ซึ่งจะช่วยให้คุณใช้ออบเจ็กต์โมเดลที่กำหนดเองกับ Firestore ได้ เมื่อคุณเรียกใช้ getDocuments() ด้วยคำค้นหาที่แสดงผล ตัวแปลงที่มีให้จะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภท NewAppModelType ที่กำหนดเองของคุณ |
Query (เครื่องมือสร้าง)
สร้างอินสแตนซ์ใหม่ของคลาส Query
ลายเซ็น:
protected constructor();
Query.converter
หากระบุ FirestoreDataConverter
ที่เชื่อมโยงกับอินสแตนซ์นี้
ลายเซ็น:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Query.firestore
อินสแตนซ์ Firestore
สำหรับฐานข้อมูล Firestore (มีประโยชน์สำหรับการทำธุรกรรม ฯลฯ)
ลายเซ็น:
readonly firestore: Firestore;
Query.type
ประเภทของการอ้างอิง Firestore นี้
ลายเซ็น:
readonly type: 'query' | 'collection';
Query.withConverter()
นำตัวแปลงปัจจุบันออก
ลายเซ็น:
withConverter(converter: null): Query<DocumentData, DocumentData>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ผู้ทำ Conversion | Null | null นำตัวแปลงปัจจุบันออก |
การคืนสินค้า:
การค้นหา<DocumentData, DocumentData>
Query<DocumentData, DocumentData>
ที่ไม่ได้ใช้ตัวแปลง
Query.withConverter()
ใช้เครื่องมือแปลงข้อมูลที่กำหนดเองกับการค้นหานี้ซึ่งจะช่วยให้คุณใช้ออบเจ็กต์โมเดลที่กำหนดเองกับ Firestore ได้ เมื่อคุณเรียกใช้ getDocuments() ด้วยคำค้นหาที่แสดงผล ตัวแปลงที่มีให้จะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType
และประเภท NewAppModelType
ที่กำหนดเอง
ลายเซ็น:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ผู้ทำ Conversion | FirestoreDataConverter<NewAppModelType, NewDbModelType> | แปลงออบเจ็กต์เป็นและจาก Firestore |
การคืนสินค้า:
คำค้นหา<NewAppModelType, NewDbModelType>
Query
ที่ใช้ตัวแปลงที่ระบุ