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

7.3.24. logical_range_filter

7.3.24.1. Summary

Note

This command is an experimental feature.

New in version 5.0.0.

TODO: Write summary

7.3.24.2. Syntax

The required parameters are logical_table and shard_key:

logical_range_filter
              logical_table
              shard_key
              [min]
              [min_border]
              [max]
              [max_border]
              [order]
              [filter]
              [offset]
              [output_columns]
              [use_range_index]

7.3.24.3. Usage

Register sharding plugin to use logical_range_filter command in advance.

TODO: Add examples

7.3.24.4. Parameters

This section describes parameters of logical_range_filter.

7.3.24.4.1. Required parameter

There are required parameters, logical_table and shard_key.

7.3.24.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.24.4.1.2. shard_key

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

TODO: Add examples

7.3.24.4.2. Optional parameters

There are optional parameters.

7.3.24.4.2.1. min

Specifies the min value of shard_key

TODO: Add examples

7.3.24.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.24.4.2.3. max

Specifies the max value of shard_key.

TODO: Add examples

7.3.24.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.24.4.2.5. order

TODO

7.3.24.4.2.6. filter

TODO

7.3.24.4.2.7. offset

TODO

7.3.24.4.2.8. output_columns

TODO

7.3.24.4.2.9. 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.24.5. Return value

[HEADER, LOGICAL_FILTERED]