-
Notifications
You must be signed in to change notification settings - Fork 326
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Able to pretty print sql query result in http output #3539
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3a64591
feat: Able to pretty print sql query result in http output
YCCDSZXH 6bd2135
Merge branch 'GreptimeTeam:main' into main
YCCDSZXH 0126a60
fix: add some tests
YCCDSZXH dfc621c
Merge branch 'GreptimeTeam:main' into main
YCCDSZXH e84e7da
fix: add some space, delete fn into_payload, and impl Display for Tab…
YCCDSZXH File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| // Copyright 2023 Greptime Team | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| use std::cmp::max; | ||
| use std::fmt::Write; | ||
|
|
||
| use axum::http::{header, HeaderValue}; | ||
| use axum::response::{IntoResponse, Response}; | ||
| use common_error::status_code::StatusCode; | ||
| use common_query::Output; | ||
| use itertools::Itertools; | ||
| use mime_guess::mime; | ||
| use schemars::JsonSchema; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| use crate::http::error_result::ErrorResponse; | ||
| use crate::http::header::{GREPTIME_DB_HEADER_EXECUTION_TIME, GREPTIME_DB_HEADER_FORMAT}; | ||
| use crate::http::{handler, GreptimeQueryOutput, HttpResponse, ResponseFormat}; | ||
|
|
||
| #[derive(Serialize, Deserialize, Debug, JsonSchema)] | ||
| pub struct TableResponse { | ||
| output: Vec<GreptimeQueryOutput>, | ||
| execution_time_ms: u64, | ||
| } | ||
|
|
||
| impl TableResponse { | ||
| pub async fn from_output(outputs: Vec<crate::error::Result<Output>>) -> HttpResponse { | ||
| match handler::from_output(ResponseFormat::Csv, outputs).await { | ||
| Err(err) => HttpResponse::Error(err), | ||
| Ok((output, _)) => { | ||
| if output.len() > 1 { | ||
| HttpResponse::Error(ErrorResponse::from_error_message( | ||
| ResponseFormat::Table, | ||
| StatusCode::InvalidArguments, | ||
| "Multi-statements are not allowed".to_string(), | ||
| )) | ||
| } else { | ||
| HttpResponse::Table(TableResponse { | ||
| output, | ||
| execution_time_ms: 0, | ||
| }) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| pub fn output(&self) -> &[GreptimeQueryOutput] { | ||
| &self.output | ||
| } | ||
|
|
||
| pub fn with_execution_time(mut self, execution_time: u64) -> Self { | ||
| self.execution_time_ms = execution_time; | ||
| self | ||
| } | ||
|
|
||
| pub fn execution_time_ms(&self) -> u64 { | ||
| self.execution_time_ms | ||
| } | ||
YCCDSZXH marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| impl IntoResponse for TableResponse { | ||
YCCDSZXH marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| fn into_response(mut self) -> Response { | ||
| debug_assert!( | ||
| self.output.len() <= 1, | ||
| "self.output has extra elements: {}", | ||
| self.output.len() | ||
| ); | ||
|
|
||
| let execution_time = self.execution_time_ms; | ||
|
|
||
| let payload = match self.output.pop() { | ||
| None => String::default(), | ||
| Some(GreptimeQueryOutput::AffectedRows(n)) => { | ||
| format!("{n}\n") | ||
| } | ||
| Some(GreptimeQueryOutput::Records(records)) => { | ||
| let mut max_width = vec![0; records.num_cols()]; | ||
| let mut result = String::new(); | ||
| // Determine maximum width for each column | ||
| for (i, column) in records.schema.column_schemas.iter().enumerate() { | ||
| max_width[i] = max(max_width[i], column.name.len()); | ||
| } | ||
| for row in &records.rows { | ||
| for (i, v) in row.iter().enumerate() { | ||
| let s = v.to_string(); | ||
| max_width[i] = max(max_width[i], s.len()); | ||
| } | ||
| } | ||
|
|
||
| // Construct the header | ||
| let head: String = records | ||
| .schema | ||
| .column_schemas | ||
| .iter() | ||
| .enumerate() | ||
| .map(|(i, column)| format!("─{:─<1$}─", column.name, max_width[i])) | ||
| .join("┬"); | ||
| writeln!(result, "┌{}┐", head).unwrap(); | ||
|
|
||
| // Construct rows | ||
| for row in &records.rows { | ||
| let row = row | ||
| .iter() | ||
| .enumerate() | ||
| .map(|(i, v)| { | ||
| let s = v.to_string(); | ||
| format!(" {:1$} ", s, max_width[i]) | ||
| }) | ||
| .join("│"); | ||
| writeln!(result, "│{row}│").unwrap(); | ||
| } | ||
|
|
||
| // Construct the footer | ||
| let footer: String = max_width.iter().map(|v| "─".repeat(*v + 2)).join("┴"); | ||
| writeln!(result, "└{}┘", footer).unwrap(); | ||
| result | ||
| } | ||
| }; | ||
|
|
||
| let mut resp = ( | ||
| [( | ||
| header::CONTENT_TYPE, | ||
| HeaderValue::from_static(mime::PLAIN.as_ref()), | ||
| )], | ||
| payload, | ||
| ) | ||
| .into_response(); | ||
| resp.headers_mut().insert( | ||
| &GREPTIME_DB_HEADER_FORMAT, | ||
| HeaderValue::from_static("TABLE"), | ||
| ); | ||
| resp.headers_mut().insert( | ||
| &GREPTIME_DB_HEADER_EXECUTION_TIME, | ||
| HeaderValue::from(execution_time), | ||
| ); | ||
| resp | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo csv.
But we don't need it at all.
I'm working on a patch to clean up all these unnecessary extra format param.