مرجع أمر واجهة سطر الأوامر في Firebase لـ Data Connect

ملاحظة: يتوفر "Firebase Data Connect" ضمن برنامج "الميزات التجريبية المتاحة للجميع". تخضع Data Connect "لأحكام العروض لمرحلة ما قبل التوفّر للجمهور العام" في القسم الأحكام الخاصة بالخدمة من بنود خدمة Google Cloud Platform. تتوفّر ميزات مرحلة ما قبل التوفّر للجمهور العام. "كما هي" وقد يكون دعمها محدودًا. لمزيد من المعلومات، يُرجى الاطّلاع على أوصاف مرحلة الإطلاق.

واجهة سطر الأوامر Firebase هي أداة تتيح لك إدارة Firebase وإعداده المنتجات والخدمات من سطر الأوامر.

توفّر واجهة برمجة التطبيقات (CLI) أوامر يمكن استخدامها لتنفيذ مجموعة متنوعة من مهام Data Connect، مثل إنشاء مشروع Data Connect جديد وإعداد دليل عمل محلي ملائم وإعداد محاكي Data Connect وعرض موارد Data Connect و إنشاء حِزم تطوير البرامج (SDK) للعملاء وغير ذلك.

أوامر الإعداد

إضافة Data Connect إلى مشروع Firebase

firebase init

استخدِم firebase init لإعداد إعدادات مشروع محلي جديد. ينشئ سير العمل هذا ملفات إعدادات Firebase أو يعدّلها في directory.

firebase init

يرشدك مسار "firebase init" خلال عملية إعداد خدمة وقاعدة بيانات. ويمكنك اختياريًا تثبيت محاكي Data Connect وإعداد حِزم تطوير البرامج (SDK) التي تم إنشاؤها

إعداد قاعدة البيانات والخدمة

في حال اختيار dataconnect لإعداد المنتج، سيطلب منك واجهة سطر الأوامر اسم الخدمة وموقعها، وما إذا كان ينبغي الربط وخدمة Cloud SQL الحالية مثيل PostgreSQL أو إنشاء مثيل جديد

في حال ربط مثيل حالي، يتحقق واجهة سطر الأوامر (CLI) من الإعدادات المتوافقة، مثل كمصادقة إدارة الهوية وإمكانية الوصول وعناوين IP العامة.

ملاحظة: يمكن أن يستغرق توفير مثيل Cloud SQL جديد أثناء عملية الإعداد ما يصل إلى 15 دقيقة.

إعداد "Local Emulator Suite"

يعرض مسار سطر الأوامر إعداد المحاكيات، بما في ذلك Data Connect المحاكي.

Data Connect أوامر المحاكي

بدء محاكي "Data Connect"

emulators:start/exec

firebase emulators:start/exec

استخدِم الإصدار Local Emulator Suite من محاكي Data Connect في الوضع التفاعلي مع start أو الوضع غير التفاعلي المستنِد إلى النصوص البرمجية مع exec.

ملاحظة: يمكنك استخدام كلّ من الإصدار Local Emulator Suite من المحاكي و المحاكي المدمج مع إضافة Data Connect في VS Code في بيئة العمل نفسها. ولا يتأثر المحاكي الأخير بالأوامر التي تصدرها باستخدام واجهة سطر الأوامر Firebase.

أوامر إدارة المخططات والموصّلات

يحتوي هذا القسم على معلومات مرجعية لواجهة سطر الأوامر عن الأوامر التي تستخدمها لإدارة المخططات وأدوات الربط.

للحصول على معلومات حول حالات طريقة الاستخدام والممارسات المقترَحة المتعلّقة بهذه الأوامر، يُرجى الاطّلاع على دليل إدارة المخططات والموصلات.

نشر موارد المخطط والموصّل

تفعيل

firebase deploy

ينشر هذا الأمر الموارد لخدمات Data Connect المفهرَسة في firebase.json. نقل بيانات المخطط إذا لزم الأمر.

