@vulcan-sql/extension-driver-ksqldb

extension-driver-ksqldb

This is the KSqlDb driver for VulcanSQL, provided by Canner.

Installation

1. Install the package:

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

2. Update your vulcan.yaml file to enable the extension:

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

3. Create a new profile in your profiles.yaml file or in the designated profile paths. For more information, please refer to the KsqlDb documentation for the available arguments.

   - name: ksql # Profile name
     type: ksqldb
     connection:
       # Optional: ksqlDB instance URL. Default is http://localhost:8088.
       host: 'www.example.com:8088'
       # Optional: The name of the user on whose behalf requests are made.
       username: '<username>',
       # The user's password
       password: '<password>',
       # Optional: Request timeout in milliseconds. Default value: 25000
       timeout: 25000
   

Testing

To run tests for the extension-driver-ksqldb module, use the following command:

nx test extension-driver-ksqldb