Firebase डेटा कनेक्ट का इस्तेमाल शुरू करना

इस क्विकस्टार्ट में, आपको यह पता चलेगा कि कैसे:

• अपने Firebase प्रोजेक्ट में Firebase डेटा कनेक्ट जोड़ें.
• प्रोडक्शन इंस्टेंस के साथ काम करने के लिए, Visual Studio कोड एक्सटेंशन जैसे डेवलपमेंट एनवायरमेंट सेट अप करें.
• इसके बाद, हम आपको बताएंगे कि ये काम कैसे किए जा सकते हैं:
  • ईमेल ऐप्लिकेशन के उदाहरण का इस्तेमाल करके, स्कीमा बनाएं.
  • अपने स्कीमा के लिए, क्वेरी और म्यूटेशन के बारे में बताएं.
  • अपने क्लाइंट की इन क्वेरी और म्यूटेशन को कॉल करने के लिए, अपने-आप जनरेट होने वाले SDK टूल का इस्तेमाल करें.
  • अपने फ़ाइनल प्रोटोटाइप को प्रोडक्शन में डिप्लॉय करें.

ज़रूरी शर्तें

इस क्विकस्टार्ट का इस्तेमाल करने के लिए, आपको इनकी ज़रूरत होगी.

• Linux, macOS या Windows
• विज़ुअल स्टूडियो कोड

अपने प्रोजेक्ट में Data Connect जोड़ना और डेटा सोर्स बनाना

1. अगर आपने पहले से कोई Firebase प्रोजेक्ट नहीं बनाया है, तो अब एक Firebase प्रोजेक्ट बनाएं.
   1. Firebase कंसोल में, प्रोजेक्ट जोड़ें पर क्लिक करें. इसके बाद, स्क्रीन पर दिए गए निर्देशों का पालन करें.

2. अपने प्रोजेक्ट को Blaze प्लान में अपग्रेड करें. इससे आपको PostgreSQL इंस्टेंस के लिए, Cloud SQL बनाने में मदद मिलती है.

3. Firebase कंसोल के डेटा कनेक्ट सेक्शन पर जाएं और प्रॉडक्ट सेटअप वर्कफ़्लो का पालन करें.

4. अपने PostgreSQL डेटाबेस के लिए CloudSQL के लिए, कोई जगह चुनें.

5. बाद में पुष्टि के लिए प्रोजेक्ट, सेवा, और डेटाबेस के नाम और आईडी नोट कर लें.

6. बचे हुए सेटअप फ़्लो को फ़ॉलो करें और फिर हो गया पर क्लिक करें.

डेवलपमेंट एनवायरमेंट चुनें और सेट अप करें

आप विज़ुअल स्टूडियो कोड में किसी ऐप्लिकेशन का प्रोटोटाइप बनाकर, Data Connect के साथ शुरुआत करेंगे.

इसके अलावा, Data Connect एम्युलेटर की मदद से लोकल डेवलपमेंट के लिए, एक स्थानीय PostgreSQL डेटाबेस इंस्टॉल किया जा सकता है. यह सेटअप इस क्विकस्टार्ट गाइड के आखिर में बताया गया है.

Data Connect, प्रोटोटाइप करने के दो तरीके उपलब्ध कराता है:

• अगर आप वेब या Kotlin Android डेवलपर हैं, तो PostgreSQL के लिए अपने Cloud SQL इंस्टेंस से कनेक्ट करते समय, स्कीमा और कार्रवाइयों को स्थानीय तौर पर प्रोटोटाइप किया जा सकता है. इसके अलावा, (ज़रूरी नहीं है) PostgreSQL को स्थानीय तौर पर चलाया जा सकता है.

• अगर आप वेब डेवलपर हैं, तो आपके पास IDX फ़ाइल फ़ोल्डर में प्रोटोटाइप बनाने के लिए IDX का इस्तेमाल करने का विकल्प है. इसके लिए, आपको PostgreSQL के साथ पहले से कॉन्फ़िगर किए गए IDX टेंप्लेट, Data Connect एम्युलेटर के साथ VS Code एक्सटेंशन, और आपके लिए सेट अप किए गए क्विकस्टार्ट कोड का इस्तेमाल करना होगा.

