Enabled with --services firestore,datastore

Google's Firestore and Datastore emulators, one flag away.

Documents, entities, collections and kinds on Google's own emulators, opt-in with --services, and MongoDB drivers through Firestore with MongoDB compatibility.

Backed by: Google's Firestore and Datastore emulators Google's emulator

Get started
Local scope

What it covers

Firestore and Datastore run on Google’s own emulators and start when you ask for them with --services. Each has an official emulator variable, so an application needs no code change. The coverage table links each verified operation to its test, including the Firestore Admin API and measured persistence in persistent mode. CloudBurrow also serves Firestore with MongoDB compatibility: its own server for the MongoDB wire protocol, in front of the same Firestore documents, so a MongoDB driver and the Firestore client read each other’s writes.

  • Firestore documents and collections through the official SDKs
  • Datastore entities and kinds through the official SDKs
  • Queries and transactions
  • Firestore Admin database, index and backup operations
  • Firestore data survives a restart in persistent mode (#1615)
  • Firestore with MongoDB compatibility: the MongoDB wire protocol on its own port, through the official MongoDB driver (#1703)
  • MongoDB reads, writes, aggregates, indexes, text search, explain and multi-document transactions on the database's Firestore documents (#1738)
  • MongoDB sign-in with SCRAM user credentials or an access token, checked against IAM roles and conditions (#1738, #1742)

In the console

The Firestore query builder in the local console
Captured 2026-09-28 from main @5da2bd0. Product icons hidden.
The Datastore query builder in the local console
Captured 2026-09-28 from main @5da2bd0. Product icons hidden.
Run the example

Tested snippet

From docs/examples/ at main 0ea2594. CI runs these blocks against CloudBurrow.

Node.js · Firestore
import assert from 'node:assert/strict';
import { randomUUID } from 'node:crypto';
import { Firestore } from '@google-cloud/firestore';

const db = new Firestore({ projectId: process.env.GOOGLE_CLOUD_PROJECT });
const doc = db.collection(`example-${randomUUID()}`).doc('hello');
await doc.set({ greeting: 'hello' });
assert.equal((await doc.get()).get('greeting'), 'hello');
await doc.delete();
await db.terminate();

This block is run by CloudBurrow's Node.js suite in CI. If it stops working, CI fails. docs/examples/node.md

Release and main

What's verified

Follow the operation matrix to see what the backend serves and the tests linked to Verified calls.

Firestore

17 of 17 RPCs Verified in v0.3.0

Firestore in v0.3.0: 17 Verified of 17
Inspect the Firestore operation matrix →

Firestore Admin API

32 of 32 RPCs Verified in v0.3.0

Firestore Admin API in v0.3.0: 32 Verified of 32
Inspect the Firestore Admin API operation matrix →

Datastore

8 of 8 RPCs Verified in v0.3.0

Datastore in v0.3.0: 8 Verified of 8
Inspect the Datastore operation matrix →
Local boundaries

Not supported

  • 01 / Local boundary

    Check the coverage table for each supported data and admin operation.

  • 02 / Local boundary

    Firestore with MongoDB compatibility is CloudBurrow's own server, as Google publishes no emulator of it. Commands Google does not list are refused CommandNotFound.

Evidence source

Source: docs/compatibility.md at main 0ea2594.

Frequently asked

Questions

Does Firestore data survive a restart?

Yes, in persistent mode: Firestore keeps its documents across a pod restart and an emulator crash, measured by TestFirestoreAcrossRestart. Datastore keeps its persistent store. In v0.1.0 Firestore was in memory.
Link to this answer

Can I use a MongoDB driver?

Yes. With Firestore enabled, cloudburrow env exports CLOUDBURROW_FIRESTORE_MONGODB_ENDPOINT, and the connection string Google documents works with the official MongoDB driver. What a driver writes is read back by the Firestore client as the same documents.
Link to this answer
Develop locally

Build against Google Cloud APIs, locally

Free and open source under Apache-2.0. No account, no sign-up, no Google Cloud bill.

Get started