Extract SQLCloseCursor implementation

Update doxygen

Co-Authored-By: alinalibq <[email protected]>

Author: alinaliBQ

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

@@ -1065,8 +1065,16 @@ SQLRETURN SQLBindCol(SQLHSTMT stmt, SQLUSMALLINT record_number, SQLSMALLINT c_ty
 
 SQLRETURN SQLCloseCursor(SQLHSTMT stmt) {
   ARROW_LOG(DEBUG) << "SQLCloseCursor called with stmt: " << stmt;
-  // GH-47717 TODO: Implement SQLCloseCursor
-  return SQL_INVALID_HANDLE;
+
+  using ODBC::ODBCStatement;
+  return ODBCStatement::ExecuteWithDiagnostics(stmt, SQL_ERROR, [=]() {
+    ODBCStatement* statement = reinterpret_cast<ODBCStatement*>(stmt);
+
+    // Close cursor with suppressErrors set to false
+    statement->CloseCursor(false);
+
+    return SQL_SUCCESS;
+  });
 }
 
 SQLRETURN SQLGetData(SQLHSTMT stmt, SQLUSMALLINT record_number, SQLSMALLINT c_type,

cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.cc

@@ -693,7 +693,7 @@ void ODBCStatement::RevertAppDescriptor(bool isApd) {
 
 void ODBCStatement::CloseCursor(bool suppress_errors) {
   if (!suppress_errors && !current_result_) {
-    throw DriverException("Invalid cursor state", "28000");
+    throw DriverException("Invalid cursor state", "24000");
   }
 
   if (current_result_) {

cpp/src/arrow/flight/sql/odbc/odbc_impl/odbc_statement.h

@@ -80,15 +80,11 @@ class ODBCStatement : public ODBCHandle<ODBCStatement> {
   bool GetData(SQLSMALLINT record_number, SQLSMALLINT c_type, SQLPOINTER data_ptr,
                SQLLEN buffer_length, SQLLEN* indicator_ptr);
 
-  /**
-   * @brief Closes the cursor. This does _not_ un-prepare the statement or change
-   * bindings.
-   */
+  /// \brief Closes the cursor. This does _not_ un-prepare the statement or change
+  /// bindings.
   void CloseCursor(bool suppress_errors);
 
-  /**
-   * @brief Releases this statement from memory.
-   */
+  /// \brief Releases this statement from memory.
   void ReleaseStatement();
 
   void GetTables(const std::string* catalog, const std::string* schema,

cpp/src/arrow/flight/sql/odbc/tests/statement_test.cc

@@ -39,7 +39,7 @@ TYPED_TEST_SUITE(StatementTest, TestTypes);
 
 TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsInputString) {
   SQLWCHAR buf[1024];
-  SQLINTEGER buf_char_len = sizeof(buf) / ODBC::GetSqlWCharSize();
+  SQLINTEGER buf_char_len = sizeof(buf) / GetSqlWCharSize();
   SQLWCHAR input_str[] = L"SELECT * FROM mytable WHERE id == 1";
   SQLINTEGER input_char_len = static_cast<SQLINTEGER>(wcslen(input_str));
   SQLINTEGER output_char_len = 0;
@@ -58,7 +58,7 @@ TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsInputString) {
 
 TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsNTSInputString) {
   SQLWCHAR buf[1024];
-  SQLINTEGER buf_char_len = sizeof(buf) / ODBC::GetSqlWCharSize();
+  SQLINTEGER buf_char_len = sizeof(buf) / GetSqlWCharSize();
   SQLWCHAR input_str[] = L"SELECT * FROM mytable WHERE id == 1";
   SQLINTEGER input_char_len = static_cast<SQLINTEGER>(wcslen(input_str));
   SQLINTEGER output_char_len = 0;
@@ -95,7 +95,7 @@ TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsInputStringLength) {
 TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsTruncatedString) {
   const SQLINTEGER small_buf_size_in_char = 11;
   SQLWCHAR small_buf[small_buf_size_in_char];
-  SQLINTEGER small_buf_char_len = sizeof(small_buf) / ODBC::GetSqlWCharSize();
+  SQLINTEGER small_buf_char_len = sizeof(small_buf) / GetSqlWCharSize();
   SQLWCHAR input_str[] = L"SELECT * FROM mytable WHERE id == 1";
   SQLINTEGER input_char_len = static_cast<SQLINTEGER>(wcslen(input_str));
   SQLINTEGER output_char_len = 0;
@@ -122,7 +122,7 @@ TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsTruncatedString) {
 
 TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsErrorOnBadInputs) {
   SQLWCHAR buf[1024];
-  SQLINTEGER buf_char_len = sizeof(buf) / ODBC::GetSqlWCharSize();
+  SQLINTEGER buf_char_len = sizeof(buf) / GetSqlWCharSize();
   SQLWCHAR input_str[] = L"SELECT * FROM mytable WHERE id == 1";
   SQLINTEGER input_char_len = static_cast<SQLINTEGER>(wcslen(input_str));
   SQLINTEGER output_char_len = 0;
@@ -140,4 +140,27 @@ TYPED_TEST(StatementTest, TestSQLNativeSqlReturnsErrorOnBadInputs) {
   VerifyOdbcErrorState(SQL_HANDLE_DBC, this->conn, kErrorStateHY090);
 }
 
+TYPED_TEST(StatementTest, TestSQLCloseCursor) {
+  std::wstring wsql = L"SELECT 1;";
+  std::vector<SQLWCHAR> sql0(wsql.begin(), wsql.end());
+
+  ASSERT_EQ(SQL_SUCCESS,
+            SQLExecDirect(this->stmt, &sql0[0], static_cast<SQLINTEGER>(sql0.size())));
+
+  ASSERT_EQ(SQL_SUCCESS, SQLCloseCursor(this->stmt));
+}
+
+TYPED_TEST(StatementTest, TestSQLFreeStmtSQLCloseWithoutCursor) {
+  // Verify SQLFreeStmt(SQL_CLOSE) does not throw error with invalid cursor
+
+  ASSERT_EQ(SQL_SUCCESS, SQLFreeStmt(this->stmt, SQL_CLOSE));
+}
+
+TYPED_TEST(StatementTest, TestSQLCloseCursorWithoutCursor) {
+  ASSERT_EQ(SQL_ERROR, SQLCloseCursor(this->stmt));
+
+  // Verify invalid cursor error state is returned
+  VerifyOdbcErrorState(SQL_HANDLE_STMT, this->stmt, kErrorState24000);
+}
+
 }  // namespace arrow::flight::sql::odbc