GH-47697: [C++][FlightRPC] Add ODBC API placeholders #47725

alinaliBQ · 2025-10-06T22:26:55Z

Rationale for this change

Add placeholders for ODBC APIs to make it easier to create draft PRs for ODBC APIs

What changes are included in this PR?

Add placeholders for ODBC APIs and link the corresponding GitHub issues.
Minor build fixes

Are these changes tested?

Tested on local machine

Are there any user-facing changes?

No

GitHub Issue: [C++][FlightSQL] Add remaining placeholder APIs to initial ODBC framework #47697

github-actions · 2025-10-06T22:27:23Z

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

Update entry_points.cc Update odbc_api.cc

alinaliBQ · 2025-10-06T23:40:22Z

@kou @lidavidm Please review this PR, it is extracted from #46099. After this PR is merged, my team can start creating the draft PRs for ODBC API

kou

+1

kou · 2025-10-07T01:25:32Z

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

+    SQLSMALLINT fk_catalog_name_length, SQLWCHAR* fk_schema_name,
+    SQLSMALLINT fk_schema_name_length, SQLWCHAR* fk_table_name,
+    SQLSMALLINT fk_table_name_length) {
+  ARROW_LOG(DEBUG) << "SQLForeignKeysW called with stmt: " << stmt


Suggested change

ARROW_LOG(DEBUG) << "SQLForeignKeysW called with stmt: " << stmt

ARROW_LOG(DEBUG) << "SQLForeignKeys called with stmt: " << stmt

Unicode support will be added in upcoming PRs. Some ODBC unicode APIs will have a W at the end after compilation, because some of the function names are macros that expand to names with W. Please see:
https://github.com/microsoft/ODBC-Specification/blob/4dda95986bda5d3b55d7749315d3e5a0951c1e50/Windows/inc/sqlucode.h#L952-L996

OK. This may be better then:

Suggested change

ARROW_LOG(DEBUG) << "SQLForeignKeysW called with stmt: " << stmt

ARROW_LOG(DEBUG) << #SQLColAttribute " called with stmt: " << stmt

kou · 2025-10-07T01:25:41Z

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

+                   << ", fk_table_name: " << static_cast<const void*>(fk_table_name)
+                   << ", fk_table_name_length: " << fk_table_name_length;
+  return ODBC::ODBCStatement::ExecuteWithDiagnostics(stmt, SQL_ERROR, [=]() {
+    throw driver::odbcabstraction::DriverException("SQLForeignKeysW is not implemented",


Suggested change

throw driver::odbcabstraction::DriverException("SQLForeignKeysW is not implemented",

throw driver::odbcabstraction::DriverException("SQLForeignKeys is not implemented",

Please see #47725 (comment)

kou · 2025-10-07T01:26:44Z

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

+                   << ", pk_catalog_name: " << static_cast<const void*>(pk_catalog_name)
+                   << ", pk_catalog_name_length: " << pk_catalog_name_length


Should we print as string...?

To get the variable names in string, the user can use ODBC driver manager to trace the API calls and the inputs. I hope printing the addresses for now is ok

kou · 2025-10-07T01:27:22Z

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

+                                 SQLSMALLINT catalog_name_length, SQLWCHAR* schema_name,
+                                 SQLSMALLINT schema_name_length, SQLWCHAR* table_name,
+                                 SQLSMALLINT table_name_length) {
+  ARROW_LOG(DEBUG) << "SQLPrimaryKeysW called with stmt: " << stmt


Suggested change

ARROW_LOG(DEBUG) << "SQLPrimaryKeysW called with stmt: " << stmt

ARROW_LOG(DEBUG) << "SQLPrimaryKeys called with stmt: " << stmt

Please see #47725 (comment)

kou · 2025-10-07T01:27:29Z

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

+                   << ", table_name: " << static_cast<const void*>(table_name)
+                   << ", table_name_length: " << table_name_length;
+  return ODBC::ODBCStatement::ExecuteWithDiagnostics(stmt, SQL_ERROR, [=]() {
+    throw driver::odbcabstraction::DriverException("SQLPrimaryKeysW is not implemented",


Suggested change

throw driver::odbcabstraction::DriverException("SQLPrimaryKeysW is not implemented",

throw driver::odbcabstraction::DriverException("SQLPrimaryKeys is not implemented",

Please see #47725 (comment)

kou · 2025-10-07T01:27:52Z

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

                   << ", result: " << static_cast<const void*>(result);
+  // GH-46096 TODO: Implement SQLAllocEnv
+  // GH-46097 TODO: Implement SQLAllocConnect, pre-requisite requires SQLAllocEnv
+  // implementation GH-47706 TODO: Implement SQLAllocStmt, pre-requisite requires


Suggested change

// implementation GH-47706 TODO: Implement SQLAllocStmt, pre-requisite requires

// implementation

// GH-47706 TODO: Implement SQLAllocStmt, pre-requisite requires

Good catch, fixed

kou · 2025-10-07T01:28:04Z

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

+  // GH-46096 TODO: Implement SQLAllocEnv
+  // GH-46097 TODO: Implement SQLAllocConnect, pre-requisite requires SQLAllocEnv
+  // implementation GH-47706 TODO: Implement SQLAllocStmt, pre-requisite requires
+  // SQLDriverConnect implementation GH-47707 TODO: Implement SQL_HANDLE_DESC for


Suggested change

// SQLDriverConnect implementation GH-47707 TODO: Implement SQL_HANDLE_DESC for

// SQLDriverConnect implementation

// GH-47707 TODO: Implement SQL_HANDLE_DESC for

Good catch, fixed

kou · 2025-10-07T01:36:53Z

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

+                          SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
+                          SQLSMALLINT* string_length_ptr) {
+  // GH-46573 TODO: Implement additional fields types
+  ARROW_LOG(DEBUG) << "SQLGetDiagFieldW called with handle_type: " << handle_type


Suggested change

ARROW_LOG(DEBUG) << "SQLGetDiagFieldW called with handle_type: " << handle_type

ARROW_LOG(DEBUG) << "SQLGetDiagField called with handle_type: " << handle_type

Please see #47725 (comment)

kou · 2025-10-07T01:37:01Z

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

+                        SQLWCHAR* sql_state, SQLINTEGER* native_error_ptr,
+                        SQLWCHAR* message_text, SQLSMALLINT buffer_length,
+                        SQLSMALLINT* text_length_ptr) {
+  ARROW_LOG(DEBUG) << "SQLGetDiagRecW called with handle_type: " << handle_type


Suggested change

ARROW_LOG(DEBUG) << "SQLGetDiagRecW called with handle_type: " << handle_type

ARROW_LOG(DEBUG) << "SQLGetDiagRec called with handle_type: " << handle_type

Please see #47725 (comment)

alinaliBQ

Addressing @kou's comments

alinaliBQ · 2025-10-07T18:40:41Z

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

+                          SQLPOINTER diag_info_ptr, SQLSMALLINT buffer_length,
+                          SQLSMALLINT* string_length_ptr) {
+  // GH-46573 TODO: Implement additional fields types
+  ARROW_LOG(DEBUG) << "SQLGetDiagFieldW called with handle_type: " << handle_type


Please see #47725 (comment)

alinaliBQ · 2025-10-07T18:40:49Z

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

+                        SQLWCHAR* sql_state, SQLINTEGER* native_error_ptr,
+                        SQLWCHAR* message_text, SQLSMALLINT buffer_length,
+                        SQLSMALLINT* text_length_ptr) {
+  ARROW_LOG(DEBUG) << "SQLGetDiagRecW called with handle_type: " << handle_type


Please see #47725 (comment)

alinaliBQ · 2025-10-07T18:41:04Z

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

+                                 SQLSMALLINT catalog_name_length, SQLWCHAR* schema_name,
+                                 SQLSMALLINT schema_name_length, SQLWCHAR* table_name,
+                                 SQLSMALLINT table_name_length) {
+  ARROW_LOG(DEBUG) << "SQLPrimaryKeysW called with stmt: " << stmt


Please see #47725 (comment)

alinaliBQ · 2025-10-07T18:41:07Z

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

+                   << ", table_name: " << static_cast<const void*>(table_name)
+                   << ", table_name_length: " << table_name_length;
+  return ODBC::ODBCStatement::ExecuteWithDiagnostics(stmt, SQL_ERROR, [=]() {
+    throw driver::odbcabstraction::DriverException("SQLPrimaryKeysW is not implemented",


Please see #47725 (comment)

alinaliBQ · 2025-10-07T18:41:13Z

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

+                   << ", fk_table_name: " << static_cast<const void*>(fk_table_name)
+                   << ", fk_table_name_length: " << fk_table_name_length;
+  return ODBC::ODBCStatement::ExecuteWithDiagnostics(stmt, SQL_ERROR, [=]() {
+    throw driver::odbcabstraction::DriverException("SQLForeignKeysW is not implemented",


Please see #47725 (comment)

alinaliBQ · 2025-10-07T18:52:26Z

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

+                   << ", pk_catalog_name: " << static_cast<const void*>(pk_catalog_name)
+                   << ", pk_catalog_name_length: " << pk_catalog_name_length


To get the variable names in string, the user can use ODBC driver manager to trace the API calls and the inputs. I hope printing the addresses for now is ok

conbench-apache-arrow · 2025-10-08T05:06:05Z

After merging your PR, Conbench analyzed the 2 benchmarking runs that have been run so far on merge-commit 353a0a2.

There were no benchmark performance regressions. 🎉

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

alinaliBQ · 2025-10-08T16:16:07Z

Thanks for merging it

) ### Rationale for this change Add placeholders for ODBC APIs to make it easier to create draft PRs for ODBC APIs ### What changes are included in this PR? Add placeholders for ODBC APIs and link the corresponding GitHub issues. Minor build fixes ### Are these changes tested? Tested on local machine ### Are there any user-facing changes? No * GitHub Issue: apache#47697 Authored-by: Alina (Xi) Li <[email protected]> Signed-off-by: Sutou Kouhei <[email protected]>

github-actions bot added Component: C++ Component: FlightRPC awaiting review Awaiting review labels Oct 6, 2025

alinaliBQ added 2 commits October 6, 2025 15:38

Add placeholders to API calls

5971882

Update entry_points.cc Update odbc_api.cc

Fix build errors

833824a

alinaliBQ force-pushed the gh-47697-add-api-placeholders branch from 63a95cd to 833824a Compare October 6, 2025 22:38

alinaliBQ marked this pull request as ready for review October 6, 2025 23:39

alinaliBQ requested a review from lidavidm as a code owner October 6, 2025 23:39

lidavidm approved these changes Oct 7, 2025

View reviewed changes

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

kou approved these changes Oct 7, 2025

View reviewed changes

Address Sutou's code review comments

5fda255

alinaliBQ commented Oct 7, 2025

View reviewed changes

Fix typo

58c101f

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

kou merged commit 353a0a2 into apache:main Oct 8, 2025
43 checks passed

kou removed the awaiting changes Awaiting changes label Oct 8, 2025

kou mentioned this pull request Oct 8, 2025

[C++][FlightSQL] Add remaining placeholder APIs to initial ODBC framework #47697

Closed

	ARROW_LOG(DEBUG) << "SQLForeignKeysW called with stmt: " << stmt
	ARROW_LOG(DEBUG) << "SQLForeignKeys called with stmt: " << stmt

	ARROW_LOG(DEBUG) << "SQLForeignKeysW called with stmt: " << stmt
	ARROW_LOG(DEBUG) << #SQLColAttribute " called with stmt: " << stmt

	throw driver::odbcabstraction::DriverException("SQLForeignKeysW is not implemented",
	throw driver::odbcabstraction::DriverException("SQLForeignKeys is not implemented",

		<< ", pk_catalog_name: " << static_cast<const void*>(pk_catalog_name)
		<< ", pk_catalog_name_length: " << pk_catalog_name_length

	ARROW_LOG(DEBUG) << "SQLPrimaryKeysW called with stmt: " << stmt
	ARROW_LOG(DEBUG) << "SQLPrimaryKeys called with stmt: " << stmt

	// implementation GH-47706 TODO: Implement SQLAllocStmt, pre-requisite requires
	// implementation
	// GH-47706 TODO: Implement SQLAllocStmt, pre-requisite requires

	// SQLDriverConnect implementation GH-47707 TODO: Implement SQL_HANDLE_DESC for
	// SQLDriverConnect implementation
	// GH-47707 TODO: Implement SQL_HANDLE_DESC for

	ARROW_LOG(DEBUG) << "SQLGetDiagFieldW called with handle_type: " << handle_type
	ARROW_LOG(DEBUG) << "SQLGetDiagField called with handle_type: " << handle_type

	ARROW_LOG(DEBUG) << "SQLGetDiagRecW called with handle_type: " << handle_type
	ARROW_LOG(DEBUG) << "SQLGetDiagRec called with handle_type: " << handle_type

GH-47697: [C++][FlightRPC] Add ODBC API placeholders #47725

GH-47697: [C++][FlightRPC] Add ODBC API placeholders #47725

Uh oh!

Conversation

alinaliBQ commented Oct 6, 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 6, 2025

Uh oh!

alinaliBQ commented Oct 6, 2025

Uh oh!

kou left a comment

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alinaliBQ left a comment

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!

Uh oh!

conbench-apache-arrow bot commented Oct 8, 2025

Uh oh!

alinaliBQ commented Oct 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

alinaliBQ commented Oct 6, 2025 •

edited

Loading