Help Center

Menu

blueprint

This section lists and describes all CLI commands available for Datastore.

dxp-next datastore blueprint --help 
Usage: dxp-next datastore blueprint [options] [command]

Datastore Blueprint Commands

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

Commands:
  add [options]     Adds a new blueprint
  update [options]  Updates an existing blueprint
  list [options]    lists the  blueprint
  rename [options]  Renames an existing blueprint
  help [command]    display help for command

dxp-next datastore blueprint add

Adds and uploads a new blueprint to your Datastore instance and creates a Datastore service for this blueprint.

Before running this command, work with a simulation of your blueprint first, to verify that the functionality of your blueprint meets your expectations.
Required parameters
-p, --path

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

-n, --name

The name of your blueprint from which a Datastore service will be created.
Blueprint names support spaces, although the name must be enclosed within either single or double quotes.

-r, --region

Your nearest (cloud-based) region to upload your blueprint and access the Datastore service.
The valid values for this parameter include us for the US and au for Australia.

Optional parameters

Some of these parameters may be mandatory based on your signed-in user account’s current circumstances.

-t, --tenant

The ID of the Datastore instance to which the blueprint will be added.
If your signed-in user account is a member of one Datastore instance only, you can omit this parameter.
Otherwise, this parameter is mandatory.

Example
dxp-next datastore blueprint add -p /path/to/api.yaml --name Events -r us --tenant squiz-training-1234

This example command adds and uploads your new blueprint with the name "Events", whose API specification file is located at /path/to/api.yaml to your Datastore instance, and creates a Datastore service for this blueprint in the US region.

dxp-next datastore blueprint list

Lists all blueprints which have been added to your Datastore instance.

Optional parameters

Some of these parameters may be mandatory based on your signed-in user account’s current circumstances.

-t, --tenant

The ID of the Datastore instance whose blueprints will be listed.
If your signed-in user account is a member of one Datastore instance only, you can omit this parameter.
Otherwise, this parameter is mandatory.

Example
dxp-next datastore blueprint list --tenant squiz-training-1234

Lists all blueprints which have been added to your Datastore instance (with the example ID squiz-training-1234).

dxp-next datastore blueprint rename

Renames an existing blueprint in your Datastore instance.

Required parameters
-on, --oldName

The name of an existing blueprint in your Datastore instance.
If your blueprint’s name contains one or more spaces, enclose the name in either single or double quotes.

-nn, --newName

The new name for this blueprint in your Datastore instance.
Blueprint names support spaces, although the name must be enclosed within either single or double quotes.

Optional parameters

Some of these parameters may be mandatory based on your signed-in user account’s current circumstances.

-t, --tenant

The ID of the Datastore instance containing the blueprint to be renamed.
If your signed-in user account is a member of one Datastore instance only, you can omit this parameter.
Otherwise, this parameter is mandatory.

Example
dxp-next datastore blueprint rename -on Events --newName "Event management"

Rename the "Events" blueprint in your Datastore instance to "Event management".

dxp-next datastore blueprint update

Updates an existing blueprint in your Datastore instance.

If you have made functional changes to your existing blueprint’s files, use this command to update the blueprint in your Datastore instance with these changes.

Required parameters
-p, --path

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

-n, --name

The name of the blueprint in your Datastore service.
Blueprint names support spaces, although the name must be enclosed within either single or double quotes.

You cannot use this parameter to change the name of the blueprint. To change the name of the blueprint, use the dxp-next datastore blueprint rename command instead.
Optional parameters

Some of these parameters may be mandatory based on your signed-in user account’s current circumstances.

-t, --tenant

The ID of the Datastore instance containing the blueprint to be updated.
If your signed-in user account is a member of one Datastore instance only, you can omit this parameter.
Otherwise, this parameter is mandatory.

Example
dxp-next datastore blueprint update -n "Event management" --path /path/to/api.yaml

Updates the "Event management" blueprint in your Datastore instance (with functional changes you have made to your blueprint files).

dxp-next datastore blueprint delete

There is no blueprint delete command available from the command line as a safeguard to prevent unintentional loss of data.

If you have reached the maximum number of blueprints in your DXP organization, you have the following options:

  • Request that blueprints are deleted on your behalf through Squiz Support.

  • Select a blueprint that is no longer used, rename it, then update it with a new local blueprint.

To repurpose a blueprint as a new blueprint:

  1. Decide which blueprint is no longer required from the list of blueprints in your instance.

  2. Run the dxp-next datastore blueprint list command to return all blueprint names associated with your instance.

  3. Run the dxp-next datastore blueprint rename command against the chosen blueprint to make it easy to identify which one to overwrite.

  4. Run the dxp-next datastore blueprint update command against the renamed blueprint to overwrite it with your local blueprint changes.