ARROW-14698: [Docs][FlightRPC] Add API docs for Flight SQL #12616
Conversation
Rendered (new protocol docs section)
The API docs are a little too large to render. |
|
CC @jduo if you'd like to take a look |
pitrou
left a comment
pitrou
left a comment
There was a problem hiding this comment.
This is really nice, thank you!
cpp/src/arrow/flight/sql/server.h
Outdated
There was a problem hiding this comment.
Spell out "POD" in full (or use an equivalent term)?
docs/source/cpp/api/flightsql.rst
Outdated
There was a problem hiding this comment.
Perhaps you want to define a doxygen group encompassing these typedefs and enums?
There was a problem hiding this comment.
For the record, how are the corresponding SVGs generated? (do you want to add a comment as to that?)
There was a problem hiding this comment.
Is this the case? I though all returned tickets were equivalent and only one of them needed to be fetched, am I misremembering?
There was a problem hiding this comment.
Ah yes, this should be "for each FlightEndpoint in FlightInfo"
cpp/src/arrow/flight/sql/types.h
Outdated
cpp/src/arrow/flight/sql/types.h
Outdated
|
Hey @lidavidm ! uint32 values are not returned by CommandGetSqlInfo, just int64 ones. Is it better to address this in another PR or in this one? Thanks! |
|
I think if it's just clarifications/fixes, we can address them here. |
|
Thank you all for the suggestions, I've cleaned up the reST markup a bit, tweaked the charts, and fixed up the types in the Protobuf and C++ header |
|
Any final comments? We can open another issue to address anything else we see |
|
Benchmark runs are scheduled for baseline = b285350 and contender = dd52b38. dd52b38 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
5 participants
This improves the protocol docs and adds C++ API documentation. Java already has Javadocs so this PR doesn't touch anything there.