You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/03/22 16:34:06 UTC
[GitHub] [arrow] jduo commented on a change in pull request #12616: ARROW-14698: [Docs][FlightRPC] Add API docs for Flight SQL
jduo commented on a change in pull request #12616:
URL: https://github.com/apache/arrow/pull/12616#discussion_r832384123
##########
File path: cpp/src/arrow/flight/sql/types.h
##########
@@ -41,819 +41,770 @@ using SqlInfoResultMap = std::unordered_map<int32_t, SqlInfoResult>;
/// \brief Options to be set in the SqlInfo.
struct SqlInfoOptions {
enum SqlInfo {
- // Server Information [0-500): Provides basic information about the Flight SQL Server.
+ /// \name Server Information
+ /// Values [0-500): Provides basic information about the Flight SQL Server.
+ /// @{
- // Retrieves a UTF-8 string with the name of the Flight SQL Server.
+ /// Retrieves a UTF-8 string with the name of the Flight SQL Server.
FLIGHT_SQL_SERVER_NAME = 0,
- // Retrieves a UTF-8 string with the native version of the Flight SQL Server.
+ /// Retrieves a UTF-8 string with the native version of the Flight SQL
+ /// Server.
FLIGHT_SQL_SERVER_VERSION = 1,
- // Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server.
+ /// Retrieves a UTF-8 string with the Arrow format version of the Flight
+ /// SQL Server.
FLIGHT_SQL_SERVER_ARROW_VERSION = 2,
- /*
- * Retrieves a boolean value indicating whether the Flight SQL Server is read only.
- *
- * Returns:
- * - false: if read-write
- * - true: if read only
- */
+ /// Retrieves a boolean value indicating whether the Flight SQL Server is
+ /// read only.
+ ///
+ /// Returns:
+ /// - false: if read-write
+ /// - true: if read only
FLIGHT_SQL_SERVER_READ_ONLY = 3,
- // SQL Syntax Information [500-1000): provides information about SQL syntax supported
- // by the Flight SQL Server.
-
- /*
- * Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE
- * and DROP of catalogs.
- *
- * Returns:
- * - false: if it doesn't support CREATE and DROP of catalogs.
- * - true: if it supports CREATE and DROP of catalogs.
- */
+ /// @}
+
+ /// \name SQL Syntax Information
+ /// Values [500-1000): provides information about SQL syntax supported
+ /// by the Flight SQL Server.
+ /// @{
+
+ /// Retrieves a boolean value indicating whether the Flight SQL
+ /// Server supports CREATE and DROP of catalogs.
+ ///
+ /// Returns:
+ /// - false: if it doesn't support CREATE and DROP of catalogs.
+ /// - true: if it supports CREATE and DROP of catalogs.
SQL_DDL_CATALOG = 500,
- /*
- * Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE
- * and DROP of schemas.
- *
- * Returns:
- * - false: if it doesn't support CREATE and DROP of schemas.
- * - true: if it supports CREATE and DROP of schemas.
- */
+ /// Retrieves a boolean value indicating whether the Flight SQL
+ /// Server supports CREATE and DROP of schemas.
+ ///
+ /// Returns:
+ /// - false: if it doesn't support CREATE and DROP of schemas.
+ /// - true: if it supports CREATE and DROP of schemas.
SQL_DDL_SCHEMA = 501,
- /*
- * Indicates whether the Flight SQL Server supports CREATE and DROP of tables.
- *
- * Returns:
- * - false: if it doesn't support CREATE and DROP of tables.
- * - true: if it supports CREATE and DROP of tables.
- */
+ /// Indicates whether the Flight SQL Server supports CREATE and DROP of
+ /// tables.
+ ///
+ /// Returns:
+ /// - false: if it doesn't support CREATE and DROP of tables.
+ /// - true: if it supports CREATE and DROP of tables.
SQL_DDL_TABLE = 502,
- /*
- * Retrieves a uint32 value representing the enu uint32 ordinal for the case
- * sensitivity of catalog, table and schema names.
- *
- * The possible values are listed in
- * `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
- */
+ /// Retrieves a uint32 value representing the enu uint32 ordinal
Review comment:
*enum int32 ordinal
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org