oneiriq-surql 0.2.2

Code-first database toolkit for SurrealDB - schema definitions, migrations, query building, and typed CRUD (Rust port of oneiriq-surql). Published as the `oneiriq-surql` crate; imported as `use surql::...`.
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

# Visualization

Render Mermaid / GraphViz / ASCII diagrams straight from a
`SchemaRegistry`.

## Mermaid

```rust
use surql::schema::themes::modern_theme;
use surql::schema::visualize::generate_mermaid;

let mermaid = generate_mermaid(&registry, &modern_theme().mermaid);
println!("{mermaid}");
```

## GraphViz DOT

```rust
use surql::schema::themes::dark_theme;
use surql::schema::visualize::generate_graphviz;

let dot = generate_graphviz(&registry, &dark_theme().graphviz);
std::fs::write("schema.dot", dot)?;
```

## ASCII

```rust
use surql::schema::themes::minimal_theme;
use surql::schema::visualize::generate_ascii;

println!("{}", generate_ascii(&registry, &minimal_theme().ascii));
```

## Themes

| Preset             | Mood                                        |
|--------------------|---------------------------------------------|
| `modern_theme`     | Bright accents, clean typography, emoji.    |
| `dark_theme`       | Dim palette, good on dark terminals.        |
| `forest_theme`     | Earthy greens, muted secondary color.       |
| `minimal_theme`    | Monochrome, no decorative glyphs.           |

## What's next

- **[Schema Definition](schema.md)** -- building the registry the
  visualizer consumes.