Vizzly & Snowflake
Vizzly CLI
To get started, sign in to your Vizzly account (opens in a new tab), and visit the CLI authentication page (opens in a new tab). On that page, you will find two CLI commands, one to install the Vizzly CLI, and the other to authenticate the CLI. After running those commands, return here to continue the setup process.
Project setup
In this step, we will set up all the main resources that you need for your Vizzly integration in a single command.
vizzly setup -i snowflake
You will now have
- A
vizzly-private.pem
file you will use to sign your Vizzly identity config. - A
vizzly-public.pem
file that validates the identity config JSON Web Tokens (JWTs). - The
vizzly-public.pem
file has been uploaded to your key-pairs on your account (opens in a new tab). - The unique identifier of a new parent dashboard.
Deployment
Now we need to deploy the Vizzly Query Engine. If you are doing this for the first time, we strongly recommend doing this for your local or staging environment.
Follow either one these guides to deploy your Vizzly Query Engine to your chosen environment;
- Locally using docker.
- Amazon Web Services
- Google Cloud Platform
- Heroku
Connecting to your data
To connect the Vizzly Query Engine to your data, you will need to navigate to the /connect
page of your deployed Query Engine. Once your connection has been established, the /status
page will tell you it is ready to start accepting queries!
Alternatively connecting via environment variables
If you would prefer to provide your connection credentials through environment variables, we support that too;
Snowflake connection environment variables
VIZZLY_CLIENT
Set this environment variable value to "snowflake".
VIZZLY_SNOWFLAKE_PASSWORD
Set the password to access your Snowflake database.
VIZZLY_SNOWFLAKE_DATABASE
The name of your snowflake database to connect to.
VIZZLY_SNOWFLAKE_USERNAME
The name of your snowflake database to connect to.
VIZZLY_SNOWFLAKE_ACCOUNT
The ID of your Snowflake account.
VIZZLY_SNOWFLAKE_WAREHOUSE
The ID of your snowflake warehouse.
VIZZLY_SNOWFLAKE_ROLE
The name of a role to use when connecting to your Snowflake DB.
VIZZLY_SNOWFLAKE_SCHEMA
The name of the Snowflake schema to connect to.
VIZZLY_SNOWFLAKE_SESSION_KEEP_ALIVE
Connection option to keep the session alive, set a string value of 'true' to enable keep-alive.
These integation specific variables are in addition to the common environment variables.
Config Manager
Now that you have deployed the Vizzly Query Engine, we will now be able to open the config manager to build the data set schemas that you want to make available to your users on the dashboard.
From the same directory as your private key, run the following command to open the config manager;
vizzly config-manager
Next steps
After completing the Snowflake integration, the recommended next step is to set up the identity config on your servers.
Support
Aggregates
Aggregate | Key |
---|---|
Mean | mean |
Sum | sum |
Min | min |
Max | max |
Count | count |
Unique | countDistinct |
Comparison operators
Comparison | Key |
---|---|
Greater than | > |
Less than | < |
Equal to | = |
Not equal to | != |
Greater than or equal to | >= |
Less than or equal to | <= |
Is one of | is_one_of |
Is not one of | is_not_one_of |
Starts with | starts_with |
Ends with | ends_with |
Contains text | contains_substring |
Does not contain text | does_not_contain_substring |
Time dimensions operators
Function | Key |
---|---|
Monthly | month |
Yearly | year |
Per quarter | quarter |
Weekly | week |
Daily | day |
Hourly | hour |
Per minute | minute |
Per second | second |
Supported features
Feature | Key |
---|---|
Simple maths | simpleMaths |
Aggregate maths | aggregateMaths |
Percentages | subquery |
Config Manager | configManagerUi |
Define data sets using custom SQL | sqlDefinedDataSet |
Rounded numbers, custom field | roundedNumbers |
Rule-based field group | switchField |