GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

alinaliBQ · 2025-10-08T23:53:24Z

Rationale for this change

ODBC needs to provide diagnostic information so users can debug the error

What changes are included in this PR?

Implementation of SQLGetDiagField and SQLGetDiagRec
Tests are included in separate PR (see GH-46575: [C++][FlightRPC] Add Diagnostic tests #47764)

Are these changes tested?

Tests will be in a separate PR (see #47764). Other APIs depend on SQLGetDiagField and SQLGetDiagRec to get error reporting functionality, and tests for SQLGetDiagField and SQLGetDiagRec depend on other APIs for creating errors, as these diagnostic APIs alone do not initiate any errors.

Changes tested locally

Are there any user-facing changes?

No

GitHub Issue: [C++][FlightSQL][ODBC] Develop basic diagnostic record handling: SQLGetDiagField, SQLGetDiagRec #46575

github-actions · 2025-10-08T23:54:04Z

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

alinaliBQ · 2025-10-08T23:59:42Z

@lidavidm @kou Please review this draft ODBC API PR. The test PR is at #47764.

Tests will be in a separate PR (see #47764). Other APIs depend on SQLGetDiagField and SQLGetDiagRec to get error reporting functionality, and tests for SQLGetDiagField and SQLGetDiagRec depend on other APIs for creating errors, as these diagnostic APIs alone do not initiate any errors.

lidavidm · 2025-10-09T00:09:55Z

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

+    // The length of the sql state is always 5 characters plus null
+    SQLSMALLINT size = 6;
+    const std::string& state = diagnostics->GetSQLState(record_index);
+    GetStringAttribute(is_unicode, state, false, sql_state, size, &size, *diagnostics);


Do we not need to check the return value?

According to Microsoft documentation https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlgetdiagrec-function?view=sql-server-ver17#diagnostics, SQL_SUCCESS_WITH_INFO should be returned if *message_text buffer was too small to hold the requested diagnostic message. But the doc does not mention any SQLGetDiagRec return value that is associated with sql_state buffer, so the return value for writing sql_state buffer is ignored by the driver. I have added an in-line comment for this.

sql_state is meant to always contain a 5-character string, so error risk for writing it is low.

Can we be explicit with ARROW_UNUSED? (Also, not necessarily for this PR, but if SQLRETURN is meant to be an error code, perhaps functions returning it should be annotated [[nodiscard]].)

Sure, added ARROW_UNUSED here.

Regarding [[nodiscard]], we can add it in this PR for ODBC API internal headers (odbc_api_internal.h).
On the other hand, since BI applications (and ODBC tests) will use the ODBC API definition headers at sql.h which doesn't have [[nodiscard]], I think we could skip adding [[nodiscard]] to entry_points.cc as it won't make any impact.

We can split it out too. [[nodiscard]] isn't a hard requirement, just a potential suggestion.

yup. It's not a big change so we could do it

kou · 2025-10-09T06:42:05Z

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

+                                   SQLSMALLINT* string_length_ptr, bool is_unicode) {
+  const SQLSMALLINT char_size = is_unicode ? GetSqlWCharSize() : sizeof(char);
+  const bool has_valid_buffer =
+      diag_info_ptr && buffer_length >= 0 && buffer_length % char_size == 0;


Do we need diag_info_ptr && here?

Suggested change

diag_info_ptr && buffer_length >= 0 && buffer_length % char_size == 0;

buffer_length >= 0 && buffer_length % char_size == 0;

Good catch, removed diag_info_ptr from has_valid_buffer

lidavidm · 2025-10-22T00:10:37Z

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

+    // The length of the sql state is always 5 characters plus null
+    SQLSMALLINT size = 6;
+    const std::string& state = diagnostics->GetSQLState(record_index);
+    GetStringAttribute(is_unicode, state, false, sql_state, size, &size, *diagnostics);


Can we be explicit with ARROW_UNUSED? (Also, not necessarily for this PR, but if SQLRETURN is meant to be an error code, perhaps functions returning it should be annotated [[nodiscard]].)

Work on code review comments - remove `diag_info_ptr` from `IsValidStringFieldArgs` checks Co-Authored-By: rscales <[email protected]>

Addresses community comment: https://github.com/apache/arrow/pull/47763/files#r2450014186

alinaliBQ

worked on review comment, thanks for reviewing!

alinaliBQ · 2025-10-22T20:41:48Z

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

+    // The length of the sql state is always 5 characters plus null
+    SQLSMALLINT size = 6;
+    const std::string& state = diagnostics->GetSQLState(record_index);
+    GetStringAttribute(is_unicode, state, false, sql_state, size, &size, *diagnostics);


Sure, added ARROW_UNUSED here.

Regarding [[nodiscard]], we can add it in this PR for ODBC API internal headers (odbc_api_internal.h).
On the other hand, since BI applications (and ODBC tests) will use the ODBC API definition headers at sql.h which doesn't have [[nodiscard]], I think we could skip adding [[nodiscard]] to entry_points.cc as it won't make any impact.

alinaliBQ · 2025-10-23T19:16:23Z

cpp/src/arrow/flight/sql/odbc/odbc_api_internal.h

-                         SQLSMALLINT buffer_length, SQLSMALLINT* name_length_ptr,
-                         SQLSMALLINT* data_type_ptr, SQLULEN* column_size_ptr,
-                         SQLSMALLINT* decimal_digits_ptr, SQLSMALLINT* nullable_ptr);
+[[nodiscard]] SQLRETURN SQLAllocHandle(SQLSMALLINT type, SQLHANDLE parent,


Added [[nodiscard]] here

alinaliBQ · 2025-10-23T19:16:30Z

cpp/src/arrow/flight/sql/odbc/odbc_api.cc

+    // The length of the sql state is always 5 characters plus null
+    SQLSMALLINT size = 6;
+    const std::string& state = diagnostics->GetSQLState(record_index);
+    GetStringAttribute(is_unicode, state, false, sql_state, size, &size, *diagnostics);


yup. It's not a big change so we could do it

alinaliBQ changed the title ~~GH-46096: [C++][FlightRPC] ODBC Diagnostics Report~~ GH-46575: [C++][FlightRPC] ODBC Diagnostics Report Oct 8, 2025

github-actions bot added the awaiting review Awaiting review label Oct 8, 2025

alinaliBQ force-pushed the gh-46575-odbc-diagnostics branch from fe98d28 to 8d1b940 Compare October 8, 2025 23:54

github-actions bot added Component: C++ Component: FlightRPC labels Oct 8, 2025

alinaliBQ force-pushed the gh-46575-odbc-diagnostics branch from 8d1b940 to 0c8fddc Compare October 8, 2025 23:55

alinaliBQ mentioned this pull request Oct 8, 2025

GH-46575: [C++][FlightRPC] Add Diagnostic tests #47764

Draft

lidavidm reviewed Oct 9, 2025

View reviewed changes

github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Oct 9, 2025

kou reviewed Oct 9, 2025

View reviewed changes

alinaliBQ mentioned this pull request Oct 10, 2025

GH-46734: [C++] Arrow Flight SQL ODBC layer #46099

Open

alinaliBQ force-pushed the gh-46575-odbc-diagnostics branch from 0c8fddc to c2a93f4 Compare October 21, 2025 21:43

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Oct 21, 2025

lidavidm approved these changes Oct 22, 2025

View reviewed changes

github-actions bot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Oct 22, 2025

alinaliBQ and others added 3 commits October 22, 2025 13:40

Extract SQLGetDiagField and SQLGetDiagRec implementation

0ae2993

Work on code review comments - remove `diag_info_ptr` from `IsValidStringFieldArgs` checks Co-Authored-By: rscales <[email protected]>

Use ARROW_UNUSED for ignored results

34281ec

Add [[nodiscard]] for ODBC APIs

4a0fb9d

Addresses community comment: https://github.com/apache/arrow/pull/47763/files#r2450014186

alinaliBQ force-pushed the gh-46575-odbc-diagnostics branch from c2a93f4 to 4a0fb9d Compare October 22, 2025 20:59

alinaliBQ commented Oct 22, 2025

View reviewed changes

github-actions bot added awaiting changes Awaiting changes and removed awaiting merge Awaiting merge labels Oct 22, 2025

alinaliBQ commented Oct 23, 2025

View reviewed changes

lidavidm approved these changes Oct 24, 2025

View reviewed changes

github-actions bot removed the awaiting changes Awaiting changes label Oct 24, 2025

github-actions bot added the awaiting merge Awaiting merge label Oct 24, 2025

alinaliBQ marked this pull request as ready for review October 27, 2025 22:54

alinaliBQ mentioned this pull request Oct 27, 2025

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

Draft

	diag_info_ptr && buffer_length >= 0 && buffer_length % char_size == 0;
	buffer_length >= 0 && buffer_length % char_size == 0;

Uh oh!

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Are you sure you want to change the base?

GH-46575: [C++][FlightRPC] ODBC Diagnostics Report #47763

Conversation

alinaliBQ commented Oct 8, 2025 • edited Loading 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-actions bot commented Oct 8, 2025

Uh oh!

alinaliBQ commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alinaliBQ left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alinaliBQ commented Oct 8, 2025 •

edited

Loading

alinaliBQ commented Oct 8, 2025 •

edited

Loading

alinaliBQ left a comment •

edited

Loading