GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation by justing-bq · Pull Request #49851 · apache/arrow

justing-bq · 2026-04-23T21:08:06Z

Rationale for this change

Update ODBC Documentation in preparation for public release.
Resolves#49723

What changes are included in this PR?

Miscellaneous doc changes.

Are these changes tested?

N/A

Are there any user-facing changes?

No

GitHub Issue: [C++][FlightRPC][ODBC] Documentation: Connection Options for Unix Systems #49723

github-actions · 2026-04-23T21:08:29Z

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

Pull request overview

Updates documentation for the Arrow Flight SQL ODBC driver to better support Unix/macOS users ahead of public release (GH-49723), including a new reference for connection properties and expanded install/registration steps across platforms.

Changes:

Add a new connection-options.md document describing connection string / DSN properties.
Update ODBC README with Windows/macOS/Linux driver binary locations and registration commands.
Add a Linux-specific known limitation note for isql.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 14 comments.

File	Description
`cpp/src/arrow/flight/sql/odbc/connection-options.md`	New doc describing ODBC connection properties and defaults.
`cpp/src/arrow/flight/sql/odbc/README.md`	Expanded registration instructions for macOS/Linux and updated known limitations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

alinaliBQ

+1

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

justing-bq · 2026-05-19T22:14:21Z

@lidavidm @kou
Please take a look when you have time.

kou

+1

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

+ODBC connection parameters can be set in a connection string or defined in a DSN. On macOS and Linux, DSNs are typically defined in your system's `odbc.ini`. On Windows they are typically configured with the ODBC Data Source Administrator.
+
+The following sample connection string and sample DSN are two equivalent ways to connect to Arrow.
+



 - Conversion from timestamp data type with specified time zone value to strings is not supported at the moment. This doesn't impact driver's usage of retrieving timestamp data from Power BI on Windows, and Excel on macOS and Windows. See GH-47504 for more context.
 - Conversion from strings to big int data type has a limit range of -9007199254740992 to 9007199254740992.
+- On Linux, `isql` commands `tables` and `columns` don't work due to GH-49702. Users are not blocked from fetching data tables.


conbench-apache-arrow · 2026-05-20T09:22:50Z

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

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 15 possible false positives for unstable benchmarks that are known to sometimes produce them.

…che#49851) ### Rationale for this change Update ODBC Documentation in preparation for public release. Resolvesapache#49723 ### What changes are included in this PR? Miscellaneous doc changes. ### Are these changes tested? N/A ### Are there any user-facing changes? No * GitHub Issue: apache#49723 Authored-by: justing-bq <62349012+justing-bq@users.noreply.github.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>

justing-bq requested a review from lidavidm as a code owner April 23, 2026 21:08

github-actionsBot added Component: C++ Component: FlightRPC Component: Documentation CI: Extra: C++ Run extra C++ CI awaiting review Awaiting review labels Apr 23, 2026

justing-bq changed the title ~~Update ODBC Documentation~~GH-49723: [C++][FlightRPC][ODBC] Update ODBC DocumentationApr 23, 2026

lidavidm approved these changes Apr 23, 2026
View reviewed changes

Comment threadcpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment threadcpp/src/arrow/flight/sql/odbc/connection-options.md Outdated

github-actionsBot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Apr 23, 2026

justing-bq force-pushed the gh-49723-doc-updates branch from c9d55a8 to 8e68507Compare April 24, 2026 20:49

kou requested a review from Copilot April 28, 2026 02:21

Copilotstarted reviewing on behalf of kou April 28, 2026 02:22 View session

kou reviewed Apr 28, 2026
View reviewed changes

kou requested a review from alinaliBQ April 28, 2026 02:25

github-actionsBot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Apr 28, 2026

CopilotAI reviewed Apr 28, 2026
View reviewed changes

github-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Apr 28, 2026

kou requested a review from Copilot April 30, 2026 08:46

Copilotstarted reviewing on behalf of kou April 30, 2026 08:46 View session

CopilotAI reviewed Apr 30, 2026
View reviewed changes

Comment threadcpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment threadcpp/src/arrow/flight/sql/odbc/connection-options.md Outdated

justing-bq force-pushed the gh-49723-doc-updates branch from f132729 to 99bb351Compare April 30, 2026 22:03

alinaliBQ approved these changes May 1, 2026
View reviewed changes

kou requested a review from Copilot May 1, 2026 21:59

Copilotstarted reviewing on behalf of kou May 1, 2026 22:00 View session

CopilotAI reviewed May 1, 2026
View reviewed changes

Comment threadcpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment threadcpp/src/arrow/flight/sql/odbc/README.md Outdated

justing-bq force-pushed the gh-49723-doc-updates branch 2 times, most recently from 96f38fd to 89aa25cCompare May 5, 2026 21:27

justing-bq added 3 commits May 19, 2026 11:48

Update ODBC Documentation
a114db4

Address feedback
26dbad2

Address more feedback
ab44ea2

justing-bq force-pushed the gh-49723-doc-updates branch from 89aa25c to ab44ea2Compare May 19, 2026 18:48

kou requested a review from Copilot May 20, 2026 01:36

Copilotstarted reviewing on behalf of kou May 20, 2026 01:36 View session

kou approved these changes May 20, 2026
View reviewed changes

github-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels May 20, 2026

CopilotAI reviewed May 20, 2026
View reviewed changes

kou merged commit 603eeec into apache:mainMay 20, 2026
59 of 63 checks passed

kou removed the awaiting merge Awaiting merge label May 20, 2026

kou mentioned this pull request May 20, 2026
[C++][FlightRPC][ODBC] Documentation: Connection Options for Unix Systems #49723
Closed

+| `host` | The IP address or hostname for the server. | `NONE`
+| `port` | The TCP port number the server uses for ODBC connections. | `NONE`
+| `user` | The username for authentication to the server. | `NONE`
+| `user id` | The username for authentication to the server. | `NONE`

		ODBC connection parameters can be set in a connection string or defined in a DSN. On macOS and Linux, DSNs are typically defined in your system's `odbc.ini`. On Windows they are typically configured with the ODBC Data Source Administrator.

		The following sample connection string and sample DSN are two equivalent ways to connect to Arrow.

Uh oh!

Conversation

justing-bq commented Apr 23, 2026• edited by github-actions BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

Uh oh!

github-actionsBot commented Apr 23, 2026

Uh oh!

github-actionsBot commented Apr 23, 2026

Uh oh!

justing-bq commented Apr 23, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kouApr 28, 2026

Choose a reason for hiding this comment

Uh oh!

justing-bqApr 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

alinaliBQ left a comment

Choose a reason for hiding this comment

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

justing-bq commented May 19, 2026

Uh oh!

kou left a comment

Choose a reason for hiding this comment

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

conbench-apache-arrowBot commented May 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

justing-bq commented Apr 23, 2026•
edited by github-actions Bot
Loading