GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support - #47971

Merged
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity
Nov 14, 2025
Merged

GH-46574: [C++][FlightRPC] ODBC Driver Connectivity support#47971
lidavidm merged 11 commits into
apache:mainfrom
Bit-Quill:gh-46574-driver-connectivity

Conversation

@alinaliBQ

@alinaliBQalinaliBQ commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

Rationale for this change

Add ODBC driver connection support for the driver, so the driver can connect to servers.

What changes are included in this PR?

Implementation of unicode APIs:

  • SQLDriverConnect
  • SQLDisconnect
  • SQLConnect
  • DSN Window
  • Test refactoring

Are these changes tested?

Tested locally on MSVC Windows.

Are there any user-facing changes?

N/A

@github-actions

Copy link
Copy Markdown

⚠️ GitHub issue #46574has been automatically assigned in GitHub to PR creator.

Comment threadcpp/src/arrow/flight/sql/odbc/tests/odbc_test_suite.cc
@github-actionsgithub-actionsBot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 27, 2025
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch 2 times, most recently from f28ed1f to 8ad5b6aCompareOctober 28, 2025 22:29
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm@kou Changes in this PR are ready for review, please let me know if you have any comments. Thank you! This PR is in draft because it depends on #47763 to get 2 of its tests passing.

alinaliBQ referenced this pull request in Bit-Quill/arrow Oct 29, 2025
* use suggestion from James for one-liner change to return `Status::OK` directly
* fix for iterating endpoints, it is based on JDBC's fix for the same bug
* save value of `FlightClientOptions`
* Use `TestFlightServer`
Add `arrow_flight_sql_shared` to enable usages for `TestFlightServer`
* Fix build errors from missing `gmock`
* Add checks for array data
Update flight_sql_stream_chunk_buffer_test.cc
Add `FlightStreamChunkBufferTest` unit test
Draft test with `FlightSQLODBCMockEndpointTestBase`
* Reference apacheGH-47117 and Clean up code
* Add driver and DSN to built-in properties to not pass driver/dsn as attributes to server
* Allow `=` in values inside connection strings, fixes connectivity problems
* Address comments from Rob
@alinaliBQ
alinaliBQforce-pushed the gh-46574-driver-connectivity branch from b5159a7 to fc95da6CompareOctober 29, 2025 18:35
@alinaliBQ
alinaliBQ marked this pull request as ready for review October 29, 2025 18:36
@alinaliBQ

alinaliBQ commented Oct 29, 2025

Copy link
Copy Markdown
CollaboratorAuthor

Rebased onto master to get changes from #47763

Edit: getting segfault error, looking into it.

@alinaliBQ
alinaliBQ marked this pull request as draft October 29, 2025 20:42
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

#include "arrow/flight/sql/odbc/odbc_impl/config/configuration.h"
#include "arrow/result.h"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if you wanted arrow::Status, just include status.h

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

