SQLModel Configuration

enable

Whether to enable the plugin.

Type: bool | Default: False

metaxy.tomlpyproject.tomlEnvironment Variable

[ext.sqlmodel]
enable = false

[tool.metaxy.ext.sqlmodel]
enable = false

export METAXY_EXT__SQLMODEL_EXT__SQLMODEL__ENABLE=false

---

inject_primary_key

Automatically inject composite primary key constraints on SQLModel tables. The key is composed of ID columns, metaxy_created_at, and metaxy_data_version.

Type: bool | Default: False

metaxy.tomlpyproject.tomlEnvironment Variable

[ext.sqlmodel]
inject_primary_key = false

[tool.metaxy.ext.sqlmodel]
inject_primary_key = false

export METAXY_EXT__SQLMODEL_EXT__SQLMODEL__INJECT_PRIMARY_KEY=false

---

inject_index

Automatically inject composite index on SQLModel tables. The index covers ID columns, metaxy_created_at, and metaxy_data_version.

Type: bool | Default: False

metaxy.tomlpyproject.tomlEnvironment Variable

[ext.sqlmodel]
inject_index = false

[tool.metaxy.ext.sqlmodel]
inject_index = false

export METAXY_EXT__SQLMODEL_EXT__SQLMODEL__INJECT_INDEX=false

---