Skip to content

GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation#49851

Open
justing-bq wants to merge 3 commits intoapache:mainfrom
Bit-Quill:gh-49723-doc-updates
Open

GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation#49851
justing-bq wants to merge 3 commits intoapache:mainfrom
Bit-Quill:gh-49723-doc-updates

Conversation

@justing-bq
Copy link
Copy Markdown
Contributor

@justing-bq justing-bq commented Apr 23, 2026

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

@justing-bq justing-bq requested a review from lidavidm as a code owner April 23, 2026 21:08
@github-actions
Copy link
Copy Markdown

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}

See also:

@justing-bq justing-bq changed the title Update ODBC Documentation GH-49723: [C++][FlightRPC][ODBC] Update ODBC Documentation Apr 23, 2026
@github-actions
Copy link
Copy Markdown

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

@justing-bq
Copy link
Copy Markdown
Contributor Author

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

Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
@github-actions github-actions Bot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Apr 23, 2026
@justing-bq justing-bq force-pushed the gh-49723-doc-updates branch from c9d55a8 to 8e68507 Compare April 24, 2026 20:49
@kou kou requested a review from Copilot April 28, 2026 02:21
Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
| `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`
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.

This includes a space. Is it correct?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes this is one of the keys accepted by the driver.

Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
@kou kou requested a review from alinaliBQ April 28, 2026 02:25
@github-actions github-actions Bot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Apr 28, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md
Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
@github-actions github-actions Bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Apr 28, 2026
@kou kou requested a review from Copilot April 30, 2026 08:46
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
@justing-bq justing-bq force-pushed the gh-49723-doc-updates branch from f132729 to 99bb351 Compare April 30, 2026 22:03
Copy link
Copy Markdown
Collaborator

@alinaliBQ alinaliBQ left a comment

Choose a reason for hiding this comment

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

+1

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Comment thread cpp/src/arrow/flight/sql/odbc/connection-options.md Outdated
Comment thread cpp/src/arrow/flight/sql/odbc/README.md Outdated
@justing-bq justing-bq force-pushed the gh-49723-doc-updates branch from 99bb351 to 96f38fd Compare May 1, 2026 23:42
Sign up for free to 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.

[C++][FlightRPC][ODBC] Documentation: Connection Options for Unix Systems

5 participants