Reveal

LOAD DASHBOARD

Kinetica provides a SQL interface for loading Reveal dashboards from a variety of sources:

  • Local server path
  • KiFS path
  • Cloud provider via data source
  • Public URL (GitHub, etc.)

LOAD DASHBOARD Syntax
1
2
3
LOAD DASHBOARD "<dashboard name>"
FROM FILE PATHS '<file path>'
[WITH OPTIONS (DATASOURCE = '<data source name>')]
ParametersDescription
<dashboard name>Name of the dashboard; must match the name of the dashboard in the file.
<file paths>

Dashboard source file path.

If a data source is specified, the path must resolve to an accessible file at that location.

If no data source is specified, the file path can refer to one of three locations:

  • Public URL

  • KiFS path

    File PathOutcome
    kifs://reveal/db/nyctaxi.dbFile nyctaxi.db, under the KiFS virtual directory reveal/db
  • OS-level path under the Kinetica configuration file's external files directory that is accessible to the gpudb user and either:

    • accessible to all nodes in the Kinetica cluster
    • mirrored across each node in the Kinetica cluster

    For example, if external_files_directory is set to /opt/gpudb/data, the following <file path> specifications will have the corresponding outcomes:

    File PathOutcome
    /opt/gpudb/data/nyctaxi.dbDashboard loaded into Reveal from file /opt/gpudb/data/nyctaxi.db
    /opt/gpudb/nyctaxi.dbError, as absolute path /opt/gpudb does not contain external files directory /opt/gpudb/data as part of the path
<data source name>Name of data source through which the dashboard will be loaded.

For example, to load a dashboard named nyctaxi.db into Reveal:

Local Path
1
2
LOAD DASHBOARD "NYC Taxi"
FROM FILE PATHS '/opt/gpudb/persist/data/nyctaxi.db'
KiFS
1
2
LOAD DASHBOARD "NYC Taxi"
FROM FILE PATHS 'kifs://reveal/nyctaxi.db'
Data Source
1
2
3
LOAD DASHBOARD "NYC Taxi"
FROM FILE PATHS 'nyctaxi.db'
WITH OPTIONS (DATASOURCE = 'reveal')
Public URL
1
2
LOAD DASHBOARD "NYC Taxi"
FROM FILE PATHS 'https://github.com/kineticadb/kinetica-workbooks/raw/master/quickstart/nyctaxi.db'