bestool-psql 1.7.1

psql-inspired client for PostgreSQL
Documentation 
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

use std::sync::Arc;

use bestool_postgres::text_cast::TextCaster;
use miette::Result;
use tokio::io::AsyncWrite;

use crate::{Config, column_extractor::ColumnRef};

mod csv;
mod excel;
mod expanded;
mod json;
mod normal;
mod plain;
mod sql;
mod sqlite;

/// Context for displaying query results.
pub struct DisplayContext<'a, W: AsyncWrite + Unpin> {
	pub config: &'a Arc<Config>,
	pub columns: &'a [tokio_postgres::Column],
	pub rows: &'a [tokio_postgres::Row],
	pub unprintable_columns: &'a [usize],
	pub text_caster: Option<TextCaster>,
	pub writer: &'a mut W,
	pub use_colours: bool,
	/// Optional column indices to filter display (None means show all columns)
	pub column_indices: Option<&'a [usize]>,
	/// Whether redaction mode is enabled
	pub redact_mode: bool,
	/// Extracted column references from the query (for redaction matching)
	pub column_refs: &'a [ColumnRef],
}

impl<'a, W: AsyncWrite + Unpin> DisplayContext<'a, W> {
	/// Check if a column at the given index should be redacted.
	pub fn should_redact(&self, col_idx: usize) -> bool {
		if !self.redact_mode {
			return false;
		}

		let column_name = self.columns[col_idx].name();
		self.column_refs.iter().any(|col_ref| {
			col_ref.column == column_name && self.config.redactions.contains(col_ref)
		})
	}
}

pub async fn display<W: AsyncWrite + Unpin>(
	ctx: &mut DisplayContext<'_, W>,
	is_json: bool,
	is_expanded: bool,
) -> Result<()> {
	if is_json {
		json::display(ctx, is_expanded).await
	} else if is_expanded {
		expanded::display(ctx).await
	} else {
		normal::display(ctx).await
	}
}

pub async fn display_csv<W: AsyncWrite + Unpin>(ctx: &mut DisplayContext<'_, W>) -> Result<()> {
	csv::display(ctx).await
}

pub async fn display_plain<W: AsyncWrite + Unpin>(ctx: &mut DisplayContext<'_, W>) -> Result<()> {
	plain::display(ctx).await
}

pub async fn display_sql<W: AsyncWrite + Unpin>(
	ctx: &mut DisplayContext<'_, W>,
	expanded: bool,
	table: &str,
) -> Result<()> {
	sql::display(ctx, expanded, table).await
}

pub async fn display_excel<W: AsyncWrite + Unpin>(
	ctx: &mut DisplayContext<'_, W>,
	file_path: &str,
) -> Result<()> {
	excel::display(ctx, file_path).await
}

pub async fn display_sqlite<W: AsyncWrite + Unpin>(
	ctx: &mut DisplayContext<'_, W>,
	file_path: &str,
) -> Result<()> {
	sqlite::display(ctx, file_path).await
}