chore: update documentation and clean up automations #510
Conversation
This file contains hidden or 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
crystall-bitquill
approved these changes
May 1, 2024
| - To use the wrapper with Aurora with PostgreSQL compatibility, install [Psycopg](https://github.com/psycopg/psycopg). | ||
| - To use the wrapper with Aurora with MySQL compatibility, install [MySQL Connector/Python](https://github.com/mysql/mysql-connector-python). | ||
| > [!NOTE]\ | ||
| > The driver has been verified on Psycopg 3.1.12+ and MySQL Connector/Python 8.1.0+. Compatibility with prior versions have not been tested. |
Contributor
There was a problem hiding this comment.
Suggested change
| > The driver has been verified on Psycopg 3.1.12+ and MySQL Connector/Python 8.1.0+. Compatibility with prior versions have not been tested. | |
| > The driver has been verified on Psycopg 3.1.12+ and MySQL Connector/Python 8.1.0+. Compatibility with prior versions has not been tested. |
|
|
||
| ## Secret Data | ||
| The plugin assumes that the secret contains the following properties `username` and `password` | ||
| The plugin assumes that the secret contains the following properties `username` and `password`. |
Contributor
There was a problem hiding this comment.
Suggested change
| The plugin assumes that the secret contains the following properties `username` and `password`. | |
| The plugin assumes that the secret contains the following properties: `username` and `password`. |
|
|
||
| The AWS Advanced Python Driver leverages community Python drivers and enables support of AWS and Aurora functionalities. | ||
| Currently, [Psycopg](https://github.com/psycopg/psycopg) and [MySQL Connector/Python](https://github.com/mysql/mysql-connector-python) are supported. | ||
| Currently, [Psycopg](https://github.com/psycopg/psycopg) 3.1.12+ and [MySQL Connector/Python](https://github.com/mysql/mysql-connector-python) 8.1.0+ are supported. Compatibility with prior versions of these drivers have not been tested. |
Contributor
There was a problem hiding this comment.
Suggested change
| Currently, [Psycopg](https://github.com/psycopg/psycopg) 3.1.12+ and [MySQL Connector/Python](https://github.com/mysql/mysql-connector-python) 8.1.0+ are supported. Compatibility with prior versions of these drivers have not been tested. | |
| Currently, [Psycopg](https://github.com/psycopg/psycopg) 3.1.12+ and [MySQL Connector/Python](https://github.com/mysql/mysql-connector-python) 8.1.0+ are supported. Compatibility with prior versions of these drivers has not been tested. |
docs/GettingStarted.md
Outdated
| ) | ||
| ``` | ||
|
|
||
| Similarly, to start using the driver with MySQL Connector/Python, you pass the connect function to the `AwsWrapperConnection#connect` method as shown in the following example: |
Contributor
There was a problem hiding this comment.
Suggested change
| Similarly, to start using the driver with MySQL Connector/Python, you pass the connect function to the `AwsWrapperConnection#connect` method as shown in the following example: | |
| Similarly, to start using the driver with MySQL Connector/Python, you need to pass the connect function to the `AwsWrapperConnection#connect` method as shown in the following example: |
karenc-bq
force-pushed
the
update-documentation
branch
from
4d72b05 to
7cb8d54
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.