Skip to content

Commit

Permalink
doc(flightsql): document stateless prepared statements
Browse files Browse the repository at this point in the history
  • Loading branch information
erratic-pattern committed Feb 26, 2024
1 parent 0dbbd43 commit df571f1
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/source/format/FlightSql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,9 @@ the ``type`` should be ``ClosePreparedStatement``).
Execute a previously created prepared statement and get the results.

When used with DoPut: binds parameter values to the prepared statement.
The server may optionally respond with an updated handle. The client
should use this updated handle for all subsequent requests for this
prepared statement.

When used with GetFlightInfo: execute the prepared statement. The
prepared statement can be reused after fetching results.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Server->>Client: ActionCreatePreparedStatementResult{handle}
loop for each invocation of the prepared statement
Client->>Server: DoPut(CommandPreparedStatementQuery)
Client->>Server: stream of FlightData
Server-->>Client: DoPutPreparedStatementResult{handle}
Note over Client,Server: optional response with updated handle
Client->>Server: GetFlightInfo(CommandPreparedStatementQuery)
Server->>Client: FlightInfo{endpoints: [FlightEndpoint{…}, …]}
loop for each endpoint in FlightInfo.endpoints
Expand Down
Loading

0 comments on commit df571f1

Please sign in to comment.