django-dbml

https://pypi.org/project/django-dbml/
Admin
Django extension that generates DBML database schemas from installed Django models for visualization...
Tokens:2,829
Snippets:50
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install django-dbml

Source: https://pypi.org/project/django-dbml/1.1.2

Install the django-dbml package using pip. Ensure you specify the version if needed.

```bash
pip install django-dbml==1.1.2
```

--------------------------------

### Install django-dbml

Source: https://pypi.org/project/django-dbml

Install the django-dbml package using pip. This is the first step to integrate DBML schema generation into your Django project.

```bash
pip install django-dbml
```

--------------------------------

### Example DBML Output Structure

Source: https://pypi.org/project/django-dbml/1.1.2

Illustrates the structure of DBML generated from Django models, including project details, table definitions, and references.

```dbml
Project "Library" {
  database_type: 'PostgreSQL'
  Note: '''Generated from Django models.
  Last Updated At 03-30-2026 02:15PM UTC'''
}

Table library.Book {
  title char [not null]
  author_id bigint [not null]
}

ref: library.Book.author_id > library.Author.id

```

--------------------------------

### Generate DBML for all installed models

Source: https://pypi.org/project/django-dbml/1.1.2

Run the django-dbml management command to generate a DBML schema for all models in your Django project.

```bash
python manage.py dbml
```

--------------------------------

### Bootstrap Development Environment

Source: https://pypi.org/project/django-dbml/1.1.2

Command to set up the development environment using 'uv' and 'make'.

```bash
make sync
```

--------------------------------

### Common Development Commands

Source: https://pypi.org/project/django-dbml/1.1.2

Provides common commands for testing, linting, and building the project.

```bash
make test
make lint
make build
```

--------------------------------

### Group and color tables by app in DBML

Source: https://pypi.org/project/django-dbml/1.1.2

Organize the DBML output by app using --group_by_app and apply color coding with --color_by_app for better visualization.

```bash
python manage.py dbml --group_by_app --color_by_app
```

--------------------------------

### Generate DBML with project name

Source: https://pypi.org/project/django-dbml/1.1.2

Generate a DBML schema and set a project name using the --add_project_name option.

```bash
python manage.py dbml --add_project_name "Backoffice"
```

--------------------------------

### Add project name and notes to DBML

Source: https://pypi.org/project/django-dbml/1.1.2

Include project metadata such as name and notes in the DBML output using --add_project_name and --add_project_notes. The output can be redirected to a file.

```bash
python manage.py dbml \
  --add_project_name "Commerce Platform" \
  --add_project_notes "Generated from production models." \
  --output_file schema.dbml
```

--------------------------------

### Generate DBML for multiple apps

Source: https://pypi.org/project/django-dbml/1.1.2

Generate DBML schemas for a selected subset of Django apps by listing their labels.

```bash
python manage.py dbml accounts billing crm
```

--------------------------------

### Run Test Suite with Specific Django Version

Source: https://pypi.org/project/django-dbml/1.1.2

Command to execute the test suite against a particular Django version constraint and Python interpreter.

```bash
make test-django DJANGO_CONSTRAINT="django>=5.1,<5.2" PYTHON=3.13
```

--------------------------------

### Write DBML schema to a file

Source: https://pypi.org/project/django-dbml/1.1.2

Use the --output_file option to save the generated DBML schema to a specified file path.

```bash
python manage.py dbml --output_file schema.dbml
```

--------------------------------

### Use physical table names in DBML

Source: https://pypi.org/project/django-dbml/1.1.2

Use the --table_names option to generate DBML using underlying database table names instead of Django model labels.

```bash
python manage.py dbml --table_names
```

--------------------------------

### Add django_dbml to INSTALLED_APPS

Source: https://pypi.org/project/django-dbml/1.1.2

Configure your Django project's settings to include 'django_dbml' in the INSTALLED_APPS list.

```python
INSTALLED_APPS = [
    # ...
    "django_dbml",
]
```

--------------------------------

### Generate DBML for multiple models

Source: https://pypi.org/project/django-dbml/1.1.2

Generate DBML schemas for a specific set of models by providing their app labels and model names.

```bash
python manage.py dbml billing.Invoice billing.InvoiceLine
```

--------------------------------

### Save DBML output to a specific file path

Source: https://pypi.org/project/django-dbml/1.1.2

Specify a detailed file path using --output_file to save the generated DBML schema.

```bash
python manage.py dbml --output_file docs/schema.dbml
```

--------------------------------

### Generate DBML for a single model

Source: https://pypi.org/project/django-dbml/1.1.2

Generate DBML for a specific model by providing its app label and model name.

```bash
python manage.py dbml billing.Invoice
```

--------------------------------

### Generate DBML for a single app

Source: https://pypi.org/project/django-dbml/1.1.2

Generate DBML for all models within a specific Django app by providing the app's label.

```bash
python manage.py dbml billing
```

--------------------------------

### Generate DBML from Django Models

Source: https://pypi.org/project/django-dbml/1.1.2

Command to generate DBML schema from Django models, with an option to add a project name.

```bash
python manage.py dbml library --add_project_name "Library"
```
Tokens:
Raw