استخدام SDK للمشرف مع Data Connect

‫Firebase Admin SDK هي مجموعة من مكتبات الخادم التي تتيح لك التفاعل مع Firebase من البيئات المميّزة لتنفيذ إجراءات مثل تنفيذ طلبات البحث والعمليات على خدمة Firebase Data Connect لإدارة البيانات المجمّعة وعمليات أخرى بصلاحيات مميّزة.

توفّر Admin SDK واجهة برمجة تطبيقات لاستدعاء العمليات في وضعَي القراءة/الكتابة والقراءة فقط. باستخدام عمليات القراءة فقط، يمكنك الشعور بالراحة عند تنفيذ الوظائف الإدارية التي لا يمكنها تعديل البيانات في قواعد بياناتك.

إعداد حزمة SDK للمشرف

لبدء استخدام Firebase Data Connect على خادمك، عليك أولاً تثبيت حزمة Admin SDK وإعدادها ليعمل مع IDE Node.js.

إعداد حزمة Admin SDK في النصوص البرمجية

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


import { initializeApp } from 'firebase-admin/app';
import { getDataConnect } from 'firebase-admin/data-connect';

// If you'd like to use OAuth2 flows and other credentials to log in,
// visit https://firebase.google.com/docs/admin/setup#initialize-sdk
// for alternative ways to initialize the SDK.

const app = initializeApp();

const dataConnect = getDataConnect({
    serviceId: 'serviceId',
    location: 'us-west2'
});

تصميم طلبات البحث والتغييرات لاستخدامها مع Admin SDK

يكون Admin SDK مفيدًا لاختبار عمليات Data Connect، مع مراعاة الاعتبارات التالية.

فهم توجيه عمليات حزمة تطوير البرامج (SDK) و@auth(level: NO_ACCESS)

بما أنّ Admin SDK يعمل باستخدام امتيازات، يمكنه تنفيذ أي من طلبات البحث والطفرات بغض النظر عن مستويات الوصول التي تم ضبطها باستخدام توجيهات @auth، بما في ذلك مستوى NO_ACCESS.

إذا كنت تُنظّم طلبات البحث الإدارية والعمليات الإدارية في ملفات المصدر .gql لاستيرادها إلى النصوص البرمجية الإدارية، بجانب عمليات العميل، يقترح Firebase وضع علامة على العمليات الإدارية بدون أي مستوى وصول إذن، أو ربما يكون أكثر وضوحًا وضبطها على NO_ACCESS. وفي كلتا الحالتَين، يمنع ذلك تنفيذ هذه العمليات من العميل أو في سياقات أخرى غير مميّزة.

استخدام حزمة تطوير البرامج (SDK) مع محاكي "Data Connect"

في النماذج الأولية وبيئات الاختبار، قد يكون من المفيد إجراء بذر البيانات وعمليات أخرى على البيانات المحلية. يتيح لك الخيار Admin SDK تبسيط عمليات سير العمل لأنّه يتجاهل المصادقة والتفويض لعمليات سير العمل المحلية.

تتصل حِزم تطوير البرامج (SDK) الخاصة بمسؤولي Firebase تلقائيًا بمحاكي Data Connect عند ضبط متغيّر البيئة DATA_CONNECT_EMULATOR_HOST:

export DATA_CONNECT_EMULATOR_HOST="127.0.0.1:8080"

يمكنك الاطّلاع على ما يلي للحصول على مزيد من المعلومات:

تنفيذ حالات الاستخدام الشائعة

يتم توفير Admin SDK لإجراء عمليات مميّزة على بياناتك المهمة.

تتألف واجهة برمجة التطبيقات لخدمة Data Connect من واجهة executeGraphql للقراءة والكتابة وواجهة executeGraphqlRead للقراءة فقط.

إدارة بيانات المستخدمين

ومن حالات الاستخدام الشائعة لـ Admin SDK هي إدارة بيانات المستخدمين.

interface UserData {
  user: {
    id: string;
    name: string;
  };
}

export interface UserVariables {
  id: string;
}

const options:GraphqlOptions<UserVariables> = { variables: { id: "QVBJcy5ndXJ1" } };

// user can be publicly accessible, or restricted to admins
const query = "query getProfile(id: AuthID) { user(id: $id) { id name } }";

//executeGraphql
const gqlResponse = await dataConnect.executeGraphql<UserData, UserVariables>(query, options);

//executeGraphqlRead (similar to above but only for read operations)
const gqlResponse = await dataConnect.executeGraphqlRead<UserData, UserVariables>(query, options);

// gqlResponse -> { "data": { "user": { "id": "QVBJcy5ndXJ1", "name": "Fred" } } }

ما هي الخطوات التالية؟