अपना लोकल प्रोजेक्ट सेट अप करें

सामान्य निर्देशों का पालन करते हुए, सीएलआई इंस्टॉल करें.

इसके बाद, Firebase डेटा कनेक्ट के प्रयोग को चालू करें.

firebase experiments:enable dataconnect

आपका लोकल प्रोजेक्ट सेट अप करने के लिए, हम आपके प्रोजेक्ट डायरेक्ट्री को शुरू करेंगे. साथ ही, कोड जनरेट करने के लिए ज़रूरी कुछ कॉन्फ़िगरेशन फ़ाइलें अपडेट करेंगे.

अपनी प्रोजेक्ट डायरेक्ट्री सेट अप करें

अपनी प्रोजेक्ट डायरेक्ट्री शुरू करें.

दोनों में से कोई भी फ़्लो, firebase.json और .firebaserc फ़ाइल के साथ-साथ, dataconnect सबडायरेक्ट्री जनरेट करेगा, जिसमें आपकी लोकल वर्किंग डायरेक्ट्री में ज़रूरी dataconnect.yaml और connector.yaml फ़ाइलें शामिल होंगी.

कॉन्फ़िगर करें कि SDK कोड कहां जनरेट किया गया है

स्कीमा में बदलाव करने के दौरान, Data Connect अपने-आप SDK कोड जनरेट करता है.

SDK टूल कहां जनरेट किए जाएं, यह बताने के लिए dataconnect/connector/connector.yaml में अपने शुरुआती कनेक्टर की फ़ाइल को अपडेट करें.

connectorId: "my-connector"
authMode: "PUBLIC"
generate:
  javascriptSdk:
    outputDir: "../../js-email-generated"
    package: "@email-manager/emails"
    packageJsonDir: "../../"
  kotlinSdk:
    outputDir: "../kotlin-email-generated"
    package: com.myemailapplication

Data Connect टूलकिट के बारे में जानें

Data Connect टूलकिट, Firebase VS Code एक्सटेंशन का एक कॉम्पोनेंट है. यह सीधे तौर पर Visual Studio Code से स्कीमा तैयार करने, क्वेरी और बदलाव मैनेज करने में मदद करता है.

टूलकिट की सुविधाओं के बारे में जानने के लिए:

1. अगर आपने अब तक अपनी Firebase प्रोजेक्ट डायरेक्ट्री को VS Code में नहीं खोला है, तो उसे खोलें.
2. VS Code में बाईं ओर मौजूद पैनल में, Firebase आइकॉन पर क्लिक करके Firebase VS कोड एक्सटेंशन यूज़र इंटरफ़ेस (यूआई) खोलें.

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

एक्सटेंशन यूज़र इंटरफ़ेस (यूआई) आपको कई उपयोगी सुविधाएं उपलब्ध कराता है:

VS कोड के मुख्य साइड बार में:

मुख्य साइड बार

• कॉन्फ़िगरेशन पैनल, जिसकी मदद से Google में साइन इन करके Firebase प्रोजेक्ट चुना जा सकता है.
• Firebase डेटा कनेक्ट पैनल की मदद से, पहले से मौजूद एम्युलेटर को कंट्रोल किया जा सकता है. साथ ही, संसाधनों को प्रोडक्शन में डिप्लॉय किया जा सकता है.
• एफ़डीसी एक्सप्लोरर पैनल, जिसमें आपके स्कीमा के आधार पर, अपने-आप जनरेट होने वाली इंप्लिसिट क्वेरी और म्यूटेशन की सूची होती है

बनाम कोड के निचले पैनल में:

निचला पैनल

• डेटा कनेक्ट एक्ज़ीक्यूशन टैब, जिसमें ऐसे टूल होते हैं जिनकी मदद से अनुरोधों में डेटा पास किया जा सकता है, पुष्टि करने की नकल की जा सकती है, और नतीजे देखे जा सकते हैं.

