如何在Peewee中使用Postgres JSONPath特性？

Peewee核心库和Playhouse扩展目前确实没有对Postgres JSONPath做开箱即用的封装，你查不到对应说明是正常的。不需要魔改框架就能实现相关查询，以下是经过验证的可用方法：

方法1：直接通过内置函数调用（最简便） #

Peewee的fn对象支持直接调用所有PostgreSQL内置函数，你可以直接用它调用JSONPath相关的系统函数，不需要额外写扩展：
PostgreSQL 12+版本提供的核心JSONPath函数包括jsonb_path_exists（判断是否存在匹配路径的内容）、jsonb_path_query（提取匹配路径的内容）、jsonb_path_match（判断路径返回结果是否为真值），调用示例如下：

from peewee import fn, PostgresqlDatabase, Model, JSONField

db = PostgresqlDatabase("your_database")

class Goods(Model):
    extra_info = JSONField()  # 对应表中的jsonb类型字段
    class Meta:
        database = db

# 基础JSONPath查询：查找extra_info中price字段小于100的记录
low_price_goods = Goods.select().where(
    fn.jsonb_path_exists(
        Goods.extra_info,
        "$.price ? (@ < 100)"
    )
)

如果需要传入动态参数，不要直接拼接字符串，通过函数的第三个参数传JSON格式的变量集合即可，避免SQL注入：

# 带动态变量的查询
max_stock = 50
low_stock_goods = Goods.select().where(
    fn.jsonb_path_match(
        Goods.extra_info,
        "$.stock ? (@ <= $threshold)",
        {"threshold": max_stock}
    )
)

方法2：封装为可复用字段方法（高频使用推荐） #

如果项目中频繁用到JSONPath查询，可以自定义一个扩展字段类，把JSONPath相关方法封装进去，调用更简洁：

class JsonbPathField(JSONField):
    def path_has_match(self, path: str, vars: dict | None = None):
        args = [self, path]
        if vars is not None:
            args.append(vars)
        return fn.jsonb_path_exists(*args)
    
    def get_path_value(self, path: str, vars: dict | None = None):
        args = [self, path]
        if vars is not None:
            args.append(vars)
        return fn.jsonb_path_query(*args)

后续模型中直接用这个自定义字段替换原来的JSONField，就可以直接链式调用相关方法：

class Goods(Model):
    extra_info = JsonbPathField()
    class Meta:
        database = db

# 调用示例
res = Goods.select().where(Goods.extra_info.path_has_match("$.tags ? (@[*] == 'discount')"))

注意事项 #

• 以上方法仅适用于PostgreSQL 12及以上版本，低版本Postgres没有内置JSONPath支持，无法使用
• 所有动态传入的查询值必须通过函数参数位传递，不要直接拼接到JSONPath字符串中，避免注入风险
• Peewee不会对JSONPath语法做校验，路径表达式的写法完全遵循PostgreSQL官方JSONPath规范，写错路径会直接返回数据库层面的报错

内容的提问来源于stack exchange，提问作者Pablo Label