Skip to content

Commit

Permalink
clarify usage of the updated statement handle
Browse files Browse the repository at this point in the history
  • Loading branch information
erratic-pattern committed Mar 4, 2024
1 parent d4a30c1 commit 0f4d1f4
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions format/FlightSql.proto
Original file line number Diff line number Diff line change
Expand Up @@ -1797,15 +1797,24 @@ message DoPutUpdateResult {
int64 record_count = 1;
}

// An optional response returned when `DoPut` is called with `CommandPreparedStatementQuery`
// An *optional* response returned when `DoPut` is called with `CommandPreparedStatementQuery`.
//
// *Note on legacy behavior*: previous versions of the protocol did not return any result for
// this command, and that behavior should still be supported by clients. See documentation
// of individual fields for more details on expected client behavior in this case.
message DoPutPreparedStatementResult {
option (experimental) = true;

// (potentially updated) opaque handle for the prepared statement on the server.
// All subsequent requests for this prepared statement must use this new handle, if specified.
// Represents a (potentially updated) opaque handle for the prepared statement on the server.
// Because the handle could potentially be updated, any previous handles for this prepared
// statement should be considered invalid, and all subsequent requests for this prepared
// statement must use this new handle, if specified.
// The updated handle allows implementing query parameters with stateless services
// as described in https://github.com/apache/arrow/issues/37720
bytes prepared_statement_handle = 1;
// as described in https://github.com/apache/arrow/issues/37720.
//
// When an updated handle is not provided by the server, clients should contiue
// using the previous handle provided by `ActionCreatePreparedStatementResonse`.
optional bytes prepared_statement_handle = 1;
}

/*
Expand Down

0 comments on commit 0f4d1f4

Please sign in to comment.