किसी ऐप्लिकेशन को डेवलप करना शुरू करने से पहले, एक्सटेंशन की कुछ सुविधाओं पर एक नज़र डालें.

Data Connect स्कीमा और क्वेरी बनाना

सेटअप पूरा हो गया है. अब हम इसे Data Connect के साथ डेवलप करना शुरू कर सकते हैं.

उपयोगकर्ताओं और ईमेल को मॉडल करने के लिए, ग्राफ़QL का इस्तेमाल करना शुरू करें. सोर्स को इसमें अपडेट किया जाएगा:

• /dataconnect/schema/schema.gql
• /dataconnect/connector/queries.gql

स्कीमा बनाना शुरू करें

अपनी Firebase प्रोजेक्ट डायरेक्ट्री में, dataconnect फ़ोल्डर पर ध्यान दें. यहीं पर, ग्राफ़QL का इस्तेमाल करके, Cloud SQL डेटाबेस के लिए अपना डेटा मॉडल तय किया जाता है.

/dataconnect/schema/schema.gql फ़ाइल में, ऐसा स्कीमा तय करना शुरू करें जिसमें उपयोगकर्ता और ईमेल शामिल हों.

उपयोगकर्ता

Data Connect में, ScoreQL फ़ील्ड कॉलम पर मैप किए जाते हैं. उपयोगकर्ताओं के पास uid, name, और ईमेल address है. Data Connect कई शुरुआती डेटा टाइप की पहचान करता है: String और Date.

नीचे दिए गए स्निपेट को कॉपी करें या फ़ाइल में इनसे जुड़ी लाइनों की टिप्पणी हटाएं.

# File `/dataconnect/schema/schema.gql`

type User @table(key: "uid") {
   uid: String!
   name: String!
   address: String!
}

डिफ़ॉल्ट रूप से, Firebase डेटा कनेक्ट यूयूआईडी id कुंजी जोड़ देगा, अगर कोई यूयूआईडी नहीं दिया जाता है. हालांकि, इस मामले में आपको मेरा uid मुख्य कुंजी के तौर पर सेट करना है. ऐसा @table(key: "uid") डायरेक्टिव की मदद से किया जा सकता है.

ईमेल

अब आपके पास उपयोगकर्ता हैं, इसलिए ईमेल को मॉडल किया जा सकता है. यहां ईमेल डेटा के लिए, सामान्य फ़ील्ड (या कॉलम) जोड़े जा सकते हैं. इस बार, हम प्राथमिक कुंजी जोड़ना छोड़ देते हैं क्योंकि उसे प्रबंधित करने के लिए आप डेटा कनेक्ट पर भरोसा कर सकते हैं.

# File `/dataconnect/schema/schema.gql`

type Email @table {
   subject: String!
   date: Date!
   text: String!
   from: User!
}

ध्यान दें कि from फ़ील्ड को User टाइप के साथ मैप किया गया है. Data Connect को पता है कि यह Email और User के बीच का संबंध है. इसलिए, यह आपके लिए इस संबंध को मैनेज करेगा.

अपने स्कीमा को प्रोडक्शन में डिप्लॉय करें

आप अपने प्रोडक्शन डेटाबेस के साथ काम करने के लिए Firebase बनाम कोड एक्सटेंशन का इस्तेमाल कर रहे हैं. इसलिए, जारी रखने से पहले आपको अपना स्कीमा डिप्लॉय करना होगा.

1. Firebase बनाम कोड एक्सटेंशन को डिप्लॉय करने के लिए, इसका इस्तेमाल किया जा सकता है.
   • एक्सटेंशन यूज़र इंटरफ़ेस (यूआई) में, Firebase डेटा कनेक्ट पैनल में, डिप्लॉय करें पर क्लिक करें.

2. इसके अलावा, Firebase सीएलआई का इस्तेमाल भी किया जा सकता है.

   firebase deploy
   

