Python 2.7 has reached end of support
and will be
deprecated
on January 31, 2026. After deprecation, you won't be able to deploy Python 2.7
applications, even if your organization previously used an organization policy to
re-enable deployments of legacy runtimes. Your existing Python
2.7 applications will continue to run and receive traffic after their
deprecation date. We recommend that
you
migrate to the latest supported version of Python.
The SortExpression Class
Stay organized with collections
Save and categorize content based on your preferences.
Class SortExpression allows you to customize how your search results are sorted.
SortExpression is defined in the google.appengine.api.search module.
Constructor
The constructor for class SortExpression is defined as follows:
-
class SortExpression(expression=None, direction=DESCENDING, default_value=None)
Sort results by the specified scoring expression.
Arguments
- expression
An expression to be evaluated when sorting results for each matching document. The expression can simply be a field name, or some compound expression such as
_score + count(likes) * 0.1
which will add the score from a scorer to a count of the values of a
likes field weighted by a factor of 0.1.
- direction
The direction to sort the search results, either ASCENDING or DESCENDING.
- default_value
The default value of the expression, if no field is present and cannot be calculated for a document. A text value must be specified for text sorts. A numeric value must be specified for numeric sorts.
Result value
A new instance of class SortExpression.
Exceptions
- TypeError
If any of the parameters have an invalid type, or an unknown attribute is passed.
- ValueError
If any parameter has an invalid value.
Properties
An instance of class SortExpression has the following properties:
- expression
Returns the expression used to sort matched results.
- direction
Returns the direction of sort expression: ASCENDING or DESCENDING.
- default_value
Returns a default value for the expression if no other value could be computed.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["The `SortExpression` class enables customization of search result sorting using an expression."],["It can be used with first-generation runtimes and is applicable when upgrading to second-generation runtimes."],["The class constructor accepts `expression`, `direction` (`ASCENDING` or `DESCENDING`), and `default_value` to define how results are sorted."],["Properties `expression`, `direction`, and `default_value` can be retrieved from an instance of `SortExpression`."]]],[]]
