eliaperantoni commented on code in PR #13664: URL: https://github.com/apache/datafusion/pull/13664#discussion_r1932071772
########## datafusion/common/src/diagnostic.rs: ########## @@ -0,0 +1,112 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you 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 sqlparser::tokenizer::Span; + +/// Additional contextual information intended for end users, to help them +/// understand what went wrong by providing human-readable messages, and +/// locations in the source query that relate to the error in some way. +/// +/// You can think of a single [`Diagnostic`] as a single "block" of output from +/// rustc. i.e. either an error or a warning, optionally with some notes and +/// help messages. +/// +/// If the diagnostic, a note, or a help message doesn't need to point to a +/// specific location in the original SQL query (or the [`Span`] is not +/// available), use [`Span::empty`]. +/// +/// Example: +/// +/// ```rust +/// # use datafusion_common::Diagnostic; +/// # use sqlparser::tokenizer::Span; +/// # let span = Span::empty(); +/// let diagnostic = Diagnostic::new_error("Something went wrong", span) +/// .with_help("Have you tried turning it on and off again?", Span::empty()); +/// ``` +#[derive(Debug, Clone)] +pub struct Diagnostic { + pub kind: DiagnosticKind, + pub message: String, + pub span: Span, + pub notes: Vec<DiagnosticNote>, + pub helps: Vec<DiagnosticHelp>, +} + +#[derive(Debug, Clone)] +pub struct DiagnosticNote { + pub message: String, + pub span: Span, +} + +#[derive(Debug, Clone)] +pub struct DiagnosticHelp { Review Comment: Their difference is only semantic, for now (I expect their structure might diverge too at some point). The former is meant to give more context as to _why the error occurred_ (e.g. a non aggregate expression is not in the `GROUP BY` clause) and the latter is meant to try to give a direct suggestion as to _how to solve the error_ (e.g. add the expression to the `GROUP BY`). `rustc` has the same. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
