firebase-admin.firestore package

बाहरी एपीआई फिर से एक्सपोर्ट करें

सुविधा के लिए, इस मॉड्यूल एंट्री पॉइंट से बाहर से तय किए गए नीचे दिए गए एपीआई फिर से एक्सपोर्ट किए जाते हैं.

चिह्न ब्यौरा
bulkराइटर @google-cloud/firestore पैकेज से BulkWriter टाइप.
एग्रीगेट फ़ील्ड @google-cloud/firestore पैकेज से AggregateField टाइप.
bulkWriterOptions @google-cloud/firestore पैकेज से BulkWriterOptions टाइप.
bundleBuilder @google-cloud/firestore पैकेज से BundleBuilder टाइप.
कलेक्शन ग्रुप @google-cloud/firestore पैकेज से CollectionGroup टाइप.
कलेक्शन रेफ़रंस @google-cloud/firestore पैकेज से CollectionReference टाइप.
दस्तावेज़ में बदलाव @google-cloud/firestore पैकेज से DocumentChange टाइप.
दस्तावेज़ डेटा @google-cloud/firestore पैकेज से DocumentData टाइप.
DocumentReference @google-cloud/firestore पैकेज से DocumentReference टाइप.
DocumentSnapशॉट @google-cloud/firestore पैकेज से DocumentSnapshot टाइप.
फ़ील्डपाथ @google-cloud/firestore पैकेज से FieldPath टाइप.
FieldValue @google-cloud/firestore पैकेज से FieldValue टाइप.
फ़िल्टर करना @google-cloud/firestore पैकेज से Filter टाइप.
फ़ायरस्टोर @google-cloud/firestore पैकेज से Firestore टाइप.
FirestoreDataConverter @google-cloud/firestore पैकेज से FirestoreDataConverter टाइप.
GeoPoint @google-cloud/firestore पैकेज से GeoPoint टाइप.
GrpcStatus @google-cloud/firestore पैकेज से GrpcStatus टाइप.
पहले से तय की गई शर्त @google-cloud/firestore पैकेज से Precondition टाइप.
क्वेरी @google-cloud/firestore पैकेज से Query टाइप.
QueryDocumentSnapshot @google-cloud/firestore पैकेज से QueryDocumentSnapshot टाइप.
QueryPartition @google-cloud/firestore पैकेज से QueryPartition टाइप.
QuerySnapshot @google-cloud/firestore पैकेज से QuerySnapshot टाइप.
रीडविकल्प @google-cloud/firestore पैकेज से ReadOptions टाइप.
सेटविकल्प @google-cloud/firestore पैकेज से SetOptions टाइप.
टाइमस्टैंप @google-cloud/firestore पैकेज से Timestamp टाइप.
लेन-देन @google-cloud/firestore पैकेज से Transaction टाइप.
लिखने के लिए बैच @google-cloud/firestore पैकेज से WriteBatch टाइप.
लिखने का नतीजा @google-cloud/firestore पैकेज से WriteResult टाइप.
setLogFunction @google-cloud/firestore पैकेज से setLogFunction फ़ंक्शन.

Cloud Firestore.

फ़ंक्शन

फ़ंक्शन ब्यौरा
getFirestore() इसे डिफ़ॉल्ट ऐप्लिकेशन के लिए डिफ़ॉल्ट Firestore सेवा मिलती है.
getFirestore(ऐप्लिकेशन) इसे दिए गए ऐप्लिकेशन के लिए डिफ़ॉल्ट Firestore सेवा मिलती है.
getFirestore(databaseId) (बीटा) को डिफ़ॉल्ट ऐप्लिकेशन के लिए, Firestore नाम की सेवा मिलती है.
getFirestore(ऐप्लिकेशन, डेटाबेस आईडी) (बीटा वर्शन) इसमें दिए गए ऐप्लिकेशन के लिए, Firestore नाम की सेवा मिलती है.
beginFirestore(ऐप्लिकेशन, सेटिंग) यह दिए गए ऐप्लिकेशन के लिए डिफ़ॉल्ट Firestore सेवा लेती है और इसके कंस्ट्रक्टर के लिए अतिरिक्त पैरामीटर पास करती है.
beginFirestore(ऐप्लिकेशन, सेटिंग, डेटाबेस आईडी) (बीटा) ऐप्लिकेशन के कंस्ट्रक्टर को अतिरिक्त पैरामीटर पास करते हुए, दिए गए ऐप्लिकेशन के लिए Firestore नाम की सेवा देता है.

