يمكن استخدام كائن 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 . | |
مع محول (محول) | يزيل المحول الحالي. |
CollectionReference.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>
الذي لا يستخدم محولاً.