Function convert_to_sql_value

piccolo/utils/sql_values.py:14–50

Some values which can be passed into Piccolo queries aren't valid in the database. For example, Enums, Table instances, and dictionaries for JSON columns.

(value: Any, column: Column)

def convert_to_sql_value(value: Any, column: Column) -> Any:
    """
    Some values which can be passed into Piccolo queries aren't valid in the
    database. For example, Enums, Table instances, and dictionaries for JSON
    columns.
    """
    from piccolo.columns.column_types import JSON, JSONB, ForeignKey
    from piccolo.table import Table

    if isinstance(value, Table):
        if isinstance(column, ForeignKey):
            return getattr(
                value,
                column._foreign_key_meta.resolved_target_column._meta.name,
            )
        elif column._meta.primary_key:
            return getattr(value, column._meta.name)
        else:
            raise ValueError(
                "Table instance provided, and the column isn't a ForeignKey, "
                "or primary key column."
            )
    elif isinstance(value, Enum):
        return value.value
    elif isinstance(column, (JSON, JSONB)) and not isinstance(value, str):
        return None if value is None else dump_json(value)
    elif isinstance(value, list):
        if len(value) > 100:
            colored_warning(
                "When using large lists, consider bypassing the ORM and "
                "using SQL directly for improved performance."
            )
        # Attempt to do this as performantly as possible.
        func = functools.partial(convert_to_sql_value, column=column)
        return list(map(func, value))
    else:
        return value