3. एक्सटेंशन या सीएलआई फ़्लो में, आपको स्कीमा में हुए बदलावों की समीक्षा करनी पड़ सकती है और ऐसे बदलावों को मंज़ूरी देनी पड़ सकती है जो नुकसान पहुंचा सकते हैं. आपको यह करने के लिए कहा जाएगा:

   • firebase dataconnect:sql:diff का इस्तेमाल करके स्कीमा में हुए बदलावों की समीक्षा करें
   • जब आप बदलावों से संतुष्ट हो जाएं, तो उन्हें firebase dataconnect:sql:migrate के शुरू किए गए फ़्लो का इस्तेमाल करके लागू करें.

जनरेट किए गए स्कीमा एक्सटेंशन देखें

ईमेल स्कीमा में बदलाव करते ही, Data Connect अपने-आप स्कीमा एक्सटेंशन, क्वेरी, म्यूटेशन, फ़िल्टर, और टेबल रिलेशन जनरेट करता है. जनरेट किए गए इस कोड को दो तरीकों से देखा जा सकता है.

• एफ़डीसी एक्सप्लोरर पैनल में, Firebase एक्सटेंशन यूज़र इंटरफ़ेस (यूआई) में जनरेट की गई इंप्लिसिट क्वेरी और म्यूटेशन की सूची देखी जा सकती है.
• .dataconnect/schema डायरेक्ट्री के सोर्स में, लोकल जनरेट किए गए सभी कोड देखे जा सकते हैं.

अपनी टेबल में डेटा जोड़ने के लिए, बदलाव करें

/dataconnect/schema/schema.gql में, ग्राफ़QL टाइप पर CodeLens बटन दिखते हैं.

डेवलपमेंट टाइम से जुड़ी क्वेरी और म्यूटेशन

इन CodeLens बटन से जुड़े काम, तेज़ और काम के होते हैं. इस मामले में, टेबल में डेटा जोड़ा जा सकता है. Data Connect, ग्राफ़QL म्यूटेशन का इस्तेमाल करके यह बताता है कि डेटाबेस का इस्तेमाल कैसे और कौन कर सकता है. इस बटन का इस्तेमाल करने से, यह डेटा को तुरंत सीडिंग के लिए डेवलपमेंट टाइम ऑपरेशन में बदल देता है.

अपने स्कीमा को प्रोडक्शन में डिप्लॉय करने के बाद, अपने बैकएंड पर ये कार्रवाइयां करने के लिए, रन (प्रोडक्शन) CodeLens बटन का इस्तेमाल किया जा सकता है.

ईमेल पतों की सूची बनाने के लिए क्वेरी लिखें

अब मज़ेदार बात है सवाल. डेवलपर के तौर पर, आपको ग्राफ़क्यूएल क्वेरी के बजाय एसक्यूएल क्वेरी लिखने की आदत है, इसलिए शुरुआत में यह कुछ अलग लग सकता है. हालांकि, रॉ एसक्यूएल की तुलना में ग्राफ़क्यूएल काफ़ी छोटा और टाइप-सुरक्षित है. साथ ही, हमारा VS Code एक्सटेंशन डेवलप करने के अनुभव को आसान बना रहा है.

/dataconnect/connector/queries.gql फ़ाइल में बदलाव करना शुरू करें. अगर आपको सभी ईमेल चाहिए, तो इस तरह की क्वेरी का इस्तेमाल करें.

# File `/dataconnect/connector/queries.gql`

query listEmails @auth(level: PUBLIC) {
  emails {
    id, subject, text, date
    from {
      name
    }
  }
}

इसकी सबसे बड़ी सुविधा यह है कि डेटाबेस के संबंधों को ग्राफ़ की तरह देखा जा सकता है. ईमेल में एक from फ़ील्ड होता है, जो उपयोगकर्ता के बारे में बताता है. इसलिए, उस फ़ील्ड में नेस्ट किया जा सकता है और उपयोगकर्ता के बारे में जानकारी पाई जा सकती है.

@auth डायरेक्टिव

