कॉन्फ़िगरेशन और सुरक्षा से जुड़ा रेफ़रंस

Firebase CLI की मदद से, अपने Firebase प्रोजेक्ट को किसी स्थानीय और वर्शन कंट्रोल की सुविधा वाली प्रोजेक्ट डायरेक्ट्री में मैनेज किया जा सकता है. इसमें Data Connect आपके प्रोजेक्ट में मौजूद सेवाएं, उन सेवाओं के लिए कनेक्टर, और हर कनेक्टर के लिए स्कीमा, क्वेरी, और म्यूटेशन सोर्स जैसे संसाधन शामिल हैं. CLI की मदद से, Firebase Data Connect एम्युलेटर को इंस्टॉल और इस्तेमाल भी किया जा सकता है. सीएलआई, Firebase कंसोल में काम करने का एक बेहतर विकल्प है.

निजी झलक प्रोग्राम के लिए Firebase सीएलआई एक्सपेरिमेंट और Data Connect से जुड़े सीएलआई निर्देशों को इंस्टॉल करने के लिए, सीएलआई रेफ़रंस देखें.

इस रेफ़रंस गाइड में ये दस्तावेज़ शामिल हैं:

• firebase.json प्रोजेक्ट की कॉन्फ़िगरेशन फ़ाइल में, Data Connect से जुड़ी एंट्री.
• dataconnect.yaml और connector.yaml में Data Connect कॉन्फ़िगरेशन.
• Data Connect का इस्तेमाल करने वाले अपने प्रोजेक्ट के लिए, आपको IAM की उन भूमिकाओं को कॉन्फ़िगर करना होगा.

Firebase प्रोजेक्ट की कॉन्फ़िगरेशन फ़ाइलें

firebase.json कॉन्फ़िगरेशन का रेफ़रंस

अपने प्रोजेक्ट में एक या उससे ज़्यादा Data Connect सेवाओं को कॉन्फ़िगर करने के लिए, dataconnect बटन का इस्तेमाल करें.

dataconnect: {
   source: string // Path to the directory containing the dataconnect.yaml service file.
}

dataconnect.yaml कॉन्फ़िगरेशन का रेफ़रंस

dataconnect.yaml फ़ाइल में, ऐप्लिकेशन स्कीमा सोर्स, कनेक्टर सोर्स, और डेटा सोर्स कनेक्शन की जानकारी की जगहों के बारे में कॉन्फ़िगरेशन की जानकारी सेव होती है. यह फ़ाइल, Firebase सीएलआई के लिए प्रोजेक्ट डायरेक्ट्री के सिग्नीफ़ायर के तौर पर भी काम करती है.

schemaValidation कुंजी, स्कीमा की पुष्टि के लेवल को कंट्रोल करती है. यह पुष्टि तब की जाती है, जब स्कीमा को डिप्लॉयमेंट के दौरान माइग्रेट किया जाता है. कोई वैल्यू सेट न होने पर, dataconect:sql:migrate कमांड का काम, काम करने वाले बदलाव लागू करना होता है. साथ ही, कोई भी ज़रूरी बदलाव लागू करने से पहले, आपसे पूछता है. सेट होने पर, इसकी सेटिंग का व्यवहार इस तरह होता है:

• STRICT मोड पर जाएं. ऐप्लिकेशन स्कीमा को डिप्लॉय करने से पहले, डेटाबेस स्कीमा का ऐप्लिकेशन स्कीमा से एग्ज़ैक्ट मैच होना चाहिए. आपके Data Connect स्कीमा में इस्तेमाल नहीं की गई टेबल या कॉलम, डेटाबेस से मिटा दिए जाएंगे.
• COMPATIBLE मोड पर जाएं. ऐप्लिकेशन स्कीमा को डिप्लॉय करने से पहले, डेटाबेस स्कीमा को ऐप्लिकेशन स्कीमा के साथ काम करना चाहिए. इसके अलावा, कोई भी अन्य बदलाव करना ज़रूरी नहीं है. काम करने का मतलब है कि स्कीमा ट्रांज़िशन, आपके लिखे गए ऐप्लिकेशन स्कीमा पर आधारित होते हैं. आपके डेटाबेस में मौजूद ऐसे एलिमेंट जिनका इस्तेमाल आपके ऐप्लिकेशन स्कीमा में नहीं किया जाता है उन्हें बिना बदलाव के छोड़ दिया जाता है. इसलिए, डिप्लॉयमेंट के बाद, आपके बैकएंड में ऐसे स्कीमा, टेबल, और कॉलम हो सकते हैं जिनका इस्तेमाल नहीं किया गया है.

