SortExpression クラス

SortExpression クラスを使用すると、検索結果の並べ替え方法をカスタマイズできます。

SortExpression は、google.appengine.api.search モジュールで定義されます。

コンストラクタ

SortExpression クラスのコンストラクタは、次のように定義されます。

class SortExpression(expression=None, direction=DESCENDING, default_value=None)

指定したスコアリング式で結果を並べ替えます。

引数

expression

一致するドキュメントごとに結果を並べ替える際に評価される式。この式は、単なるフィールド名の場合もあれば、複合式の場合もあります。たとえば、_score + count(likes) * 0.1 という複合式では、スコアラーからのスコアを、因数 0.1 で加重された likes フィールドの値の数に加算します。

direction

検索結果の並べ替えの方向。昇順（ASCENDING）または降順（DESCENDING）のいずれかになります。

default_value

フィールドが存在せず、ドキュメントに関する計算ができない場合の、式のデフォルト値。テキストの並べ替えの場合、テキスト値を指定する必要があります。数字の並べ替えの場合は、数値を指定してください。

結果値

SortExpression クラスの新しいインスタンス。

例外

TypeError

いずれかのパラメータが無効なタイプであるか、不明な属性が渡されました。

ValueError

いずれかのパラメータの値が無効です。

プロパティ

SortExpression クラスのインスタンスには次のプロパティがあります。

expression

一致した結果の並べ替えに使用される式を返します。

direction

並べ替えの式の方向（ASCENDING または DESCENDING）を返します。

default_value

他の値が計算できない場合の式のデフォルト値を返します。