Struct DdlDisplay 

pub struct DdlDisplay { /* private fields */ }

DDL display for schema output with syntax highlighting.

Displays DDL statements with optional line numbers, dialect-specific highlighting, and change region highlighting for migration diffs.

Implementations

impl DdlDisplay

pub fn new(sql: impl Into<String>) -> Self

Create a new DDL display from SQL.

Example

use sqlmodel_console::renderables::DdlDisplay;

let display = DdlDisplay::new("CREATE TABLE users (id INT);");

pub fn dialect(self, dialect: SqlDialect) -> Self

Set the SQL dialect for highlighting.

pub fn line_numbers(self, show: bool) -> Self

Set whether to show line numbers.

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

Set the theme for coloring.

pub fn highlight_changes(self, regions: Vec<ChangeRegion>) -> Self

Add change regions for diff highlighting.

pub fn add_change(self, region: ChangeRegion) -> Self

Add a single change region.

pub fn sql(&self) -> &str

Get the SQL content.

pub fn get_dialect(&self) -> SqlDialect

Get the dialect.

pub fn shows_line_numbers(&self) -> bool

Get whether line numbers are shown.

pub fn change_regions(&self) -> &[ChangeRegion]

Get the change regions.

pub fn render_plain(&self) -> String

Render as plain text (no ANSI codes).

Returns the SQL with optional line numbers, suitable for agent consumption or non-TTY output.

Example

use sqlmodel_console::renderables::DdlDisplay;

let display = DdlDisplay::new("SELECT 1;").line_numbers(true);
let plain = display.render_plain();
assert!(plain.contains("1 |"));

pub fn render(&self, _width: usize) -> String

Render with syntax highlighting (ANSI codes).

Returns the DDL with syntax highlighting, optional line numbers, and change region highlighting.

Trait Implementations

impl Clone for DdlDisplay

fn clone(&self) -> DdlDisplay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DdlDisplay

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

Formats the value using the given formatter.

impl Default for DdlDisplay

fn default() -> Self

Returns the “default value” for a type.