Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

@aws-cdk/aws-redshift-alpha: Add comments for redshift tables construct #22682

Closed
2 tasks
ksco92 opened this issue Oct 28, 2022 · 2 comments · Fixed by #23847 · May be fixed by WontonSam/apollo-federation-subgraph-compatibility#508, WontonSam/apollo-federation-subgraph-compatibility#511 or WontonSam/apollo-federation-subgraph-compatibility#523
Closed
2 tasks

@aws-cdk/aws-redshift-alpha: Add comments for redshift tables construct #22682

ksco92 opened this issue Oct 28, 2022 · 2 comments · Fixed by #23847 · May be fixed by WontonSam/apollo-federation-subgraph-compatibility#508, WontonSam/apollo-federation-subgraph-compatibility#511 or WontonSam/apollo-federation-subgraph-compatibility#523
Labels
@aws-cdk/aws-redshift Related to Amazon Redshift effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2

Comments

@ksco92
Copy link

ksco92 commented Oct 28, 2022

Describe the feature

Currently we have this construct:

https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-redshift-alpha.Table.html

In order to be able to fully utilize CI/CD for tables and generate version controlled documentation, we need to be able to add table descriptions through code. A simple description attribute like in Glue tables should be enough:

https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-glue.Table.html

Use Case

The current table construct allows the programmatic creation and modification of tables, however, in real life, comments for documentation are critical in any big data use case for automated documentation.

This addition will bring CDK one step closer to being able to fully manage a Redshift's table table structure and documentation.

Proposed Solution

Add a description attribute to the table construct.

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.45

Environment details (OS name and version, etc.)

AmazonLinux2
@ksco92 ksco92 added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Oct 28, 2022
@github-actions github-actions bot added the @aws-cdk/aws-redshift Related to Amazon Redshift label Oct 28, 2022
@peterwoodworth peterwoodworth added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Oct 29, 2022
@peterwoodworth
Copy link
Contributor

For the Glue table we are able to make use of the CloudFormation Glue Table description property. However for Redshift we make use of a custom resource which I'm personally not too familiar with. But this custom resource gives us quite a bit of freedom, if there's any way to create comments with the Redshift API then we should be able to support this 🙂

@comcalvi comcalvi removed their assignment Nov 14, 2022
@Rizxcviii Rizxcviii mentioned this issue Jan 6, 2023
Merged
4 tasks
@Rizxcviii Rizxcviii mentioned this issue Jan 26, 2023
Merged
4 tasks
@mergify mergify bot closed this as completed in #23847 Feb 3, 2023
mergify bot pushed a commit that referenced this issue Feb 3, 2023
@Rizxcviii
feat(redshift): Tables can include comments (#23847)
46cadd4 
Adds comments to tables.

closes #22682

----

### All Submissions:

* [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Construct Runtime Dependencies:

* [ ] This PR adds new construct runtime dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-construct-runtime-dependencies)

### New Features

* [x] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [x] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

github-actions bot commented Feb 3, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

This was referenced Sep 13, 2024
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-redshift Related to Amazon Redshift effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2
Projects
None yet
Milestone
No milestone
3 participants
@ksco92 @peterwoodworth @comcalvi