Command	الوصف
تفعيل firebase	الإبلاغ	الوصف
	–-only dataconnect	يمكنك نشر المخططات وأدوات الربط لجميع خدمات Data Connect لهذا المشروع، ولكن لا يمكنك نشر موارد منتجات Firebase الأخرى.
	–-only dataconnect:serviceId	نشر المخطّط وأدوات الربط لخدمة Data Connect المحدّدة
	–-only dataconnect:serviceId:connectorId	نشر موصل واحد لخدمة Data Connect المحددة.
	–-only dataconnect:serviceId:schema	انشر المخطط لخدمة Data Connect المحدّدة.

باستخدام علامات –-only، يمكنك تمرير قيم مفصولة بفواصل لنشر أي مجموعة فرعية من الموارد التي تريدها.

firebase deploy --only dataconnect:service1:schema,dataconnect:service2

إدراج خدمات ومخططات وموصِّلات Data Connect

dataconnect:services:list

firebase dataconnect:services:list

يطبع هذا الأمر معلومات أساسية عن الخدمات والمخططات والموصلات. المنشورة في مشروع ما.

مقارنة مخطّطات SQL ونقلها

dataconnect:sql:diff

firebase dataconnect:sql:diff

يقارن هذا الأمر المخطّط المحلي لخدمة مع المخطّط الحالي لقاعدة بيانات Cloud SQL المقابلة. يطبع الأوامر التي سيتم تشغيلها لنقل قاعدة البيانات إلى المخطط الجديد.

الأمر	الوصف
firebase dataconnect:sql:diff	علامة/مَعلمة	الوصف
	serviceId	حدِّد الخدمة. إذا تم حذفها، اطبع الاختلاف بين جميع الخدمات في firebase.json.

dataconnect:sql:migrate

firebase dataconnect:sql:migrate

يطبّق هذا الأمر تغييرات المخطّط المحلي على قاعدة بيانات Cloud SQL لخدمة معيّنة.

عند إعداد مشروع Data Connect جديد على الجهاز، باستخدام ملف dataconnect.yaml التلقائي، يتمثل سلوك الأمر dataconect:sql:migrate في إعلامك بأي تغييرات مطلوبة، ثم إعلامك بأي تغييرات اختيارية، قبل تنفيذ التغييرات. يمكنك تعديل هذا السلوك لتضمين التغييرات الاختيارية أو تجاهلها دائمًا من خلال تعديل إعدادات dataconnect.yaml ، كما هو موضّح في مقالة نقل مخطّط في الوضع الصارم أو المتوافق.

في البيئات التفاعلية، يعرض واجهة سطر الأوامر كل عبارة SQL (لغة الاستعلام البنيوية) للهجرة (وما إذا كان ضارًا) وطلبات بالتغييرات التي تريد تطبيقها. يعني اجتياز العلامة --force قبول جميع الطلبات.

في البيئات غير التفاعلية:

• بدون --force، فسيتم إجراء تغييرات غير مدمرة فقط. في حال حدوث تغييرات مدمرة، يتم إيقاف وحدة التحكم في واجهة المستخدم بدون إجراء أي تغييرات.
• مع --force، يتم إجراء جميع التغييرات. إذا كان ذلك يتضمّن أي تغييرات تدميرية، تتم طباعتها ويُطلب منك تحديد ما إذا كنت تريد المتابعة، ما لم يتم تقديم علامة --force.

Command	الوصف
firebase dataconnect:sql:migrate	الإبلاغ	الوصف
	serviceId	نقل قاعدة البيانات للخدمة المحدّدة. يتم تحديد serviceId بشكلٍ افتراضي إذا كان مشروعك يتضمّن خدمة واحدة فقط.
	–-force	قبول الطلبات تلقائيًا

كما هو الحال مع علامات --only الأخرى، يمكنك تقديم خدمات متعددة مفصولة بفواصل.

نقل مخطّط في الوضع الصارم أو المتوافق