इस फ़ाइल में मौजूद अन्य कुंजियों की वैल्यू के बारे में, नीचे दी गई टिप्पणियों में बताया गया है.

# The top-level Firebase Data Connect YAML file.

# The Firebase Data Connect API version to target.
# Optional. Defaults to the latest version.
specVersion: string

# The ID of the Firebase Data Connect service resource.
# Required.
serviceId: string

# The location of the Firebase Data Connect service.
# Required.
location: string

# Required.
schema:
  # Relative path to directory for schema definitions.
  # Recursively loads all .gql files in this directory.
  # Optional. If not present, defaults to ./schema.
  source: string
  # Datasource connection information.
  # Required.
  datasource:
    # Required.
    postgresql:
      # The name of the PostgreSQL database.
      # Required.
      database: string
      cloudSql:
        # The ID of the CloudSQL instance resource.
        # Required.
        instanceId: string
        # Schema validation mode for schema migrations.
        # Defaults to unspecified/commented out, meaning you are prompted to
        # review all changes during migration.
        # If desired, uncomment and indicate one of "STRICT" or "COMPATIBLE".
        schemaValidation: string

# Required.
# Relative paths to directories for connector definitions.
# Recursively loads all .gql files in the listed directories.
# All directories specified MUST contain a connector.yaml file.
connectorDirs: [string]

YAML फ़ाइल में, डिफ़ॉल्ट (हालांकि, कॉन्फ़िगर किया जा सकता है) डायरेक्ट्री स्ट्रक्चर का इस्तेमाल किया जाता है:

./(project root)
   /dataconnect
      dataconnect.yaml
      /schema
        *.gql
      /connector
        connector.yaml
        *.gql

connector.yaml कॉन्फ़िगरेशन का रेफ़रंस

पुष्टि करने के डिफ़ॉल्ट मोड और SDK टूल जनरेट करने के विकल्पों को कॉन्फ़िगर करने के लिए, connector.yaml का इस्तेमाल करें.

# The connector-level YAML file.

# Required. The connector name of the Firebase Data Connect connector resource.
connectorId: string

# Optional. If not specified, no generated libraries (i.e. type-safe SDKs) will be generated.
generate:
    # Optional.
    javascriptSdk:
        # Path to the directory that will be updated with the latest generated
        # web SDK.
        # Required.
      - outputDir: string
        # Path to your package.json directory. If specified, the new generated sdk will be installed in this path.
        # Optional. If not provided, the package will not be auto-installed for you.
      - packageJsonDir: string
        # Name of the package to be created.
        # Optional. Defaults to @firebasegen/<connectorID>
      - package: string
        <option>: string
    # Optional.
    swiftSdk:
        # Path to the directory that will be updated with the latest generated
        # iOS Swift SDK.
        # Required.
      - outputDir: string
        # Name of the package to be created.
      - package: string
        <option>: string
    # Optional.
    kotlinSdk:
        # Path to the directory that will be updated with the latest generated
        # Android SDK.
        # Required.
      - outputDir: string
        # Name of the package to be created.
      - package: string
        <option>: string

Data Connect प्रोजेक्ट के लिए IAM कॉन्फ़िगरेशन

Data Connect के लिए ज़्यादा जानकारी वाली IAM भूमिकाएं

Firebase की बुनियादी भूमिकाएं और पहले से तय भूमिकाएं, कम लेवल की Data Connect भूमिकाओं पर मैप होती हैं. मैपिंग के लिए टेबल देखें.

