Skip to content

Commit 23aa7df

Browse files
authored
Merge pull request #303 from Canner/feature/update-doc
add Redshift docs
2 parents 9de213f + e7d23db commit 23aa7df

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed
+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Redshift
2+
3+
## Installation
4+
5+
1. Install the package:
6+
7+
**If you are developing with VulcanSQL's binary version, the package is already bundled in the binary. You can skip this step.**
8+
9+
```bash
10+
npm i @vulcan-sql/extension-driver-redshift
11+
```
12+
13+
2. Update your `vulcan.yaml` file to enable the extension:
14+
15+
```yaml
16+
extensions:
17+
...
18+
redshift: '@vulcan-sql/extension-driver-redshift' # Add this line
19+
```
20+
21+
3. Create a new profile in your `profiles.yaml` file or in the designated profile paths. For example if you are using Redshift Serverless:
22+
23+
```yaml
24+
- name: redshift # profile name
25+
type: redshift
26+
allow: '*'
27+
connection:
28+
# please see the type definition of RedshiftDataClientConfig
29+
# https://github.com/aws/aws-sdk-js-v3/blob/29056f4ca545f7e5cf951b915bb52178305fc305/clients/client-redshift-data/src/RedshiftDataClient.ts#L253C18-L253C42
30+
credentials:
31+
accessKeyId: <AWS_ACCESS_KEY_ID>
32+
secretAccessKey: <AWS_SECRET_ACCESS_KEY>
33+
# please see the type definition of ExecuteStatementCommandInput(omit Sql and Parameters)
34+
# https://github.com/aws/aws-sdk-js-v3/blob/29056f4ca545f7e5cf951b915bb52178305fc305/clients/client-redshift-data/src/models/models_0.ts#L805C18-L805C39
35+
Database: <AWS_REDSHIFT_DATABASE>
36+
WorkgroupName: <AWS_REDSHIFT_WORKGROUP_NAME>
37+
```
38+
39+
## Configuration
40+
41+
For more information, please refer to the [Redshift Data API Client documentation](https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-redshift-data) to learn about the available arguments for the Redshift Data Client.
42+
The configuration is composed of two types defined in Redshift Data API Client,
43+
namely [`RedshiftDataClientConfig`](https://github.com/aws/aws-sdk-js-v3/blob/91e51ab99e58091068d1f4173ecf9f457db92df8/clients/client-redshift-data/src/RedshiftDataClient.ts#L253)
44+
and [`ExecuteStatementCommandInput`](https://github.com/aws/aws-sdk-js-v3/blob/91e51ab99e58091068d1f4173ecf9f457db92df8/clients/client-redshift-data/src/models/models_0.ts#L805)(without `Sql` and `Parameters`).

packages/doc/sidebars.js

+4
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ const sidebars = {
7676
type: 'doc',
7777
id: 'connectors/clickhouse',
7878
},
79+
{
80+
type: 'doc',
81+
id: 'connectors/redshift',
82+
},
7983
{
8084
type: 'doc',
8185
id: 'connectors/ksqldb',

0 commit comments

Comments
 (0)