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