Class BinaryField

tortoise/fields/data.py:842–873

Binary field. This is for storing ``bytes`` objects. Note that filter or queryset-update operations are not supported.

class BinaryField(Field[T_BINARY], bytes):  # type: ignore
    """
    Binary field.

    This is for storing ``bytes`` objects.
    Note that filter or queryset-update operations are not supported.
    """

    indexable = False
    SQL_TYPE = "BLOB"

    @overload
    def __init__(
        self: BinaryField[bytes], *, null: Literal[False] = False, **kwargs: Any
    ) -> None: ...

    @overload
    def __init__(
        self: BinaryField[bytes | None], *, null: Literal[True], **kwargs: Any
    ) -> None: ...

    def __init__(self, **kwargs: Any) -> None:
        super().__init__(**kwargs)

    class _db_postgres:
        SQL_TYPE = "BYTEA"

    class _db_mysql:
        SQL_TYPE = "LONGBLOB"

    class _db_mssql:
        SQL_TYPE = "VARBINARY(MAX)"


class IntEnumFieldInstance(SmallIntField):