7.3.33. logical_range_filter — Groonga v7.0.6ドキュメント

# groonga - オープンソースのカラムストア機能付き全文検索エンジン

- English

# 7.3.33. `logical_range_filter`

## 7.3.33.1. 概要

バージョン 5.0.0 で追加.

TODO: Write summary

## 7.3.33.2. 構文

このコマンドにはたくさんの引数があります。

必須引数は2つあります。 `logical_table` と `shard_key` です。

    logical_range_filter
      logical_table
      shard_key
      [min=null]
      [min_border=null]
      [max=null]
      [max_border=null]
      [order=ascending]
      [filter=null]
      [offset=0]
      [limit=10]
      [output_columns=_key,*]
      [use_range_index=null]

いくつか名前付き引数としてしか使えない引数があります。これらの引数を「○番目の引数」として使うことはできません。必ず名前を指定する必要があります。

名前付き引数としてしか使えない引数は次の通りです。

> - `cache=no`

## 7.3.33.3. 使い方

`logical_range_filter` コマンドを使うには事前に `sharding` プラグインを登録します。

TODO: Add examples

## 7.3.33.4. 引数

このセクションでは `logical_range_filter` の引数について説明します。

### 7.3.33.4.1. 必須引数

必須引数は二つあります。 `logical_table` と `shard_key` です。

#### 7.3.33.4.1.1. `logical_table`

論理テーブル名を指定します。これは "_YYYYMMDD" をテーブル名から除いたものです。実際のテーブルが "Logs_20150203" や "Logs_20150203" といったものなら、論理テーブル名は "Logs" です。

TODO: Add examples

#### 7.3.33.4.1.2. `shard_key`

個々のテーブルで共通のキーとして扱うカラム名を指定します。

TODO: Add examples

### 7.3.33.4.2. 省略可能引数

いくつか省略可能な引数があります。

#### 7.3.33.4.2.1. `min`

`shard_key` の最小値を指定します。

TODO: Add examples

#### 7.3.33.4.2.2. `min_border`

最小値を境界値として含めるのか否かを指定します。 `include` もしくは `exclude` を指定します。

TODO: Add examples

#### 7.3.33.4.2.3. `max`

`shard_key` の最大値を指定します。

TODO: Add examples

#### 7.3.33.4.2.4. `max_border`

最大値を境界値として含めるのか否かを指定します。 `include` もしくは `exclude` を指定します。

TODO: Add examples

#### 7.3.33.4.2.5. `order`

TODO

#### 7.3.33.4.2.6. `filter`

TODO

#### 7.3.33.4.2.7. `offset`

TODO

#### 7.3.33.4.2.8. `limit`

TODO

#### 7.3.33.4.2.9. `output_columns`

TODO

#### 7.3.33.4.2.10. `use_range_index`

range_indexを使うかどうかを指定します。ただし、この引数はテスト用なので、本番で使うべきではありません。

TODO: Add examples

### 7.3.33.4.3. キャッシュ関連の引数

#### 7.3.33.4.3.1. `cache`

このクエリーの結果をキャッシュするかどうかを指定します。

このクエリーの結果がキャッシュしてあると、次に同じクエリーを実行するときはキャッシュを使って高速にレスポンスを返すことができます。

これは既存のキャッシュされた結果を使うかどうかを指定するものではありません。

指定可能な値は以下の通りです。

Value | 説明
--- | ---
`no` | このクエリーの出力をキャッシュしない。
`yes` | このクエリーの出力をキャッシュする。デフォルト値。

TODO: Add examples

デフォルト値は `yes` です。

## 7.3.33.5. 戻り値

TODO

    [HEADER, LOGICAL_FILTERED]