|
| 1 | +package cmd |
| 2 | + |
| 3 | +import ( |
| 4 | + "database/sql" |
| 5 | + "fmt" |
| 6 | + "os" |
| 7 | + |
| 8 | + "github.com/attaradev/ditto/engine" |
| 9 | + copypkg "github.com/attaradev/ditto/internal/copy" |
| 10 | + "github.com/attaradev/ditto/internal/erd" |
| 11 | + "github.com/attaradev/ditto/internal/secret" |
| 12 | + "github.com/spf13/cobra" |
| 13 | +) |
| 14 | + |
| 15 | +func newErdCmd() *cobra.Command { |
| 16 | + var ( |
| 17 | + format string |
| 18 | + output string |
| 19 | + useSource bool |
| 20 | + serverURL string |
| 21 | + ) |
| 22 | + |
| 23 | + cmd := &cobra.Command{ |
| 24 | + Use: "erd", |
| 25 | + Short: "Generate an Entity-Relationship Diagram from the database schema", |
| 26 | + Long: `Generate an ERD by introspecting the live database schema. |
| 27 | +
|
| 28 | +By default ditto creates a temporary copy, introspects its schema, then |
| 29 | +destroys it — so your source database is never accessed at query time. |
| 30 | +Use --source to connect directly to the configured source database instead. |
| 31 | +
|
| 32 | +Supported output formats: |
| 33 | + mermaid Mermaid erDiagram syntax (default) — paste into any Mermaid renderer, |
| 34 | + GitHub markdown fences, Notion, or VS Code with the Mermaid extension. |
| 35 | + dbml DBML syntax — compatible with dbdiagram.io. |
| 36 | +
|
| 37 | +Examples: |
| 38 | + ditto erd # Mermaid ERD to stdout via a copy |
| 39 | + ditto erd --format=dbml # DBML to stdout |
| 40 | + ditto erd --output=schema.md # Write Mermaid to file |
| 41 | + ditto erd --source # Connect to source DB directly (no copy) |
| 42 | + ditto erd --server http://ditto:8080 # Use remote ditto server for the copy`, |
| 43 | + RunE: func(cmd *cobra.Command, args []string) error { |
| 44 | + return runERD(cmd, format, output, useSource) |
| 45 | + }, |
| 46 | + } |
| 47 | + |
| 48 | + cmd.Flags().StringVar(&format, "format", "mermaid", "Output format: mermaid, dbml") |
| 49 | + cmd.Flags().StringVar(&output, "output", "", "Output file path (default: stdout)") |
| 50 | + cmd.Flags().BoolVar(&useSource, "source", false, "Connect directly to source DB instead of creating a copy") |
| 51 | + cmd.Flags().StringVar(&serverURL, "server", "", "Remote ditto server URL (e.g. http://ditto.internal:8080)") |
| 52 | + |
| 53 | + return cmd |
| 54 | +} |
| 55 | + |
| 56 | +func runERD(cmd *cobra.Command, format, output string, useSource bool) error { |
| 57 | + cfg := configFromContext(cmd) |
| 58 | + |
| 59 | + var ( |
| 60 | + dsn string |
| 61 | + copyID string |
| 62 | + cleanup func() |
| 63 | + ) |
| 64 | + |
| 65 | + if useSource { |
| 66 | + var sc secret.Cache |
| 67 | + pwd, err := sc.Resolve(cmd.Context(), cfg.Source.PasswordSecret, cfg.Source.Password) |
| 68 | + if err != nil { |
| 69 | + return fmt.Errorf("erd: resolve source password: %w", err) |
| 70 | + } |
| 71 | + dsn = buildERDSourceDSN(cfg.Source.Engine, cfg.Source.Host, cfg.Source.Port, cfg.Source.Database, cfg.Source.User, pwd) |
| 72 | + cleanup = func() {} |
| 73 | + } else { |
| 74 | + client := copyClientFromContext(cmd) |
| 75 | + c, err := client.Create(cmd.Context(), copypkg.CreateOptions{RunID: "erd"}) |
| 76 | + if err != nil { |
| 77 | + return fmt.Errorf("erd: create copy: %w", err) |
| 78 | + } |
| 79 | + dsn = c.ConnectionString |
| 80 | + copyID = c.ID |
| 81 | + cleanup = func() { |
| 82 | + if err := client.Destroy(cmd.Context(), copyID); err != nil { |
| 83 | + // Non-fatal: copy will expire via TTL. |
| 84 | + _ = err |
| 85 | + } |
| 86 | + } |
| 87 | + } |
| 88 | + defer cleanup() |
| 89 | + |
| 90 | + driver := erdDriverName(cfg.Source.Engine) |
| 91 | + db, err := sql.Open(driver, dsn) |
| 92 | + if err != nil { |
| 93 | + return fmt.Errorf("erd: open db: %w", err) |
| 94 | + } |
| 95 | + defer func() { _ = db.Close() }() |
| 96 | + |
| 97 | + eng, err := engine.Get(cfg.Source.Engine) |
| 98 | + if err != nil { |
| 99 | + return fmt.Errorf("erd: %w", err) |
| 100 | + } |
| 101 | + |
| 102 | + schema, err := erd.Introspect(cmd.Context(), db, eng.Name(), cfg.Source.Database) |
| 103 | + if err != nil { |
| 104 | + return fmt.Errorf("erd: introspect: %w", err) |
| 105 | + } |
| 106 | + |
| 107 | + w := os.Stdout |
| 108 | + if output != "" { |
| 109 | + f, err := os.Create(output) |
| 110 | + if err != nil { |
| 111 | + return fmt.Errorf("erd: create output file: %w", err) |
| 112 | + } |
| 113 | + defer func() { _ = f.Close() }() |
| 114 | + w = f |
| 115 | + } |
| 116 | + |
| 117 | + switch format { |
| 118 | + case "mermaid": |
| 119 | + return erd.RenderMermaid(schema, w) |
| 120 | + case "dbml": |
| 121 | + return erd.RenderDBML(schema, w) |
| 122 | + default: |
| 123 | + return fmt.Errorf("erd: unknown format %q — use mermaid or dbml", format) |
| 124 | + } |
| 125 | +} |
| 126 | + |
| 127 | +// buildERDSourceDSN builds a DSN for direct connection to the source database. |
| 128 | +// Unlike copy container DSNs, this uses sslmode=require for Postgres (the |
| 129 | +// source is a real server, not a local container). |
| 130 | +func buildERDSourceDSN(eng, host string, port int, database, user, password string) string { |
| 131 | + switch eng { |
| 132 | + case "mysql": |
| 133 | + return fmt.Sprintf("%s:%s@tcp(%s:%d)/%s", user, password, host, port, database) |
| 134 | + default: // postgres |
| 135 | + return fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=require", user, password, host, port, database) |
| 136 | + } |
| 137 | +} |
| 138 | + |
| 139 | +// erdDriverName returns the database/sql driver name for the given engine. |
| 140 | +// Both drivers are registered via blank imports in cmd/ditto/main.go. |
| 141 | +func erdDriverName(eng string) string { |
| 142 | + if eng == "mysql" { |
| 143 | + return "mysql" |
| 144 | + } |
| 145 | + return "pgx" |
| 146 | +} |
0 commit comments