chore: add a table for exception codes #46
Merged
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
docs/using-the-jdbc-wrapper/using-plugins/UsingTheFailoverPlugin.md
Outdated
Show resolved
Hide resolved
crystall-bitquill
approved these changes
Aug 10, 2022
sergiyvamz
reviewed
Aug 10, 2022
| @@ -34,6 +34,13 @@ In addition to the parameters that you can configure for the underlying driver, | |||
| When connecting to Aurora clusters, the [`clusterInstanceHostPattern`](#failover-parameters) parameter is required when the connection string does not provide enough information about the database cluster domain name. If the Aurora cluster endpoint is used directly, the JDBC Wrapper will recognize the standard Aurora domain name and can re-build a proper Aurora instance name when needed. In cases where the connection string uses an IP address, a custom domain name or localhost, the wrapper won't know how to build a proper domain name for a database instance endpoint. For example, if a custom domain was being used and the cluster instance endpoints followed a pattern of `instanceIdentifier1.customHost`, `instanceIdentifier2.customHost`, etc., the wrapper would need to know how to construct the instance endpoints using the specified custom domain. Because there isn't enough information from the custom domain alone to create the instance endpoints, the `clusterInstanceHostPattern` should be set to `?.customHost`, making the connection string `jdbc:aws-wrapper:postgresql://customHost:1234/test?clusterInstanceHostPattern=?.customHost`. Refer to [this diagram](../../images/failover_behavior.png) on JDBC Wrapper behavior during failover for different connection URLs for more details and examples. | |||
|
|
|||
| ## Failover Exception Codes | |||
|
|
|||
| | Exceptions | Is the connection valid? | Can the connection be reused? | Has the session state changed? | Does the session need to be reconfigured? | Does the last statement need to be re-executed | Does the transaction need to be restarted | | |||
| | ------------------------------------------ | ------------------------ | ----------------------------- | ------------------------------ | ----------------------------------------- | ---------------------------------------------- | ----------------------------------------- | | |||
There was a problem hiding this comment.
If we need to add more columns/questions then the table gets wider that makes it unreadable. Does it makes sense to pivot the table?
There was a problem hiding this comment.
I tried to transpose the table but I think this version is more readable. If we do decide to add columns I think we should look for a better representation than using table.
sergiyvamz
reviewed
Aug 10, 2022
docs/using-the-jdbc-wrapper/using-plugins/UsingTheFailoverPlugin.md
Outdated
Show resolved
Hide resolved
sergiyvamz
reviewed
Aug 10, 2022
docs/using-the-jdbc-wrapper/using-plugins/UsingTheFailoverPlugin.md
Outdated
Show resolved
Hide resolved
sergiyvamz
approved these changes
Aug 11, 2022
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.
Summary
chore: add a table for exception codes
Additional Reviewers
@sergiyvamz