(arrow) branch main updated: GH-48675: [C++][FlightRPC] Document StatementAttributeId enum values in ODBC SPI (#48676)

[lidavidm]

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 a9f0a4ae6e GH-48675: [C++][FlightRPC] Document StatementAttributeId 
enum values in ODBC SPI (#48676)
a9f0a4ae6e is described below

commit a9f0a4ae6e47e6b2d0aeeeedf4e1bcdd2c246b14
Author: Hyukjin Kwon <gurwls...@apache.org>
AuthorDate: Sat Jan 3 14:44:37 2026 +0900

    GH-48675: [C++][FlightRPC] Document StatementAttributeId enum values in 
ODBC SPI (#48676)
    
    ### Rationale for this change
    
    
https://github.com/apache/arrow/commit/ed36107ad8#diff-cbd67e664d899cd38324e1b1a05b073722bd9c011a3449127c408efcf2f1592eR42-R52
    
    There is a todo in https://github.com/apache/arrow/commit/ed36107ad8 which 
I presume that the author just forgot to do it.
    
    ### What changes are included in this PR?
    
    This PR simply moves the comments to the docs to the attributes per Doxygen.
    
    ### Are these changes tested?
    
    No, I did not test.
    
    ### Are there any user-facing changes?
    
    No, I believe this is an internal API.
    
    * GitHub Issue: #48675
    
    Authored-by: Hyukjin Kwon <gurwls...@apache.org>
    Signed-off-by: David Li <li.david...@gmail.com>
---
 .../arrow/flight/sql/odbc/odbc_impl/spi/statement.h | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/cpp/src/arrow/flight/sql/odbc/odbc_impl/spi/statement.h 
b/cpp/src/arrow/flight/sql/odbc/odbc_impl/spi/statement.h
index 7278acd802..e825791a6e 100644
--- a/cpp/src/arrow/flight/sql/odbc/odbc_impl/spi/statement.h
+++ b/cpp/src/arrow/flight/sql/odbc/odbc_impl/spi/statement.h
@@ -37,16 +37,19 @@ class Statement {
   virtual ~Statement() = default;
 
   /// \brief Statement attributes that can be called at anytime.
-  ////TODO: Document attributes
   enum StatementAttributeId {
-    MAX_LENGTH,   // size_t - The maximum length when retrieving variable 
length data. 0
-                  // means no limit.
-    METADATA_ID,  // size_t - Modifies catalog function arguments to be 
identifiers.
-                  // SQL_TRUE or SQL_FALSE.
-    NOSCAN,  // size_t - Indicates that the driver does not scan for escape 
sequences.
-             // Default to SQL_NOSCAN_OFF
-    QUERY_TIMEOUT,  // size_t - The time to wait in seconds for queries to 
execute. 0 to
-                    // have no timeout.
+    /// \brief Maximum length when retrieving variable length data.
+    /// Type: size_t. Value 0 means no limit.
+    MAX_LENGTH,
+    /// \brief Modifies catalog function arguments to be identifiers.
+    /// Type: size_t. Values: SQL_TRUE or SQL_FALSE.
+    METADATA_ID,
+    /// \brief Indicates that the driver does not scan for escape sequences.
+    /// Type: size_t. Default: SQL_NOSCAN_OFF.
+    NOSCAN,
+    /// \brief The time to wait in seconds for queries to execute.
+    /// Type: size_t. Value 0 means no timeout.
+    QUERY_TIMEOUT,
   };
 
   typedef boost::variant<size_t> Attribute;