Using Sisense CLI Commands

Displays a list of all data groups.

Example:

si datagroups list

Create a new data group.

Example:

si datagroups create -name example

Mandatory:

name

Optional:

connector-mode
index-size
default
query-instances
query-cpu-limit
query-cpu-request
query-memory-limit
query-memory-request
query-cores-usage-percentage
build-cpu-limit
build-cpu-request
build-memory-limit
build-memory-request
build-cores-usage-percentage
enable-recycler

Rename a data group.

Example:

si datagroups create -name example -new-name example

Mandatory:

name
new-name

Update a data group.

Example:

si datagroups update -name example

name

Optional:

connector-mode
index-size
default
query-instances
query-cpu-limit
query-cpu-request
query-memory-limit
query-memory-request
query-cores-usage-percentage
build-cpu-limit
build-cpu-request
build-memory-limit
build-memory-request
build-cores-usage-percentage
enable-recycler

Assigns an ElastiCube to a data group.

Example:

si datagroups assign -name example -cube examplecube

name
cube

Attaches a node to a data group.

Example:

si datagroups attach -name example -node myhost -roles BUILD,QUERY

name
node
roles

Detaches a node to a data group.

Example:

si datagroups detach -name example -node myhost

name
node

Deletes a data group.

Example:

si elasticubes delete -name 'example'

name

Displays a list of all ElastiCubes.

Example:

si elasticubes list

Starts an ElastiCube.

Example:

si elasticubes start -name example

Mandatory:

name

Stops an ElastiCube.

Example:

si elasticubes stop -name example

Mandatory:

name

Deletes an ElastiCube.

Example:

si elasticubes delete -name example

name

Detaches an ElastiCube.

Example:

si elasticubes detach [-name example] [-delete false]

name

Optional:

delete

Attaches an ElastiCube.

Example:

si elasticubes attach -path /path/to/cube/files

path
title

Builds an ElastiCube.

Example:

si elasticubes build -name example -type full -sync true [< ecm_model.json]

type

Optional:

sync
name

Import an ElastiCube.

Example:

si elasticubes import from-local -path /opt/sisense/storage/resources/Sample.sdata

Optional:

path
start

Deletes all ElastiCubes from a database and storage

Example:

si elasticubes reset

Exports an ElastiCube.

Example:

si elasticubes export -name EC2

This command exports the to /opt/sisense/storage/backups/EC3.sdata

Parameters

• (Mandatory) name <CubeName>
• (Optional) file <FileName>

Optional:

name
path
file

Starts mclient console for a specific Elasticube.

Example:

si elasticubes console -name xxx -language sql or elasticube console -name xxx -language mal

Optional:

language
name

Displays a list of all nodes.

Example:

si deployment list

id

Adds a node to the system.

Example:

si deployment add -id myhost -hostname myhost -roles BUILD,QUERY

Mandatory:

id
hostname
roles

Removes a node from the system.

Example:

si deployment remove -id myhost

Mandatory:

id

Lists all instances in the deployment.

Example:

si deployment instances

version

List all the deployment nodes' versions.

Example:

si deployment version

Displays a list of all data sources.

Example:

si datasources list

id

Query JAQL on data source.

Example:

cat myJaql.txt | si datasources query -name myEcube

Mandatory:

name

Optional:

format

Executes an SQL query on data source.

Example:

echo 'select * from MyTable' | si datasources sql -name myEcube

Mandatory:

name

Displays versions of your services.

Example:

si system

Backs up Sisense metadata stored in the Sisense application database, system configuration information, and if you include your farms, Sisense data is backed up. The command below generates an archive of all these files in the following location: /opt/sisense/storage/system_backups/sisense_assets_collector_[date]

Note: Files you configured on shared storage, such as automated emails, plugins, language files, branding files and custom connectors are not backed up.

si system backup [-include-farm]

To a log of the back up, enter the following command:

kubectl -n sisense logs sisense-backup-[tab]

Restores Sisense from an archive file created with the Back UP command described above.

si system restore -name [-include-farm] /opt/sisense/storage/system_backups/sisense_assets_collector_[date]

Gets the configuration value.

Example:

si configuration get -key category.entry -type key

key

Optional:

type

Sets a configuration value.

Example:

si configuration set -key category.entry -new-value 1412

Mandatory:

key
new-value

Resets a configuration to the default value if possible.

Example:

si configuration reset -key category.entry, or to reset all configuration of a sepecific category: configuration reset -key category, to change all configurations: configuration reset -key ALL

Optional:

key