firebase-admin.firestore package

API خارجی صادر مجدد

APIهای تعریف شده خارجی زیر برای راحتی از این نقطه ورودی ماژول دوباره صادر می شوند.

سمبل شرح
BulkWriter BulkWriter را از بسته @google-cloud/firestore تایپ کنید.
AggregateField AggregateField را از بسته @google-cloud/firestore تایپ کنید.
BulkWriterOptions BulkWriterOptions از بسته @google-cloud/firestore تایپ کنید.
BundleBuilder BundleBuilder را از بسته @google-cloud/firestore تایپ کنید.
CollectionGroup CollectionGroup را از بسته @google-cloud/firestore تایپ کنید.
مرجع مجموعه نوع CollectionReference از بسته @google-cloud/firestore .
تغییر سند نوع DocumentChange از بسته @google-cloud/firestore .
DocumentData 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 تایپ کنید.
QueryPartition QueryPartition را از بسته @google-cloud/firestore تایپ کنید.
QuerySnapshot QuerySnapshot را از بسته @google-cloud/firestore تایپ کنید.
ReadOptions ReadOptions از بسته @google-cloud/firestore تایپ کنید.
SetOptions SetOptions را از بسته @google-cloud/firestore تایپ کنید.
مهر زمان نوع Timestamp از بسته @google-cloud/firestore .
معامله نوع Transaction از بسته @google-cloud/firestore .
WriteBatch WriteBatch از بسته @google-cloud/firestore تایپ کنید.
Write Result WriteResult را از بسته @google-cloud/firestore تایپ کنید.
setLogFunction تابع setLogFunction از بسته @google-cloud/firestore .

Cloud Firestore.

کارکرد