Data Connect تتضمّن عمليات نقل المخططات وضعَين مختلفَين للتحقّق من صحة المخطط: صارم ومتوافق. يتطلب التحقّق من الصحة في الوضع الصارم أن يتطابق مخطّط قاعدة بيانات تمامًا مع مخطّط التطبيق قبل أن يتم نشر مخطّط التطبيق. يتطلّب التحقّق من توافق الوضع أن يكون مخطّط قاعدة بيانات متوافقًا مع مخطّط التطبيق، ما يعني أنّه لا يتم تعديل العناصر في قاعدة بياناتك التي لا يستخدمها مخطّط التطبيق.

يمكنك الاطّلاع على أوضاع التحقّق من المخطّط وأفضل الممارسات لنقل المخطّط في دليل إدارة المخطّط والرابط.

يتم تحديد وضع التحقّق من الصحة باستخدام مفتاح schemaValidation في ملف dataconnect.yaml. إذا لم يتم تحديد schemaValidation، تطبِّق وحدة تحكّم سطر الأوامر التغييرات المتوافقة وتسألك قبل تنفيذ أي تغييرات صارمة. اطّلِع على مرجع الضبط.

أوامر حزمة تطوير البرامج (SDK)

إنشاء حِزم تطوير البرامج (SDK)

dataconnect:sdk:generate

firebase dataconnect:sdk:generate

ينشئ هذا الأمر حِزم SDK المكتوبة التي تمّ الإعلان عنها في connector.yaml.

اطّلِع أيضًا على أدلّة العمل باستخدام حِزم تطوير البرامج (SDK) على الويب. حِزم تطوير البرامج (SDK) لنظام التشغيل Android وحِزم تطوير البرامج (SDK) لنظام التشغيل iOS.

الأمر	الوصف
firebase dataconnect:sdk:generate	الإبلاغ	الوصف
	–-مشاهدة	مواصلة العملية وإنشاء حِزم تطوير برامج (SDK) جديدة كلما حفظت تغييرات على ملفات GQL للمخطط والموصل. إذا تعذّر الإنشاء، ستتم طباعة الأخطاء على تنسيق stdout، وهو الرمز الذي تم إنشاؤه وسوف يستمر الأمر قيد التشغيل.
	–-only ConnectorId:platform	لا تُنشئ حِزم تطوير البرامج إلا لمنصّة واحدة وموصّل واحد.

باستخدام علامات –only، يمكنك تمرير قيم مفصولة بفواصل.

firebase dataconnect:sdk:generate –-only connector1, connector1:kotlin

أوامر إدارة Cloud SQL

منح أدوار SQL في Cloud SQL

dataconnect:sql:grant

firebase dataconnect:sql:grant

يمنح هذا الأمر دور مستخدم PostgreSQL للمستخدم أو حساب الخدمة المحدّدَين:

• القارئ: يمكنه القراءة من الجداول في المخطّط.
• الكاتب: يمكنه قراءة الجداول والكتابة إليها في المخطط.
• المالك: يمكنه إجراء عمليات نقل البيانات وتغيير المخطّط. الحالات المستبعدة إذنًا لتثبيت الإضافات.

ملاحظة: تختلف أدوار SQL هذه عن أدوار إدارة الهوية وإمكانية الوصول في Cloud SQL. تتحكّم أدوار إدارة الهوية وإمكانية الوصول في المستخدمين الذين يمكنهم الوصول إلى قاعدة بيانات. تتحكّم أدوار SQL في العمليات التي يمكنك تنفيذها باستخدام هذا الوصول، والجداول التي يمكنك تعديلها.

الأمر	الوصف
firebase dataconnect:sql:grant	العلامة/المَعلمة	الوصف
	-R أو --role role	دور SQL المطلوب منحه، وهو أحد الأدوار التالية: مالك أو كاتب أو قارئ
	-E, --email email_address	عنوان بريد إلكتروني لمستخدم أو حساب خدمة لمنح الدور إليه

الخيارات العامة

تنطبق الخيارات العامة التالية على جميع الأوامر:

• يحوِّل --json إخراج واجهة سطر الأوامر إلى JSON للتحليل باستخدام أدوات أخرى.
• الإلغاء التلقائي للسمتَين --noninteractive و--interactive، حسب الحاجة اكتشاف البيئات التي لا تستخدم جهاز TTY.