Configuring a dataset

A dataset is a collection of tables and fields that you want to encrypt. The configuration includes:

  • The types of indexes set for each column in the table
  • The mode for each index
  • The data type
  • Settings for match indexes, eg tokenization settings.

We suggest creating a separate dataset for each environment you are handling sensitive data in. This allows the dataset configuration to be updated and tested without affecting another environment. When creating the dataset, make sure you specify a clear and unique description that identifies what the dataset is used for.

Creating a dataset

To create a dataset run the following command in the CipherStash CLI. If you don't have the CLI installed, please follow Installing the CipherStash CLI.

1stash datasets create my_dataset_name --description "Test application"

Uploading a dataset

Use the CipherStash CLI to upload a dataset configuration to your account. Note you will need to have created a client key before you can upload a dataset configuration.

1stash datasets config upload --file dataset.yml --client-id $CS_CLIENT_ID --client-key $CS_CLIENT_KEY

Setting the Workspace region

You may have multiple workspaces in different regions. To set the region for the workspace you are working in, use the following option in the CLI.

1--vitur-host https://us-east-1.aws.viturhosted.net/

Where us-east-1 is the region you are working in. You can find the region you are working in by checking the workspace overview in the CipherStash dashboard.

Setting config options

See Dataset config for the available options you can configure.