dbcrab 0.5.0

Modern REPL-first PostgreSQL client.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use sqlx::{AssertSqlSafe, PgPool, postgres::PgRow};

use crate::{
    catalog::SharedCatalog,
    config::{KeyRemaps, TuiKeybindings},
    errors::{AppResult, format_query_error},
    render::{
        DisplayMode, ResultGrid, RowsDisplay, render_row_count, render_rows, render_rows_affected,
        render_rows_blank, rows_display,
    },
    sql::{first_keyword, likely_returns_rows},
};

use super::output::print_rows_display;

pub(super) async fn execute_statement(
    pool: &PgPool,
    catalog: &SharedCatalog,
    statement: &str,
    tui_keybindings: &TuiKeybindings,
    key_remaps: &KeyRemaps,
    display_mode: DisplayMode,
) -> AppResult<()> {
    if statement.trim().is_empty() {
        return Ok(());
    }

    if likely_returns_rows(statement) {
        match sqlx::query(AssertSqlSafe(statement.to_owned()))
            .fetch_all(pool)
            .await
        {
            Ok(rows) => {
                let display =
                    add_update_metadata(statement_rows_display(&rows, display_mode), pool).await?;
                print_rows_display(display, tui_keybindings, key_remaps, Some(pool)).await?;
            }
            Err(err) => print_query_error(&err, statement, catalog),
        }
    } else {
        match sqlx::query(AssertSqlSafe(statement.to_owned()))
            .execute(pool)
            .await
        {
            Ok(result) => println!(
                "{}",
                render_statement_status(statement, result.rows_affected())
            ),
            Err(err) => print_query_error(&err, statement, catalog),
        }
    }

    Ok(())
}

fn print_query_error(err: &sqlx::Error, statement: &str, catalog: &SharedCatalog) {
    eprintln!("{}", format_statement_error(err, statement, catalog));
}

fn format_statement_error(err: &sqlx::Error, statement: &str, catalog: &SharedCatalog) -> String {
    catalog.read().map_or_else(
        |_| format_query_error(err, Some(statement), None),
        |catalog| format_query_error(err, Some(statement), Some(&catalog)),
    )
}

fn statement_rows_display(rows: &[PgRow], display_mode: DisplayMode) -> RowsDisplay {
    match display_mode {
        DisplayMode::Auto => rows_display(rows),
        DisplayMode::Inline => RowsDisplay::Inline(render_rows(rows)),
        DisplayMode::InlineBlank => RowsDisplay::Inline(render_rows_blank(rows)),
        DisplayMode::Tui if rows.is_empty() => RowsDisplay::Inline(render_row_count(0)),
        DisplayMode::Tui => RowsDisplay::Tui(ResultGrid::from_rows(rows)),
    }
}

async fn add_update_metadata(
    display: RowsDisplay,
    pool: &PgPool,
) -> Result<RowsDisplay, sqlx::Error> {
    match display {
        RowsDisplay::Tui(mut grid) => {
            grid.load_update_metadata(pool).await?;
            Ok(RowsDisplay::Tui(grid))
        }
        display => Ok(display),
    }
}

fn render_statement_status(statement: &str, rows_affected: u64) -> String {
    if rows_affected > 0 || statement_reports_rows_affected(statement) {
        render_rows_affected(rows_affected)
    } else {
        "OK".to_owned()
    }
}

fn statement_reports_rows_affected(statement: &str) -> bool {
    first_keyword(statement).is_some_and(|keyword| {
        matches!(
            keyword.as_str(),
            "copy" | "delete" | "fetch" | "insert" | "merge" | "move" | "update"
        )
    })
}

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

    #[test]
    fn tui_display_mode_keeps_empty_results_inline() {
        // Given
        let rows = [];

        // When
        let display = statement_rows_display(&rows, DisplayMode::Tui);

        // Then
        match display {
            RowsDisplay::Inline(output) => assert_eq!(output, render_row_count(0)),
            RowsDisplay::Tui(_) => panic!("empty results should not open TUI"),
        }
    }

    #[test]
    fn statement_status_renders_dml_rows_affected() {
        // Given
        let statement = "update users set active = false";

        // When
        let rendered = render_statement_status(statement, 2);

        // Then
        assert_eq!(rendered, "\u{1b}[2m(2 rows affected)\u{1b}[0m");
    }

    #[test]
    fn statement_status_renders_ok_for_ddl_without_affected_rows() {
        // Given
        let statement = "create table users(id bigint)";

        // When
        let rendered = render_statement_status(statement, 0);

        // Then
        assert_eq!(rendered, "OK");
    }
}