feat: add the influxdb3_client crate
#24665
Conversation
A new crate, influxdb3_client, was added, which provides the Client struct. This gives programmatic access to the infludxb3 HTTP API. This commit implements a partial version of the api_v3_write_lp method along with a test for ensuring the happy path. The underlying API is not yet complete, so the response handling is still a TODO.
The new Client and types related to the Client::api_v3_write_lp method have been documented The stub for the write_lp_from_file test was removed, to be done later
The api_v3_query_sql method was added to the influxdb3 Client, which allows caller to compose a request to the respective API. Similar to the write_lp API, this uses a builder approach to composing the request. The handling of the response was kept naive and just gives back the bytes returned. We may improve this in future once the format handling in the API is nailed down and we have JSON lines supported.
Switched reqwest to use rustls and disabled default features in mockito
There was a problem hiding this comment.
@hiltontj I had two actual changes worth making: the stray crate name in Cargo.toml and the test formatting for the lp message. The rest are mostly comments. Otherwise this is solid, couldn't have written it better myself and the API should be real nice to use.
|
|
||
| use bytes::Bytes; | ||
| use reqwest::{Body, IntoUrl, StatusCode}; | ||
| use secrecy::{ExposeSecret, Secret}; |
There was a problem hiding this comment.
TIL about the secrecy crate this is really cool
| let status = resp.status(); | ||
| let content = resp.bytes().await.map_err(Error::Bytes)?; | ||
| match status { | ||
| // TODO - handle the OK response content, return to caller, etc. |
There was a problem hiding this comment.
I think it should be an empty body. I'm not sure why we left it as just {}. @pauldix were we planning on returning more on a successful response in the future for the write_lp endpoint? I don't see a reason too, but I'm probably missing context.
There was a problem hiding this comment.
Yeah, I was wondering if there would be stats returned, e.g., number of lines inserted, or in the case of accept_partial = true, the rejected lines, etc.
Clean up some rustdoc comments and TODO comments Rename the with_auth_header method to with_auth_token to distinguish setting the token itself vs. the entire header; and rename the struct field on Client accordingly Indent the write_lp payload in the test code Remove the reqwest::Client as a parameter to the Client new method
Closes #24661, as this should allow us to build a barebones CLI, but some follow-on issues will likely be needed.
This adds a new crate:
influxdb3_client, which provides aClienttype for accessing the HTTP API of InfluxDB 3. Currently, with support for:POST /api/v3/write_lpGET /api/v3/query_sqlA test is included for each corresponding method to check/demonstrate usage, and each method also has a short doc comment with an example.
Implementation Notes
write_lp, it looks to be just responding with"{}", so if/once there is some content being returned there we can handle it.query_sql, the client method just returns the rawBytes, and the caller will have to handle. We may certainly get more sophisticated with this, but for the sake of the CLI, which will just stream the bytes to stdout anyways, I figured this acceptable.QueryParamsandWriteParams, currently I have re-defined them in this crate