สามารถใช้ออบเจ็กต์ CollectionReference ในการเพิ่มเอกสาร รับการอ้างอิงเอกสาร และการสืบค้นเอกสาร (โดยใช้ query() ).
ลายเซ็น:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
ขยาย: แบบสอบถาม <AppModelType, DbModelType>
คุณสมบัติ
| คุณสมบัติ | ตัวดัดแปลง | พิมพ์ | คำอธิบาย |
|---|---|---|---|
| รหัส | เชือก | ตัวระบุของคอลเลกชัน | |
| พ่อแม่ | เอกสารอ้างอิง < เอกสารข้อมูล , เอกสารข้อมูล > | โมฆะ | การอ้างอิงถึง DocumentReference ที่มี ถ้านี่คือคอลเลกชันย่อย หากนี่ไม่ใช่คอลเลกชันย่อย การอ้างอิงจะเป็นโมฆะ | |
| เส้นทาง | เชือก | สตริงที่แสดงถึงเส้นทางของคอลเลกชันที่อ้างอิง (สัมพันธ์กับรากของฐานข้อมูล) | |
| พิมพ์ | (ไม่ได้ประกาศ) | ประเภทของการอ้างอิง Firestore นี้ |
วิธีการ
| วิธี | ตัวดัดแปลง | คำอธิบาย |
|---|---|---|
| ด้วยตัวแปลง(ตัวแปลง) | ใช้ตัวแปลงข้อมูลที่กำหนดเองกับ CollectionReference นี้ ซึ่งช่วยให้คุณใช้ออบเจ็กต์โมเดลที่คุณกำหนดเองกับ Firestore เมื่อคุณเรียก addDoc() ด้วยอินสแตนซ์ CollectionReference ที่ส่งคืน ตัวแปลงที่ให้มาจะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภทที่คุณกำหนดเอง NewAppModelType | |
| ด้วยตัวแปลง(ตัวแปลง) | ลบตัวแปลงปัจจุบัน |
คอลเลกชันReference.id
ตัวระบุของคอลเลกชัน
ลายเซ็น:
get id(): string;
CollectionReference.parent
การอ้างอิงถึง DocumentReference ที่มี ถ้านี่คือคอลเลกชันย่อย หากนี่ไม่ใช่คอลเลกชันย่อย การอ้างอิงจะเป็นโมฆะ
ลายเซ็น:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
สตริงที่แสดงถึงเส้นทางของคอลเลกชันที่อ้างอิง (สัมพันธ์กับรากของฐานข้อมูล)
ลายเซ็น:
get path(): string;
CollectionReference.type
ประเภทของการอ้างอิง Firestore นี้
ลายเซ็น:
readonly type = "collection";
CollectionReference.withConverter()
ใช้ตัวแปลงข้อมูลแบบกำหนดเองกับ CollectionReference นี้ ทำให้คุณสามารถใช้ออบเจ็กต์โมเดลที่คุณกำหนดเองกับ Firestore เมื่อคุณเรียก addDoc() ด้วยอินสแตนซ์ CollectionReference ที่ส่งคืน ตัวแปลงที่ให้มาจะแปลงระหว่างข้อมูล Firestore ประเภท NewDbModelType และประเภทที่คุณกำหนดเอง NewAppModelType .
ลายเซ็น:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวแปลง | FirestoreDataConverter <NewAppModelType, NewDbModelType> | แปลงวัตถุเข้าและออกจาก Firestore |
ผลตอบแทน:
คอลเลกชันอ้างอิง <NewAppModelType, NewDbModelType>
CollectionReference ที่ใช้ตัวแปลงที่ให้มา
CollectionReference.withConverter()
ลบตัวแปลงปัจจุบัน
ลายเซ็น:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| ตัวแปลง | โมฆะ | null ลบตัวแปลงปัจจุบัน |
ผลตอบแทน:
คอลเลกชันอ้างอิง < เอกสารข้อมูล , เอกสารข้อมูล >
CollectionReference<DocumentData, DocumentData> ที่ไม่ได้ใช้ตัวแปลง