इस उदाहरण में, @auth डायरेक्टिव का पूरी तरह से इस्तेमाल नहीं किया गया है, लेकिन यह सिद्धांत बहुत असरदार है. डेटाबेस के लिए, अनुमति देने से जुड़ी नीति को इसी तरह तय किया जाता है.

यह क्वेरी आसान है. जब आप कई-से-कई संबंधों के साथ ज़्यादा जटिल जुड़ाव लागू करते हैं, तो Data Connect की असली रोमांचक सुविधाएं तेज़ी से काम करने लगती हैं. टूल और दस्तावेज़ एक्सप्लोर करते समय, आपको इसके बारे में ज़्यादा जानकारी मिलेगी.

अपनी क्वेरी की जांच करना

अब जब हमने यह क्वेरी बना ली है, तो इसे क्लाइंट कोड में इंटिग्रेट करने से पहले जांच लें कि यह काम करती है या नहीं. डेटा कनेक्ट के लिए डेवलपर अनुभव का एक हिस्सा डेटा कनेक्ट एक्ज़ीक्यूशन पैनल की मदद से क्वेरी के नतीजों को तेज़ी से दोहराने और उनकी जांच करने की सुविधा है.

इस क्वेरी के लिए ज़रूरी तर्क दें. इसके बाद, क्वेरी के नाम के ऊपर CodeLens बटन पर क्लिक करें. यह क्वेरी को एक्ज़ीक्यूट करता है और नतीजे दिखाता है, ताकि आप देख सकें कि यह उम्मीद के मुताबिक काम कर रहा है.

क्लाइंट ऐप्लिकेशन से, क्लाइंट SDK कोड और क्वेरी डेटा जनरेट करें

डेवलपमेंट साइकल को बंद करने के लिए, इस क्वेरी को क्लाइंट कोड में इंटिग्रेट करें.

डेटा कनेक्ट सेवा से क्वेरी को कॉल करने और जवाब हैंडल करने के जवाब दिखाने के लिए, क्लाइंट को लिखा जा सकता है.

1. आपने connector.yaml फ़ाइल में जिस जगह के बारे में पहले बताया था उस जगह पर अपने-आप जनरेट हुए सोर्स ढूंढें.

2. अपने प्रोजेक्ट में Firebase जोड़ें, अपना ऐप्लिकेशन रजिस्टर करें, और काम का Firebase मुख्य SDK टूल इंस्टॉल करें:

   • JavaScript के लिए, इन निर्देशों का पालन करें.
   • Kotlin के लिए, इन निर्देशों का पालन करें.

3. अगर IDX का इस्तेमाल नहीं किया जा रहा है, तो आपके पास एक ऐसा क्लाइंट सेट अप करने का विकल्प है जिसे कमांड लाइन से कॉल किया जा सकता है.

const { initializeApp } = require("firebase/app");
const {
  connectDataConnectEmulator,
  getDataConnect,
} = require("firebase/data-connect");
const { listEmails, connectorConfig } = require("@email-manager/emails");

// TODO: Replace the following with your app's Firebase project configuration
const firebaseConfig = {
  //...
};

const app = initializeApp(firebaseConfig);
const dc = getDataConnect(app, connectorConfig);

// Remove the following line to connect directly to production
connectDataConnectEmulator(dc, "localhost", 9399);

listEmails().then(res => {
  console.log(res.data.emails);
  process.exit(0);
});
    

    node clientTest.js
    

class MainActivity : ComponentActivity() {
  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    lifecycleScope.launch {
      val connector = MyConnector.instance
      connector.dataConnect.useEmulator() // Remove to connect to production
      try {
        println(connector.listEmails.execute().data.emails)
      } catch (e: Throwable) {
        println("ERROR: $e")
      }
    }
  }
}
    

पूरे हो चुके प्रोटोटाइप को प्रोडक्शन में डिप्लॉय करें

आपने लगातार डेवलपमेंट पर काम किया है. अब आप Firebase एक्सटेंशन यूज़र इंटरफ़ेस (यूआई) या Firebase सीएलआई की मदद से सर्वर पर अपना स्कीमा, डेटा, क्वेरी, और म्यूटेशन डिप्लॉय कर सकते हैं. यह ठीक वैसे ही होता है जैसे आपने अपने स्कीमा के साथ किया.

