ormdantic-schema 2.0.1

Schema metadata structures for Ormdantic
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

# ormdantic-schema

Schema metadata structures for Ormdantic.

`ormdantic-schema` models tables, columns, indexes, unique constraints, and relationships before they are compiled into SQL or exposed through the Python extension.

## Public API

| Item                      | Purpose                                                                                     |
| ------------------------- | ------------------------------------------------------------------------------------------- |
| `TableDef`                | Table definition with columns, primary key, indexes, unique constraints, and relationships. |
| `ColumnDef`               | Column metadata used by validation and DDL compilation.                                     |
| `FieldKind`               | Logical field kind derived from Python/Pydantic fields.                                     |
| `IndexDef`                | Index metadata for generated DDL.                                                           |
| `UniqueConstraintDef`     | Single-column and multi-column uniqueness metadata.                                         |
| `RelationshipDef`         | Relationship metadata between tables.                                                       |
| `RelationshipCardinality` | Relationship direction/cardinality marker.                                                  |
| `SchemaRegistry`          | Registers tables and validates relationship targets.                                        |
| `ColumnAlias`             | Parses aliases such as `table\\column` from result sets.                                    |

## Dependencies

Internal dependencies:

- `ormdantic-core`

External dependencies: none.

## Tests

The crate tests registry validation, duplicate metadata detection, alias parsing, and relationship target errors.