feat: add write and query CLI sub-commands
#24671
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
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
Adds two new sub-commands to the influxdb3 CLI: - query: perform queries against the running server - write: perform writes against the running server Both share a common set of parameters for connecting to the database which are managed in influxdb3/src/commands/common.rs. Currently, query supports all underlying output formats, and can write the output to a file on disk. It only supports SQL as the query language, but will eventually also support InfluxQL. Write supports line protocol for input and expects the source of data to be from a file.
mgattozzi
reviewed
Feb 16, 2024
There was a problem hiding this comment.
We should get #24665 merged in first, but this looks good to me and I saw the loom where you demonstrate it. Should make testing things out a bit easier. I'll give it the green check once that is in and this PR has merged in those changes.
| eprintln!("Serve command failed: {e}"); | ||
| std::process::exit(ReturnCode::Failure as _) | ||
| } | ||
| } | ||
| Some(Command::Query(config)) => { | ||
| if let Err(e) = commands::query::command(config).await { | ||
| eprintln!("Query command failed: {e}"); |
There was a problem hiding this comment.
Tangential to this, but not for this PR, but I feel like we should invest some time in the output of these errors or just the regular command output to look really nice. Possibly something like miette would be good. This is beyond the scope of this PR though. I should probably just open an issue for this.
|
@mgattozzi - I pulled down |
mgattozzi
approved these changes
Feb 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This builds on #24665 and is meant to close #24651
Two new sub-commands are added to the
influxdb3CLI:query: for performing queries against the running serverwrite: for performing writes to the running serverThe generated help documentation summarizes each below.
querywrite