Allow user to set up a lambda to initialize new connections #705
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
|
docs ? |
sergiyvamz
changed the title
sergiyvamz
force-pushed
the
init-connection
branch
from
c08bdea
to
36d9337
Compare
sergiyvamz
force-pushed
the
init-connection
branch
from
36d9337
to
c4b9c6d
Compare
brunos-bq
reviewed
Oct 27, 2023
|
|
||
| ConnectionProviderManager.setConnectionInitFunc((connection, protocol, hostSpec, props) -> { | ||
| if ("test-database".equals(props.getProperty("database"))) { | ||
| connection.setSchema("test-database-schema"); |
There was a problem hiding this comment.
NIT: assert schema is set for the connection?
There was a problem hiding this comment.
Ops. That's not supposed to be here.
| ### Connection Initialization | ||
| In some cases it's necessary to configure a connection before a user application can use it. Some target drivers provides such functionality and allow to specify a configuration parameter with SQL statements that are executed when connection is established. However, not all drivers supports such functionality. Also, in some cases, additional conditions should be checked in order to identify what initialization is required for a particular connection. | ||
|
|
||
| AWS JDBC Driver allows to specify a special function that can initialize a connection. It can be done with `ConnectionProviderManager.setConnectionInitFunc` method. `resetConnectionInitFunc` method is also available. |
There was a problem hiding this comment.
The AWS JDBC Driver allows users to specify a specific function that will be executed every time a connection is initialized. This function needs to be wrapped in a ConnectionInitFunc object, that implements the initConnection() method. Once that object is defined, it is passed to the driver using the ConnectionProviderManager.setConnectionInitFunc method.
It is also possible to stop/reset executing this function by using the resetConnectionInitFunc method.
| > :warning: Executing CPU and network intensive code in the initialization function may cause significant performance degradation. | ||
|
|
||
| ```java | ||
| ConnectionProviderManager.setConnectionInitFunc((connection, protocol, hostSpec, props) -> { |
There was a problem hiding this comment.
NIT: let's also add a case without a lambda
| @@ -100,6 +100,25 @@ DriverConfigurationProfiles.addOrReplaceProfile( | |||
| CustomConnectionPluginFactory.class)); | |||
| ``` | |||
|
|
|||
| ### Connection Initialization | |||
| In some cases it's necessary to configure a connection before a user application can use it. Some target drivers provides such functionality and allow to specify a configuration parameter with SQL statements that are executed when connection is established. However, not all drivers supports such functionality. Also, in some cases, additional conditions should be checked in order to identify what initialization is required for a particular connection. | |||
There was a problem hiding this comment.
In some particular cases, users may need to define a specific configuration for a connection that has just been opened by the driver before an application can use it.
Some...
sergiyvamz
force-pushed
the
init-connection
branch
from
c4b9c6d
to
4d001b6
Compare
Co-authored-by: crystall-bitquill <97126568+crystall-bitquill@users.noreply.github.com>
Co-authored-by: crystall-bitquill <97126568+crystall-bitquill@users.noreply.github.com>
karenc-bq
reviewed
Oct 27, 2023
karenc-bq
reviewed
Oct 27, 2023
karenc-bq
reviewed
Oct 27, 2023
Co-authored-by: crystall-bitquill <97126568+crystall-bitquill@users.noreply.github.com>
Co-authored-by: Karen <64801825+karenc-bq@users.noreply.github.com>
Co-authored-by: Karen <64801825+karenc-bq@users.noreply.github.com>
Co-authored-by: Karen <64801825+karenc-bq@users.noreply.github.com>
karenc-bq
approved these changes
Oct 27, 2023
Merged
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
Allow user to set up a lambda to initialize new connections.
Description
User needs to set an connection initialization function with ConnectionProviderManager.setConnectionInitFunc()
Related to #679
Additional Reviewers
@karenc-bq
@crystall-bitquill
@brunos-bq
@aaronchung-bitquill
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.