Klasse "SortOptions"

Die Klasse SortExpression ermöglicht eine mehrdimensionale Sortierung von Dokumenten.

Mit dem folgenden Codebeispiel werden Dokumente basierend auf der Produktbewertung in absteigender Reihenfolge sortiert. Anschließend wird nach dem preisgünstigsten Produkt innerhalb der ähnlich bewerteten Produkte sortiert und ein Limit von 1.000 Dokumenten festgelegt:

     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 ist im Modul google.appengine.api.search definiert.

Konstruktor

Der Konstruktor für die Klasse SortOptions ist so definiert:

Klasse SortOptions(expressions=None, match_scorer=None, limit=1.000)

Sortiert Dokumente anhand der angegebenen Optionen.

Argumente

expressions

Ein iterierbares Element von SortExpression, das eine mehrdimensionale Sortierung von Dokumenten darstellt.

match_scorer

Eine Spezifikation für die Übereinstimmung mit einer Punktzahl, die zur Bewertung von Dokumenten oder in einer SortExpression kombiniert mit anderen Funktionen verwendet werden kann.

limit

Die höchste Anzahl der zu bewertenden Dokumente. Bei großen Indexen empfiehlt es sich, ein Limit festzulegen.

Ergebniswert

Eine neue Instanz der Klasse SortOptions.

Ausnahmen

TypeError

Wenn einer der Parameter einen ungültigen Typ hat oder ein unbekanntes Attribut übergeben wird.

ValueError

Wenn einer der Parameter einen ungültigen Wert hat.

Eigenschaften

Eine Instanz der Klasse SortOptions hat die folgenden Attribute:

expressions

Gibt eine Liste von SortExpressions zurück, in denen eine mehrdimensionale Sortierung angegeben wird.

match_scorer

Gibt eine Übereinstimmung mit einer Punktzahl zurück, mit der Dokumente bewertet werden.

limit

Gibt die höchste Anzahl der zu bewertenden Dokumente zurück.