इसके लागू होने पर, आपकी Data Connect सेवा, क्लाइंट के ऑपरेशन प्रोसेस करने के लिए तैयार हो जाएगी. 'PostgreSQL के लिए Cloud SQL' इंस्टेंस को, डिप्लॉय किए गए फ़ाइनल स्कीमा और डेटा के साथ अपडेट किया जाएगा.

(ज़रूरी नहीं) PostgreSQL को स्थानीय तौर पर इंस्टॉल करना

PostgreSQL को स्थानीय तौर पर इंस्टॉल करने और उसे एम्युलेटर के साथ इंटिग्रेट करने से, पूरी तरह से लोकल डेवलपमेंट एनवायरमेंट में प्रोटोटाइप बनाए जा सकते हैं.

आपके पास PostgreSQL का एक नया इंस्टेंस इंस्टॉल करने या किसी मौजूदा इंस्टेंस का इस्तेमाल करने का विकल्प है.

PostgreSQL इंस्टॉल करना

अपने प्लैटफ़ॉर्म के निर्देशों का पालन करते हुए, PostgreSQL के वर्शन 15.x को इंस्टॉल करें.

• macOS पर सेट किया जाता है. Postgres.app डाउनलोड और इंस्टॉल करें.
• Windows: PostgreSQL डाउनलोड पेज से, EDB इंस्टॉलर का इस्तेमाल करें.
• Docker: pgvector/pgvector:15 इमेज को खींचें और चलाएं. यह PostgreSQL 15.x और वेक्टर, दोनों के साथ काम करती है.
• Linux: हमारा सुझाव है कि पिछली इमेज के साथ Docker का इस्तेमाल करें. हालांकि, सबसे ज़्यादा इस्तेमाल किए जाने वाले डिस्ट्रिब्यूशन के लिए अन्य निर्देशों का भी इस्तेमाल किया जा सकता है.

इंस्टॉल करने के क्रम के दौरान होस्टनेम, पोर्ट, उपयोगकर्ता नाम, और पासवर्ड, और उनसे जुड़े पैरामीटर के आउटपुट को नोट करें.

आपके PostgreSQL इंस्टेंस से कनेक्ट करने के लिए, एम्युलेटर को इनकी ज़रूरत होगी:

• ये सेटअप कॉन्फ़िगरेशन पैरामीटर
• आपके dataconnect.yaml से डेटाबेस का नाम और आपके लोकल इंस्टेंस में शुरू किए गए, संबंधित नाम वाले डेटाबेस का नाम.

कनेक्शन स्ट्रिंग की मदद से अपना .firebaserc अपडेट करें

अपनी .firebaserc फ़ाइल में यहां दी गई कुंजी को जोड़ने के लिए, कनेक्शन स्ट्रिंग के लिए अपने स्थानीय PostgreSQL कॉन्फ़िगरेशन की जानकारी का इस्तेमाल करें. इसमें स्थानीय PostgreSQL उपयोगकर्ता नाम और पासवर्ड भी शामिल हैं.

{
  "projects": {},
  ...,
  ...,
  "dataconnectEmulatorConfig": {
    "postgres": {
      "localConnectionString": "postgresql://postgresusername:postgrespassword@localhost:5432?sslmode=disable"
    }}
}

अपने स्थानीय PostgreSQL इंस्टेंस से कनेक्ट करना

इस कॉन्फ़िगरेशन के पूरा होने पर, अपने लोकल डेटाबेस से कनेक्ट करने के लिए:

1. VS Code में बाईं ओर मौजूद पैनल में, Firebase आइकॉन पर क्लिक करके Firebase VS कोड एक्सटेंशन यूज़र इंटरफ़ेस (यूआई) खोलें.
2. लोकल PostgreSQL से कनेक्ट करें बटन पर क्लिक करें.

अगले चरण