@vulcan-sql/extension-driver-duckdb

extension-driver-duckdb

Duckdb driver for Vulcan SQL

Install

1. Install package

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

2. Update vulcan.yaml, enable the extension.

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

3. Create a new profile in profiles.yaml or in your profiles' paths.

   - name: duck # profile name
     type: duckdb
     connection:
       # Optional: Path to your persistent DB, if this value is not set, we use in-memory database. (default: ":memory:")
       persistent-path: 'path-to-a-folder'
       # Optional: Whether log query requests (default: false)
       log-queries: false
       # Optional: Whether log query requests' parameters, please be aware that query parameters might contain sensitive data (default: false)
       log-parameters: false
       # Optional: Contains the configuration parameters DuckDB need (ex: for duckdb extension "httpfs", it will needs region, accessKeyId, ...)
       # You can read more in the [duckdb extension page](https://duckdb.org/docs/extensions/overview) 
       configuration-parameters: 
         region?: string
         accessKeyId?: string
         secretAccessKey?: string
         # alternative option for accessKeyId and secretAccessKey
         sessionToken?: string
         endpoint?: string
         url_style?: string
         use_ssl?: boolean