Data Connect के लिए, अलग-अलग आईएएम भूमिकाओं को ज़्यादा बारीकी से मैनेज करने के लिए, Google Cloud console का इस्तेमाल करें.

IAM भूमिका	अनुमतियां
firebasedataconnect.googleapis.com/admin Firebase Data Connect API एडमिन इस भूमिका में Firebase Data Connect API व्यूअर शामिल है. यह firebasedataconnect.* के बराबर है. यह अनुमति, क्लाउड के मालिक, क्लाउड एडिटर, Firebase एडमिन, और Firebase डेवलप एडमिन की भूमिकाओं वाले उपयोगकर्ताओं को मिलती है.	Firebase Data Connect API के संसाधनों का पूरा ऐक्सेस. इसमें डेटा भी शामिल है. firebasedataconnect.googleapis.com/operations.delete firebasedataconnect.googleapis.com/operations.cancel firebasedataconnect.googleapis.com/services.create firebasedataconnect.googleapis.com/services.update firebasedataconnect.googleapis.com/services.delete firebasedataconnect.googleapis.com/services.executeGraphql firebasedataconnect.googleapis.com/services.executeGraphqlRead firebasedataconnect.googleapis.com/schemas.create firebasedataconnect.googleapis.com/schemas.update firebasedataconnect.googleapis.com/schemas.delete firebasedataconnect.googleapis.com/schemaRevisions.create firebasedataconnect.googleapis.com/schemaRevisions.delete firebasedataconnect.googleapis.com/connectors.create firebasedataconnect.googleapis.com/connectors.update firebasedataconnect.googleapis.com/connectors.delete firebasedataconnect.googleapis.com/connectorRevisions.create firebasedataconnect.googleapis.com/connectorRevisions.delete
firebasedataconnect.googleapis.com/viewer Firebase Data Connect API व्यूअर यह भूमिका, क्लाउड के मालिक, क्लाउड एडिटर, क्लाउड व्यूअर, Firebase एडमिन, Firebase व्यूअर, Firebase Develop एडमिन, और Firebase Develop व्यूअर को दी जाती है.	Firebase Data Connect API के संसाधनों का रीड-ओनली ऐक्सेस. भूमिका से, डेटा का ऐक्सेस नहीं मिलता. cloudresourcemanager.googleapis.com/projects.list cloudresourcemanager.googleapis.com/projects.get firebasedataconnect.googleapis.com/operations.list firebasedataconnect.googleapis.com/operations.get firebasedataconnect.googleapis.com/locations.list firebasedataconnect.googleapis.com/locations.get firebasedataconnect.googleapis.com/services.list firebasedataconnect.googleapis.com/services.get firebasedataconnect.googleapis.com/schemas.list firebasedataconnect.googleapis.com/schemas.get firebasedataconnect.googleapis.com/schemaRevisions.list firebasedataconnect.googleapis.com/schemaRevisions.get firebasedataconnect.googleapis.com/connectors.list firebasedataconnect.googleapis.com/connectors.get firebasedataconnect.googleapis.com/connectorRevisions.list firebasedataconnect.googleapis.com/connectorRevisions.get
firebasedataconnect.googleapis.com/dataAdmin Firebase Data Connect API डेटा एडमिन यह भूमिका, क्लाउड के मालिक, क्लाउड एडिटर, Firebase एडमिन, और Firebase डेवलप एडमिन की भूमिकाओं के ज़रिए दी जाती है.	डेटा सोर्स को पढ़ने और उसमें बदलाव करने का पूरा ऐक्सेस. firebasedataconnect.googleapis.com/services.executeGraphql firebasedataconnect.googleapis.com/services.executeGraphqlRead
firebasedataconnect.googleapis.com/dataViewer Firebase Data Connect API डेटा व्यूअर यह सुविधा, क्लाउड के मालिक, क्लाउड एडिटर, Firebase एडमिन, और Firebase डेवलप एडमिन की भूमिकाओं वाले उपयोगकर्ताओं को मिलती है.	डेटा सोर्स का रीड ओनली ऐक्सेस. firebasedataconnect.googleapis.com/services.executeGraphqlRead