feat(firestore): add databaseId configuration option (#966)

robingenz · web-flow · commit 78c174d9fece · 2026-03-30T18:22:02.000+02:00
* feat(firestore): add `databaseId` configuration option

* refactor(firestore): store Firestore instance in local variable

* fix(firestore): pass Firestore instance to query constraints on iOS

* fix(firestore): add `FirebaseFirestoreConfig.swift` to Xcode project
diff --git a/.changeset/bright-foxes-dance.md b/.changeset/bright-foxes-dance.md
@@ -0,0 +1,5 @@
+---
+'@capacitor-firebase/firestore': minor
+---
+
+feat: add `databaseId` configuration option
diff --git a/packages/firestore/README.md b/packages/firestore/README.md
@@ -60,7 +60,48 @@ This can be useful if you encounter dependency conflicts with other plugins in y
 
 ## Configuration
 
-No configuration required for this plugin.
+<docgen-config>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+These configuration values are available:
+
+| Prop             | Type                | Description                                                                           | Since |
+| ---------------- | ------------------- | ------------------------------------------------------------------------------------- | ----- |
+| **`databaseId`** | <code>string</code> | The database ID of the Firestore database to use. Only available for Android and iOS. | 8.3.0 |
+
+### Examples
+
+In `capacitor.config.json`:
+
+```json
+{
+  "plugins": {
+    "FirebaseFirestore": {
+      "databaseId": undefined
+    }
+  }
+}
+```
+
+In `capacitor.config.ts`:
+
+```ts
+/// <reference types="@capacitor-firebase/firestore" />
+
+import { CapacitorConfig } from '@capacitor/cli';
+
+const config: CapacitorConfig = {
+  plugins: {
+    FirebaseFirestore: {
+      databaseId: undefined,
+    },
+  },
+};
+
+export default config;
+```
+
+</docgen-config>
 
 ## Demo
 
diff --git a/packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestore.java b/packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestore.java
@@ -44,10 +44,12 @@
 public class FirebaseFirestore {
 
     private FirebaseFirestorePlugin plugin;
+    private FirebaseFirestoreConfig config;
     private Map<String, ListenerRegistration> listenerRegistrationMap = new HashMap<>();
 
-    public FirebaseFirestore(FirebaseFirestorePlugin plugin) {
+    public FirebaseFirestore(FirebaseFirestorePlugin plugin, FirebaseFirestoreConfig config) {
         this.plugin = plugin;
+        this.config = config;
     }
 
     public void addDocument(@NonNull AddDocumentOptions options, @NonNull NonEmptyResultCallback callback) {
@@ -370,6 +372,10 @@ public void removeAllListeners() {
     }
 
     private com.google.firebase.firestore.FirebaseFirestore getFirebaseFirestoreInstance() {
+        String databaseId = config.getDatabaseId();
+        if (databaseId != null) {
+            return com.google.firebase.firestore.FirebaseFirestore.getInstance(databaseId);
+        }
         return com.google.firebase.firestore.FirebaseFirestore.getInstance();
     }
 }
diff --git a/packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestoreConfig.java b/packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestoreConfig.java
@@ -0,0 +1,14 @@
+package io.capawesome.capacitorjs.plugins.firebase.firestore;
+
+public class FirebaseFirestoreConfig {
+
+    private String databaseId = null;
+
+    public String getDatabaseId() {
+        return databaseId;
+    }
+
+    public void setDatabaseId(String databaseId) {
+        this.databaseId = databaseId;
+    }
+}
diff --git a/packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java b/packages/firestore/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/firestore/FirebaseFirestorePlugin.java
@@ -42,10 +42,12 @@ public class FirebaseFirestorePlugin extends Plugin {
 
     private Map<String, PluginCall> pluginCallMap = new HashMap<>();
 
+    private FirebaseFirestoreConfig config;
     private FirebaseFirestore implementation;
 
     public void load() {
-        implementation = new FirebaseFirestore(this);
+        config = getFirebaseFirestoreConfig();
+        implementation = new FirebaseFirestore(this, config);
     }
 
     @PluginMethod
@@ -617,4 +619,13 @@ public void removeAllListeners(PluginCall call) {
             call.reject(exception.getMessage(), FirebaseFirestoreHelper.createErrorCode(exception));
         }
     }
+
+    private FirebaseFirestoreConfig getFirebaseFirestoreConfig() {
+        FirebaseFirestoreConfig config = new FirebaseFirestoreConfig();
+
+        String databaseId = getConfig().getString("databaseId");
+        config.setDatabaseId(databaseId);
+
+        return config;
+    }
 }
diff --git a/packages/firestore/ios/Plugin.xcodeproj/project.pbxproj b/packages/firestore/ios/Plugin.xcodeproj/project.pbxproj
@@ -36,6 +36,7 @@
 		7C0070362ABC1FD7000C0F28 /* UpdateDocumentOptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C0070352ABC1FD7000C0F28 /* UpdateDocumentOptions.swift */; };
 		7C00703A2ABC21D0000C0F28 /* Result.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C0070392ABC21D0000C0F28 /* Result.swift */; };
 		7C0070402ABC2DF8000C0F28 /* FirebaseFirestoreHelper.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C00703F2ABC2DF8000C0F28 /* FirebaseFirestoreHelper.swift */; };
