Struct SchemaGraph 

pub struct SchemaGraph {
    pub graph: DiGraph<SchemaNode, SchemaEdge>,
    pub table_index: HashMap<String, NodeIndex>,
    pub column_index: HashMap<String, NodeIndex>,
    pub index_index: HashMap<String, NodeIndex>,
}

Fields

graph: DiGraph<SchemaNode, SchemaEdge>

table_index: HashMap<String, NodeIndex>

table_name -> NodeIndex

column_index: HashMap<String, NodeIndex>

“table.column” -> NodeIndex

index_index: HashMap<String, NodeIndex>

index_name -> NodeIndex

Implementations

impl SchemaGraph

pub fn new() -> Self

pub fn add_table( &mut self, name: &str, estimated_rows: Option<u64>, ) -> NodeIndex

pub fn add_column( &mut self, table: &str, name: &str, data_type: &str, nullable: bool, ) -> NodeIndex

pub fn add_index( &mut self, index_name: &str, table: &str, unique: bool, ) -> NodeIndex

pub fn add_foreign_key( &mut self, from_table: &str, to_table: &str, constraint_name: Option<String>, from_columns: Vec<String>, to_columns: Vec<String>, cascade_delete: bool, cascade_update: bool, )

pub fn tables_referencing(&self, table: &str) -> Vec<String>

Returns all tables that hold a foreign key pointing TO the given table.

pub fn fk_downstream(&self, table: &str) -> Vec<String>

Depth-first search: all tables reachable from table via FK edges.

pub fn all_tables(&self) -> Vec<String>

List all tables in the graph.

pub fn text_summary(&self) -> String

Produces a plain-text adjacency summary of the graph.

pub fn export_mermaid(&self) -> String

Export the schema as a Mermaid ER diagram.

Output can be embedded in a Markdown file and rendered by GitHub, GitLab, Notion, etc.

Example:

erDiagram
    users {
        uuid id PK
        text email
    }
    orders ||--o{ users : "user_id"

pub fn export_graphviz(&self) -> String

Export the schema as a Graphviz DOT document.

Pipe to dot -Tsvg -o schema.svg or dot -Tpng -o schema.png.

Trait Implementations

impl Default for SchemaGraph

fn default() -> Self

Returns the “default value” for a type.