Struct QueryResultTable 

pub struct QueryResultTable { /* private fields */ }

A table for displaying query results.

Provides rich formatting for query result sets including type-based coloring, auto-sized columns, and multiple output formats.

Implementations

impl QueryResultTable

pub fn new() -> Self

Create a new empty query result table.

pub fn from_data(columns: Vec<String>, rows: Vec<Vec<String>>) -> Self

Create a query result table from column names and row data.

This is a convenience constructor that directly sets columns and rows.

Example

use sqlmodel_console::renderables::QueryResultTable;

let columns = vec!["id".to_string(), "name".to_string()];
let rows = vec![
    vec!["1".to_string(), "Alice".to_string()],
    vec!["2".to_string(), "Bob".to_string()],
];
let table = QueryResultTable::from_data(columns, rows);

pub fn title(self, title: impl Into<String>) -> Self

Set the table title.

pub fn columns( self, columns: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the column names.

pub fn row(self, values: impl IntoIterator<Item = impl Into<String>>) -> Self

Add a row of string values (types inferred).

pub fn row_cells(self, cells: Vec<Cell>) -> Self

Add a row of cells (with explicit types).

pub fn rows( self, rows: impl IntoIterator<Item = impl IntoIterator<Item = impl Into<String>>>, ) -> Self

Add multiple rows at once.

pub fn timing_ms(self, ms: f64) -> Self

Set the query timing in milliseconds.

pub fn timing(self, duration: Duration) -> Self

Set the query timing from a Duration.

pub fn max_width(self, width: usize) -> Self

Set maximum table width.

pub fn max_rows(self, max: usize) -> Self

Set maximum rows to display.

pub fn with_row_numbers(self) -> Self

Enable row numbers.

pub fn theme(self, theme: Theme) -> Self

Set the theme for styled output.

pub fn plain_format(self, format: PlainFormat) -> Self

Set the plain format for non-styled output.

pub fn row_count(&self) -> usize

Get the number of rows.

pub fn column_count(&self) -> usize

Get the number of columns.

pub fn render_plain(&self) -> String

Render as plain text using the configured format.

pub fn render_plain_format(&self, format: PlainFormat) -> String

Render as plain text using a specific format.

pub fn render_styled(&self) -> String

Render as styled text with ANSI colors and box drawing.

pub fn to_json(&self) -> Value

Render as JSON-serializable structure.

Trait Implementations

impl Clone for QueryResultTable

fn clone(&self) -> QueryResultTable

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryResultTable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryResultTable

fn default() -> Self

Returns the “default value” for a type.