Skip to content

Commit f9634f2

Browse files
committed
feat(doc): add ksqldb connecting document
1 parent 842289e commit f9634f2

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# KsqlDB
2+
3+
## Installation
4+
5+
1. Install the package:
6+
7+
**If you are developing with binary, the package is already bundled in the binary. You can skip this step.**
8+
9+
```bash
10+
npm i @vulcan-sql/extension-driver-ksqldb
11+
```
12+
13+
2. Update your `vulcan.yaml` file to enable the extension:
14+
15+
```yaml
16+
extensions:
17+
...
18+
// highlight-next-line
19+
ksqldb: '@vulcan-sql/extension-driver-ksqldb' # Add this line
20+
```
21+
22+
3. Create a new profile in your `profiles.yaml` file or in the designated profile paths. For example:
23+
24+
```yaml
25+
- name: ksql # profile name
26+
type: ksqldb
27+
connection:
28+
host: www.example.com:8088
29+
username: <username>
30+
password: <password>
31+
allow: '*'
32+
```
33+
34+
## Configuration
35+
36+
| Name | Required | Default | Description |
37+
| ------- | -------- | --------- | ----------- |
38+
| host | N | http://localhost:8088 | ksqlDB instance. |
39+
| username | N | | The name of the user on whose behalf requests are made. |
40+
| password | N | | The user's password. |

packages/doc/sidebars.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ const sidebars = {
7676
type: 'doc',
7777
id: 'connect/clickhouse',
7878
},
79+
{
80+
type: 'doc',
81+
id: 'connect/ksqldb',
82+
},
7983
],
8084
},
8185
{

0 commit comments

Comments
 (0)