एडमिन डेटाबेस एपीआई के बारे में जानकारी

Admin SDK टूल की मदद से, एडमिन के सभी अधिकारों के साथ या सीमित अधिकारों के साथ, रीयलटाइम डेटाबेस का डेटा पढ़ा और लिखा जा सकता है. इस दस्तावेज़ में, हम आपको Firebase Realtime Database को ऐक्सेस करने के लिए, अपने प्रोजेक्ट में Firebase Admin SDK टूल जोड़ने का तरीका बताएंगे.

Admin SDK सेटअप करना

अपने सर्वर पर Firebase Realtime Database का इस्तेमाल शुरू करने के लिए, आपको अपनी पसंद की भाषा में Firebase Admin SDK टूल को सेट अप करना होगा.

Admin SDK की पुष्टि करना

Firebase Admin SDK टूल का इस्तेमाल करके, किसी सर्वर से Firebase Realtime Database को ऐक्सेस करने से पहले, आपको Firebase की मदद से अपने सर्वर की पुष्टि करनी होगी. किसी सर्वर की पुष्टि करने के लिए, क्लाइंट ऐप्लिकेशन में उपयोगकर्ता खाते के क्रेडेंशियल से साइन इन करने के बजाय, सेवा खाते से साइन इन किया जाता है. इससे Firebase को आपके सर्वर की पहचान करने में मदद मिलती है.

Firebase Admin SDK टूल का इस्तेमाल करके पुष्टि करने पर, आपको दो अलग-अलग लेवल का ऐक्सेस मिल सकता है:

Firebase Admin SDK टूल के लिए पुष्टि करने की सुविधा के ऐक्सेस लेवल
एडमिन के अधिकार किसी प्रोजेक्ट के Realtime Database को पढ़ने और उसमें बदलाव करने का पूरा ऐक्सेस. डेटा माइग्रेट करने या प्रोजेक्ट का स्ट्रक्चर बदलने जैसे एडमिन से जुड़े कामों को पूरा करने के लिए, इस सुविधा का इस्तेमाल सावधानी से करें. इन कामों के लिए, आपके पास प्रोजेक्ट के संसाधनों का बिना किसी पाबंदी वाला ऐक्सेस होना चाहिए.
सीमित सुविधाएं किसी प्रोजेक्ट के Realtime Database का ऐक्सेस, सिर्फ़ उन संसाधनों तक सीमित है जिनकी आपके सर्वर को ज़रूरत है. इस लेवल का इस्तेमाल, एडमिन के तौर पर ऐसे कामों को पूरा करने के लिए करें जिनके लिए ऐक्सेस की ज़रूरी शर्तें पहले से तय हों. उदाहरण के लिए, पूरे डेटाबेस का डेटा पढ़ने वाले, खास जानकारी देने वाले जॉब को चलाते समय, रीड-ओनली सुरक्षा नियम सेट करके, डेटा को गलती से लिखे जाने से बचाया जा सकता है. इसके बाद, उस नियम से सीमित अनुमतियों के साथ एडमिन SDK टूल को शुरू किया जा सकता है.

एडमिन के खास अधिकारों से पुष्टि करना

जब Firebase प्रोजेक्ट में एडिटर की भूमिका वाले सेवा खाते के क्रेडेंशियल का इस्तेमाल करके, Firebase Admin SDK टूल को शुरू किया जाता है, तो उस इंस्टेंस के पास आपके प्रोजेक्ट के Realtime Database को पढ़ने और उसमें बदलाव करने का पूरा ऐक्सेस होता है.

Java
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccount.json");

// Initialize the app with a service account, granting admin privileges
FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.fromStream(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .build();
FirebaseApp.initializeApp(options);

// As an admin, the app has access to read and write all data, regardless of Security Rules
DatabaseReference ref = FirebaseDatabase.getInstance()
    .getReference("restricted_access/secret_document");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    Object document = dataSnapshot.getValue();
    System.out.println(document);
  }

  @Override
  public void onCancelled(DatabaseError error) {
  }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a service account, granting admin privileges
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com"
});

