در این شروع سریع، نحوه ایجاد Firebase Data Connect را در برنامه خود خواهید آموخت.
- Firebase Data Connect به پروژه Firebase خود اضافه کنید.
- یک محیط توسعه شامل پسوند Visual Studio Code برای کار با یک نمونه تولید راه اندازی کنید.
- سپس به شما نشان خواهیم داد که چگونه:
- یک طرح واره برای یک برنامه نقد و بررسی فیلم ایجاد کنید و در مرحله تولید قرار دهید.
- پرس و جوها و جهش ها را برای طرح واره خود تعریف کنید.
- SDKهایی با تایپ قوی ایجاد کنید و از آنها در برنامه خود استفاده کنید
- طرح، پرس و جو و داده های نهایی خود را برای تولید مستقر کنید .
پیش نیازها
برای استفاده از این شروع سریع در محیط محلی خود، به موارد زیر نیاز دارید.
- لینوکس، macOS یا ویندوز
- کد ویژوال استودیو
به پروژه Firebase خود متصل شوید
- اگر قبلاً این کار را نکرده اید، یک پروژه Firebase ایجاد کنید.
- در کنسول Firebase ، روی افزودن پروژه کلیک کنید، سپس دستورالعملهای روی صفحه را دنبال کنید.
- به بخش Data Connect کنسول Firebase بروید و گردش کار راه اندازی محصول را دنبال کنید.
پروژه خود را به پلان Blaze ارتقا دهید. این به شما امکان می دهد یک Cloud SQL برای نمونه PostgreSQL ایجاد کنید.
مکانی را برای پایگاه داده CloudSQL برای PostgreSQL خود انتخاب کنید.
برای تأیید بعداً به نام و شناسه پروژه، سرویس و پایگاه داده توجه کنید.
جریان راهاندازی باقیمانده را دنبال کنید و روی Done کلیک کنید.
یک محیط توسعه را انتخاب و راه اندازی کنید
Data Connect از دو تجربه توسعه برای توسعه پشتیبانی می کند:
- اگر یک توسعهدهنده اندروید، iOS ، Flutter یا وب سایت Kotlin هستید، میتوانید از توسعه کد VS برای طراحی و آزمایش طرحوارهها و عملیات به صورت محلی و همزمان با اتصال به Cloud SQL خود برای نمونه PostgreSQL استفاده کنید.
- اگر توسعهدهنده وب هستید، میتوانید از توسعه IDX برای نمونهسازی اولیه در یک فضای کاری IDX با استفاده از یک الگوی از پیش پیکربندیشده IDX با PostgreSQL، پسوند VS Code با شبیهساز Data Connect و کد سرویسگیرنده سریع راهاندازی شده برای شما استفاده کنید. اطلاعات بیشتر را در سایت Project IDX خواهید یافت.
این شروع سریع بر جریان توسعه برنامه افزودنی VS Code متمرکز است. برای ادامه:
- یک دایرکتوری جدید برای پروژه محلی خود ایجاد کنید.
- VS Code را در دایرکتوری جدید باز کنید.
افزونه Firebase Data Connect را از Visual Studio Code Marketplace نصب کنید.
پروژه محلی خود را تنظیم کنید
CLI را با پیروی از دستورالعمل های معمولی نصب کنید. اگر npm را قبلاً نصب کرده اید، دستور زیر را اجرا کنید:
npm install -g firebase-tools
دایرکتوری پروژه خود را تنظیم کنید
برای راه اندازی پروژه محلی خود، دایرکتوری پروژه خود را مقداردهی اولیه کنید.
در پانل سمت چپ VS Code، روی نماد Firebase کلیک کنید تا رابط کاربری افزونه Firebase VS Code باز شود.
- روی دکمه Sign in with Google کلیک کنید.
- روی دکمه Connect a Firebase project کلیک کنید و پروژه ای را که قبلا در کنسول ایجاد کردید انتخاب کنید.
- روی دکمه Run firebase init کلیک کنید.
- اگر پروژه شما در طرح Blaze است، وقتی از شما خواسته شد «آیا میخواهید منابع پشتیبان خود را اکنون پیکربندی کنید؟»، به «بله» پاسخ دهید.
روی دکمه Start emulators کلیک کنید.
یک طرحواره ایجاد کنید
در فهرست پروژه Firebase، در فایل /dataconnect/schema/schema.gql
، شروع به تعریف یک طرح GraphQL کنید که شامل فیلمها میشود.
فیلم
در Data Connect ، فیلدهای GraphQL به ستونها نگاشت میشوند. نوع Movie
دارای id
, title
, imageUrl
و genre
است . Data Connect انواع داده های اولیه String
و UUID
را تشخیص می دهد.
قطعه زیر را کپی کنید یا خطوط مربوطه را در فایل از نظر خارج کنید.
# File `/dataconnect/schema/schema.gql`
# By default, a UUID id key will be created by default as primary key.
type Movie @table {
id: UUID! @default(expr: "uuidV4()")
title: String!
imageUrl: String!
genre: String
}
MovieMetadata
اکنون که فیلم دارید، می توانید ابرداده فیلم را مدل کنید.
قطعه زیر را کپی کنید یا خطوط مربوطه را در فایل از نظر خارج کنید.
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
# This time, we omit adding a primary key because
# you can rely on Data Connect to manage it.
# @unique indicates a 1-1 relationship
movie: Movie! @unique
# movieId: UUID <- this is created by the above reference
rating: Float
releaseYear: Int
description: String
}
توجه داشته باشید که فیلد movie
به نوعی از Movie
نگاشت شده است. Data Connect می داند که این رابطه بین Movie
و MovieMetadata
است و این رابطه را برای شما مدیریت می کند.
درباره طرحواره های Data Connect در مستندات بیشتر بیاموزید
طرحواره خود را در تولید مستقر کنید
اگر از افزونه Firebase VS Code برای کار با پایگاه داده تولید خود استفاده میکنید، باید قبل از ادامه طرح خود را مستقر کنید. پس از استقرار طرحواره خود در پایگاه داده تولید خود، باید بتوانید طرحواره را در کنسول مشاهده کنید.
- می توانید از پسوند Data Connect VS Code برای استقرار استفاده کنید.
- در رابط کاربری افزونه، در پانل Firebase Data Connect ، روی Deploy to production کلیک کنید.
- ممکن است لازم باشد تغییرات طرحواره را بررسی کرده و تغییرات مخرب احتمالی را تأیید کنید. از شما خواسته می شود که:
- تغییرات طرحواره را با استفاده از
firebase dataconnect:sql:diff
مرور کنید - هنگامی که از تغییرات راضی هستید، آنها را با استفاده از جریانی که توسط
firebase dataconnect:sql:migrate
آغاز شده است، اعمال کنید.
- تغییرات طرحواره را با استفاده از
داده ها را به جداول خود اضافه کنید
در پنل ویرایشگر کد VS، میتوانید مشاهده کنید که دکمههای CodeLens روی انواع GraphQL در /dataconnect/schema/schema.gql
ظاهر میشوند. از آنجایی که شما طرحواره خود را برای تولید مستقر کرده اید، می توانید از دکمه های Add data و Run (Production) برای افزودن داده به پایگاه داده خود در باطن استفاده کنید.
برای افزودن رکوردها به جدول Movie
:
- در
schema.gql
، روی دکمه افزودن داده در بالای اعلان نوعMovie
کلیک کنید. - در فایل
Movie_insert.gql
که تولید میشود، دادههای کد سخت برای چهار فیلد وجود دارد. - روی دکمه Run (Production) کلیک کنید.
- مراحل قبلی را تکرار کنید تا یک رکورد به جدول
MovieMetadata
اضافه کنید، همانطور که در جهشMovieMetadata_insert
ایجاد شده،id
فیلم خود را در قسمتmovieId
ارائه کنید.
برای تأیید سریع داده ها اضافه شد:
- به
schema.gql
برگردید، روی دکمه Read data بالای اعلان نوعMovie
کلیک کنید. - در فایل
Movie_read.gql
به دست آمده، روی دکمه Run (Production) کلیک کنید تا کوئری اجرا شود.
درباره جهش های Data Connect در مستندات بیشتر بیاموزید
سوال خود را تعریف کنید
در حال حاضر بخش سرگرم کننده، نمایش داده شد. بهعنوان یک توسعهدهنده، شما به نوشتن پرسوجوهای SQL به جای پرسوجوهای GraphQL عادت دارید، بنابراین در ابتدا کمی متفاوت به نظر میرسد. با این حال، GraphQL بسیار مختصرتر و ایمن تر از SQL خام است. و برنامه افزودنی VS Code ما تجربه توسعه را آسان می کند.
ویرایش فایل /dataconnect/connector/queries.gql
را شروع کنید. اگر میخواهید همه فیلمها را دریافت کنید، از یک پرس و جو مانند این استفاده کنید.
# File `/dataconnect/connector/queries.gql`
# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level
# is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
movies {
id
title
imageUrl
genre
}
}
پرس و جو را با استفاده از دکمه CodeLens نزدیک اجرا کنید.
درباره پرسشهای Data Connect در مستندات بیشتر بیاموزید
SDK ها را تولید کنید و از آنها در برنامه خود استفاده کنید
- روی دکمه افزودن SDK به برنامه کلیک کنید.
در گفتگوی ظاهر شده، دایرکتوری حاوی کد برنامه خود را انتخاب کنید. Data Connect کد SDK در آنجا تولید و ذخیره خواهد شد.
پلت فرم برنامه خود را انتخاب کنید، سپس توجه داشته باشید که کد SDK بلافاصله در فهرست انتخابی شما ایجاد می شود.
بیاموزید که چگونه از SDK تولید شده برای فراخوانی درخواستها و جهشهای برنامههای مشتری ( وب ، Android ، iOS ، Flutter ) استفاده کنید.
طرح و پرس و جو خود را در تولید مستقر کنید
شما از طریق یک تکرار توسعه کار کرده اید. اکنون میتوانید طرح، دادهها و درخواستهای خود را با رابط کاربری افزونه Firebase یا Firebase CLI روی سرور مستقر کنید، دقیقاً همانطور که با طرحواره خود انجام دادید.
اگر از افزونه Firebase VS Code برای استقرار استفاده می کنید، روی دکمه Deploy to production کلیک کنید.
پس از استقرار، به کنسول Firebase بروید تا بررسی کنید که طرحواره، عملیات و دادهها در فضای ابری آپلود شدهاند. شما باید بتوانید طرحواره را مشاهده کنید و عملیات خود را روی کنسول نیز اجرا کنید. Cloud SQL برای نمونه PostgreSQL با طرح و داده های تولید شده نهایی مستقر شده خود به روز می شود.
درباره استفاده از شبیه ساز Data Connect در مستندات بیشتر بیاموزید
مراحل بعدی
پروژه مستقر خود را مرور کنید و ابزارهای بیشتری را کشف کنید:
داده ها را به پایگاه داده خود اضافه کنید، طرحواره های خود را بررسی و اصلاح کنید، و سرویس Data Connect خود را در کنسول Firebase نظارت کنید. به اطلاعات بیشتر در اسناد دسترسی پیدا کنید. به عنوان مثال، از آنجایی که شروع سریع را کامل کرده اید:
درباره طرحواره، پرس و جو و توسعه جهش بیشتر بیاموزید
درباره ایجاد SDK های مشتری و درخواست های تماس و جهش از کد مشتری برای وب ، Android ، iOS و Flutter بیاموزید.
در این شروع سریع، نحوه ایجاد Firebase Data Connect را در برنامه خود خواهید آموخت.
- Firebase Data Connect به پروژه Firebase خود اضافه کنید.
- یک محیط توسعه شامل پسوند Visual Studio Code برای کار با یک نمونه تولید راه اندازی کنید.
- سپس به شما نشان خواهیم داد که چگونه:
- یک طرح واره برای یک برنامه نقد و بررسی فیلم ایجاد کنید و در مرحله تولید قرار دهید.
- پرس و جوها و جهش ها را برای طرح واره خود تعریف کنید.
- SDKهایی با تایپ قوی ایجاد کنید و از آنها در برنامه خود استفاده کنید
- طرح، پرس و جو و داده های نهایی خود را برای تولید مستقر کنید .
پیش نیازها
برای استفاده از این شروع سریع در محیط محلی خود، به موارد زیر نیاز دارید.
- لینوکس، macOS یا ویندوز
- کد ویژوال استودیو
به پروژه Firebase خود متصل شوید
- اگر قبلاً این کار را نکرده اید، یک پروژه Firebase ایجاد کنید.
- در کنسول Firebase ، روی افزودن پروژه کلیک کنید، سپس دستورالعملهای روی صفحه را دنبال کنید.
- به بخش Data Connect کنسول Firebase بروید و گردش کار راه اندازی محصول را دنبال کنید.
پروژه خود را به پلان Blaze ارتقا دهید. این به شما امکان می دهد یک Cloud SQL برای نمونه PostgreSQL ایجاد کنید.
مکانی را برای پایگاه داده CloudSQL برای PostgreSQL خود انتخاب کنید.
برای تأیید بعداً به نام و شناسه پروژه، سرویس و پایگاه داده توجه کنید.
جریان راهاندازی باقیمانده را دنبال کنید و روی Done کلیک کنید.
یک محیط توسعه را انتخاب و راه اندازی کنید
Data Connect از دو تجربه توسعه برای توسعه پشتیبانی می کند:
- اگر یک توسعهدهنده اندروید، iOS ، Flutter یا وب سایت Kotlin هستید، میتوانید از توسعه کد VS برای طراحی و آزمایش طرحوارهها و عملیات به صورت محلی و همزمان با اتصال به Cloud SQL خود برای نمونه PostgreSQL استفاده کنید.
- اگر توسعهدهنده وب هستید، میتوانید از توسعه IDX برای نمونهسازی اولیه در یک فضای کاری IDX با استفاده از یک الگوی از پیش پیکربندیشده IDX با PostgreSQL، پسوند VS Code با شبیهساز Data Connect و کد سرویسگیرنده سریع راهاندازی شده برای شما استفاده کنید. اطلاعات بیشتر را در سایت Project IDX خواهید یافت.
این شروع سریع بر جریان توسعه برنامه افزودنی VS Code متمرکز است. برای ادامه:
- یک دایرکتوری جدید برای پروژه محلی خود ایجاد کنید.
- VS Code را در دایرکتوری جدید باز کنید.
افزونه Firebase Data Connect را از Visual Studio Code Marketplace نصب کنید.
پروژه محلی خود را تنظیم کنید
CLI را با پیروی از دستورالعمل های معمولی نصب کنید. اگر npm را قبلاً نصب کرده اید، دستور زیر را اجرا کنید:
npm install -g firebase-tools
دایرکتوری پروژه خود را تنظیم کنید
برای راه اندازی پروژه محلی خود، دایرکتوری پروژه خود را مقداردهی اولیه کنید.
در پانل سمت چپ VS Code، روی نماد Firebase کلیک کنید تا رابط کاربری افزونه Firebase VS Code باز شود.
- روی دکمه Sign in with Google کلیک کنید.
- روی دکمه Connect a Firebase project کلیک کنید و پروژه ای را که قبلا در کنسول ایجاد کردید انتخاب کنید.
- روی دکمه Run firebase init کلیک کنید.
- اگر پروژه شما در طرح Blaze است، وقتی از شما خواسته شد «آیا میخواهید منابع پشتیبان خود را اکنون پیکربندی کنید؟»، به «بله» پاسخ دهید.
روی دکمه Start emulators کلیک کنید.
یک طرحواره ایجاد کنید
در فهرست پروژه Firebase، در فایل /dataconnect/schema/schema.gql
، شروع به تعریف یک طرح GraphQL کنید که شامل فیلمها میشود.
فیلم
در Data Connect ، فیلدهای GraphQL به ستونها نگاشت میشوند. نوع Movie
دارای id
, title
, imageUrl
و genre
است . Data Connect انواع داده های اولیه String
و UUID
را تشخیص می دهد.
قطعه زیر را کپی کنید یا خطوط مربوطه را در فایل از نظر خارج کنید.
# File `/dataconnect/schema/schema.gql`
# By default, a UUID id key will be created by default as primary key.
type Movie @table {
id: UUID! @default(expr: "uuidV4()")
title: String!
imageUrl: String!
genre: String
}
MovieMetadata
اکنون که فیلم دارید، می توانید ابرداده فیلم را مدل کنید.
قطعه زیر را کپی کنید یا خطوط مربوطه را در فایل از نظر خارج کنید.
# Movie - MovieMetadata is a one-to-one relationship
type MovieMetadata @table {
# This time, we omit adding a primary key because
# you can rely on Data Connect to manage it.
# @unique indicates a 1-1 relationship
movie: Movie! @unique
# movieId: UUID <- this is created by the above reference
rating: Float
releaseYear: Int
description: String
}
توجه داشته باشید که فیلد movie
به نوعی از Movie
نگاشت شده است. Data Connect می داند که این رابطه بین Movie
و MovieMetadata
است و این رابطه را برای شما مدیریت می کند.
درباره طرحواره های Data Connect در مستندات بیشتر بیاموزید
طرحواره خود را در تولید مستقر کنید
اگر از افزونه Firebase VS Code برای کار با پایگاه داده تولید خود استفاده میکنید، باید قبل از ادامه طرح خود را مستقر کنید. پس از استقرار طرحواره خود در پایگاه داده تولید خود، باید بتوانید طرحواره را در کنسول مشاهده کنید.
- می توانید از پسوند Data Connect VS Code برای استقرار استفاده کنید.
- در رابط کاربری افزونه، در پانل Firebase Data Connect ، روی Deploy to production کلیک کنید.
- ممکن است لازم باشد تغییرات طرحواره را بررسی کرده و تغییرات مخرب احتمالی را تأیید کنید. از شما خواسته می شود که:
- تغییرات طرحواره را با استفاده از
firebase dataconnect:sql:diff
مرور کنید - هنگامی که از تغییرات راضی هستید، آنها را با استفاده از جریانی که توسط
firebase dataconnect:sql:migrate
آغاز شده است، اعمال کنید.
- تغییرات طرحواره را با استفاده از
داده ها را به جداول خود اضافه کنید
در پنل ویرایشگر کد VS، میتوانید مشاهده کنید که دکمههای CodeLens روی انواع GraphQL در /dataconnect/schema/schema.gql
ظاهر میشوند. از آنجایی که شما طرحواره خود را برای تولید مستقر کرده اید، می توانید از دکمه های Add data و Run (Production) برای افزودن داده به پایگاه داده خود در باطن استفاده کنید.
برای افزودن رکوردها به جدول Movie
:
- در
schema.gql
، روی دکمه افزودن داده در بالای اعلان نوعMovie
کلیک کنید. - در فایل
Movie_insert.gql
که تولید میشود، دادههای کد سخت برای چهار فیلد وجود دارد. - روی دکمه Run (Production) کلیک کنید.
- مراحل قبلی را تکرار کنید تا یک رکورد به جدول
MovieMetadata
اضافه کنید، همانطور که در جهشMovieMetadata_insert
ایجاد شده،id
فیلم خود را در قسمتmovieId
ارائه کنید.
برای تأیید سریع داده ها اضافه شد:
- به
schema.gql
برگردید، روی دکمه Read data بالای اعلان نوعMovie
کلیک کنید. - در فایل
Movie_read.gql
به دست آمده، روی دکمه Run (Production) کلیک کنید تا کوئری اجرا شود.
درباره جهش های Data Connect در مستندات بیشتر بیاموزید
سوال خود را تعریف کنید
در حال حاضر بخش سرگرم کننده، نمایش داده شد. بهعنوان یک توسعهدهنده، شما به نوشتن پرسوجوهای SQL به جای پرسوجوهای GraphQL عادت دارید، بنابراین در ابتدا کمی متفاوت به نظر میرسد. با این حال، GraphQL بسیار مختصرتر و ایمن تر از SQL خام است. و برنامه افزودنی VS Code ما تجربه توسعه را آسان می کند.
ویرایش فایل /dataconnect/connector/queries.gql
را شروع کنید. اگر میخواهید همه فیلمها را دریافت کنید، از یک پرس و جو مانند این استفاده کنید.
# File `/dataconnect/connector/queries.gql`
# @auth() directives control who can call each operation.
# Anyone should be able to list all movies, so the auth level
# is set to PUBLIC
query ListMovies @auth(level: PUBLIC) {
movies {
id
title
imageUrl
genre
}
}
پرس و جو را با استفاده از دکمه CodeLens نزدیک اجرا کنید.
درباره پرسشهای Data Connect در مستندات بیشتر بیاموزید
SDK ها را تولید کنید و از آنها در برنامه خود استفاده کنید
- روی دکمه افزودن SDK به برنامه کلیک کنید.
در گفتگوی ظاهر شده، دایرکتوری حاوی کد برنامه خود را انتخاب کنید. Data Connect کد SDK در آنجا تولید و ذخیره خواهد شد.
پلت فرم برنامه خود را انتخاب کنید، سپس توجه داشته باشید که کد SDK بلافاصله در فهرست انتخابی شما ایجاد می شود.
بیاموزید که چگونه از SDK تولید شده برای فراخوانی درخواستها و جهشهای برنامههای مشتری ( وب ، Android ، iOS ، Flutter ) استفاده کنید.
طرح و پرس و جو خود را در تولید مستقر کنید
شما از طریق یک تکرار توسعه کار کرده اید. اکنون میتوانید طرح، دادهها و درخواستهای خود را با رابط کاربری افزونه Firebase یا Firebase CLI روی سرور مستقر کنید، دقیقاً همانطور که با طرحواره خود انجام دادید.
اگر از افزونه Firebase VS Code برای استقرار استفاده می کنید، روی دکمه Deploy to production کلیک کنید.
پس از استقرار، به کنسول Firebase بروید تا بررسی کنید که طرحواره، عملیات و دادهها در فضای ابری آپلود شدهاند. شما باید بتوانید طرحواره را مشاهده کنید و عملیات خود را روی کنسول نیز اجرا کنید. Cloud SQL برای نمونه PostgreSQL با طرح و داده های تولید شده نهایی مستقر شده خود به روز می شود.
درباره استفاده از شبیه ساز Data Connect در مستندات بیشتر بیاموزید
مراحل بعدی
پروژه مستقر خود را مرور کنید و ابزارهای بیشتری را کشف کنید:
داده ها را به پایگاه داده خود اضافه کنید، طرحواره های خود را بررسی و اصلاح کنید، و سرویس Data Connect خود را در کنسول Firebase نظارت کنید. به اطلاعات بیشتر در اسناد دسترسی پیدا کنید. به عنوان مثال، از آنجایی که شروع سریع را کامل کرده اید:
درباره طرحواره، پرس و جو و توسعه جهش بیشتر بیاموزید
درباره ایجاد SDK های مشتری و درخواست های تماس و جهش از کد مشتری برای وب ، Android ، iOS و Flutter بیاموزید.