如何使用“endpoints-proto-datastore”在google appengine端点api中执行自定义查询?

时间:2015-02-02 06:10:38

标签: google-app-engine google-cloud-endpoints endpoints-proto-datastore

通常我们会做这样的查询

@MyModel.query_method(path='mymodels', name='mymodel.list')
def MyModelList(self, query):
   return query

但是如何在端点模型上执行自定义查询以及如何传递除“id,limit,order ...”等之外的自定义参数

例如:

return query.filter(Student.name == somename )

如何向端点提供“somename”?

1 个答案:

答案 0 :(得分:3)

如果要过滤的属性是模型的一部分,则只需将“名称”添加为query_field

@MyModel.query_method(path='mymodels',
                      name='mymodel.list',
                      query_fields=('name',))

如果在API请求中提供了名称,这将自动应用相等过滤器(MyModel.name == name)

如果您需要更多自定义查询,可以在模型上使用EndpointsAliasProperty并直接访问模型的_endpoints_query_info._filters

使用日期执行不等式过滤器的示例:

class MyModel(EndpointsModel):

    ...
    updated = EndpointsDateTimeProperty(auto_now=True)
    ...

    def MinDateSet(self, value):
        if value is not None:
            self._endpoints_query_info._filters.add(MyModel.updated >= value)

    @EndpointsAliasProperty(setter=MinDateSet,
                            property_type=message_types.DateTimeField)
    def minDate(self):
        """
        minDate is only used as parameter in query_methods
        so there should never be a reason to actually retrieve the value
        """
        return None


@MyModel.query_method(path='mymodels',
                      name='mymodel.list',
                      query_fields=('minDate',))

如果API请求中提供了minDate,则会自动应用MyModel.updated >= minDate过滤器。