Admin Database API के बारे में जानकारी

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

एडमिन SDK टूल का सेटअप

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

एडमिन SDK टूल की पुष्टि करना

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

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

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

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

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

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 ऐप्लिकेशन शुरू करते समय, databaseAuthVariableOverride विकल्प का इस्तेमाल करके, उस auth ऑब्जेक्ट को बदलें जिसे आपके डेटाबेस के नियमों में इस्तेमाल किया जाता है. पसंद के मुताबिक बनाए गए इस 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)

कुछ मामलों में, हो सकता है कि आप पुष्टि न किए गए क्लाइंट के तौर पर काम करने के लिए, एडमिन SDK टूल का दायरा कम करना चाहें. ऐसा करने के लिए, डेटाबेस के ऑथराइज़ेशन वैरिएबल को बदलने के लिए, 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)

अगले चरण