با Firebase Data Connect شروع کنید

در این شروع سریع، یاد خواهید گرفت که چگونه:

  • Firebase Data Connect به پروژه Firebase خود اضافه کنید.
  • یک محیط توسعه شامل پسوند Visual Studio Code برای کار با یک نمونه تولید راه اندازی کنید.
  • سپس به شما نشان خواهیم داد که چگونه:
    • یک طرح برای یک برنامه ایمیل ایجاد کنید و آن را در مرحله تولید قرار دهید.
    • پرس و جوها و جهش ها را برای طرح واره خود تعریف کنید.
    • طرح، پرس و جو و داده های نهایی خود را برای تولید مستقر کنید.

پیش نیازها

برای استفاده از این شروع سریع، به موارد زیر نیاز دارید.

به پروژه Firebase خود متصل شوید

  1. اگر قبلاً این کار را نکرده اید، یک پروژه Firebase ایجاد کنید.
    1. در کنسول Firebase ، روی افزودن پروژه کلیک کنید، سپس دستورالعمل‌های روی صفحه را دنبال کنید.

  2. پروژه خود را به پلان Blaze ارتقا دهید. این به شما امکان می دهد یک Cloud SQL برای نمونه PostgreSQL ایجاد کنید.

  3. به بخش Data Connect کنسول Firebase بروید و گردش کار راه اندازی محصول را دنبال کنید.

  4. مکانی را برای پایگاه داده CloudSQL برای PostgreSQL خود انتخاب کنید.

  5. برای تأیید بعداً به نام و شناسه پروژه، سرویس و پایگاه داده توجه کنید.

  6. جریان راه‌اندازی باقی‌مانده را دنبال کنید و روی Done کلیک کنید.

یک محیط توسعه را انتخاب و راه اندازی کنید

Data Connect از دو تجربه توسعه برای نمونه سازی پشتیبانی می کند:

  • اگر یک توسعه‌دهنده اندروید ، iOS یا وب Kotlin هستید، می‌توانید از توسعه VS Code برای طراحی و آزمایش طرح‌واره‌ها و عملیات به صورت محلی و همزمان با اتصال به Cloud SQL خود برای نمونه PostgreSQL استفاده کنید.
  • اگر یک توسعه‌دهنده وب هستید، می‌توانید از توسعه IDX برای توسعه در یک فضای کاری IDX با استفاده از یک الگوی از پیش پیکربندی شده IDX با PostgreSQL، پسوند VS Code با شبیه‌ساز Data Connect و کد راه‌اندازی سریع برای شما استفاده کنید. اطلاعات بیشتر را در سایت Project IDX خواهید یافت.

این شروع سریع بر جریان توسعه برنامه افزودنی VS Code متمرکز است. برای ادامه:

  1. یک دایرکتوری جدید برای پروژه محلی خود ایجاد کنید.
  2. VS Code را در دایرکتوری جدید باز کنید.

  3. برنامه افزودنی را به صورت بسته VSIX از Firebase Storage دانلود کنید.

  4. در VS Code، از منوی View ، Extensions را انتخاب کنید.

  5. در نوار عنوان پانل Extensions ، روی نماد منو more_horiz کلیک کنید، سپس Install from VSIX... را دنبال کنید.

به صورت اختیاری، می توانید یک پایگاه داده محلی PostgreSQL را برای توسعه محلی با شبیه ساز Data Connect نصب کنید. این تنظیمات در انتهای این راهنمای شروع سریع پوشش داده شده است.

پروژه محلی خود را تنظیم کنید

CLI را با پیروی از دستورالعمل های معمولی نصب کنید. اگر npm را قبلاً نصب کرده اید، دستور زیر را اجرا کنید:

npm install -g firebase-tools

دایرکتوری پروژه خود را تنظیم کنید

برای راه اندازی پروژه محلی خود، دایرکتوری پروژه خود را مقداردهی اولیه کنید.

در پانل سمت چپ VS Code، روی نماد Firebase کلیک کنید تا رابط کاربری افزونه Firebase VS Code باز شود.

