Installation

Install Vulcan CLI

With Node JS

If you have NodeJS (≥ 16) installed, you can simply install Vulcan CLI globally via NPM.

npm i -g @vulcan-sql/cli

With Docker

If you have Docker Desktop installed, you can run Vulcan CLI directly.

docker pull ghcr.io/canner/vulcan-sql/cli
alias vulcan="docker run -it --rm -p 3000:3000 -v ${PWD}:/usr/app ghcr.io/canner/vulcan-sql/cli"
alias "vulcan-install"="docker run -it --rm -p 3000:3000 -v ${PWD}:/usr/app --entrypoint npm ghcr.io/canner/vulcan-sql/cli install"

Initialize your first project

1. Initialize a Vulcan project. In an empty folder, run the following command:

   vulcan init .

2. Check the installation.

   vulcan version

Install desired connector(s)

You need to install corresponding connectors in order to connect with your data warehouses. Please check Connectors (TBD, link to doc) to install these connectors.

For example, to use Postgres connector:

1. Install connector

   npm i @vulcan-sql/extension-driver-pg

2. Enable it by updating vulcan.yaml.

   extensions:
     pg: '@vulcan-sql/extension-driver-pg'

Set proper profiles

We need some credentials to connect to your data warehouses, which we call “profiles”. You need to set up at least one profile to let Vulcan work. Please check Authentication / Authorization (TBD, link to doc) for further information.

For example, to set up a profile for PostgreSQL connector, you can add the following content to profiles.yaml at your project root.

- name: pg
  type: pg
  allow: '*'
  connection:
    host: 'host-of-the-server'
    user: 'postgres'
    password: 'postgres'
    database: 'postgres'

Start your API server

Start your local API server:

vulcan start --watch

You can develop your API server with SQL files now!