gcloud emulators firestore start

gcloud emulators firestore start - start a local Firestore emulator

gcloud emulators firestore start [--database-mode =DATABASE_MODE] [--edition =EDITION; default="standard"] [--export-on-exit =EXPORT_ON_EXIT] [--host-port =HOST_PORT] [--import-data =IMPORT_DATA] [--index-file =INDEX_FILE] [--licenses ] [--require-indexes ] [--rules =RULES] [GCLOUD_WIDE_FLAG …]

gcloudemulatorsfirestorestart

To bind to a specific host and port, run:

gcloudemulatorsfirestorestart--host-port=0.0.0.0:8080

To run the local Firestore emulator with a Firebase Rules set, run:

gcloudemulatorsfirestorestart--rules=firestore.rules

To run the local Firestore emulator in Datastore Mode, run:

gcloudemulatorsfirestorestart--database-mode=datastore-mode

To import data at the start of the Firestore emulator, run:

gcloudemulatorsfirestorestart--import-data=<path/to/file>

To export emulator data upon emulator shutdown, run:

gcloudemulatorsfirestorestart--export-on-exit=<path/to/directory>

To run the local Firestore emulator with a specific database edition, run:

gcloudemulatorsfirestorestart--edition=edition

--database-mode=DATABASE_MODE

The database mode to start the Firestore Emulator in. The valid options are:

`firestore-native`(default):starttheemulatorinFirestoreNative
`datastore-mode`:starttheemulatorinDatastoreMode

--edition=EDITION; default="standard"

The database edition to start the Firestore Emulator in. EDITION must be one of: standard, enterprise.

--export-on-exit=EXPORT_ON_EXIT

Directory path in which emulator data will be saved upon shutdown. Example: /home/user/myexports/2024-03-26/

--host-port=HOST_PORT

The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port:

[ADDRESS][:PORT]

In this format you must enclose IPv6 addresses in square brackets: e.g.

[2001:db8:0:0:0:ff00:42:8329]:8080

The default value is localhost:8080.

--import-data=IMPORT_DATA

File path to the data to be loaded into the emulator upon start up. Example: /home/user/myexports/sampleExport/sampleExport.overall_export_metadata.

--index-file=INDEX_FILE

File path to the index file to be used by the emulator. Example: /home/user/firestore.indexes.yaml

Only supported in Datastore Mode in conjunction with --require-indexes.

--licenses

If set, the emulator will print open-source dependencies and licenses, then exit.

--require-indexes

If set, the emulator will require composite indexes to be defined in the index file for all queries that require them.

Only supported in Datastore Mode in conjunction with --index-file.

--rules=RULES

If set, all projects will use the security rules in this file. More information on Firebase Rules and the syntax for this file is available at https://firebase.google.com/docs/rules.

Run $ gcloud help for details.