DuckDB

Duckdb is an in-processSQL OLAP database management system, you can connect with it vai this connector.

Installation

1. Install package.

   npm i @vulcan-sql/extension-driver-duckdb
   info

   If you run Vulcan with Docker, you should use the command vulcan-install @vulcan-sql/extension-driver-duckdb instead.

2. Update vulcan.yaml, and enable the extension.

   extensions:
     ...
     duckdb: '@vulcan-sql/extension-driver-duckdb' # Add this line

3. Create a new profile in profiles.yaml or in your profile files. For example:

   - name: duckdb # profile name
     type: duckdb
     connection:
       persistent-path: 'path-to-a-db-file'

Configuration

Name	Required	Default	Description
persistent-path	N	:in-memory:	Path to your persistent DB, if this value is not set, we use an in-memory database. This path is relative to the work directory, which is your project root.
log-queries	N	false	Whether log query requests
log-parameters	N	false	Whether log query requests' parameters, please be aware that query parameters might contain sensitive data.