Change strategy to test connectivity between ODBC driver and SQL plugin #69
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
…-project#26 # Conflicts: # sql-odbc/src/sqlodbc/opensearch_communication.cpp
…-project#26 # Conflicts: # sql-odbc/src/sqlodbc/opensearch_communication.cpp
penghuo
reviewed
May 20, 2021
|
|
||
| if(!IsSQLPluginEnabled(error_details)) { | ||
| m_error_message += | ||
| "The SQL plugin is disabled. The SQL plugin must be " |
There was a problem hiding this comment.
could we add the doc link to guide customer how to enable SQL plugin.
penghuo
reviewed
May 20, 2021
| } | ||
|
|
||
| if (response->HasClientError()) { | ||
| m_error_message += " Client error: '" |
There was a problem hiding this comment.
What is the action item if the customer receive "Client error" or "Response error". Could we reduce all the error into same pattern. e.g. "Error: detailReason"
There was a problem hiding this comment.
I think the detailed error messages are only for log debug purpose, it will not be sent to the users. Yes we can merge them together.
dai-chen
approved these changes
May 20, 2021
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.
Description
Currently before establishes the connection between the ODBC driver and the OpenSearch server, the client tries to check the installed plugins in the current OpenSearch cluster by calling the
_cat/pluginsAPI. In this way, the connection will not be established if it does not detect the plugin with exactly the same name that was hard coded in the code base. It might cause compatibility issue once the SQL plugin is renamed, and it does not follow the common strategy to test the odbc connectivity as well.Thus we changed the strategy in this PR to let it send a simple
select 1query to the server to check the sql plugin availability instead.Case 1: SQL plugin is not installed
Behavior: connectivity test fails
Case 2: SQL plugin is installed but disabled
Behavior: connectivity test fails
Case 3: SQL plugin is installed and enabled, but somehow unhealthy (query execution failed)
Behavior: connectivity test fails
Similar error windows pop up with message: Connection error: [OpenSearch][SQL ODBC Driver][SQL Plugin] Connection error: SQL plugin is disabled, please enable the plugin to use this driver.
Case 4: SQL plugin is installed, enabled and in healthy status
Behavior: connectivity test passes
Issues Resolved
#57
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.