Add documentation #4
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chathushkaayash
requested review from
daneshk and
ThisaruGuruge
as code owners
Nuvindu
reviewed
Jan 24, 2025
Nuvindu
reviewed
Jan 24, 2025
Nuvindu
reviewed
Jan 24, 2025
| @@ -0,0 +1,14 @@ | |||
| [package] | |||
| org = "sample" | |||
There was a problem hiding this comment.
Suggested change
| org = "sample" | |
| org = "wso2" |
Nuvindu
reviewed
Jan 24, 2025
Comment on lines
+10
to
+14
| [[dependency]] | ||
| org="ballerinax" | ||
| name="aws.redshiftdata" | ||
| version="0.1.0" | ||
| repository="local" |
Nuvindu
reviewed
Jan 24, 2025
Comment on lines
+14
to
+19
| ### Usage Options | ||
|
|
||
| The Redshift Data Ballerina Connector can be used in two ways: | ||
|
|
||
| 1. **Redshift Cluster**: Connect directly to a provisioned Amazon Redshift cluster. | ||
| 2. **Serverless Mode**: Leverage the serverless capabilities of the Redshift Data API, which is particularly suited for applications that need to scale dynamically without managing infrastructure. |
There was a problem hiding this comment.
Should not this be included as a subsection in the setup guide on how to retrieve connection configs for cluster or a serverless workgroup ?
Nuvindu
reviewed
Jan 24, 2025
| 1. **Redshift Cluster**: Connect directly to a provisioned Amazon Redshift cluster. | ||
| 2. **Serverless Mode**: Leverage the serverless capabilities of the Redshift Data API, which is particularly suited for applications that need to scale dynamically without managing infrastructure. | ||
|
|
||
| ## Setup guide: Cluster |
There was a problem hiding this comment.
This should be Setup guide, there can be subsection like Cluster configurations. Please sync all the documentation.
Suggested change
| ## Setup guide: Cluster | |
| ## Setup guide | |
| ### Option 1: Cluster based setup |
Nuvindu
reviewed
Jan 24, 2025
|
|
||
| 1. In the AWS Management Console, search for Redshift in the services search bar. | ||
| 1. Click on Amazon Redshift. | ||
|  |
There was a problem hiding this comment.
Rather doing this lets add the complete URL for the image. Please check the other places as well.
Suggested change
|  | |
|  |
Nuvindu
reviewed
Jan 24, 2025
| configurable string secretAccessKey = ?; | ||
| configurable redshiftdata:Cluster dbAccessConfig = ?; | ||
|
|
||
| redshiftdata:Client redshift = check new (region = "us-east-2", |
There was a problem hiding this comment.
Check for other places as well.
Suggested change
| redshiftdata:Client redshift = check new (region = "us-east-2", | |
| redshiftdata:Client redshiftdata = check new (region = redshiftdata:US_EAST_2, |
Nuvindu
reviewed
Jan 24, 2025
Nuvindu
reviewed
Jan 24, 2025
|
|
||
| ## Examples | ||
|
|
||
| The `aws.redshiftdata` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](/examples). |
There was a problem hiding this comment.
Suggested change
| The `aws.redshiftdata` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](/examples). | |
| The `aws.redshiftdata` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-aws.redshiftdata/tree/main/examples). |
Nuvindu
reviewed
Jan 24, 2025
|
|
||
| ```bash | ||
| bal run | ||
| ``` |
There was a problem hiding this comment.
Let's add examples to Package.md and Module.md files
Nuvindu
reviewed
Jan 24, 2025
Comment on lines
+10
to
+14
| [[dependency]] | ||
| org="ballerinax" | ||
| name="aws.redshiftdata" | ||
| version="0.1.0" | ||
| repository="local" |
There was a problem hiding this comment.
Suggested change
| [[dependency]] | |
| org="ballerinax" | |
| name="aws.redshiftdata" | |
| version="0.1.0" | |
| repository="local" |
Nuvindu
reviewed
Jan 24, 2025
| while (i < 10) { | ||
| redshiftdata:DescriptionResponse|redshiftdata:Error describeStatementResponse = | ||
| redshift->describeStatement(statementId); | ||
| if (describeStatementResponse is redshiftdata:Error) { |
There was a problem hiding this comment.
Suggested change
| if (describeStatementResponse is redshiftdata:Error) { | |
| if describeStatementResponse is redshiftdata:Error { |
Nuvindu
reviewed
Jan 24, 2025
| isolated function waitForDescribeStatementCompletion(redshiftdata:Client redshift, string statementId) | ||
| returns redshiftdata:DescriptionResponse|redshiftdata:Error { | ||
| int i = 0; | ||
| while (i < 10) { |
There was a problem hiding this comment.
Suggested change
| while (i < 10) { | |
| while i < 10 { |
|
We will merge this PR for the time-being and will address the review comments along with the feedback received during the connector review. |
ayeshLK
approved these changes
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Part of: #7446