در رابط کاربری افزونه Firebase:

  1. مطمئن شوید که وارد سیستم شده اید.
  2. روی دکمه Run firebase init کلیک کنید.
  3. برگه ترمینال را در پنل پایینی VS Code برای دریافت اعلان بررسی کنید.
  4. Data Connect را به عنوان یک ویژگی برای استفاده در این فهرست انتخاب کنید.
  5. هنگامی که از شما خواسته شد، شناسه پروژه، سرویس و پایگاه داده پروژه Data Connect را که قبلاً در کنسول ایجاد کردید، ارائه دهید.

یک طرحواره ایجاد کنید

در فهرست پروژه Firebase، در فایل /dataconnect/schema/schema.gql ، شروع به تعریف یک طرح GraphQL کنید که شامل کاربران و ایمیل‌ها می‌شود.

کاربر

در Data Connect ، فیلدهای GraphQL به ستون‌ها نگاشت می‌شوند. کاربران یک uid ، name و address ایمیل دارند. Data Connect چندین نوع داده اولیه را می شناسد: String و Date .

قطعه زیر را کپی کنید یا خطوط مربوطه را در فایل از نظر خارج کنید.

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

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

به‌طور پیش‌فرض Firebase Data Connect یک کلید id UUID اضافه می‌کند، اگر هیچ کلیدی ارائه نشود. با این حال، در این مورد می‌خواهید uid من کلید اصلی باشد، که می‌توانید از طریق دستور العمل @table(key: "uid") انجام دهید.

ایمیل

اکنون که کاربران دارید، می توانید ایمیل ها را مدل کنید. در اینجا می توانید فیلدهای معمولی (یا ستون ها) را برای داده های ایمیل اضافه کنید. این بار، از افزودن کلید اصلی صرف نظر می کنیم زیرا می توانید برای مدیریت آن به Data Connect تکیه کنید.

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

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

توجه داشته باشید که فیلد from به نوعی از User نگاشت شده است. Data Connect می داند که این رابطه بین Email و User است و این رابطه را برای شما مدیریت خواهد کرد.

طرحواره خود را در تولید مستقر کنید

اگر از افزونه Firebase VS Code برای کار با پایگاه داده تولید خود استفاده می‌کنید، باید قبل از ادامه طرح خود را مستقر کنید. پس از استقرار طرحواره خود در پایگاه داده تولید خود، باید بتوانید طرحواره را در کنسول مشاهده کنید.

  1. می توانید از پسوند Firebase VS Code برای استقرار استفاده کنید.
    • در رابط کاربری افزونه، در زیر پانل Firebase Data Connect ، روی Deploy کلیک کنید.
  2. ممکن است لازم باشد تغییرات طرحواره را بررسی کرده و تغییرات مخرب احتمالی را تأیید کنید. از شما خواسته می شود که:
    • تغییرات طرحواره را با استفاده از firebase dataconnect:sql:diff مرور کنید
    • هنگامی که از تغییرات راضی هستید، آنها را با استفاده از جریانی که توسط firebase dataconnect:sql:migrate آغاز شده است، اعمال کنید.

داده ها را به جداول خود اضافه کنید

در پنل ویرایشگر کد VS، می‌توانید مشاهده کنید که دکمه‌های CodeLens روی انواع GraphQL در /dataconnect/schema/schema.gql ظاهر می‌شوند. از آنجایی که شما طرحواره خود را برای تولید مستقر کرده اید، می توانید از دکمه های Add data و Run (Production) برای افزودن داده به پایگاه داده خود در باطن استفاده کنید.

برای افزودن رکورد به جداول User و Email :

  1. در schema.gql ، روی دکمه افزودن داده در بالای اعلان نوع User کلیک کنید.
    لنز کد دکمه افزودن داده برای Firebase Data Connect
  2. در فایل User_insert.gql که تولید می‌شود، داده‌های کد سخت برای سه فیلد وجود دارد.
  3. روی دکمه Run (Production) کلیک کنید.
    دکمه اجرای کد لنز برای اتصال داده Firebase
  4. همانطور که در جهش ایجاد شده Email_insert خواسته شده است، مراحل قبلی را تکرار کنید تا یک رکورد به جدول Email اضافه کنید، و uid کاربر خود را در قسمت fromUid فراهم کنید.