+		7C0070512ABC3000000C0F28 /* FirebaseFirestoreConfig.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C0070502ABC3000000C0F28 /* FirebaseFirestoreConfig.swift */; };
 		7C0070422ABC97E5000C0F28 /* QueryNonFilterConstraint.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C0070412ABC97E5000C0F28 /* QueryNonFilterConstraint.swift */; };
 		7C0070442ABC9AE9000C0F28 /* QueryFilterConstraint.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C0070432ABC9AE9000C0F28 /* QueryFilterConstraint.swift */; };
 		7C2AE7C92D2DBF7000F40418 /* GetCountFromServerOptions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C2AE7C82D2DBF6D00F40418 /* GetCountFromServerOptions.swift */; };
@@ -88,6 +89,7 @@
 		7C0070352ABC1FD7000C0F28 /* UpdateDocumentOptions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UpdateDocumentOptions.swift; sourceTree = "<group>"; };
 		7C0070392ABC21D0000C0F28 /* Result.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Result.swift; sourceTree = "<group>"; };
 		7C00703F2ABC2DF8000C0F28 /* FirebaseFirestoreHelper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FirebaseFirestoreHelper.swift; sourceTree = "<group>"; };
+		7C0070502ABC3000000C0F28 /* FirebaseFirestoreConfig.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FirebaseFirestoreConfig.swift; sourceTree = "<group>"; };
 		7C0070412ABC97E5000C0F28 /* QueryNonFilterConstraint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QueryNonFilterConstraint.swift; sourceTree = "<group>"; };
 		7C0070432ABC9AE9000C0F28 /* QueryFilterConstraint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = QueryFilterConstraint.swift; sourceTree = "<group>"; };
 		7C2AE7C82D2DBF6D00F40418 /* GetCountFromServerOptions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GetCountFromServerOptions.swift; sourceTree = "<group>"; };
@@ -152,6 +154,7 @@
 				2F98D68124C9AAE400613A4C /* FirebaseFirestore.swift */,
 				50ADFF8C201F53D600D50D53 /* Info.plist */,
 				7C00703F2ABC2DF8000C0F28 /* FirebaseFirestoreHelper.swift */,
+				7C0070502ABC3000000C0F28 /* FirebaseFirestoreConfig.swift */,
 			);
 			path = Plugin;
 			sourceTree = "<group>";
@@ -477,6 +480,7 @@
 				7C0070162ABC1F18000C0F28 /* DeleteDocumentOptions.swift in Sources */,
 				7C0070122ABC1F03000C0F28 /* AddDocumentResult.swift in Sources */,
 				7C0070402ABC2DF8000C0F28 /* FirebaseFirestoreHelper.swift in Sources */,
+				7C0070512ABC3000000C0F28 /* FirebaseFirestoreConfig.swift in Sources */,
 				2F98D68224C9AAE500613A4C /* FirebaseFirestore.swift in Sources */,
 				7C90A58E2C21519B00A71389 /* AddCollectionGroupSnapshotListenerOptions.swift in Sources */,
 				7C0070222ABC1F4A000C0F28 /* GetDocumentResult.swift in Sources */,
diff --git a/packages/firestore/ios/Plugin/Classes/Constraints/QueryEndAtConstraint.swift b/packages/firestore/ios/Plugin/Classes/Constraints/QueryEndAtConstraint.swift
@@ -11,8 +11,8 @@ import Capacitor
         self.reference = queryConstraint["reference"] as? String ?? ""
     }
 
