Class JSONField

tortoise/fields/data.py:711–805

JSON field. This field can store dictionaries or lists of any JSON-compliant structure. You can use generics to make static checking more friendly. Example: ``JSONField[dict[str, str]]`` You can specify your own custom JSON encoder/decoder, leaving at the default should work well

class JSONField(Field[T], dict, list):  # type: ignore
    """
    JSON field.

    This field can store dictionaries or lists of any JSON-compliant structure.

    You can use generics to make static checking more friendly. Example: ``JSONField[dict[str, str]]``

    You can specify your own custom JSON encoder/decoder, leaving at the default should work well.
    If you have ``orjson`` installed, we default to using that,
    else the default ``json`` module will be used.

    ``encoder``:
        The custom JSON encoder.
    ``decoder``:
        The custom JSON decoder.

    If you want to use Pydantic model as the field type for generating a better OpenAPI documentation, you can use ``field_type`` to specify the type of the field.

    ``field_type``:
        The Pydantic model class.

    """

    SQL_TYPE = "JSON"
    indexable = False

    class _db_postgres:
        SQL_TYPE = "JSONB"

    class _db_mssql:
        SQL_TYPE = "NVARCHAR(MAX)"

    class _db_oracle:
        SQL_TYPE = "NCLOB"

    def __init__(
        self,
        encoder: JsonDumpsFunc = JSON_DUMPS,
        decoder: JsonLoadsFunc = JSON_LOADS,
        **kwargs: Any,
    ) -> None:
        super().__init__(**kwargs)
        self.encoder = encoder
        self.decoder = decoder
        if field_type := kwargs.get("field_type"):
            self.field_type = field_type

    def to_db_value(
        self,
        value: T | dict | list | str | bytes | None,
        instance: type[Model] | Model,
    ) -> str | None:
        self.validate(value)
        if value is None:
            return None

        if isinstance(value, (str, bytes)):