This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 082377ae44 GH-47713: [C++][FlightRPC] ODBC return number of affected
rows (#48037)
082377ae44 is described below
commit 082377ae44b5efc209ceb8b5d6b7cb18ed62341b
Author: Alina (Xi) Li <[email protected]>
AuthorDate: Mon Dec 8 09:17:24 2025 -0800
GH-47713: [C++][FlightRPC] ODBC return number of affected rows (#48037)
### Rationale for this change
Make ODBC return number of affected rows as -1 which to BI tools means
number of affected rows is unknown. This is because ODBC only supports `select`
statement and doesn't support queries that affect rows.
### What changes are included in this PR?
- SQLRowCount & tests
### Are these changes tested?
Tested locally on MSVC
### Are there any user-facing changes?
N/A
* GitHub Issue: #47713
Authored-by: Alina (Xi) Li <[email protected]>
Signed-off-by: David Li <[email protected]>
---
cpp/src/arrow/flight/sql/odbc/odbc_api.cc | 9 ++++-
.../flight/sql/odbc/odbc_impl/odbc_statement.cc | 11 ++++++
.../flight/sql/odbc/odbc_impl/odbc_statement.h | 5 +++
.../arrow/flight/sql/odbc/tests/statement_test.cc | 44 ++++++++++++++++++++++
4 files changed, 67 insertions(+), 2 deletions(-)
diff --git a/cpp/src/arrow/flight/sql/odbc/odbc_api.cc
b/cpp/src/arrow/flight/sql/odbc/odbc_api.cc
index 270da0de4a..500378eb81 100644
--- a/cpp/src/arrow/flight/sql/odbc/odbc_api.cc
+++ b/cpp/src/arrow/flight/sql/odbc/odbc_api.cc
@@ -1156,8 +1156,13 @@ SQLRETURN SQLNumResultCols(SQLHSTMT stmt, SQLSMALLINT*
column_count_ptr) {
SQLRETURN SQLRowCount(SQLHSTMT stmt, SQLLEN* row_count_ptr) {
ARROW_LOG(DEBUG) << "SQLRowCount called with stmt: " << stmt
<< ", column_count_ptr: " << static_cast<const
void*>(row_count_ptr);
- // GH-47713 TODO: Implement SQLRowCount
- return SQL_INVALID_HANDLE;
+
+ using ODBC::ODBCStatement;
+ return ODBCStatement::ExecuteWithDiagnostics(stmt, SQL_ERROR, [=]() {
+ ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(stmt);
+ statement->GetRowCount(row_count_ptr);
+ return SQL_SUCCESS;
+ });
}
SQLRETURN SQLTables(SQLHSTMT stmt, SQLWCHAR* catalog_name,
diff --git a/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.cc
b/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.cc
index e54621c12e..e19bb0ed12 100644
--- a/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.cc
+++ b/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.cc
@@ -761,6 +761,17 @@ SQLRETURN ODBCStatement::GetData(SQLSMALLINT
record_number, SQLSMALLINT c_type,
data_ptr, buffer_length, indicator_ptr);
}
+void ODBCStatement::GetRowCount(SQLLEN* row_count_ptr) {
+ if (!row_count_ptr) {
+ // row count pointer is not valid, do nothing as ODBC spec does not
mention this as an
+ // error
+ return;
+ }
+ // Will always be -1 (meaning number of rows unknown) since only SELECT is
supported by
+ // driver
+ *row_count_ptr = -1;
+}
+
void ODBCStatement::ReleaseStatement() {
CloseCursor(true);
connection_.DropStatement(this);
diff --git a/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.h
b/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.h
index c90b9a87d2..475a9018ca 100644
--- a/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.h
+++ b/cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.h
@@ -78,6 +78,11 @@ class ODBCStatement : public ODBCHandle<ODBCStatement> {
SQLRETURN GetData(SQLSMALLINT record_number, SQLSMALLINT c_type, SQLPOINTER
data_ptr,
SQLLEN buffer_length, SQLLEN* indicator_ptr);
+ /// \brief Return number of rows affected by an UPDATE, INSERT, or DELETE
statement\
+ ///
+ /// -1 is returned as driver only supports SELECT statement
+ void GetRowCount(SQLLEN* row_count_ptr);
+
/// \brief Closes the cursor. This does _not_ un-prepare the statement or
change
/// bindings.
void CloseCursor(bool suppress_errors);
diff --git a/cpp/src/arrow/flight/sql/odbc/tests/statement_test.cc
b/cpp/src/arrow/flight/sql/odbc/tests/statement_test.cc
index 869cdd987f..844df782db 100644
--- a/cpp/src/arrow/flight/sql/odbc/tests/statement_test.cc
+++ b/cpp/src/arrow/flight/sql/odbc/tests/statement_test.cc
@@ -1281,6 +1281,50 @@ TYPED_TEST(StatementTest,
TestSQLNativeSqlReturnsErrorOnBadInputs) {
VerifyOdbcErrorState(SQL_HANDLE_DBC, this->conn, kErrorStateHY090);
}
+TYPED_TEST(StatementTest, SQLRowCountReturnsNegativeOneOnSelect) {
+ SQLLEN row_count = 0;
+ SQLLEN expected_value = -1;
+ SQLWCHAR sql_query[] = L"SELECT 1 AS col1, 'One' AS col2, 3 AS col3";
+ SQLINTEGER query_length = static_cast<SQLINTEGER>(wcslen(sql_query));
+
+ ASSERT_EQ(SQL_SUCCESS, SQLExecDirect(this->stmt, sql_query, query_length));
+
+ ASSERT_EQ(SQL_SUCCESS, SQLFetch(this->stmt));
+
+ CheckIntColumn(this->stmt, 1, 1);
+ CheckStringColumnW(this->stmt, 2, L"One");
+ CheckIntColumn(this->stmt, 3, 3);
+
+ ASSERT_EQ(SQL_SUCCESS, SQLRowCount(this->stmt, &row_count));
+
+ EXPECT_EQ(expected_value, row_count);
+}
+
+TYPED_TEST(StatementTest, SQLRowCountReturnsSuccessOnNullptr) {
+ SQLWCHAR sql_query[] = L"SELECT 1 AS col1, 'One' AS col2, 3 AS col3";
+ SQLINTEGER query_length = static_cast<SQLINTEGER>(wcslen(sql_query));
+
+ ASSERT_EQ(SQL_SUCCESS, SQLExecDirect(this->stmt, sql_query, query_length));
+
+ ASSERT_EQ(SQL_SUCCESS, SQLFetch(this->stmt));
+
+ CheckIntColumn(this->stmt, 1, 1);
+ CheckStringColumnW(this->stmt, 2, L"One");
+ CheckIntColumn(this->stmt, 3, 3);
+
+ ASSERT_EQ(SQL_SUCCESS, SQLRowCount(this->stmt, nullptr));
+}
+
+TYPED_TEST(StatementTest, SQLRowCountFunctionSequenceErrorOnNoQuery) {
+ SQLLEN row_count = 0;
+ SQLLEN expected_value = 0;
+
+ ASSERT_EQ(SQL_ERROR, SQLRowCount(this->stmt, &row_count));
+ VerifyOdbcErrorState(SQL_HANDLE_STMT, this->stmt, kErrorStateHY010);
+
+ EXPECT_EQ(expected_value, row_count);
+}
+
TYPED_TEST(StatementTest, TestSQLCloseCursor) {
std::wstring wsql = L"SELECT 1;";
std::vector<SQLWCHAR> sql0(wsql.begin(), wsql.end());
