uqa-cli 0.5.3

usql: interactive REPL for UQA
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! The text of the errors and notices that SQL statements report.

use uqa_sql::{SQLError, SQLNotice};

/// An error as the CLI prints it after `ERROR: `: its SQLSTATE and message, then its detail and hint on lines of their own.
pub(super) fn sql_error_text(error: &SQLError) -> String {
    let mut text = format!("{}: {error}", error.sqlstate().unwrap_or("XX000"));
    append_fields(&mut text, error.detail(), error.hint());
    text
}

/// A notice as the CLI prints it: its level and message, then its detail and hint on lines of their own.
pub(super) fn sql_notice_text(notice: &SQLNotice) -> String {
    let mut text = format!("{}: {}", notice.level.as_str(), notice.message);
    append_fields(&mut text, notice.detail.as_deref(), notice.hint.as_deref());
    text
}

fn append_fields(text: &mut String, detail: Option<&str>, hint: Option<&str>) {
    if let Some(detail) = detail {
        text.push_str("\nDETAIL: ");
        text.push_str(detail);
    }
    if let Some(hint) = hint {
        text.push_str("\nHINT: ");
        text.push_str(hint);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn preserves_parser_diagnostic_fields() {
        let mut error = uqa_sql::parse_statements("SELECT )").unwrap_err();
        let SQLError::ParseDiagnostic(diagnostic) = &mut error else {
            panic!("expected original parser diagnostic");
        };
        diagnostic.detail = Some("parser detail".into());
        diagnostic.hint = Some("parser hint".into());
        let text = sql_error_text(&error);
        assert!(text.starts_with("42601: "));
        assert!(text.ends_with("\nDETAIL: parser detail\nHINT: parser hint"));
    }
}