docker-compose and mermaid diagrams

[ltsallas]

Hi and thanks for creating this awesome tool!

I am able to generate a pdf export of my database with a docker compose file like this

  schemacrawler:
    image: schemacrawler/schemacrawler:v16.8.1
    entrypoint: ['/opt/schemacrawler/schemacrawler.sh']
    command: --info-level=standard --command=schema --sort-columns --portable-names --output-format=pdf --output-file=/docs/db-schema.pdf --url="jdbc:postgresql://demodbservice:5432/demodb" --user=dbuser --password=password
    depends_on:
      - liquibase
    volumes:
      - ./docs:/docs

Now I want to use the mermaid-diagrams option, I couldn't find a docker-compose example for this one. I am getting a Error: Script engine not found with the following setup. I've downloaded the mermaid script in the scripts/ folder and then I am using the volumes to have it available inside the container. Do I have to create a custom Dockerfile and place the jython-slim jar inside?https://gist.github.com/sualeh/761e808f2803bba8e6f003e3276cf6e3

  schemacrawler-mermaid:
    image: schemacrawler/schemacrawler:v16.8.1
    entrypoint: [ '/opt/schemacrawler/schemacrawler.sh' ]
    command: --log-level=CONFIG --info-level=standard --command=script --script-language=python --script=scripts/mermaid.py --url="jdbc:postgresql://demodbservice:5432/demodb" --user=dbuser --password=password
    depends_on:
      - liquibase
    volumes:
      - ./scripts:/home/schcrwlr/scripts

[sualeh]

@ltsallas - you do not need to create a custom image. Please take a look at the example I have created for you: https://gist.github.com/sualeh/4aebf7098f5907467df20d00f03962cd

[ltsallas]

Thank you very much @sualeh for the support. It worked like a charm! I managed to create a really good looking diagram of my database. Making schemacrawler support those customizable scripts that can generate markup syntax like mermaid or any other format is a simple but very powerful idea. I plan to generate the schema with CI whenever my database migrations change and then embed it into an Antora static documentation site. This will allow me to to have docs with an always up to date diagram of my database :)

[sualeh]

@ltsallas - awesome! This was exactly my vision for SchemaCrawler! I am so happy you have put it into practice and are finding it useful. Thank you.

[sualeh]

1. The mermaid script is already within the SchemaCrawler Docker image. So if you want to use it as-is, simply do --script=mermaid.py
2. If you want a custom script, you can do the same thing that you were doing. Please get the examples in the gist mentioned above to work first, though. If you can get those working, you can adapt the technique to your needs.

[sualeh]

@ltsallas - I have just released a new SchemaCrawler version. This one runs multiple parallel threads by default. Hopefully you should see some speed up, depending on the size of your database.