Generate SQL, documentation, and ER diagrams from YAML logical data models.
94
Define your data model once. Generate SQL, documentation, and ER diagrams.
DataLexicon is a lightweight, model-driven data modeling tool that transforms YAML-based logical data models into database-ready SQL, HTML documentation, and Mermaid ER diagrams.
Designed for data engineers, analysts, and architects, DataLexicon helps teams maintain consistent, version-controlled data models across multiple database platforms.
The recommended way to run DataLexicon in a container is Docker Compose. This keeps your project files and license on your machine, while DataLexicon runs in a disposable container.
Create a folder for your DataLexicon Docker setup.
mkdir datalexicon-docker
cd datalexicon-docker
compose.ymlCreate a file named compose.yml in this directory and paste in the following configuration:
services:
datalexicon:
image: nvisiondata/datalexicon:latest
working_dir: /workspace
volumes:
- type: bind
source: ./projects
target: /workspace
bind:
create_host_path: true
- type: bind
source: ./.license
target: /license
bind:
create_host_path: true
This configuration creates two separate storage locations:
| Location on your computer | Purpose |
|---|---|
projects/ | DataLexicon projects, generated SQL, HTML documentation, and diagrams |
.license/ | License file, stored separately from your projects |
Docker Compose creates these directories when you first run a command.
Run this command from the directory containing compose.yml:
docker compose run --rm datalexicon license activate
Follow the interactive prompts to enter your license key or start the 30-day free trial, if offered.
The license is stored in the mounted .license/ directory on your computer. It is not stored only inside the temporary container.
You only need to activate once per license installation, provided you retain the license directory.
mkdir my-project
cd my-project
docker compose run --rm datalexicon init .
Your project will be created under the projects/my-project/ directory.
docker compose run --rm datalexicon build .
DataLexicon generates SQL into the project's configured output directory, typically target/.
docker compose run --rm datalexicon validate models/customer.yaml
docker compose run --rm datalexicon docs .
The generated HTML documentation and Mermaid ER diagram are written to the project's configured output directory. Open the generated HTML file in your browser.
Your directory structure will look similar to this:
datalexicon-docker/
├── compose.yml
├── .license/
│ └── license.json
└── projects/
└── my-project/
├── models/
├── standards/
├── datalexicon.yml
└── target/
The exact generated files depend on your project configuration.
Your files are safe when the container exits. The --rm option removes the temporary container, not the directories mounted from your computer.
Keep the .license/ directory to preserve your license. Do not commit license files to Git or include them in public repositories.
Copyright © 2026 NvisionData. All rights reserved.
DataLexicon is licensed under the DataLexicon End User License Agreement (EULA).
The EULA defines the permitted use, restrictions, intellectual property rights, and licensing terms for DataLexicon.
For the full license agreement, see:
Content type
Image
Digest
sha256:9a80afdd1…
Size
76.6 MB
Last updated
27 days ago
docker pull nvisiondata/datalexicon