डेटा बचाने के तरीके |
|
|---|---|
| PUT | तय किए गए पाथ पर डेटा लिखना या बदलना, जैसे कि fireblog/users/user1/<data> |
| PATCH | पूरे डेटा को बदले बिना, तय किए गए पाथ के लिए कुछ कुंजियों को अपडेट करना. |
| पोस्ट करें | हमारे Firebase डेटाबेस में डेटा की सूची में जोड़ना. जब भी हम POST अनुरोध भेजते हैं, तब Firebase क्लाइंट एक यूनीक कुंजी जनरेट करता है, जैसे कि fireblog/users/<unique-id>/<data> |
| हटाएं | तय किए गए Firebase डेटाबेस रेफ़रंस से डेटा हटाएं. |
PUT के साथ डेटा लिखना
REST API की मदद से, डेटा लिखने की बुनियादी कार्रवाई PUT है. डेटा सेव करने का तरीका दिखाने के लिए, हम पोस्ट और उपयोगकर्ताओं के साथ एक ब्लॉगिंग ऐप्लिकेशन बनाएंगे. हमारे ऐप्लिकेशन का सारा डेटा, Firebase डेटाबेस यूआरएल `https://docs-examples.firebaseio.com/fireblog` पर, `fireblog` के पाथ में सेव किया जाएगा.
चलिए, सबसे पहले Firebase डेटाबेस में उपयोगकर्ता का कुछ डेटा सेव करते हैं. हम हर उपयोगकर्ता की जानकारी को एक यूनीक उपयोगकर्ता नाम के साथ सेव करेंगे. साथ ही, हम उनका पूरा नाम और जन्म की तारीख भी सेव करेंगे. हर उपयोगकर्ता का एक यूनीक उपयोगकर्ता नाम होगा. इसलिए, यहां POST के बजाय PUT का इस्तेमाल करना सही रहेगा. ऐसा इसलिए, क्योंकि हमारे पास पहले से ही कुंजी है और हमें कोई नई कुंजी बनाने की ज़रूरत नहीं है.
PUT का इस्तेमाल करके, हम अपने Firebase डेटाबेस में स्ट्रिंग, नंबर, बूलियन, कलेक्शन या कोई भी JSON ऑब्जेक्ट लिख सकते हैं. इस मामले में, हम इसे एक ऑब्जेक्ट पास करेंगे:
curl -X PUT -d '{
"alanisawesome": {
"name": "Alan Turing",
"birthday": "June 23, 1912"
}
}' 'https://docs-examples.firebaseio.com/fireblog/users.json'
जब किसी JSON ऑब्जेक्ट को डेटाबेस में सेव किया जाता है, तो ऑब्जेक्ट की प्रॉपर्टी, नेस्ट किए गए तरीके से चाइल्ड लोकेशन पर अपने-आप मैप हो जाती हैं. अगर हम नए बनाए गए नोड पर जाएं, तो हमें "Alan Turing" वैल्यू दिखेगी. हम डेटा को सीधे तौर पर चाइल्ड लोकेशन में भी सेव कर सकते हैं:
curl -X PUT -d '"Alan Turing"' \ 'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome/name.json'
curl -X PUT -d '"June 23, 1912"' \ 'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome/birthday.json'
ऊपर दिए गए दोनों उदाहरणों में, वैल्यू को एक ही समय पर ऑब्जेक्ट के तौर पर लिखने और उन्हें चाइल्ड लोकेशन पर अलग-अलग लिखने से, एक ही डेटा हमारे Firebase डेटाबेस में सेव हो जाएगा:
{
"users": {
"alanisawesome": {
"date_of_birth": "June 23, 1912",
"full_name": "Alan Turing"
}
}
}
अनुरोध पूरा होने पर, 200 OK एचटीटीपी स्टेटस कोड दिखेगा. साथ ही, जवाब में वह डेटा शामिल होगा जो हमने डेटाबेस में लिखा है. पहले उदाहरण में, डेटा देखने वाले क्लाइंट पर सिर्फ़ एक इवेंट ट्रिगर होगा. वहीं, दूसरे उदाहरण में दो इवेंट ट्रिगर होंगे. यह ध्यान रखना ज़रूरी है कि अगर उपयोगकर्ताओं के पाथ में डेटा पहले से मौजूद है, तो पहला तरीका उसे ओवरराइट कर देगा. हालांकि, दूसरा तरीका सिर्फ़ हर अलग चाइल्ड नोड की वैल्यू में बदलाव करेगा. साथ ही, अन्य चाइल्ड नोड में कोई बदलाव नहीं करेगा. PUT, हमारे JavaScript SDK टूल में
set() के बराबर है.
PATCH की मदद से डेटा अपडेट करना
PATCH अनुरोध का इस्तेमाल करके, हम किसी जगह पर मौजूद खास चाइल्ड एलिमेंट को अपडेट कर सकते हैं. इसके लिए, हमें मौजूदा डेटा को ओवरराइट करने की ज़रूरत नहीं होती. आइए, PATCH अनुरोध की मदद से, ट्यूरिंग के उपयोगकर्ता डेटा में उनका निकनेम जोड़ें:
curl -X PATCH -d '{
"nickname": "Alan The Machine"
}' \
'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome.json'
ऊपर दिया गया अनुरोध, name या birthday चाइल्ड ऑब्जेक्ट को मिटाए बिना, हमारे alanisawesome ऑब्जेक्ट में nickname को लिखेगा. ध्यान दें कि अगर हमने यहां PUT का अनुरोध किया होता, तो name और birthday को मिटा दिया जाता. ऐसा इसलिए, क्योंकि उन्हें अनुरोध में शामिल नहीं किया गया था. अब हमारे Firebase डेटाबेस में
डेटा कुछ ऐसा दिखेगा:
{
"users": {
"alanisawesome": {
"date_of_birth": "June 23, 1912",
"full_name": "Alan Turing",
"nickname": "Alan The Machine"
}
}
}
अनुरोध पूरा होने पर, 200 OK एचटीटीपी स्टेटस कोड दिखेगा. साथ ही, जवाब में डेटाबेस में सेव किया गया अपडेट किया गया डेटा शामिल होगा.
Firebase में, मल्टी-पाथ अपडेट की सुविधा भी मिलती है. इसका मतलब है कि PATCH अब आपके Firebase डेटाबेस में एक ही समय पर कई जगहों पर वैल्यू अपडेट कर सकता है. यह एक बेहतरीन सुविधा है, जो आपको अपने डेटा को डीनॉर्मलाइज़ करने में मदद करती है. मल्टी-पाथ अपडेट का इस्तेमाल करके, हम एलन और ग्रेस, दोनों के लिए एक ही समय पर निकनेम जोड़ सकते हैं:
curl -X PATCH -d '{
"alanisawesome/nickname": "Alan The Machine",
"gracehopper/nickname": "Amazing Grace"
}' \
'https://docs-examples.firebaseio.com/fireblog/users.json'
इस अपडेट के बाद, आनंद और गरिमा दोनों के निकनेम जोड़ दिए गए हैं:
{
"users": {
"alanisawesome": {
"date_of_birth": "June 23, 1912",
"full_name": "Alan Turing",
"nickname": "Alan The Machine"
},
"gracehop": {
"date_of_birth": "December 9, 1906",
"full_name": "Grace Hopper",
"nickname": "Amazing Grace"
}
}
}ध्यान दें कि पाथ शामिल करके ऑब्जेक्ट को अपडेट करने की कोशिश करने पर, अलग-अलग तरह के नतीजे मिल सकते हैं. आइए देखते हैं कि अगर हम ग्रेस और एलन को इस तरह अपडेट करने की कोशिश करें, तो क्या होगा:
curl -X PATCH -d '{
"alanisawesome": {"nickname": "Alan The Machine"},
"gracehopper": {"nickname": "Amazing Grace"}
}' \
'https://docs-examples.firebaseio.com/fireblog/users.json'
इससे अलग तरह का व्यवहार होता है. जैसे, पूरे /fireblog/users नोड को ओवरराइट करना:
{
"users": {
"alanisawesome": {
"nickname": "Alan The Machine"
},
"gracehop": {
"nickname": "Amazing Grace"
}
}
}शर्तों के साथ किए गए अनुरोधों की मदद से डेटा अपडेट करना
डेटा को उसकी मौजूदा स्थिति के हिसाब से अपडेट करने के लिए, लेन-देन के REST के बराबर, शर्त वाले अनुरोधों का इस्तेमाल किया जा सकता है. उदाहरण के लिए, अगर आपको 'मुझे पसंद है' काउंटर की संख्या बढ़ानी है और यह पक्का करना है कि काउंटर में एक साथ कई लोगों के 'मुझे पसंद है' क्लिक करने पर भी सही संख्या दिखे, तो काउंटर में नई वैल्यू लिखने के लिए, शर्त के साथ अनुरोध का इस्तेमाल करें. काउंटर को एक ही नंबर में बदलने वाले दो राइट के बजाय, एक राइट अनुरोध पूरा नहीं होता. इसके बाद, नई वैल्यू के साथ अनुरोध को फिर से किया जा सकता है.- किसी जगह पर शर्त के साथ अनुरोध करने के लिए, उस जगह के मौजूदा डेटा का यूनीक आइडेंटिफ़ायर या ई-टैग पाएं. अगर उस जगह पर डेटा बदलता है, तो ETag भी बदल जाता है.
PATCHके अलावा, किसी भी तरीके का इस्तेमाल करके ई-टैग का अनुरोध किया जा सकता है. नीचे दिए गए उदाहरण में,GETअनुरोध का इस्तेमाल किया गया है. हेडर में ETag को कॉल करने पर, एचटीटीपी रिस्पॉन्स में दी गई जगह का ETag दिखता है.curl -i 'https://test.example.com/posts/12345/upvotes.json' -H 'X-Firebase-ETag: true'
HTTP/1.1 200 OK Content-Length: 6 Content-Type: application/json; charset=utf-8 Access-Control-Allow-Origin: * ETag: [ETAG_VALUE] Cache-Control: no-cache 10 // Current value of the data at the specified location
- वापस किए गए ई-टैग को अपने अगले
PUTयाDELETEअनुरोध में शामिल करें, ताकि उस ई-टैग वैल्यू से मैच होने वाले डेटा को अपडेट किया जा सके. हमारे उदाहरण के मुताबिक, काउंटर को 11 पर अपडेट करने के लिए या फ़ेच की गई शुरुआती वैल्यू 10 से 1 ज़्यादा करने के लिए, इस कोड का इस्तेमाल करें. साथ ही, अगर वैल्यू अब मैच नहीं होती है, तो अनुरोध को अस्वीकार कर दें: अगर तय की गई जगह पर डेटा की वैल्यू अब भी 10 है, तोcurl -iX PUT -d '11' 'https://[PROJECT_ID].firebaseio.com/posts/12345/upvotes.json' -H 'if-match:[ETAG_VALUE]'
PUTअनुरोध में मौजूद ETag मैच हो जाता है. साथ ही, अनुरोध पूरा हो जाता है और डेटाबेस में 11 लिख दिया जाता है. अगर जगह की जानकारी, ETag से मैच नहीं होती है, तो हो सकता है कि किसी दूसरे उपयोगकर्ता ने डेटाबेस में नई वैल्यू डाली हो. ऐसे में, अनुरोध पूरा नहीं हो पाता और जगह की जानकारी नहीं डाली जाती. जवाब में नई वैल्यू और ई-टैग शामिल होता है.HTTP/1.1 200 OK Content-Length: 6 Content-Type: application/json; charset=utf-8 Access-Control-Allow-Origin: * Cache-Control: no-cache 11 // New value of the data at the specified location, written by the conditional request
HTTP/1.1 412 Precondition Failed Content-Length: 6 Content-Type: application/json; charset=utf-8 Access-Control-Allow-Origin: * ETag: [ETAG_VALUE] Cache-Control: no-cache 12 // New value of the data at the specified location
- अगर आपको अनुरोध फिर से करना है, तो नई जानकारी का इस्तेमाल करें. Realtime Database शर्तों के साथ किए गए उन अनुरोधों को अपने-आप फिर से नहीं भेजता जो पूरे नहीं हो पाए. हालांकि, नई वैल्यू और ETag का इस्तेमाल करके, शर्त के साथ नया अनुरोध बनाया जा सकता है. इसके लिए, अनुरोध पूरा न होने पर मिली जानकारी का इस्तेमाल करें.
REST पर आधारित शर्तों वाले अनुरोध, एचटीटीपी if-match स्टैंडर्ड को लागू करते हैं. हालांकि, ये स्टैंडर्ड विज्ञापनों से इन तरीकों से अलग होते हैं:
- हर if-match अनुरोध के लिए, सिर्फ़ एक ई-टैग वैल्यू दी जा सकती है, एक से ज़्यादा नहीं.
- स्टैंडर्ड के मुताबिक, सभी अनुरोधों के साथ ई-टैग दिखाए जाने चाहिए. हालांकि, रीयलटाइम डेटाबेस सिर्फ़ उन अनुरोधों के साथ ई-टैग दिखाता है जिनमें
X-Firebase-ETagहेडर शामिल होता है. इससे स्टैंडर्ड अनुरोधों के लिए बिलिंग की लागत कम हो जाती है.
शर्तों के साथ किए जाने वाले अनुरोध, सामान्य REST अनुरोधों की तुलना में धीमे हो सकते हैं.
डेटा की सूचियां सेव करना
Firebase डेटाबेस रेफ़रंस में जोड़े गए हर चाइल्ड के लिए, टाइमस्टैंप पर आधारित यूनीक कुंजी जनरेट करने के लिए,
हम POST अनुरोध भेज सकते हैं. हमारे users पाथ के लिए, अपनी कुंजियां तय करना सही था, क्योंकि हर उपयोगकर्ता का एक यूनीक उपयोगकर्ता नाम होता है. हालांकि, जब उपयोगकर्ता ऐप्लिकेशन में ब्लॉग पोस्ट जोड़ेंगे, तो हम हर ब्लॉग पोस्ट के लिए अपने-आप एक कुंजी जनरेट करने के लिए, POST अनुरोध का इस्तेमाल करेंगे:
curl -X POST -d '{
"author": "alanisawesome",
"title": "The Turing Machine"
}' 'https://docs-examples.firebaseio.com/fireblog/posts.json'
अब हमारे posts पाथ में यह डेटा है:
{
"posts": {
"-JSOpn9ZC54A4P4RoqVa": {
"author": "alanisawesome",
"title": "The Turing Machine"
}
}
}
ध्यान दें कि -JSOpn9ZC54A4P4RoqVa कुंजी हमारे लिए अपने-आप जनरेट हो गई थी, क्योंकि हमने POST अनुरोध का इस्तेमाल किया था. अनुरोध पूरा होने पर, 200 OK एचटीटीपी स्टेटस कोड दिखेगा. साथ ही, जवाब में जोड़े गए नए डेटा की कुंजी शामिल होगी:
{"name":"-JSOpn9ZC54A4P4RoqVa"}डेटा हटाया जा रहा है
डेटाबेस से डेटा हटाने के लिए, हम उस पाथ के यूआरएल के साथ DELETE अनुरोध भेज सकते हैं जिससे हमें डेटा मिटाना है. इससे, हमारे users पाथ से Alan को मिटा दिया जाएगा:
curl -X DELETE \ 'https://docs-examples.firebaseio.com/fireblog/users/alanisawesome.json'
DELETE अनुरोध पूरा होने पर, 200 OK एचटीटीपी स्टेटस कोड दिखेगा. साथ ही, जवाब में JSON null शामिल होगा.
यूआरआई पैरामीटर
डेटाबेस में डेटा लिखते समय, REST API इन यूआरआई पैरामीटर को स्वीकार करता है:
पुष्टिकरण
auth अनुरोध पैरामीटर, Firebase Realtime Database Security Rules से सुरक्षित किए गए डेटा को ऐक्सेस करने की अनुमति देता है. साथ ही, यह सभी तरह के अनुरोधों के साथ काम करता है. आर्ग्युमेंट, हमारे Firebase ऐप्लिकेशन का सीक्रेट या पुष्टि करने वाला टोकन हो सकता है. इसके बारे में हम उपयोगकर्ता की अनुमति वाले सेक्शन में बात करेंगे. यहां दिए गए उदाहरण में, हम auth पैरामीटर के साथ POST अनुरोध भेजते हैं. इसमें CREDENTIAL, हमारे Firebase ऐप्लिकेशन का सीक्रेट या पुष्टि करने वाला टोकन है:
curl -X POST -d '{"Authenticated POST request"}' \
'https://docs-examples.firebaseio.com/auth-example.json?auth=CREDENTIAL'
प्रिंट करें
print पैरामीटर की मदद से, डेटाबेस से मिलने वाले जवाब का फ़ॉर्मैट तय किया जा सकता है. हमारे अनुरोध में print=pretty जोड़ने पर, डेटा ऐसे फ़ॉर्मैट में दिखेगा जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. print=pretty के लिए, GET, PUT, POST, PATCH, और DELETE अनुरोधों का इस्तेमाल किया जा सकता है.
डेटा लिखते समय सर्वर से मिलने वाले आउटपुट को रोकने के लिए, हम अपने अनुरोध में print=silent जोड़ सकते हैं. अनुरोध पूरा होने पर, जवाब खाली होगा और 204 No Content एचटीटीपी स्टेटस कोड से दिखाया जाएगा.
print=silent, GET, PUT, POST, और PATCH अनुरोधों के साथ काम करता है.
सर्वर वैल्यू लिखना
सर्वर की वैल्यू को किसी जगह पर लिखने के लिए, प्लेसहोल्डर वैल्यू का इस्तेमाल किया जा सकता है. यह एक ऐसा ऑब्जेक्ट होता है जिसमें सिर्फ़ एक ".sv" कुंजी होती है. उस कुंजी की वैल्यू, सर्वर वैल्यू का वह टाइप है जिसे हमें सेट करना है.
उदाहरण के लिए, उपयोगकर्ता के बनाए जाने पर टाइमस्टैंप सेट करने के लिए, हम यह तरीका अपना सकते हैं:
curl -X PUT -d '{".sv": "timestamp"}' \
'https://docs-examples.firebaseio.com/alanisawesome/createdAt.json'
"timestamp", सर्वर की वैल्यू के तौर पर इस्तेमाल की जा सकने वाली एकमात्र वैल्यू है. यह UNIX epoch के बाद से मिलीसेकंड में समय है.
डेटा लिखने की परफ़ॉर्मेंस को बेहतर बनाना
अगर हम डेटाबेस में बड़ी मात्रा में डेटा लिख रहे हैं, तो हम डेटा लिखने की परफ़ॉर्मेंस को बेहतर बनाने और बैंडविड्थ के इस्तेमाल को कम करने के लिए, print=silent पैरामीटर का इस्तेमाल कर सकते हैं. सामान्य तौर पर, सर्वर लिखे गए JSON डेटा के साथ जवाब देता है.
print=silent की वैल्यू तय होने पर, डेटा मिलते ही सर्वर कनेक्शन को तुरंत बंद कर देता है. इससे बैंडविड्थ का इस्तेमाल कम होता है.
अगर हम डेटाबेस को कई अनुरोध भेज रहे हैं, तो एचटीटीपी हेडर में Keep-Alive अनुरोध भेजकर, एचटीटीपीएस कनेक्शन का फिर से इस्तेमाल किया जा सकता है.
गड़बड़ी की स्थितियां
REST API इन स्थितियों में गड़बड़ी के कोड दिखाएगा:
| एचटीटीपी स्टेटस कोड | |
|---|---|
| 400 गलत अनुरोध |
गड़बड़ी की इनमें से कोई एक स्थिति:
|
| 401 Unauthorized |
गड़बड़ी की इनमें से कोई एक स्थिति:
|
| 404 पेज नहीं मिला | बताया गया Firebase डेटाबेस नहीं मिला. |
| 500 सर्वर में गड़बड़ी | सर्वर से कोई गड़बड़ी हुई. ज़्यादा जानकारी के लिए, गड़बड़ी का मैसेज देखें. |
| 503 सेवा उपलब्ध नहीं है | चुना गया Firebase रीयलटाइम डेटाबेस कुछ समय के लिए उपलब्ध नहीं है. इसका मतलब है कि अनुरोध नहीं किया गया. |
डेटा को सुरक्षित रखना
Firebase में सुरक्षा से जुड़ी एक भाषा होती है. इससे हमें यह तय करने में मदद मिलती है कि किन उपयोगकर्ताओं के पास हमारे डेटा के अलग-अलग नोड को पढ़ने और उनमें बदलाव करने का ऐक्सेस है. इस बारे में ज़्यादा जानने के लिए, Realtime Database Security Rules पर जाएं.
अब हमने डेटा सेव करने के बारे में जान लिया है. अगले सेक्शन में, हम REST API की मदद से Firebase डेटाबेस से डेटा वापस पाने का तरीका जानेंगे.