patito.Model.unique_columns

property Model.unique_columns: set[str]

Return columns with uniqueness constraint.

Return type

set[str]

Returns

Set of column name strings.

Example

>>> from typing import Optional
>>> import patito as pt

>>> class Product(pt.Model):
...     product_id: int = pt.Field(unique=True)
...     barcode: Optional[str] = pt.Field(unique=True)
...     name: str
...
>>> sorted(Product.unique_columns)
['barcode', 'product_id']