ใช้ Admin SDK กับ Data Connect

Firebase Admin SDK คือชุดไลบรารีเซิร์ฟเวอร์ที่ช่วยให้คุณโต้ตอบกับ Firebase จากสภาพแวดล้อมที่มีสิทธิ์เพื่อดำเนินการต่างๆ เช่น ดำเนินการค้นหาและการเปลี่ยนแปลงในบริการ Firebase Data Connect เพื่อจัดการข้อมูลจำนวนมากและการดำเนินการอื่นๆ ที่มีสิทธิ์ที่สูงขึ้น

Admin SDK มี API ให้คุณเรียกใช้การดำเนินการทั้งในโหมดอ่าน/เขียนและอ่านอย่างเดียว การดำเนินการแบบอ่านอย่างเดียวช่วยให้คุณมั่นใจได้ว่าจะใช้ฟังก์ชันการดูแลระบบที่แก้ไขข้อมูลในฐานข้อมูลไม่ได้

การตั้งค่า Admin SDK

หากต้องการเริ่มต้นใช้งานด้วย Firebase Data Connect บนเซิร์ฟเวอร์ คุณจะต้องติดตั้งและตั้งค่า Admin SDK สำหรับ 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 ช่วยให้คุณทํางานได้ง่ายขึ้นเนื่องจากไม่สนใจการตรวจสอบสิทธิ์และการให้สิทธิ์สําหรับเวิร์กโฟลว์ในเครื่อง

Firebase Admin SDK จะเชื่อมต่อกับData Connect simulatorsโดยอัตโนมัติเมื่อตั้งค่าตัวแปรสภาพแวดล้อม DATA_CONNECT_EMULATOR_HOST ดังนี้

export DATA_CONNECT_EMULATOR_HOST="127.0.0.1:8080"

ดูข้อมูลเพิ่มเติมได้ที่

ใช้ Use Case ทั่วไป

Admin SDK มีไว้สําหรับการดำเนินการที่มีสิทธิ์ในข้อมูลสําคัญ

API สำหรับ 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" } } }

ขั้นตอนถัดไปคือ