gcloud_alpha_emulators_datastore_start (1)

NAME

gcloud alpha emulators datastore start - start a local datastore emulator

SYNOPSIS

gcloud alpha emulators datastore start [--consistency=CONSISTENCY; default=0.9] [--data-dir=DATA_DIR] [--host-port=HOST_PORT] [--legacy] [--no-store-on-disk] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) This command starts a local datastore emulator.

FLAGS

--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.

--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 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.

--legacy

Set to use the legacy emulator which supports Cloud Datastore API v1beta2.

--store-on-disk

Whether data should be persisted to disk. Enabled by default, use --no-store-on-disk to disable.

GCLOUD WIDE FLAGS

These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.

EXAMPLES

To start a local datastore emulator, run:

$ gcloud alpha emulators datastore start --data-dir DATA-DIR

NOTES

This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support This variant is also available:

$ gcloud beta emulators datastore start