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 SortOptions Class
Stay organized with collections
Save and categorize content based on your preferences.
Class SortExpression represents a multi-dimensional sort of Documents.
The following code shows how to sort documents based on product rating
in descending order and then cheapest product within similarly rated
products, sorting at most 1000 documents:
SortOptions(expressions=[
SortExpression(expression='rating',
direction=SortExpression.DESCENDING, default_value=0),
SortExpression(expression='price + tax',
direction=SortExpression.ASCENDING, default_value=999999.99)],
limit=1000)
SortOptions is defined in the google.appengine.api.search module.
Constructor
The constructor for class SortOptions is defined as follows:
-
class SortOptions(expressions=None, match_scorer=None, limit=1000)
Sort documents according to the specified options.
Arguments
- expressions
An iterable of SortExpression representing a multi-dimensional sort of Documents.
- match_scorer
A match scorer specification which may be used to score documents or in a SortExpression combined with other features.
- limit
The limit on the number of documents to score. It is advisable to set this limit on large indexes.
Result value
A new instance of class SortOptions.
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 SortOptions has the following properties:
- expressions
Returns a list of SortExpression specifying a multi-dimensional sort.
- match_scorer
Returns a match scorer used to score documents.
- limit
Returns the limit on the number of documents to score.
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."],[[["\u003cp\u003eThe \u003ccode\u003eSortOptions\u003c/code\u003e class enables multi-dimensional sorting of documents, leveraging \u003ccode\u003eSortExpression\u003c/code\u003e for detailed control.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSortOptions\u003c/code\u003e allows specifying sorting criteria using an iterable of \u003ccode\u003eSortExpression\u003c/code\u003e, a match scorer, and a limit on the number of documents to sort.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSortOptions\u003c/code\u003e constructor can be configured with \u003ccode\u003eexpressions\u003c/code\u003e, \u003ccode\u003ematch_scorer\u003c/code\u003e, and \u003ccode\u003elimit\u003c/code\u003e, throwing \u003ccode\u003eTypeError\u003c/code\u003e or \u003ccode\u003eValueError\u003c/code\u003e if input is invalid.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSortExpression\u003c/code\u003e objects can define the direction of sorting, such as ascending or descending, and a default value for the sort key.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSortOptions\u003c/code\u003e properties \u003ccode\u003eexpressions\u003c/code\u003e, \u003ccode\u003ematch_scorer\u003c/code\u003e, and \u003ccode\u003elimit\u003c/code\u003e allow you to access the configured settings for sorting.\u003c/p\u003e\n"]]],[],null,[]]