// As an admin, the app has access to read and write all data, regardless of Security Rules
var db = admin.database();
var ref = db.ref("restricted_access/secret_document");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
Python
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a service account, granting admin privileges
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com'
})

# As an admin, the app has access to read and write all data, regradless of Security Rules
ref = db.reference('restricted_access/secret_document')
print(ref.get())
शुरू करें
ctx := context.Background()
conf := &firebase.Config{
	DatabaseURL: "https://databaseName.firebaseio.com",
}
// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

// Initialize the app with a service account, granting admin privileges
app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// As an admin, the app has access to read and write all data, regradless of Security Rules
ref := client.NewRef("restricted_access/secret_document")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

सीमित अधिकारों के साथ पुष्टि करें

सबसे सही तरीका यह है कि किसी सेवा के पास सिर्फ़ उन संसाधनों का ऐक्सेस हो जिनकी उसे ज़रूरत है. Firebase ऐप्लिकेशन इंस्टेंस के ऐक्सेस किए जा सकने वाले संसाधनों पर ज़्यादा बेहतर कंट्रोल पाने के लिए, अपनी सेवा को दिखाने के लिए सुरक्षा नियमों में यूनीक आइडेंटिफ़ायर का इस्तेमाल करें. इसके बाद, ऐसे नियम सेट अप करें जिनसे आपकी सेवा को ज़रूरी संसाधनों का ऐक्सेस मिल सके. उदाहरण के लिए: 

{
  "rules": {
    "public_resource": {
      ".read": true,
      ".write": true
    },
    "some_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": false
    },
    "another_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": "auth.uid === 'my-service-worker'"
    }
  }
}

इसके बाद, अपने सर्वर पर Firebase ऐप्लिकेशन को शुरू करते समय, अपने डेटाबेस के नियमों में इस्तेमाल किए गए auth ऑब्जेक्ट को बदलने के लिए, databaseAuthVariableOverride विकल्प का इस्तेमाल करें. इस कस्टम auth ऑब्जेक्ट में, uid फ़ील्ड को उस आइडेंटिफ़ायर पर सेट करें जिसका इस्तेमाल आपने सुरक्षा नियमों में अपनी सेवा को दिखाने के लिए किया था.

Java
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

// Initialize the app with a custom auth variable, limiting the server's access
Map<String, Object> auth = new HashMap<String, Object>();
auth.put("uid", "my-service-worker");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .setDatabaseAuthVariableOverride(auth)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/some_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a custom auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com",
  databaseAuthVariableOverride: {
    uid: "my-service-worker"
  }
});

// The app only has access as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/some_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
Python
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a custom auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': {
        'uid': 'my-service-worker'
    }
})

# The app only has access as defined in the Security Rules
ref = db.reference('/some_resource')
print(ref.get())
शुरू करें
ctx := context.Background()
// Initialize the app with a custom auth variable, limiting the server's access
ao := map[string]interface{}{"uid": "my-service-worker"}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &ao,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

कुछ मामलों में, आपको Admin SDKs के दायरे को कम करना पड़ सकता है, ताकि वे पुष्टि न किए गए क्लाइंट के तौर पर काम कर सकें. ऐसा करने के लिए, डेटाबेस की पुष्टि करने वाले वैरिएबल की बदली गई वैल्यू के लिए null की वैल्यू दें.

Java
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    // The database URL depends on the location of the database
    .setDatabaseUrl("https://DATABASE_NAME.firebaseio.com")
    .setDatabaseAuthVariableOverride(null)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access to public data as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/public_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a null auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  // The database URL depends on the location of the database
  databaseURL: "https://DATABASE_NAME.firebaseio.com",
  databaseAuthVariableOverride: null
});

// The app only has access to public data as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/public_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
Python
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a None auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': None
})

# The app only has access to public data as defined in the Security Rules
ref = db.reference('/public_resource')
print(ref.get())
शुरू करें
ctx := context.Background()
// Initialize the app with a nil auth variable, limiting the server's access
var nilMap map[string]interface{}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &nilMap,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access to public data as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

अगले चरण