MCPcopy
hub / github.com/fastapi/sqlmodel / Field

Function Field

sqlmodel/main.py:237–274  ·  view source on GitHub ↗
(
    default: Any = Undefined,
    *,
    default_factory: NoArgAnyCallable | None = None,
    alias: str | None = None,
    validation_alias: str | None = None,
    serialization_alias: str | None = None,
    title: str | None = None,
    description: str | None = None,
    exclude: Set[int | str] | Mapping[int | str, Any] | Any = None,
    include: Set[int | str] | Mapping[int | str, Any] | Any = None,
    const: bool | None = None,
    gt: float | None = None,
    ge: float | None = None,
    lt: float | None = None,
    le: float | None = None,
    multiple_of: float | None = None,
    max_digits: int | None = None,
    decimal_places: int | None = None,
    min_items: int | None = None,
    max_items: int | None = None,
    unique_items: bool | None = None,
    min_length: int | None = None,
    max_length: int | None = None,
    allow_mutation: bool = True,
    regex: str | None = None,
    discriminator: str | None = None,
    repr: bool = True,
    primary_key: bool | UndefinedType = Undefined,
    foreign_key: Any = Undefined,
    unique: bool | UndefinedType = Undefined,
    nullable: bool | UndefinedType = Undefined,
    index: bool | UndefinedType = Undefined,
    sa_type: type[Any] | UndefinedType = Undefined,
    sa_column_args: Sequence[Any] | UndefinedType = Undefined,
    sa_column_kwargs: Mapping[str, Any] | UndefinedType = Undefined,
    schema_extra: dict[str, Any] | None = None,
)

Source from the content-addressed store, hash-verified

235# include sa_type, sa_column_args, sa_column_kwargs
236@overload
237def Field(
238 default: Any = Undefined,
239 *,
240 default_factory: NoArgAnyCallable | None = None,
241 alias: str | None = None,
242 validation_alias: str | None = None,
243 serialization_alias: str | None = None,
244 title: str | None = None,
245 description: str | None = None,
246 exclude: Set[int | str] | Mapping[int | str, Any] | Any = None,
247 include: Set[int | str] | Mapping[int | str, Any] | Any = None,
248 const: bool | None = None,
249 gt: float | None = None,
250 ge: float | None = None,
251 lt: float | None = None,
252 le: float | None = None,
253 multiple_of: float | None = None,
254 max_digits: int | None = None,
255 decimal_places: int | None = None,
256 min_items: int | None = None,
257 max_items: int | None = None,
258 unique_items: bool | None = None,
259 min_length: int | None = None,
260 max_length: int | None = None,
261 allow_mutation: bool = True,
262 regex: str | None = None,
263 discriminator: str | None = None,
264 repr: bool = True,
265 primary_key: bool | UndefinedType = Undefined,
266 foreign_key: Any = Undefined,
267 unique: bool | UndefinedType = Undefined,
268 nullable: bool | UndefinedType = Undefined,
269 index: bool | UndefinedType = Undefined,
270 sa_type: type[Any] | UndefinedType = Undefined,
271 sa_column_args: Sequence[Any] | UndefinedType = Undefined,
272 sa_column_kwargs: Mapping[str, Any] | UndefinedType = Undefined,
273 schema_extra: dict[str, Any] | None = None,
274) -> Any: ...
275
276
277# When foreign_key is str, include ondelete

Callers 15

HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90
HeroClass · 0.90

Calls 2

FieldInfoClass · 0.85
FieldInfoMetadataClass · 0.85

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…