sincecutoff.com
← all changes

Firestore emulator start supports index requirement and index file flags

Introduced 2026-08-04 · score 0.93

HOW TO USE IT

When running the Firestore emulator in Datastore Mode and queries require composite indexes, start it with `--require-indexes` and specify the index file with `--index-file`.

gcloud emulators firestore start --database-mode=datastore-mode --require-indexes --index-file=<path/to/firestore.indexes.yaml>

WHY THIS HELPS

Start a Firestore emulator with indexes required and a specified index file.

REQUIREMENTS AND LIMITATIONS

  • --database-mode (required): Set to `datastore-mode` to use these index flags; valid values are `firestore-native` (default) and `datastore-mode`.
  • --require-indexes (required): Require composite indexes in the index file for queries that need them. Supported only in Datastore Mode with `--index-file`.
  • --index-file (required): Path to the index file. Supported only in Datastore Mode with `--require-indexes`.

FIRST-PARTY EVIDENCE

Check the installed version and the source before using it. Entry JSON

Report a problem with this card