Workspace data tool

Deephaven's Web interface maintains state in the table DbInternal.WorkspaceData. The active set of this data is exposed by the WebClientData query as "workspaceData". The workspace data tool is a command line utility for interacting with this data. To invoke this command:

sudo -u irisadmin /usr/illumon/latest/bin/iris workspace_data_tool [arguments]

Invoking this command without any arguments will display the options described below.

Options

Short	Long	Arg?	Description
`-a`	`--add`	N	Add workspace data row
`-c`	`--writeCSV`	N	Write WorkspaceData to CSV
`-d`	`--display`	N	Display workspace data
`-e`	`--version`	Y	Data version for record to add (presently should always be 8)
`-f`	`--file`	Y	Filename for display/CSV
`-g`	`--admingGroups`	Y	Admin groups for record to add
`-i`	`--id`	Y	Id for record to add
`-m`	`--maxRows`	Y	Maximum rows to display (defaults to 100)
`-n`	`--name`	Y	Name for record to add, for display defaults to all rows
`-o`	`--owner`	Y	Owner for record to add or display, for display defaults to all rows
`-r`	`--dateValue`	Y	Data for record to add
`-rc`	`--readCsv`	N	Read WorkspaceData from CSV
`-s`	`--status`	Y	Status for record to add
`-t`	`--dataType`	Y	Data type to add or display. Legal values: `Workspace` `Dashboard` `DashboardOverride` `DraftQuery` `CommandHistoryItem.<identifer>` Note: some of these are for internal use in the Web UI. Typical types for import/export would be Workspace or Dashboard.
`-v`	`--viewGroups`	Y	Viewer groups for record to add

Examples

Display all current Dashboard records:

sudo -u irisadmin /usr/illumon/latest/bin/iris workspace_data_tool -t Dashboard -d

Export all current current Dashboard records to a CSV file at /tmp/out.csv:

sudo -u irisadmin /usr/illumon/latest/bin/iris workspace_data_tool -t Dashboard -f /tmp/out.csv -c

Import the WorkspaceData data from a CSV file at /tmp/in.csv:

sudo -u irisadmin /usr/illumon/latest/bin/iris workspace_data_tool -f /tmp/in.csv -rc

Add a single Dashboard with the given structure. Note the JSON for the Dashboard data is abridged, and must be escaped carefully due to the embedded double quotes.

sudo -u irisadmin /usr/illumon/latest/bin/iris workspace_data_tool -a \
--id b6eeb14d-cb0a-44db-8d09-7a139c0d6361 \
--name bob \
--owner bob \
--status Active \
--dataType Dashboard \
--dataValue "{\"type\":\"Dashboard\", … }"

Notes

The version argument or CSV column indicates the version of the data format. To observe the current version, export or display existing workspace data. New data imported should typically match this version.
The export and import CSV file format is the same. However, the following columns are optional and ignored when importing: Date, LastModifiedByAuthenticated, LastModifiedByEffective, LastModifiedTime. These values are assigned according to who does the import and when it occurs.
Because the active workspace data is determined by the most recent row, by id (according to LastModifiedTime), newly imported data becomes "effective" as soon as it is imported. Any existing rows with matching ids will be replaced by the imported data.