FT.AGGREGATE

FT.SEARCH コマンドのスーパーセット。クエリ式によって選択されたキーの実質的な追加処理を許可します。

[Syntax (構文)]

FT.AGGREGATE index query
  [LOAD * | [count field [field ...]]]
  [TIMEOUT timeout]
  [PARAMS count name value [name value ...]]
  [FILTER expression]
  [LIMIT offset num]  
  [GROUPBY count property [property ...] [REDUCE function count arg [arg ...] [AS name] [REDUCE function count arg [arg ...] [AS name] ...]] ...]] 
  [SORTBY count [ property ASC | DESC [property ASC | DESC ...]] [MAX num]] 
  [APPLY expression AS name]

• FILTER、LIMIT、GROUPBY、SORTBY、および APPLY 句は、任意の順序で複数回繰り返すことができ、自由に組み合わせることができます。これらは指定された順序で適用され、1 つの句の出力を次の句の入力に供給します。

• 上記の構文では、「プロパティ」は、このインデックスの FT.CREATE コマンドで宣言されたフィールド、または前の APPLY 句もしくは REDUCE 関数の出力のいずれかです。

• LOAD 句は、インデックスで宣言されたフィールドのロードに制限されます。「LOAD *」は、インデックスで宣言されたすべてのフィールドをロードします。

• 次のリデューサー関数がサポートされています: COUNT、COUNT_DISTINCTISH、SUM、MIN、MAX、AVG、STDDEV、QUANTILE、TOLIST、FIRST_VALUE、および RANDOM_SAMPLE。詳細については、「集計」を参照してください。

• LIMIT <offset> <count>: <offset> で始まり <count> まで続くレコードを保持し、他のすべてのレコードは破棄されます。

• PARAMS: key-value ペアの数の 2 倍。Param の key/value ペアはクエリ式内から参照できます。詳細については、「ベクトル検索クエリ式」を参照してください。

戻る

配列またはエラー応答を返します。

• オペレーションが正常に完了すると、配列が返されます。最初の要素は特定の意味を持たない整数です (無視する必要があります)。残りの要素は、最後のステージによって出力された結果です。各要素はフィールド名と値のペアの配列です。

• インデックスのバックフィルが進行中の場合、コマンドは直ちにエラー応答を返します。

• タイムアウトに達すると、コマンドはエラー応答を返します。