-    public func toQuery(query: Query) async throws -> Query {
-        let documentSnapshot = try await Firestore.firestore().document(reference).getDocument()
+    public func toQuery(query: Query, firestore: Firestore) async throws -> Query {
+        let documentSnapshot = try await firestore.document(reference).getDocument()
         switch self.type {
         case "endAt":
             return query.end(atDocument: documentSnapshot)
diff --git a/packages/firestore/ios/Plugin/Classes/Constraints/QueryLimitConstraint.swift b/packages/firestore/ios/Plugin/Classes/Constraints/QueryLimitConstraint.swift
@@ -11,7 +11,7 @@ import Capacitor
         self.limit = queryConstraint["limit"] as? Int ?? 0
     }
 
-    public func toQuery(query: Query) async throws -> Query {
+    public func toQuery(query: Query, firestore: Firestore) async throws -> Query {
         switch self.type {
         case "limit":
             return query.limit(to: self.limit)
diff --git a/packages/firestore/ios/Plugin/Classes/Constraints/QueryOrderByConstraint.swift b/packages/firestore/ios/Plugin/Classes/Constraints/QueryOrderByConstraint.swift
@@ -11,7 +11,7 @@ import Capacitor
         self.directionStr = queryConstraint["directionStr"] as? String ?? ""
     }
 
-    public func toQuery(query: Query) async throws -> Query {
+    public func toQuery(query: Query, firestore: Firestore) async throws -> Query {
         return query.order(by: self.fieldPath, descending: self.directionStr == "desc" ? true : false)
     }
 }
diff --git a/packages/firestore/ios/Plugin/Classes/Constraints/QueryStartAtConstraint.swift b/packages/firestore/ios/Plugin/Classes/Constraints/QueryStartAtConstraint.swift
@@ -11,8 +11,8 @@ import Capacitor
         self.reference = queryConstraint["reference"] as? String ?? ""
     }
 
-    public func toQuery(query: Query) async throws -> Query {
-        let documentSnapshot = try await Firestore.firestore().document(reference).getDocument()
+    public func toQuery(query: Query, firestore: Firestore) async throws -> Query {
+        let documentSnapshot = try await firestore.document(reference).getDocument()
         switch self.type {
         case "startAt":
             return query.start(atDocument: documentSnapshot)
diff --git a/packages/firestore/ios/Plugin/FirebaseFirestore.swift b/packages/firestore/ios/Plugin/FirebaseFirestore.swift
diff --git a/packages/firestore/ios/Plugin/FirebaseFirestoreConfig.swift b/packages/firestore/ios/Plugin/FirebaseFirestoreConfig.swift
diff --git a/packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift b/packages/firestore/ios/Plugin/FirebaseFirestorePlugin.swift
diff --git a/packages/firestore/ios/Plugin/Protocols/QueryNonFilterConstraint.swift b/packages/firestore/ios/Plugin/Protocols/QueryNonFilterConstraint.swift
diff --git a/packages/firestore/src/definitions.ts b/packages/firestore/src/definitions.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@capacitor-firebase/firestore': minor
 +---
++
 +feat: add `databaseId` configuration option
Original file line number	Diff line number	Diff line change
`@@ -44,10 +44,12 @@`
`44`	`44`	`public class FirebaseFirestore {`
`45`	`45`
`46`	`46`	`private FirebaseFirestorePlugin plugin;`
	`47`	`+ private FirebaseFirestoreConfig config;`
`47`	`48`	`private Map<String, ListenerRegistration> listenerRegistrationMap = new HashMap<>();`
`48`	`49`
`49`		`- public FirebaseFirestore(FirebaseFirestorePlugin plugin) {`
	`50`	`+ public FirebaseFirestore(FirebaseFirestorePlugin plugin, FirebaseFirestoreConfig config) {`
`50`	`51`	`this.plugin = plugin;`
	`52`	`+ this.config = config;`
`51`	`53`	`}`
`52`	`54`
`53`	`55`	`public void addDocument(@NonNull AddDocumentOptions options, @NonNull NonEmptyResultCallback callback) {`
`@@ -370,6 +372,10 @@ public void removeAllListeners() {`
`370`	`372`	`}`
`371`	`373`
`372`	`374`	`private com.google.firebase.firestore.FirebaseFirestore getFirebaseFirestoreInstance() {`
	`375`	`+ String databaseId = config.getDatabaseId();`
	`376`	`+ if (databaseId != null) {`
	`377`	`+ return com.google.firebase.firestore.FirebaseFirestore.getInstance(databaseId);`
	`378`	`+ }`
`373`	`379`	`return com.google.firebase.firestore.FirebaseFirestore.getInstance();`
`374`	`380`	`}`
`375`	`381`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,10 +42,12 @@ public class FirebaseFirestorePlugin extends Plugin {`
`42`	`42`
`43`	`43`	`private Map<String, PluginCall> pluginCallMap = new HashMap<>();`
`44`	`44`
	`45`	`+ private FirebaseFirestoreConfig config;`
`45`	`46`	`private FirebaseFirestore implementation;`
`46`	`47`
`47`	`48`	`public void load() {`
`48`		`- implementation = new FirebaseFirestore(this);`
	`49`	`+ config = getFirebaseFirestoreConfig();`
	`50`	`+ implementation = new FirebaseFirestore(this, config);`
`49`	`51`	`}`
`50`	`52`
`51`	`53`	`@PluginMethod`
`@@ -617,4 +619,13 @@ public void removeAllListeners(PluginCall call) {`
`617`	`619`	`call.reject(exception.getMessage(), FirebaseFirestoreHelper.createErrorCode(exception));`
`618`	`620`	`}`
`619`	`621`	`}`
	`622`	`+`
	`623`	`+ private FirebaseFirestoreConfig getFirebaseFirestoreConfig() {`
	`624`	`+ FirebaseFirestoreConfig config = new FirebaseFirestoreConfig();`
	`625`	`+`
	`626`	`+ String databaseId = getConfig().getString("databaseId");`
	`627`	`+ config.setDatabaseId(databaseId);`
	`628`	`+`
	`629`	`+ return config;`
	`630`	`+ }`
`620`	`631`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import Capacitor`
`11`	`11`	`self.limit = queryConstraint["limit"] as? Int ?? 0`
`12`	`12`	`}`
`13`	`13`
`14`		`- public func toQuery(query: Query) async throws -> Query {`
	`14`	`+ public func toQuery(query: Query, firestore: Firestore) async throws -> Query {`
`15`	`15`	`switch self.type {`
`16`	`16`	`case "limit":`
`17`	`17`	`return query.limit(to: self.limit)`