namespace arrow::flight::sql::odbc {

/// \brief Case insensitive comparator that takes string_view
struct CaseInsensitiveComparatorStrView {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this defined here? It seems to only be used inside the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to the .cc file.


// PropertyMap is case-insensitive for keys.
typedef std::map<std::string_view, std::string, CaseInsensitiveComparator> PropertyMap;
typedef std::map<std::string, std::string, CaseInsensitiveComparator> PropertyMap;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the right definitions, you should be able to avoid wrapping every lookup in std::string. Can we avoid that? (See the note about 'transparent' comparator in https://en.cppreference.com/w/cpp/container/map/find)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've changed it to a transparent comparator and adjusted all the unnecessary std::string() wrapping.

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(maybe for a separate issue but) can we fix this namespace?

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea we can do it for a separate issue. Are we thinking of replacing ODBC with namespace arrow::flight::sql::odbc?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a link to the github issue.

// Return the number of bytes required for the conversion.
template <typename CHAR_TYPE>
inline size_t ConvertToSqlWChar(const std::string& str, SQLWCHAR* buffer,
inline size_t ConvertToSqlWChar(const std::string_view& str, SQLWCHAR* buffer,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

string_view can (and should) be passed by value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// \return wchar_msg in std::string format
inline std::string SqlWcharToString(SQLWCHAR* wchar_msg, SQLINTEGER msg_len = SQL_NTS) {
if (msg_len == 0 || !wchar_msg || wchar_msg[0] == 0) {
if (!wchar_msg || wchar_msg[0] == 0 || msg_len == 0) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't you check length before dereferencing the pointer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

static std::string GetPropertiesFromConnString(
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver
static std::string GetDsnIfExists(const std::string& conn_str);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would std::optional<std::string> be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment on lines +78 to +79
/// @return the DSN or an empty string if the DSN is not found or is found after the
/// driver

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use \return not @return.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

#if defined _WIN32
// For displaying DSN Window
# include "arrow/flight/sql/odbc/odbc_impl/system_dsn.h"
#endif

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#endif
#endif// defined(_WIN32)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@alinaliBQalinaliBQ left a comment

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will let my teammate Justin help out with the comments cc @justing-bq

Comment on lines 312 to 314
ARROW_FLIGHT_SQL: ON
ARROW_FLIGHT_SQL_ODBC: ON
ARROW_FLIGHT_SQL_ODBC: OFF
ARROW_GANDIVA: ON

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in #48019, we will try to enable ODBC on MSVC, so I am removing ODBC build from MinGW here

#include "arrow/flight/sql/odbc/odbc_impl/exceptions.h"
#include "arrow/flight/sql/odbc/odbc_impl/platform.h"

namespace ODBC {

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have created issue #48083, @justing-bq please link this issue in the code, thanks!

GH-48083 TODO: replace `namespace ODBC` with `namespace arrow::flight::sql::odbc`

@alinaliBQ
alinaliBQ marked this pull request as ready for review November 7, 2025 17:56
@justing-bq

Copy link
Copy Markdown
Contributor

Please take another look @lidavidm

Comment threadcpp/src/arrow/flight/sql/odbc/odbc_impl/encoding_utils.h Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Nov 10, 2025
alinaliBQand others added 10 commits November 12, 2025 11:07
* SQLDriverConnect requires SQLGetInfo to be implemented for tests to pass, because driver manager requires SQLGetInfo
Co-Authored-By: alinalibq <alina.li@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Iirc, there is segfault error associated with `SQLGetStmtAttrW`
Attempt to fix segfault error by adding impl for `SQLSetConnectAttr`
Part-fix remove `using` that isn't needed
std::string_view doesn't work well with std::map because once the std::string_view object is out of scope, the key is no longer valid. The map then has undefined behavior.
Enabling transparent comparing only helps with the `find` function, not inserts. For inserts we still need to use a std::string constructor.
Ran ODBC tests on MSVC locally and they passed.
@justing-bq
justing-bqforce-pushed the gh-46574-driver-connectivity branch from a9eae88 to cfcc956CompareNovember 12, 2025 19:33
@alinaliBQ

Copy link
Copy Markdown
CollaboratorAuthor

@lidavidm All comments have been addressed, please let me know if you have other feedback, thank you!

@lidavidm
lidavidm merged commit 94b9bb6 into apache:mainNov 14, 2025
42 of 45 checks passed
@lidavidmlidavidm removed the awaiting merge Awaiting merge label Nov 14, 2025
@conbench-apache-arrow

Copy link
Copy Markdown

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 94b9bb6.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details.

jduo pushed a commit that referenced this pull request Dec 8, 2025
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on #47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: #46575
Co-authored-by: rscales <robscales@icloud.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
…ache#47971)
### Rationale for this change
Add ODBC driver connection support for the driver, so the driver can connect to servers.
### What changes are included in this PR?
Implementation of unicode APIs:
- SQLDriverConnect
- SQLDisconnect
- SQLConnect
- DSN Window
- Test refactoring
### Are these changes tested?
Tested locally on MSVC Windows.
### Are there any user-facing changes?
N/A
* GitHub Issue: apache#46574
Lead-authored-by: Alina (Xi) Li <alina.li@improving.com>
Co-authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com>
Co-authored-by: justing-bq <justin.gossett@improving.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Mottl pushed a commit to Mottl/arrow that referenced this pull request May 26, 2026
### Rationale for this change
Putting the tests for diagnostics in a separate PR from
apache#47763, because non-diagnostic ODBC
APIs are required to get diagnostics.
### What changes are included in this PR?
- Add tests for ODBC diagnostics ### Are these changes tested?
PR depends on apache#47971 for tests to
work.
Tested locally. ### Are there any user-facing changes?
No
* GitHub Issue: apache#46575
Co-authored-by: rscales <robscales@icloud.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alinaliBQ@justing-bq@lidavidm