CollectionReference ऑब्जेक्ट का इस्तेमाल, दस्तावेज़ जोड़ने, दस्तावेज़ के रेफ़रंस पाने, और दस्तावेज़ों के लिए क्वेरी करने के लिए किया जा सकता है. इसके लिए, query() का इस्तेमाल किया जा सकता है.
हस्ताक्षर:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
एक्सट्रैक्ट करता है: क्वेरी<AppModelType, DbModelType>
प्रॉपर्टी
| प्रॉपर्टी | मॉडिफ़ायर | टाइप | ब्यौरा |
|---|---|---|---|
| id | स्ट्रिंग | कलेक्शन का आइडेंटिफ़ायर. | |
| माता-पिता | DocumentReference<DocumentData, DocumentData> | शून्य | अगर यह एक सब-कलेक्शन है, तो इसमें शामिल DocumentReference का रेफ़रंस. अगर यह सब-कलेक्शन नहीं है, तो रेफ़रंस शून्य होता है. |
|
| पाथ | स्ट्रिंग | बताए गए कलेक्शन के पाथ को दिखाने वाली स्ट्रिंग (डेटाबेस के रूट के मुताबिक). | |
| टाइप | (घोषित नहीं किया गया) | इस Firestore रेफ़रंस का टाइप. |
तरीके
| तरीका | मॉडिफ़ायर | ब्यौरा |
|---|---|---|
| के साथ कन्वर्टर(कन्वर्टर) | इस CollectionReference में एक कस्टम डेटा कन्वर्टर लागू करता है, जिससे आपको Firestore के साथ अपने कस्टम मॉडल ऑब्जेक्ट का इस्तेमाल करने की अनुमति मिलती है. जब रिटर्न किए गए CollectionReference इंस्टेंस के साथ addDoc() को कॉल किया जाता है, तो दिया गया कन्वर्टर, NewDbModelType टाइप के Firestore डेटा और आपकी पसंद के मुताबिक टाइप NewAppModelType के बीच कन्वर्ट हो जाएगा. |
|
| के साथ कन्वर्टर(कन्वर्टर) | मौजूदा कन्वर्टर को हटाता है. |
संग्रह संदर्भ.आईडी
कलेक्शन का आइडेंटिफ़ायर.
हस्ताक्षर:
get id(): string;
संग्रह संदर्भ.पैरंट
अगर यह एक सब-कलेक्शन है, तो इसमें शामिल DocumentReference का रेफ़रंस. अगर यह सब-कलेक्शन नहीं है, तो रेफ़रंस शून्य होता है.
हस्ताक्षर:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
संग्रह संदर्भ.पथ
बताए गए कलेक्शन के पाथ को दिखाने वाली स्ट्रिंग (डेटाबेस के रूट के मुताबिक).
हस्ताक्षर:
get path(): string;
संग्रह संदर्भ.टाइप
इस Firestore रेफ़रंस का टाइप.
हस्ताक्षर:
readonly type = "collection";
संग्रह संदर्भ.के साथ कन्वर्टर()
इस CollectionReference में एक कस्टम डेटा कन्वर्टर लागू करता है, जिससे आपको Firestore के साथ अपनी पसंद के मॉडल ऑब्जेक्ट इस्तेमाल करने की अनुमति मिलती है. जब आप लौटाए गए CollectionReference इंस्टेंस के साथ addDoc() को कॉल करते हैं, तो दिया गया कन्वर्टर, NewDbModelType टाइप के Firestore डेटा और आपकी पसंद के मुताबिक टाइप NewAppModelType के बीच कन्वर्टर हो जाएगा.
हस्ताक्षर:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| ग्राहक के तौर पर बदलने वाला | FirestoreDataConverter<NewAppModelType, NewDbModelType> | यह ऑब्जेक्ट को Firestore में बदल देता है. साथ ही, इससे ऑब्जेक्ट को भी बदल देता है. |
लौटाए जाने वाले प्रॉडक्ट:
CollectionReference<NewAppModelType, NewDbModelType>
CollectionReference जो दिए गए कन्वर्टर का इस्तेमाल करता है.
संग्रह संदर्भ.के साथ कन्वर्टर()
मौजूदा कन्वर्टर को हटाता है.
हस्ताक्षर:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| ग्राहक के तौर पर बदलने वाला | शून्य | null, मौजूदा कन्वर्टर को हटा देता है. |
लौटाए जाने वाले प्रॉडक्ट:
CollectionReference<DocumentData, DocumentData>
ऐसा CollectionReference<DocumentData, DocumentData> जो कन्वर्टर का इस्तेमाल नहीं करता.