Skip to content

Commit

Permalink
Update FlightSql.proto docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
rafael-telles authored and vfraga committed Mar 29, 2022
1 parent 9daeb9e commit ffd861f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions format/FlightSql.proto
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ message CommandGetSqlInfo {
* Initially, Flight SQL will support the following information types:
* - Server Information - Range [0-500)
* - Syntax Information - Range [500-1000)
* Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
* Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
* Custom options should start at 10,000.
*
* If omitted, then all metadata will be retrieved.
Expand All @@ -80,7 +80,7 @@ enum SqlInfo {
// 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:
Expand Down Expand Up @@ -1427,11 +1427,11 @@ message ActionCreatePreparedStatementResult {
// Opaque handle for the prepared statement on the server.
bytes prepared_statement_handle = 1;

// If a result set generating query was provided, dataset_schema contains the
// If a result set generating query was provided, dataset_schema contains the
// schema of the dataset as described in Schema.fbs::Schema, it is serialized as an IPC message.
bytes dataset_schema = 2;

// If the query provided contained parameters, parameter_schema contains the
// If the query provided contained parameters, parameter_schema contains the
// schema of the expected parameters as described in Schema.fbs::Schema, it is serialized as an IPC message.
bytes parameter_schema = 3;
}
Expand Down Expand Up @@ -1476,7 +1476,7 @@ message CommandStatementQuery {

/**
* Represents a ticket resulting from GetFlightInfo with a CommandStatementQuery.
* This should be treated as an opaque value, that is, clients should not attempt to parse this.
* This should be used only once and treated as an opaque value, that is, clients should not attempt to parse this.
*/
message TicketStatementQuery {
option (experimental) = true;
Expand Down

0 comments on commit ffd861f

Please sign in to comment.