doteur 0.4.1

Tool to automate the visualisation of UML dependencies from a SQL file
Documentation

crates-dl doteur-stars doteur-license github-issues docker-build

Help us

If you use the tool, and like it, don't forget to add a star to the project on GitHub :star:, it helps us to keep motivation to improve it.

If you have any suggestion, or issue, please report it, it will help us to fix them.

General information

How to use through Docker

To download the tool

docker pull nag763/doteur:latest

Then to use it, simply pass a folder with your sql files, and be careful to write all your outputs in the shared folder to ensure the files are available on your host machine once the image is destroyed.

docker run --rm -v ${PATH_TO_YOUR_SQL_FOLDER}:/usr/src/doteur/shared -it nag763/doteur:latest bash

How to install it natively

  1. Optional but highly recommended

First install graphviz.

On Linux, use your default package manager.

Example on ubuntu :

usr@ubuntu:~$ sudo apt-get install graphviz

On Windows, use winget or the default graphviz installer.

You can still refer to the graphviz download page.

The tool uses graphviz libraries to render in other formats than .dot, if graphviz is not installed or you do not want to install it, you can still use this tool and pass it your output file.

  1. Download the tool
  • Via cargo
cargo install doteur

cargo install --git https://github.com/nag763/doteur
  1. Use the tool
doteur --help
  1. Add it to your path

If you need to use it regularly, it is recommended to add the bin folder to your path. For this, look on how to do it on your distro.

On linux :

ln -s path/to/doteur /usr/sbin

Cli usage

doteur 0.4.1
LABEYE Loïc <loic.labeye@pm.me>
Convert .sql files to .dot files, render them if graphviz installed

USAGE:
    doteur [FLAGS] [OPTIONS] [--] [input]...

FLAGS:
        --dark-mode    Render in dark mode
    -h, --help         Prints help information
        --it           Starts an interactive dialog to connect to a remote database
        --legend       Includes hint about the relations type at the bottom of the outpout file
        --url          Specificate that the input is a url (i.e. mysql://usr:password@localhost:3306/database)
    -V, --version      Prints version information

OPTIONS:
    -x, --exclude <exclude>...    Exclude the given tables
    -i, --include <include>...    Include only the given tables
    -o, --output <output>         The output filename

ARGS:
    <input>...    Name of the sql file or database location if url arg is passed, can also be a directory or several
                  files

Example usage

Export a .sql file to a .dot
usr@pop-os:~$ doteur sample.sql

The output will be in the output.dot

Export a .sql file to a .png
usr@pop-os:~$ doteur sample.sql -o output.png

For the format supported, please refer to the graphviz documentation

Connect to a remote database without a dialog and export the file as .png
usr@ubuntu:~/doteur$ doteur mysql://newuser:password@localhost:3306/foo --url -o output.png
Connect to a remote database with dialog and export the file as .png
usr@ubuntu:~/doteur$ doteur --it -o output.png
Database url or ip: localhost
Database port: 3306
Database name: foo
Database user: username
Database password: [hidden]

The output will be in a png file.

Export a .sql file to a .png, render in dark mode
usr@pop-os:~$ doteur sample.sql -o output.png --dark-mode
Export a .sql file to a .png, include only tables who have either the name hello or world
usr@pop-os:~$ doteur sample.sql -o output.png -i hello world
Export a .sql file to a .png, include only tables that start with the name hello
usr@pop-os:~$ doteur sample.sql -o output.png -i hello*
Export a .sql file to a .png, exclude all tables that start with the name hello
usr@pop-os:~$ doteur sample.sql -o output.png -x hello*
See logs of a output
usr@pop-os:~$ RUST_LOG=ERROR doteur sample.sql

With available levels being DEBUG, INFO, WARN, ERROR