get_reference_list_sa_column

get_reference_list_sa_column(*args: Any, **kwargs: Any) → Column[list[Reference]][source]

Get a SQLAlchemy column with the type decorator for a :list of mod:curies.Reference.

Parameters:

args – positional arguments, passed to sqlalchemy.Column
kwargs – keyword arguments, passed to sqlalchemy.Column

Returns:

A column object, parametrized with list of curies.Reference

For example, this can be used to model an author list like in the following:

from curies import Reference
from curies.database import get_reference_list_sa_column
from sqlmodel import Field, SQLModel


class Edge(SQLModel, table=True):
    id: int | None = Field(default=None, primary_key=True)
    authors: list[Reference] = Field(
        default_factory=list, sa_column=get_reference_list_sa_column()
    )