Skip to content

Commit a9f0a4a

Browse files
authored
GH-48675: [C++][FlightRPC] Document StatementAttributeId enum values in ODBC SPI (#48676)
### Rationale for this change ed36107ad8#diff-cbd67e664d899cd38324e1b1a05b073722bd9c011a3449127c408efcf2f1592eR42-R52 There is a todo in 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 <gurwls223@apache.org> Signed-off-by: David Li <li.davidm96@gmail.com>
1 parent ae41f82 commit a9f0a4a

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

cpp/src/arrow/flight/sql/odbc/odbc_impl/spi/statement.h

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,19 @@ class Statement {
3737
virtual ~Statement() = default;
3838

3939
/// \brief Statement attributes that can be called at anytime.
40-
////TODO: Document attributes
4140
enum StatementAttributeId {
42-
MAX_LENGTH, // size_t - The maximum length when retrieving variable length data. 0
43-
// means no limit.
44-
METADATA_ID, // size_t - Modifies catalog function arguments to be identifiers.
45-
// SQL_TRUE or SQL_FALSE.
46-
NOSCAN, // size_t - Indicates that the driver does not scan for escape sequences.
47-
// Default to SQL_NOSCAN_OFF
48-
QUERY_TIMEOUT, // size_t - The time to wait in seconds for queries to execute. 0 to
49-
// have no timeout.
41+
/// \brief Maximum length when retrieving variable length data.
42+
/// Type: size_t. Value 0 means no limit.
43+
MAX_LENGTH,
44+
/// \brief Modifies catalog function arguments to be identifiers.
45+
/// Type: size_t. Values: SQL_TRUE or SQL_FALSE.
46+
METADATA_ID,
47+
/// \brief Indicates that the driver does not scan for escape sequences.
48+
/// Type: size_t. Default: SQL_NOSCAN_OFF.
49+
NOSCAN,
50+
/// \brief The time to wait in seconds for queries to execute.
51+
/// Type: size_t. Value 0 means no timeout.
52+
QUERY_TIMEOUT,
5053
};
5154

5255
typedef boost::variant<size_t> Attribute;

0 commit comments

Comments
 (0)