Skip to content

hashmapinc/snowflake-inspector

Repository files navigation

CircleCI

Snowflake Inspector

Welcome to the Snowflake Inspector project!

You can access a live version of the tool at http:https://snowflakeinspector.com

How to Build:

To build the project, ensure you have npm installed and do the following:

  • run npm i to install dependencies
  • run npm run build to build the static website. The files will show up in dist/

Alternatively, you can make use of the Makefile:

  • Run make to install all dependencies and build the production bundle of the inspector site

How to run locally for development

How to build and run with Docker

  • Run npm i to install dependencies
  • Run npx webpack --mode=production to build the production distribution of the static site files
  • Run docker build -t snowflake-inspector . to build the image locally.
  • Run docker run -it -p 8083:80 snowflake-inspector to run a container based on the image you just built.
  • Access the site at http:https://localhost:8083/bundle.html

Alternatively, you can make use of the Makefile:

  • Run make install && make container to install npm modules, generate the production build of Snowflake Inspector, create a local snowflake-inspector Docker image (based on nginx), and start that container on port 8083
  • Access the site at http:https://localhost:8083/bundle.html

Providing default hierarchy data on load.

This tool now supports dynamic reading of hierarchy data on load for internal hosting of hierarchy visualizations on load without needing to run SQL manually each time.

To change or updated the default data at runtime, do the following:

  • Find the current default-data.csv at /dist/default-data.csv after building the project. If you are running the project docker container, the csv file is at /usr/share/nginx/html/default-data.csv.
  • Replace the contents of this file with the desired default hierarchy data.
  • Reload the Inspector tool. No rebuilding of the project is required - this is a hot update capability!

Future releases may include a config file for Snowflake access details that will allow the Inspector to update the hierarchy on a schedule, but for now the recommended approach is to scp your updated file into your running server environment to update the default-data.csv.

Reach out + Feedback

You can contact us at https://www.hashmapinc.com/reach-out if you want to learn more about Hashmap.

You can also provide feedback on this tool at https://forms.gle/42ACP1waPistVdTu9

About

Web tool for visualizing your Snowflake Data Platform instance.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages