firebase-admin.firestore package

عمليات إعادة تصدير واجهة برمجة التطبيقات الخارجية

تتم إعادة تصدير واجهات برمجة التطبيقات التالية المحددة خارجيًا من نقطة دخول هذه الوحدة لتسهيل الأمر.

رمز الوصف
BulkWriter نوع BulkWriter من حزمة @google-cloud/firestore.
AggregateField نوع AggregateField من حزمة @google-cloud/firestore.
BulkWriterOptions نوع BulkWriterOptions من حزمة @google-cloud/firestore.
أداة إنشاء الحزم نوع BundleBuilder من حزمة @google-cloud/firestore.
CollectionGroup نوع CollectionGroup من حزمة @google-cloud/firestore.
مرجع المجموعة نوع CollectionReference من حزمة @google-cloud/firestore.
تغيير المستند نوع DocumentChange من حزمة @google-cloud/firestore.
بيانات المستند نوع DocumentData من حزمة @google-cloud/firestore.
مرجع المستندات نوع DocumentReference من حزمة @google-cloud/firestore.
نبذة عن المستند نوع DocumentSnapshot من حزمة @google-cloud/firestore.
FieldPath نوع FieldPath من حزمة @google-cloud/firestore.
FieldValue نوع FieldValue من حزمة @google-cloud/firestore.
فلترة نوع Filter من حزمة @google-cloud/firestore.
متجر إطفاء نوع Firestore من حزمة @google-cloud/firestore.
FirestoreDataConverter نوع FirestoreDataConverter من حزمة @google-cloud/firestore.
الموقع الجغرافي نوع GeoPoint من حزمة @google-cloud/firestore.
GrpcStatus نوع GrpcStatus من حزمة @google-cloud/firestore.
الشرط المسبَق نوع Precondition من حزمة @google-cloud/firestore.
طلب البحث نوع Query من حزمة @google-cloud/firestore.
QueryDocumentSnapshot نوع QueryDocumentSnapshot من حزمة @google-cloud/firestore.
QueryPerition نوع QueryPartition من حزمة @google-cloud/firestore.
نبذة عن طلب البحث نوع QuerySnapshot من حزمة @google-cloud/firestore.
خيارات القراءة نوع ReadOptions من حزمة @google-cloud/firestore.
SetOptions نوع SetOptions من حزمة @google-cloud/firestore.
الطابع الزمني نوع Timestamp من حزمة @google-cloud/firestore.
المعاملة نوع Transaction من حزمة @google-cloud/firestore.
WriteBatch نوع WriteBatch من حزمة @google-cloud/firestore.
كتابة النتيجة نوع WriteResult من حزمة @google-cloud/firestore.
setLogFunction setLogFunction من حزمة @google-cloud/firestore.

Cloud Firestore.

الوظائف

الوظيفة الوصف
getFirestore() يحصل على خدمة Firestore التلقائية للتطبيق التلقائي.
getFirestore(app) يحصل على خدمة Firestore التلقائية للتطبيق المعنيّ.
getFirestore(databaseId) (إصدار تجريبي) الحصول على خدمة Firestore المُسمّاة للتطبيق التلقائي
getFirestore(app, DatabaseId) (إصدار تجريبي) الحصول على خدمة Firestore المُسماة للتطبيق المحدَّد
preizeFirestore(التطبيقات, الإعدادات) يمكن الحصول على خدمة Firestore التلقائية للتطبيق المحدَّد، مع تمرير معلَمات إضافية إلى الدالة الإنشائية لهذا التطبيق.
ConfigureizeFirestore(app, settings, APIsId) (إصدار تجريبي) الحصول على خدمة Firestore المُسمّاة للتطبيق المحدد، مع تمرير معلمات إضافية إلى الدالة الإنشائية

الواجهات

الواجهة الوصف
FirestoreSettings الإعدادات المطلوب تمريرها إلى الدالة الإنشائية Firestore.

getFirestore()

يحصل على خدمة Firestore التلقائية للتطبيق التلقائي.

Signature:

export declare function getFirestore(): Firestore;

المرتجعات:

Firestore

خدمة Firestore التلقائية للتطبيق التلقائي.

مثال

// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();

getFirestore(app)

يحصل على خدمة Firestore التلقائية للتطبيق المعنيّ.

Signature:

export declare function getFirestore(app: App): Firestore;

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق خدمة "Firestore" المطلوب عرضها

المرتجعات:

Firestore

خدمة Firestore التلقائية المرتبطة بالتطبيق المقدَّم.

مثال

// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);

getFirestore(databaseId)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدِم واجهة برمجة التطبيقات هذه في بيئة إنتاج.

الحصول على خدمة Firestore المُسمّاة للتطبيق التلقائي

Signature:

export declare function getFirestore(databaseId: string): Firestore;

المَعلمات

المَعلمة Type الوصف
رقم تعريف قاعدة البيانات سلسلة اسم قاعدة البيانات المراد عرضها.

المرتجعات:

Firestore

الخدمة المسماة Firestore للتطبيق التلقائي.

مثال

// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');

getFirestore(app, DatabaseId)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدِم واجهة برمجة التطبيقات هذه في بيئة إنتاج.

الحصول على خدمة Firestore المُسمّاة للتطبيق المعنيّ

Signature:

export declare function getFirestore(app: App, databaseId: string): Firestore;

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق خدمة "Firestore" المطلوب عرضها
رقم تعريف قاعدة البيانات سلسلة اسم قاعدة البيانات المراد عرضها.

المرتجعات:

Firestore

خدمة Firestore المُسمّاة المرتبطة بالتطبيق المقدَّم.

مثال

// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');

originizeFirestore(app, settings)

يمكن الحصول على خدمة Firestore التلقائية للتطبيق المحدَّد، مع تمرير معلَمات إضافية إلى الدالة الإنشائية لهذا التطبيق.

Signature:

export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق خدمة "Firestore" المطلوب عرضها
إعدادات FirestoreSettings كائن الإعدادات المراد تمريره إلى الدالة الإنشائية.

المرتجعات:

Firestore

خدمة "Firestore" التلقائية المرتبطة بالتطبيق والإعدادات المقدَّمة

مثال

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});

originizeFirestore(app, settings, APIsId)

يتم توفير واجهة برمجة التطبيقات هذه كمعاينة للمطوّرين وقد تتغير استنادًا إلى الملاحظات التي نتلقّاها. لا تستخدِم واجهة برمجة التطبيقات هذه في بيئة إنتاج.

الحصول على خدمة Firestore المُسمّاة للتطبيق المحدَّد، مع تمرير مَعلَمات إضافية إلى الدالة الإنشائية

Signature:

export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;

المَعلمات

المَعلمة Type الوصف
التطبيق التطبيق خدمة "Firestore" المطلوب عرضها
إعدادات FirestoreSettings كائن الإعدادات المراد تمريره إلى الدالة الإنشائية.
رقم تعريف قاعدة البيانات سلسلة اسم قاعدة البيانات المراد عرضها.

المرتجعات:

Firestore

خدمة "Firestore" المسماة المرتبطة بالتطبيق والإعدادات المقدَّمة

مثال

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');