किसी लेन-देन का रेफ़रंस.
ट्रांज़ैक्शन के updateFunction को पास किया गया Transaction ऑब्जेक्ट, ट्रांज़ैक्शन के कॉन्टेक्स्ट में डेटा को देखने और उसमें बदलाव करने के तरीके उपलब्ध कराता है. runलेन-देन() देखें.
हस्ताक्षर:
export declare class Transaction
तरीके
| तरीका | मॉडिफ़ायर | ब्यौरा |
|---|---|---|
| मिटाएं(documentRef) | दिए गए DocumentReference से रेफ़र किया गया दस्तावेज़ मिटाता है. | |
| get(documentRef) | दिए गए DocumentReference में बताए गए दस्तावेज़ को पढ़ता है. | |
| set(documentRef, डेटा) | दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में लिखा जाता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा. | |
| set(documentRef, डेटा, विकल्प) | दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में लिखा जाता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा. merge या mergeFields उपलब्ध कराने पर, दिए गए डेटा को किसी मौजूदा दस्तावेज़ में मर्ज किया जा सकता है. |
|
| update(documentRef, डेटा) | दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है, तो अपडेट पूरा नहीं होगा. | |
| update(documentRef, फ़ील्ड, वैल्यू, moreFieldsAndValues) | दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है, तो अपडेट नहीं हो पाएगा.डॉट से अलग किए गए फ़ील्ड पाथ की स्ट्रिंग देकर या FieldPath ऑब्जेक्ट देकर, नेस्ट किए गए फ़ील्ड अपडेट किए जा सकते हैं. |
Transaction.delete()
दिए गए DocumentReference से रेफ़र किया गया दस्तावेज़ मिटाता है.
हस्ताक्षर:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| दस्तावेज़ रेफ़रंस | DocumentReference<AppModelType, DbModelType> | मिटाए जाने वाले दस्तावेज़ का रेफ़रंस. |
लौटाए जाने वाले प्रॉडक्ट:
यह
यह Transaction इंस्टेंस. इसका इस्तेमाल कॉल चेन करने के लिए किया जाता है.
Transaction.get()
दिए गए DocumentReference में बताए गए दस्तावेज़ को पढ़ता है.
हस्ताक्षर:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| दस्तावेज़ रेफ़रंस | DocumentReference<AppModelType, DbModelType> | पढ़ने के लिए दस्तावेज़ का रेफ़रंस. |
लौटाए जाने वाले प्रॉडक्ट:
प्रॉमिस<DocumentSnapshot<AppModelType, DbModelType>>
पढ़े गए डेटा के साथ DocumentSnapshot.
transaction.set()
दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में लिखा जाता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा.
हस्ताक्षर:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| दस्तावेज़ रेफ़रंस | DocumentReference<AppModelType, DbModelType> | सेट किए जाने वाले दस्तावेज़ का रेफ़रंस. |
| डेटा | WithFieldValue<AppModelType> | दस्तावेज़ के लिए, फ़ील्ड और वैल्यू का ऑब्जेक्ट. |
लौटाए जाने वाले प्रॉडक्ट:
यह
यह Transaction इंस्टेंस. इसका इस्तेमाल कॉल चेन करने के लिए किया जाता है.
अपवाद
गड़बड़ी - अगर दिया गया इनपुट मान्य Firestore दस्तावेज़ नहीं है.
transaction.set()
दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में लिखा जाता है. अगर दस्तावेज़ अब तक मौजूद नहीं है, तो इसे बना दिया जाएगा. merge या mergeFields देने पर, दिए गए डेटा को किसी मौजूदा दस्तावेज़ में मर्ज किया जा सकता है.
हस्ताक्षर:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| दस्तावेज़ रेफ़रंस | DocumentReference<AppModelType, DbModelType> | सेट किए जाने वाले दस्तावेज़ का रेफ़रंस. |
| डेटा | PartialWithFieldValue<AppModelType> | दस्तावेज़ के लिए, फ़ील्ड और वैल्यू का ऑब्जेक्ट. |
| विकल्प | SetOptions | सेट किए गए व्यवहार को कॉन्फ़िगर करने के लिए ऑब्जेक्ट. |
लौटाए जाने वाले प्रॉडक्ट:
यह
यह Transaction इंस्टेंस. इसका इस्तेमाल कॉल चेन करने के लिए किया जाता है.
अपवाद
गड़बड़ी - अगर दिया गया इनपुट मान्य Firestore दस्तावेज़ नहीं है.
Transaction.update()
दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है, तो अपडेट पूरा नहीं होगा.
हस्ताक्षर:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| दस्तावेज़ रेफ़रंस | DocumentReference<AppModelType, DbModelType> | अपडेट किए जाने वाले दस्तावेज़ का रेफ़रंस. |
| डेटा | UpdateData<DbModelType> | एक ऑब्जेक्ट, जिसमें वे फ़ील्ड और वैल्यू हैं जिनकी मदद से दस्तावेज़ को अपडेट किया जाना है. फ़ील्ड में दस्तावेज़ में नेस्ट किए गए फ़ील्ड का रेफ़रंस देने के लिए बिंदु हो सकते हैं. |
लौटाए जाने वाले प्रॉडक्ट:
यह
यह Transaction इंस्टेंस. इसका इस्तेमाल कॉल चेन करने के लिए किया जाता है.
अपवाद
गड़बड़ी - अगर दिया गया इनपुट मान्य नहीं है.
Transaction.update()
दिए गए DocumentReference से, रेफ़र किए गए दस्तावेज़ में फ़ील्ड अपडेट करता है. अगर किसी ऐसे दस्तावेज़ पर लागू किया जाता है जो मौजूद नहीं है, तो अपडेट पूरा नहीं होगा.
बिंदु से अलग किए गए फ़ील्ड पाथ की स्ट्रिंग देकर या FieldPath ऑब्जेक्ट देकर, नेस्ट किए गए फ़ील्ड को अपडेट किया जा सकता है.
हस्ताक्षर:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| दस्तावेज़ रेफ़रंस | DocumentReference<AppModelType, DbModelType> | अपडेट किए जाने वाले दस्तावेज़ का रेफ़रंस. |
| फ़ील्ड | स्ट्रिंग | FieldPath | अपडेट किया जाने वाला पहला फ़ील्ड. |
| value | अज्ञात | पहली वैल्यू. |
| ज़्यादा फ़ील्ड और वैल्यू | अज्ञात[] | अतिरिक्त कुंजी/वैल्यू पेयर. |
लौटाए जाने वाले प्रॉडक्ट:
यह
यह Transaction इंस्टेंस. इसका इस्तेमाल कॉल चेन करने के लिए किया जाता है.
अपवाद
गड़बड़ी - अगर दिया गया इनपुट मान्य नहीं है.