# groonga - An open-source fulltext search engine and column store.

- 日本語

# 7.3.26. `logical_range_filter`

## 7.3.26.1. Summary

Note

This command is an experimental feature.

New in version 5.0.0.

TODO: Write summary

## 7.3.26.2. Syntax

This command takes many parameters.

The required parameters are `logical_table` and `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]

There are some parameters that can be only used as named parameters. You can't use these parameters as ordered parameters. You must specify parameter name.

Here are parameters that can be only used as named parameters:

> - `cache=no`

## 7.3.26.3. Usage

Register `sharding` plugin to use `logical_range_filter` command in advance.

TODO: Add examples

## 7.3.26.4. Parameters

This section describes parameters of `logical_range_filter`.

### 7.3.26.4.1. Required parameter

There are required parameters, `logical_table` and `shard_key`.

#### 7.3.26.4.1.1. `logical_table`

Specifies logical table name. It means table name without "_YYYYMMDD" postfix. If you use actual table such as "Logs_20150203", "Logs_20150203" and so on, logical table name is "Logs".

TODO: Add examples

#### 7.3.26.4.1.2. `shard_key`

Specifies column name which is treated as shared key in each parted table.

TODO: Add examples

### 7.3.26.4.2. Optional parameters

There are optional parameters.

#### 7.3.26.4.2.1. `min`

Specifies the min value of `shard_key`

TODO: Add examples

#### 7.3.26.4.2.2. `min_border`

Specifies whether the min value of borderline must be include or not. Specify `include` or `exclude` as the value of this parameter.

TODO: Add examples

#### 7.3.26.4.2.3. `max`

Specifies the max value of `shard_key`.

TODO: Add examples

#### 7.3.26.4.2.4. `max_border`

Specifies whether the max value of borderline must be include or not. Specify `include` or `exclude` as the value of this parameter.

TODO: Add examples

#### 7.3.26.4.2.5. `order`

TODO

#### 7.3.26.4.2.6. `filter`

TODO

#### 7.3.26.4.2.7. `offset`

TODO

#### 7.3.26.4.2.8. `limit`

TODO

#### 7.3.26.4.2.9. `output_columns`

TODO

#### 7.3.26.4.2.10. `use_range_index`

Specifies whether range_index is used or not. Note that it's a parameter for test. It should not be used for production.

TODO: Add examples

### 7.3.26.4.3. Cache related parameter

#### 7.3.26.4.3.1. `cache`

Specifies whether caching the result of this query or not.

If the result of this query is cached, the next same query returns response quickly by using the cache.

It doesn't control whether existing cached result is used or not.

Here are available values:

Value | Description
--- | ---
`no` | Don't cache the output of this query.
`yes` | Cache the output of this query. It's the default value.

TODO: Add examples

The default value is `yes`.

## 7.3.26.5. Return value

TODO

    [HEADER, LOGICAL_FILTERED]