gcloud alpha emulators datastore start - start a local datastore emulator
gcloud alpha emulators datastore start [--data-dir=DATA_DIR] [--host-port=HOST_PORT] [--no-store-on-disk] [--consistency=CONSISTENCY; default=0.9 | --use-firestore-in-datastore-mode] [GCLOUD_WIDE_FLAG ...]
(ALPHA) This command starts a local datastore emulator.
To start a local datastore emulator, run:
$ gcloud alpha emulators datastore start --data-dir=DATA-DIR
- --data-dir=DATA_DIR
The directory to be used to store/retrieve data/config for an emulator run. The default value is <USER_CONFIG_DIR>/emulators/datastore. The value of USER_CONFIG_DIR can be found by running:
$ gcloud info --format='get(config.paths.global_config_dir)'
- --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:8081.
- --store-on-disk
Whether data should be persisted to disk. Enabled by default, use --no-store-on-disk to disable.
- At most one of these can be specified:
- --consistency=CONSISTENCY; default=0.9
Fraction of eventually consistent operations that should succeed immediately. Setting to 1.0 can be useful for unit tests, but may mask incorrect assumptions about non-ancestor queries which are eventually consistent.
- --use-firestore-in-datastore-mode
Runs the emulator in Cloud Firestore in Datastore Mode. Reads are always strongly consistent and --consistency flag may not be specified.
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available:
$ gcloud beta emulators datastore start