Help Center

Menu

simulator

Adds a new blueprint (referenced by its API specification file) to your local Datastore simulator and creates a simulated Datastore service for this blueprint.

Unlike adding and uploading a blueprint to your Datastore instance, there is no need to update your blueprint in a simulated Datastore service. While running the local Datastore simulator, any changes you save to an added blueprint’s files locally are updated automatically in the local simulator.
dxp-next datastore simulator --help 
Usage: dxp-next datastore simulator [options] [command]

Datastore Simulator Commands

Options:
  -h, --help         display help for command

Commands:
  add [options]      Adds a new simulator
  remove [options]   Removes a datastore simulator
  list               Lists all the simulator
  clear [options]    Clears a datastore simulator
  upgrade [options]  Removes a datastore simulator
  pause [options]    Pauses the simulator
  resume [options]   Resumes the simulator
  help [command]     display help for command
Required parameters
--blueprint

The path to your blueprint’s API specification file (typically named api.yaml).

Optional parameters
--port

The HTTP port number through which your locally simulated Datastore service is available.
If you do not specify this value, then the next free port number within the range of 7001 through to 7010 will be chosen.

Example
dxp-next datastore simulator add --blueprint /path/to/api.yaml

Adds your new blueprint (whose API specification file is located at /path/to/api.yaml) to your local Datastore simulator, and
creates a simulated Datastore service for this blueprint.

dxp-next datastore simulator clear

Clears all data associated with a blueprint (referenced by its API specification file) in your local Datastore simulator.

This command is useful if you have tested a blueprint, made structural changes to it and then need to re-test the amended blueprint.

Any data stored by the blueprint’s simulated Datastore service is permanently destroyed by this command.

The blueprint and its Datastore service, however, will still be available.
Required parameters
--blueprint

The path to your blueprint’s API specification file (typically named api.yaml).

--force

This parameter must be specified (without a value) to explicitly confirm that you want to clear all data associated with this blueprint in your local Datastore simulator. If not set the command will ask you to confirm before continuing.

Example
dxp-next datastore simulator clear --blueprint /path/to/api.yaml

Clears all data for your blueprint (whose API specification file is located at /path/to/api.yaml) in your local Datastore simulator. As this command omits the --force argument, the user will be prompted to confirm the action before it continues.

dxp-next datastore simulator list

Lists all blueprints which have been added to your local Datastore simulator.

Parameters

None.

Example
dxp-next datastore simulator list

dxp-next datastore simulator pause

Pauses your entire local Datastore simulator, along with all its blueprints' simulated Datastore services.

Alternatively, this command only pauses a single blueprint’s simulated Datastore service (in your local simulator), where the blueprint is referenced by its API specification file. When a simulated Datastore service is paused, its local simulator continues to run.

Optional parameters
--blueprint

The path to your blueprint’s API specification file (typically named api.yaml).
If this parameter is omitted, then the entire local Datastore simulator will be paused, along with all its simulated Datastore services.

Example
dxp-next datastore simulator pause --blueprint /path/to/api.yaml

Pauses the simulated Datastore service associated with the blueprint (whose API specification file is located at /path/to/api.yaml) in your local Datastore simulator.

Example
dxp-next datastore simulator pause

Pauses all simulated Datastore services in your local Datastore simulator.

dxp-next datastore simulator remove

Removes and deletes a blueprint (referenced by its API specification file) and its simulated Datastore service from your local Datastore simulator.

The blueprint’s simulated Datastore service, along with all its stored data, is permanently destroyed by this command.
Required parameters
--blueprint

The path to your blueprint’s API specification file (typically named api.yaml).

--force

This parameter must be specified (without a value) to explicitly confirm that you want to remove and delete the local Datastore simulator associated with this blueprint, along with all its data. If not set the command will ask you to confirm before continuing

Example
dxp-next datastore simulator remove --blueprint /path/to/api.yaml

Removes and deletes your blueprint (whose API specification file is located at /path/to/api.yaml) and its simulated Datastore service from your local Datastore simulator after asking for confirmation.

dxp-next datastore simulator resume

Resumes your entire local Datastore simulator, along with all its blueprints' simulated Datastore services.

Alternatively, this command only resumes a single blueprint’s simulated Datastore service (in your local simulator), where the blueprint is referenced by its API specification file.

Optional parameters
--blueprint

The path to your blueprint’s API specification file (typically named api.yaml).
If this parameter is omitted, then the entire local Datastore simulator will be resumed, along with all its simulated Datastore services.

Example
dxp-next datastore simulator resume --blueprint /path/to/api.yaml

Resumes the simulated Datastore service associated with the blueprint (whose API specification file is located at /path/to/api.yaml) in your local Datastore simulator.

Example
dxp-next datastore simulator resume

Resumes all simulated Datastore services in your local Datastore simulator.

dxp-next datastore simulator upgrade

Upgrades your entire local Datastore simulation environment to the latest version currently available. This includes all your locally simulated Datastore services for each blueprint you have added, as well as the Docker image itself (from which these simulated services were instantiated).

Running this command clears all existing data within your Datastore simulator. Any data stored by all of your current blueprints' simulated Datastore services will be permanently destroyed.

All your existing blueprints and their Datastore services, however, will still be available.
Required parameters
--force

This parameter must be specified (without a value) to explicitly confirm that you want to upgrade all your local Datastore simulators (containers), as well as the Docker image itself, and also clear all your existing data in your Datastore simulator. If not set the command will ask you to confirm before continuing.

Example
dxp-next datastore simulator upgrade

Upgrades all simulated Data services in your local Datastore simulators (containers) to the latest version, after asking for confirmation.