इंटरफ़ेस

इंटरफ़ेस ब्यौरा
Firestore की सेटिंग Firestore कंस्ट्रक्टर को पास करने की सेटिंग.

getFirestore()

इसे डिफ़ॉल्ट ऐप्लिकेशन के लिए डिफ़ॉल्ट Firestore सेवा मिलती है.

हस्ताक्षर:

export declare function getFirestore(): Firestore;

लौटाए जाने वाले प्रॉडक्ट:

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

दिए गए ऐप्लिकेशन से जुड़ी डिफ़ॉल्ट Firestore सेवा.

उदाहरण

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

getFirestore(databaseId)

यह एपीआई, डेवलपर को झलक के तौर पर दिया गया है. साथ ही, हमें मिलने वाले सुझाव के आधार पर इसमें बदलाव हो सकता है. इस एपीआई का इस्तेमाल प्रोडक्शन एनवायरमेंट में न करें.

डिफ़ॉल्ट ऐप्लिकेशन के लिए, नाम की Firestore सेवा मिलती है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
डेटाबेस आईडी स्ट्रिंग वापस किए जाने वाले डेटाबेस का नाम.

लौटाए जाने वाले प्रॉडक्ट:

Firestore

डिफ़ॉल्ट ऐप्लिकेशन के लिए, नाम की Firestore सेवा.

उदाहरण

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

getFirestore(ऐप्लिकेशन, डेटाबेस आईडी)

यह एपीआई, डेवलपर को झलक के तौर पर दिया गया है. साथ ही, हमें मिलने वाले सुझाव के आधार पर इसमें बदलाव हो सकता है. इस एपीआई का इस्तेमाल प्रोडक्शन एनवायरमेंट में न करें.

दिए गए ऐप्लिकेशन के लिए, नाम की Firestore सेवा मिलती है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
ऐप्लिकेशन ऐप्लिकेशन किस Firestore सेवा का इस्तेमाल करना है.
डेटाबेस आईडी स्ट्रिंग वापस किए जाने वाले डेटाबेस का नाम.

लौटाए जाने वाले प्रॉडक्ट:

Firestore

दिए गए ऐप्लिकेशन से जुड़ी, नाम की Firestore सेवा.

उदाहरण

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

EarlyizeFirestore(ऐप्लिकेशन, सेटिंग)

यह दिए गए ऐप्लिकेशन के लिए डिफ़ॉल्ट Firestore सेवा लेती है और इसके कंस्ट्रक्टर के लिए अतिरिक्त पैरामीटर पास करती है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
ऐप्लिकेशन ऐप्लिकेशन किस Firestore सेवा का इस्तेमाल करना है.
सेटिंग Firestore की सेटिंग कंस्ट्रक्टर को पास किया जाने वाला सेटिंग ऑब्जेक्ट.

लौटाए जाने वाले प्रॉडक्ट:

Firestore

दिए गए ऐप्लिकेशन और सेटिंग से जुड़ी डिफ़ॉल्ट Firestore सेवा.

उदाहरण

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

EarlyizeFirestore(ऐप्लिकेशन, सेटिंग, डेटाबेस आईडी)

यह एपीआई, डेवलपर को झलक के तौर पर दिया गया है. साथ ही, हमें मिलने वाले सुझाव के आधार पर इसमें बदलाव हो सकता है. इस एपीआई का इस्तेमाल प्रोडक्शन एनवायरमेंट में न करें.

यह ऐप्लिकेशन, इसके कंस्ट्रक्टर को अतिरिक्त पैरामीटर पास करते हुए, दिए गए ऐप्लिकेशन के लिए Firestore सेवा नाम की सुविधा देता है.

हस्ताक्षर:

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

पैरामीटर

पैरामीटर टाइप ब्यौरा
ऐप्लिकेशन ऐप्लिकेशन किस 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');