Class TextField

tortoise/fields/data.py:259–304

Large Text field.

class TextField(Field[str], str):  # type: ignore
    """
    Large Text field.
    """

    indexable = False
    SQL_TYPE = "TEXT"

    def __init__(
        self,
        primary_key: bool | None = None,
        unique: bool = False,
        db_index: bool = False,
        **kwargs: Any,
    ) -> None:
        if primary_key or kwargs.get("pk"):
            warnings.warn(
                "TextField as a PrimaryKey is Deprecated, use CharField instead",
                DeprecationWarning,
                stacklevel=2,
            )
        if unique:
            raise ConfigurationError(
                "TextField doesn't support unique indexes, consider CharField or another strategy"
            )
        if (index := kwargs.pop("index", None)) is not None:
            warnings.warn(
                "`index` is deprecated, please use `db_index` instead",
                DeprecationWarning,
                stacklevel=2,
            )
            if index or db_index:
                raise ConfigurationError("TextField can't be indexed, consider CharField")
        elif db_index:
            raise ConfigurationError("TextField can't be indexed, consider CharField")

        super().__init__(primary_key=primary_key, **kwargs)

    class _db_mysql:
        SQL_TYPE = "LONGTEXT"

    class _db_mssql:
        SQL_TYPE = "NVARCHAR(MAX)"

    class _db_oracle:
        SQL_TYPE = "NCLOB"


class BooleanField(Field[T_BOOL]):