3

我有一个带有继电器和过滤器的石墨烯接口。它工作得很好,但我想添加 order_by 选项。我的对象看起来像:

    class FooGQLType(DjangoObjectType):
    class Meta:
        model = Foo
        exclude_fields = ('internal_id',)
        interfaces = (graphene.relay.Node,)
        filter_fields = {
            "id": ["exact"],
            "code": ["exact", "icontains"],
        }
        connection_class = ExtendedConnection

class Query(graphene.ObjectType):
    foo = DjangoFilterConnectionField(FooGQLType)

ExtendedConnection 不应该是相关的,但是:

class ExtendedConnection(graphene.Connection):
    class Meta:
        abstract = True

    total_count = graphene.Int()

    def resolve_total_count(root, info, **kwargs):
        return root.length

这让我可以像foo(code_Icontains:"bar"). 根据Graphene 文档,我应该为此在 FilterSet 中使用 OrderingFilter。我觉得这有点烦人,因为过滤器应该是自动的,但如果我这样做:

    class FooGQLFilter(FilterSet):
    class Meta:
        model = Foo

    order_by = OrderingFilter(
        fields=(
            ('code', 'code'),
            ('lastName', 'last_name'),
            ('otherNames', 'other_names'),
        )
    )

我收到一个需要提供的错误,fields或者exclude

AssertionError: Setting 'Meta.model' without either 'Meta.fields' or 'Meta.exclude' has been deprecated since 0.15.0 and is now disallowed. Add an explicit 'Meta.fields' or 'Meta.exclude' to the FooGQLFilter class.

因此,如果我添加 afields = []使其静音,它会编译。但是,当我在以下情况下使用它时:

foo = DjangoFilterConnectionField(FooGQLType, filterset_class=FooGQLFilter)

我的常规过滤器如code_Icontains消失。我可以在那里再次添加它们,但这很愚蠢。快速查看源代码,看起来 Relay 或 django-filters 已经创建了一个 FilterSet 类(有意义),并且以这种方式覆盖它显然是一个糟糕的主意。

如何在我的 Graphene Relay 过滤对象上添加 orderBy 过滤器?我觉得这应该很简单,但我正在努力解决这个问题。

我还看到了使用 a 以某种方式注入 order_by 的子类化示例DjangoFilterConnectionFieldconnection_resolver但这告诉我没有 orderBy 参数。

4

3 回答 3

5
于 2020-05-01T13:21:38.120 回答
4

此解决方案仅适用于 django-graphene 直到 2.6.0,请参阅 Alok Ramteke 的解决方案以获取最新版本

我已经从GitHub 问题中改编了关于此主题的解决方案:

from graphene_django.filter import DjangoFilterConnectionField
from graphene.utils.str_converters import to_snake_case


class OrderedDjangoFilterConnectionField(DjangoFilterConnectionField):
    """
    Adapted from https://github.com/graphql-python/graphene/issues/251
    Substituting:
    `claims = DjangoFilterConnectionField(ClaimsGraphQLType)`
    with:
    ```
    claims = OrderedDjangoFilterConnectionField(ClaimsGraphQLType,
        orderBy=graphene.List(of_type=graphene.String))
    ```
    """
    @classmethod
    def connection_resolver(cls, resolver, connection, default_manager, max_limit,
                            enforce_first_or_last, filterset_class, filtering_args,
                            root, info, **args):
        filter_kwargs = {k: v for k, v in args.items() if k in filtering_args}
        qs = filterset_class(
            data=filter_kwargs,
            queryset=default_manager.get_queryset(),
            request=info.context
        ).qs
        order = args.get('orderBy', None)
        if order:
            if type(order) is str:
                snake_order = to_snake_case(order)
            else:
                snake_order = [to_snake_case(o) for o in order]
            qs = qs.order_by(*snake_order)
        return super(DjangoFilterConnectionField, cls).connection_resolver(
            resolver,
            connection,
            qs,
            max_limit,
            enforce_first_or_last,
            root,
            info,
            **args
        )

要使用它,只需从以下位置调整查询:

claims = DjangoFilterConnectionField(ClaimsGraphQLType)

claims = OrderedDjangoFilterConnectionField(ClaimsGraphQLType,
        orderBy=graphene.List(of_type=graphene.String))

然后您可以查询:

{ claims(status: 2, orderBy: "-id") { id } }

或者

{ claims(status: 2, orderBy: ["creationDate", "lastName"]) { id } }
于 2019-09-25T15:00:25.810 回答
0

嘿,我相信我对处理 orderBy 有一个简单易行的答案,尤其是作为石墨烯中的列表。我回答的原因不是因为我相信我有最聪明的解决方案,我只是想知道如果我可能在不知不觉中造成伤害有什么区别。我实际上不了解 graphene_django 中的连接内容,所以我采取了不同的路线,灵感来自观看关于 GraphQL 中排序对象的讨论。

https://www.youtube.com/watch?v=dDxUu-K2qdE

所以首先FooType我已经将字段添加为枚举

class FooGQLType(DjangoObjectType):
    class Meta:
        model = Foo

class FooFields(graphene.Enum):
    CODE = "code"
    LAST_NAME = "last_name"
    OTHER_NAMES = "other_names"

class Directions(graphene.Enum):
    ASC = "asc"
    DESC = "desc"

然后输入将它们传递给Query

class FooOrderByInput(graphene.InputObjectType):
    order_by = FooFields()
    direction = Directions()

我不确定你想要过滤什么,但由于问题主要是关于order_by,我现在只是假设它是一个随机字符串。我觉得有一种方法可以发出这一行数据库请求,但我不确定如何。

ORDER_BY = 'order_by'
DIRECTION = 'direction'

class Query(graphene.ObjectType):
    foo = graphene.Field(FooGQLType, input=graphene.List(FooOrderByInput), filter_opt=graphene.String())

    def resolve_foo(self, info, input):
        qs = Foo.objects.filter(filter_opt=filter_opt)
        for obj in input:
            order_by = obj.get(ORDER_BY)
            direction = "-" if obj.get(DIRECTION) == Directions.DESC else ""
            qs = qs.order_by(f"{direction}{order_by}")

        return  qs

关于这个(无论如何对我来说)最好的事情是它允许对多个字段进行查询,例如

query ($input: [FooOrderByInput]) {
  foo (input: $input) {
    id
    code
    lastName
    otherNames
  }
}

VARIABLES
{
    "input": [
        {
            "orderBy": "LAST_NAME",
            "direction": "DESC"
        },
        {
            "orderBy": "CODE",
            "direction": "ASC"
        }
    ]
}

除了那些拼写正确的关键字之外,它也不允许其他任何东西。它也不必处理camelCase 到snake_case。

如果有更好的解决方案或者我的解决方案很糟糕,请告诉我。我很高兴这似乎已经解决了!

于 2021-06-10T00:37:16.767 回答