سوال خود را تعریف کنید

در حال حاضر بخش سرگرم کننده، نمایش داده شد. به‌عنوان یک توسعه‌دهنده، شما به نوشتن پرس‌وجوهای SQL به جای پرس‌و‌جوهای GraphQL عادت دارید، بنابراین در ابتدا کمی متفاوت به نظر می‌رسد. با این حال، GraphQL بسیار مختصرتر و ایمن تر از SQL خام است. و برنامه افزودنی VS Code ما تجربه توسعه را آسان می کند.

ویرایش فایل /dataconnect/connector/queries.gql را شروع کنید. اگر می خواهید همه ایمیل ها را دریافت کنید، از یک پرس و جو مانند این استفاده کنید.

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

query ListEmails @auth(level: NO_ACCESS) {
  emails {
    id, subject, text, sent
    from {
      name
    }
  }
}

پرس و جو را با استفاده از دکمه CodeLens نزدیک اجرا کنید.

یک ویژگی واقعا هیجان انگیز در اینجا، توانایی برخورد با روابط پایگاه داده مانند یک نمودار است. از آنجایی که یک ایمیل دارای یک فیلد from است که به کاربر ارجاع می دهد، می توانید در فیلد لانه کرده و اطلاعات مربوط به کاربر را دریافت کنید.

طرح و پرس و جو خود را در تولید مستقر کنید

شما از طریق یک تکرار توسعه کار کرده اید. اکنون می‌توانید طرح، داده‌ها و پرسش‌های خود را با رابط کاربری افزونه Firebase یا Firebase CLI روی سرور مستقر کنید، درست همانطور که با طرحواره خود (#deploy-schema) انجام دادید.

اگر از افزونه Firebase VS Code برای استقرار استفاده می کنید، روی دکمه Deploy کلیک کنید.

پس از استقرار، باید بتوانید عملیات خود را روی کنسول مشاهده و اجرا کنید. سرویس Data Connect شما برای پردازش عملیات مشتریان آماده خواهد بود. Cloud SQL برای نمونه PostgreSQL با طرح و داده های تولید شده نهایی مستقر شده خود به روز می شود.

(اختیاری) PostgreSQL را به صورت محلی نصب کنید

نصب PostgreSQL به صورت محلی و ادغام آن با شبیه ساز به شما امکان می دهد در یک محیط توسعه کاملاً محلی نمونه سازی کنید.

می توانید یک نمونه جدید از PostgreSQL را نصب کنید یا از یک نمونه موجود استفاده کنید.

PostgreSQL را نصب کنید

PostgreSQL نسخه 15.x را زیر دستورالعمل های پلتفرم خود نصب کنید.

به نام میزبان، پورت، نام کاربری و رمز عبور و پارامترهای مربوط به خروجی در طول مراحل نصب توجه کنید.

برای اتصال به نمونه PostgreSQL، شبیه ساز به موارد زیر نیاز دارد:

  • این پارامترهای پیکربندی راه اندازی
  • نام پایگاه داده از dataconnect.yaml شما و یک پایگاه داده با نام مربوطه در نمونه محلی شما مقداردهی اولیه شده است.

از نمونه محلی PostgreSQL خود استفاده کنید

می‌توانید با به‌روزرسانی تنظیمات شبیه‌ساز Data Connect از یک نمونه محلی PostgreSQL استفاده کنید.

firebase setup:emulators:dataconnect

وقتی از شما خواسته شد، رشته اتصال PostgreSQL را در این قالب وارد کنید: postgresql://postgresusername:postgrespassword@localhost:5432/postgresdatabase?sslmode=disable .

برای اطلاعات بیشتر در مورد رشته اتصال، به مستندات PostgreSQL مراجعه کنید.

به نمونه PostgreSQL محلی خود متصل شوید

با انجام این پیکربندی، برای اتصال به پایگاه داده محلی خود:

  1. در VS Code، در پانل سمت چپ، روی نماد Firebase کلیک کنید تا رابط کاربری افزونه Firebase VS Code باز شود.
  2. روی دکمه Connect to Local PostgreSQL کلیک کنید.

مراحل بعدی