تابع شرح
getFirestore() سرویس Firestore پیش‌فرض را برای برنامه پیش‌فرض دریافت می‌کند.
getFirestore (برنامه) سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند.
getFirestore (شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه پیش فرض دریافت می کند.
getFirestore (برنامه، شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند.
InitializeFirestore (برنامه، تنظیمات) سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.
InitializeFirestore (برنامه، تنظیمات، شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

رابط ها

رابط شرح
تنظیمات Firestore تنظیمات برای انتقال به سازنده Firestore.

getFirestore()

سرویس Firestore پیش‌فرض را برای برنامه پیش‌فرض دریافت می‌کند.

امضا:

export declare function getFirestore(): Firestore;

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض برای برنامه پیش‌فرض.

مثال

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

getFirestore()

سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض مرتبط با برنامه ارائه‌شده.

مثال

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

getFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه پیش فرض دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore نامگذاری شده برای برنامه پیش فرض.

مثال

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

getFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore با نام مرتبط با برنامه ارائه شده.

مثال

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

InitializeFirestore()

سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
تنظیمات تنظیمات Firestore شی تنظیمات باید به سازنده منتقل شود.

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض مرتبط با برنامه و تنظیمات ارائه شده.

مثال

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

InitializeFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
تنظیمات تنظیمات Firestore شی تنظیمات باید به سازنده منتقل شود.
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore با نام مرتبط با برنامه و تنظیمات ارائه شده.

مثال

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

API خارجی صادر مجدد

APIهای تعریف شده خارجی زیر برای راحتی از این نقطه ورودی ماژول دوباره صادر می شوند.

سمبل شرح
BulkWriter BulkWriter را از بسته @google-cloud/firestore تایپ کنید.
AggregateField AggregateField را از بسته @google-cloud/firestore تایپ کنید.
BulkWriterOptions BulkWriterOptions از بسته @google-cloud/firestore تایپ کنید.
BundleBuilder BundleBuilder را از بسته @google-cloud/firestore تایپ کنید.
CollectionGroup CollectionGroup را از بسته @google-cloud/firestore تایپ کنید.
مرجع مجموعه نوع CollectionReference از بسته @google-cloud/firestore .
تغییر سند نوع DocumentChange از بسته @google-cloud/firestore .
DocumentData 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 تایپ کنید.
QueryPartition QueryPartition را از بسته @google-cloud/firestore تایپ کنید.
QuerySnapshot QuerySnapshot را از بسته @google-cloud/firestore تایپ کنید.
ReadOptions ReadOptions از بسته @google-cloud/firestore تایپ کنید.
SetOptions SetOptions را از بسته @google-cloud/firestore تایپ کنید.
مهر زمان نوع Timestamp از بسته @google-cloud/firestore .
معامله نوع Transaction از بسته @google-cloud/firestore .
WriteBatch WriteBatch از بسته @google-cloud/firestore تایپ کنید.
Write Result WriteResult را از بسته @google-cloud/firestore تایپ کنید.
setLogFunction تابع setLogFunction از بسته @google-cloud/firestore .

Cloud Firestore.

کارکرد

تابع شرح
getFirestore() سرویس Firestore پیش‌فرض را برای برنامه پیش‌فرض دریافت می‌کند.
getFirestore (برنامه) سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند.
getFirestore (شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه پیش فرض دریافت می کند.
getFirestore (برنامه، شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند.
InitializeFirestore (برنامه، تنظیمات) سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.
InitializeFirestore (برنامه، تنظیمات، شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

رابط ها

رابط شرح
تنظیمات Firestore تنظیمات برای انتقال به سازنده Firestore.

getFirestore()

سرویس Firestore پیش‌فرض را برای برنامه پیش‌فرض دریافت می‌کند.

امضا:

export declare function getFirestore(): Firestore;

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض برای برنامه پیش‌فرض.

مثال

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

getFirestore()

سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض مرتبط با برنامه ارائه‌شده.

مثال

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

getFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه پیش فرض دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore نامگذاری شده برای برنامه پیش فرض.

مثال

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

getFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore با نام مرتبط با برنامه ارائه شده.

مثال

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

InitializeFirestore()

سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
تنظیمات تنظیمات Firestore شی تنظیمات باید به سازنده منتقل شود.

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض مرتبط با برنامه و تنظیمات ارائه شده.

مثال

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

InitializeFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
تنظیمات تنظیمات Firestore شی تنظیمات باید به سازنده منتقل شود.
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore با نام مرتبط با برنامه و تنظیمات ارائه شده.

مثال

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

API خارجی صادر مجدد

APIهای تعریف شده خارجی زیر برای راحتی از این نقطه ورودی ماژول دوباره صادر می شوند.

سمبل شرح
BulkWriter BulkWriter را از بسته @google-cloud/firestore تایپ کنید.
AggregateField AggregateField را از بسته @google-cloud/firestore تایپ کنید.
BulkWriterOptions BulkWriterOptions از بسته @google-cloud/firestore تایپ کنید.
BundleBuilder BundleBuilder را از بسته @google-cloud/firestore تایپ کنید.
CollectionGroup CollectionGroup را از بسته @google-cloud/firestore تایپ کنید.
مرجع مجموعه نوع CollectionReference از بسته @google-cloud/firestore .
تغییر سند نوع DocumentChange از بسته @google-cloud/firestore .
DocumentData 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 تایپ کنید.
QueryPartition QueryPartition را از بسته @google-cloud/firestore تایپ کنید.
QuerySnapshot QuerySnapshot را از بسته @google-cloud/firestore تایپ کنید.
ReadOptions ReadOptions از بسته @google-cloud/firestore تایپ کنید.
SetOptions SetOptions را از بسته @google-cloud/firestore تایپ کنید.
مهر زمان نوع Timestamp از بسته @google-cloud/firestore .
معامله نوع Transaction از بسته @google-cloud/firestore .
WriteBatch WriteBatch از بسته @google-cloud/firestore تایپ کنید.
Write Result WriteResult را از بسته @google-cloud/firestore تایپ کنید.
setLogFunction تابع setLogFunction از بسته @google-cloud/firestore .

Cloud Firestore.

کارکرد

تابع شرح
getFirestore() سرویس Firestore پیش‌فرض را برای برنامه پیش‌فرض دریافت می‌کند.
getFirestore (برنامه) سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند.
getFirestore (شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه پیش فرض دریافت می کند.
getFirestore (برنامه، شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند.
InitializeFirestore (برنامه، تنظیمات) سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.
InitializeFirestore (برنامه، تنظیمات، شناسه پایگاه داده) (BETA) سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

رابط ها

رابط شرح
تنظیمات Firestore تنظیمات برای انتقال به سازنده Firestore.

getFirestore()

سرویس Firestore پیش‌فرض را برای برنامه پیش‌فرض دریافت می‌کند.

امضا:

export declare function getFirestore(): Firestore;

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض برای برنامه پیش‌فرض.

مثال

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

getFirestore()

سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض مرتبط با برنامه ارائه‌شده.

مثال

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

getFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه پیش فرض دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore نامگذاری شده برای برنامه پیش فرض.

مثال

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

getFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore با نام مرتبط با برنامه ارائه شده.

مثال

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

InitializeFirestore()

سرویس Firestore پیش فرض را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
تنظیمات تنظیمات Firestore شی تنظیمات باید به سازنده منتقل شود.

برمی گرداند:

آتش نشانی

سرویس Firestore پیش‌فرض مرتبط با برنامه و تنظیمات ارائه شده.

مثال

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

InitializeFirestore()

این API به عنوان یک پیش نمایش برای توسعه دهندگان ارائه شده است و ممکن است بر اساس بازخوردی که دریافت می کنیم تغییر کند. از این API در محیط تولید استفاده نکنید.

سرویس Firestore نامگذاری شده را برای برنامه داده شده دریافت می کند و پارامترهای اضافی را به سازنده آن ارسال می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه برنامه کدام سرویس Firestore را برگرداند.
تنظیمات تنظیمات Firestore شیء تنظیمات باید به سازنده منتقل شود.
شناسه پایگاه داده رشته نام پایگاه داده برای بازگشت

برمی گرداند:

آتش نشانی

سرویس Firestore با نام مرتبط با برنامه و تنظیمات ارائه شده.

مثال

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