File: select.html

package info (click to toggle)
groonga 11.0.0-2
links: PTS, VCS
area: main
in suites: bullseye
size: 121,576 kB
sloc: ansic: 801,209; javascript: 62,121; ruby: 46,206; cpp: 33,790; xml: 24,951; yacc: 13,333; sh: 7,776; python: 3,266; makefile: 2,315; perl: 133
file content (6942 lines) | stat: -rw-r--r-- 299,605 bytes


<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>7.3.57. select &#8212; Groonga v10.1.1-31-g1e46ba6 documentation</title>
    <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="7.3.58. shutdown" href="shutdown.html" />
    <link rel="prev" title="7.3.56. schema" href="schema.html" /> 
  </head><body>
<div class="header">
  <h1 class="title">
    <a id="top-link" href="../../index.html">
      <span class="project">groonga</span>
      <span class="separator">-</span>
      <span class="description">An open-source fulltext search engine and column store.</span>
    </a>
  </h1>

  <div class="other-language-links">
    <ul>
      <li><a href="../../../../ja/html/reference/commands/select.html">日本語</a></li>
    </ul>
  </div>
</div>
  

    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="shutdown.html" title="7.3.58. shutdown"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="schema.html" title="7.3.56. schema"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U"><span class="section-number">7.3. </span>Command</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.57. </span><code class="docutils literal notranslate"><span class="pre">select</span></code></a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="select">
<h1><span class="section-number">7.3.57. </span><code class="docutils literal notranslate"><span class="pre">select</span></code><a class="headerlink" href="#select" title="Permalink to this headline">¶</a></h1>
<div class="section" id="summary">
<h2><span class="section-number">7.3.57.1. </span>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">select</span></code> searches records that are matched to specified conditions
from a table and then outputs them.</p>
<p><code class="docutils literal notranslate"><span class="pre">select</span></code> is the most important command in groonga. You need to
understand <code class="docutils literal notranslate"><span class="pre">select</span></code> to use the full power of Groonga.</p>
</div>
<div class="section" id="syntax">
<h2><span class="section-number">7.3.57.2. </span>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
<p>This command takes many parameters.</p>
<p>The required parameter is only <code class="docutils literal notranslate"><span class="pre">table</span></code>. Other parameters are
optional:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select table
       [match_columns=null]
       [query=null]
       [filter=null]
       [scorer=null]
       [sortby=null]
       [output_columns=&quot;_id, _key, *&quot;]
       [offset=0]
       [limit=10]
       [drilldown=null]
       [drilldown_sortby=null]
       [drilldown_output_columns=&quot;_key, _nsubrecs&quot;]
       [drilldown_offset=0]
       [drilldown_limit=10]
       [cache=yes]
       [match_escalation_threshold=0]
       [query_expansion=null]
       [query_flags=ALLOW_PRAGMA|ALLOW_COLUMN]
       [query_expander=null]
       [adjuster=null]
       [drilldown_calc_types=NONE]
       [drilldown_calc_target=null]
       [drilldown_filter=null]
       [sort_keys=null]
       [drilldown_sort_keys=null]
       [match_escalation=auto]
       [load_table=null]
       [load_columns=null]
       [load_values=null]
</pre></div>
</div>
<p>This command has the following named parameters for dynamic columns:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].stage=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].flags=COLUMN_SCALAR</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].type=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].value=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.sort_keys=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.group_keys=null</span></code></p></li>
</ul>
</div></blockquote>
<p>You can use one or more alphabets, digits, <code class="docutils literal notranslate"><span class="pre">_</span></code> for <code class="docutils literal notranslate"><span class="pre">${NAME}</span></code>. For
example, <code class="docutils literal notranslate"><span class="pre">column1</span></code> is a valid <code class="docutils literal notranslate"><span class="pre">${NAME}</span></code>. This is the same rule as
normal column. See also <a class="reference internal" href="column_create.html#column-create-name"><span class="std std-ref">name</span></a>.</p>
<p>Parameters that have the same <code class="docutils literal notranslate"><span class="pre">${NAME}</span></code> are grouped.</p>
<p>For example, the following parameters specify one dynamic column:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name].stage</span> <span class="pre">initial</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name].type</span> <span class="pre">UInt32</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name].value</span> <span class="pre">29</span></code></p></li>
</ul>
</div></blockquote>
<p>The following parameters specify two dynamic columns:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name1].stage</span> <span class="pre">initial</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name1].type</span> <span class="pre">UInt32</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name1].value</span> <span class="pre">29</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name2].stage</span> <span class="pre">filtered</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name2].type</span> <span class="pre">Float</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--columns[name2].value</span> <span class="pre">'_score</span> <span class="pre">*</span> <span class="pre">0.1'</span></code></p></li>
</ul>
</div></blockquote>
<p>This command has the following named parameters for advanced drilldown:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].sort_keys=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns=&quot;_key,</span> <span class="pre">_nsubrecs&quot;</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].offset=0</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].limit=10</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_types=NONE</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_target=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].filter=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].stage=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].flags=COLUMN_SCALAR</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].type=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].value=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].window.sort_keys=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].window.group_keys=null</span></code></p></li>
</ul>
</div></blockquote>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 6.0.3: </span><code class="docutils literal notranslate"><span class="pre">drilldown[...]</span></code> syntax is deprecated, Use <code class="docutils literal notranslate"><span class="pre">drilldowns[...]</span></code>
instead.</p>
</div>
<p>You can use one or more alphabets, digits, <code class="docutils literal notranslate"><span class="pre">_</span></code> and <code class="docutils literal notranslate"><span class="pre">.</span></code> for
<code class="docutils literal notranslate"><span class="pre">${LABEL}</span></code>. For example, <code class="docutils literal notranslate"><span class="pre">parent.sub1</span></code> is a valid <code class="docutils literal notranslate"><span class="pre">${LABEL}</span></code>.</p>
<p>Parameters that have the same <code class="docutils literal notranslate"><span class="pre">${LABEL}</span></code> are grouped.</p>
<p>For example, the following parameters specify one drilldown:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label].keys</span> <span class="pre">column</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label].sort_keys</span> <span class="pre">-_nsubrecs</span></code></p></li>
</ul>
</div></blockquote>
<p>The following parameters specify two drilldowns:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label1].keys</span> <span class="pre">column1</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label1].sort_keys</span> <span class="pre">-_nsubrecs</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label2].keys</span> <span class="pre">column2</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label2].sort_keys</span> <span class="pre">_key</span></code></p></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="usage">
<h2><span class="section-number">7.3.57.3. </span>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Let’s learn about <code class="docutils literal notranslate"><span class="pre">select</span></code> usage with examples. This section shows
many popular usages.</p>
<p>Here are a schema definition and sample data to show usage.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Entries TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries content COLUMN_SCALAR Text
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries n_likes COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Entries tag COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Terms TABLE_PAT_KEY ShortText --default_tokenizer TokenBigram --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_key_index COLUMN_INDEX|WITH_POSITION Entries _key
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Terms entries_content_index COLUMN_INDEX|WITH_POSITION Entries content
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Entries
[
{&quot;_key&quot;:    &quot;The first post!&quot;,
 &quot;content&quot;: &quot;Welcome! This is my first post!&quot;,
 &quot;n_likes&quot;: 5,
 &quot;tag&quot;: &quot;Hello&quot;},
{&quot;_key&quot;:    &quot;Groonga&quot;,
 &quot;content&quot;: &quot;I started to use Groonga. It&#39;s very fast!&quot;,
 &quot;n_likes&quot;: 10,
 &quot;tag&quot;: &quot;Groonga&quot;},
{&quot;_key&quot;:    &quot;Mroonga&quot;,
 &quot;content&quot;: &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
 &quot;n_likes&quot;: 15,
 &quot;tag&quot;: &quot;Groonga&quot;},
{&quot;_key&quot;:    &quot;Good-bye Senna&quot;,
 &quot;content&quot;: &quot;I migrated all Senna system!&quot;,
 &quot;n_likes&quot;: 3,
 &quot;tag&quot;: &quot;Senna&quot;},
{&quot;_key&quot;:    &quot;Good-bye Tritonn&quot;,
 &quot;content&quot;: &quot;I also migrated all Tritonn system!&quot;,
 &quot;n_likes&quot;: 3,
 &quot;tag&quot;: &quot;Senna&quot;}
]
# [[0, 1337566253.89858, 0.000355720520019531], 5]
</pre></div>
</div>
<p>There is a table, <code class="docutils literal notranslate"><span class="pre">Entries</span></code>, for blog entries. An entry has title,
content, the number of likes for the entry and tag. Title is key of
<code class="docutils literal notranslate"><span class="pre">Entries</span></code>. Content is value of <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column. The
number of likes is value of <code class="docutils literal notranslate"><span class="pre">Entries.n_likes</span></code> column. Tag is value
of <code class="docutils literal notranslate"><span class="pre">Entries.tag</span></code> column.</p>
<p><code class="docutils literal notranslate"><span class="pre">Entries._key</span></code> column and <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column are indexed
using <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> tokenizer. So both <code class="docutils literal notranslate"><span class="pre">Entries._key</span></code> and
<code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> are fulltext search ready.</p>
<p>OK. The schema and data for examples are ready.</p>
<div class="section" id="simple-usage">
<span id="select-simple-usage"></span><h3><span class="section-number">7.3.57.3.1. </span>Simple usage<a class="headerlink" href="#simple-usage" title="Permalink to this headline">¶</a></h3>
<p>Here is the most simple usage with the above schema and data. It outputs
all records in <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>Why does the command output all records? There are two reasons. The
first reason is that the command doesn’t specify any search
conditions. No search condition means all records are matched. The
second reason is that the number of all records is 5. <code class="docutils literal notranslate"><span class="pre">select</span></code>
command outputs 10 records at a maximum by default. There are only 5
records. It is less than 10. So the command outputs all records.</p>
</div>
<div class="section" id="search-conditions">
<h3><span class="section-number">7.3.57.3.2. </span>Search conditions<a class="headerlink" href="#search-conditions" title="Permalink to this headline">¶</a></h3>
<p>Search conditions are specified by <code class="docutils literal notranslate"><span class="pre">query</span></code> or <code class="docutils literal notranslate"><span class="pre">filter</span></code>. You can
also specify both <code class="docutils literal notranslate"><span class="pre">query</span></code> and <code class="docutils literal notranslate"><span class="pre">filter</span></code>. It means that selected
records must be matched against both <code class="docutils literal notranslate"><span class="pre">query</span></code> and <code class="docutils literal notranslate"><span class="pre">filter</span></code>.</p>
<div class="section" id="search-condition-query">
<h4><span class="section-number">7.3.57.3.2.1. </span>Search condition: <code class="docutils literal notranslate"><span class="pre">query</span></code><a class="headerlink" href="#search-condition-query" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">query</span></code> is designed for search box in Web page. Imagine a search box
in google.com. You specify search conditions for <code class="docutils literal notranslate"><span class="pre">query</span></code> as space
separated keywords. For example, <code class="docutils literal notranslate"><span class="pre">search</span> <span class="pre">engine</span></code> means a matched
record should contain two words, <code class="docutils literal notranslate"><span class="pre">search</span></code> and <code class="docutils literal notranslate"><span class="pre">engine</span></code>.</p>
<p>Normally, <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter is used for specifying fulltext search
conditions. It can be used for non fulltext search conditions but
<code class="docutils literal notranslate"><span class="pre">filter</span></code> is used for the propose.</p>
<p><code class="docutils literal notranslate"><span class="pre">query</span></code> parameter is used with <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> parameter when
<code class="docutils literal notranslate"><span class="pre">query</span></code> parameter is used for specifying fulltext search
conditions. <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> specifies which columnes and indexes are
matched against <code class="docutils literal notranslate"><span class="pre">query</span></code>.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">query</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain a word <code class="docutils literal notranslate"><span class="pre">fast</span></code>
in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p><code class="docutils literal notranslate"><span class="pre">query</span></code> has query syntax but its deatils aren’t described here. See
<a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a> for datails.</p>
</div>
<div class="section" id="search-condition-filter">
<h4><span class="section-number">7.3.57.3.2.2. </span>Search condition: <code class="docutils literal notranslate"><span class="pre">filter</span></code><a class="headerlink" href="#search-condition-filter" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">filter</span></code> is designed for complex search conditions. You specify
search conditions for <code class="docutils literal notranslate"><span class="pre">filter</span></code> as ECMAScript like syntax.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">filter</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter &#39;content @ &quot;fast&quot; &amp;&amp; _key == &quot;Groonga&quot;&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain a word <code class="docutils literal notranslate"><span class="pre">fast</span></code>
in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value and has <code class="docutils literal notranslate"><span class="pre">Groonga</span></code> as <code class="docutils literal notranslate"><span class="pre">_key</span></code> from
<code class="docutils literal notranslate"><span class="pre">Entries</span></code> table. There are three operators in the command, <code class="docutils literal notranslate"><span class="pre">&#64;</span></code>,
<code class="docutils literal notranslate"><span class="pre">&amp;&amp;</span></code> and <code class="docutils literal notranslate"><span class="pre">==</span></code>. <code class="docutils literal notranslate"><span class="pre">&#64;</span></code> is fulltext search operator. <code class="docutils literal notranslate"><span class="pre">&amp;&amp;</span></code> and
<code class="docutils literal notranslate"><span class="pre">==</span></code> are the same as ECMAScript. <code class="docutils literal notranslate"><span class="pre">&amp;&amp;</span></code> is logical AND operator and
<code class="docutils literal notranslate"><span class="pre">==</span></code> is equality operator.</p>
<p><code class="docutils literal notranslate"><span class="pre">filter</span></code> has more operators and syntax like grouping by <code class="docutils literal notranslate"><span class="pre">(...)</span></code>
its details aren’t described here. See
<a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a> for datails.</p>
</div>
</div>
<div class="section" id="paging">
<h3><span class="section-number">7.3.57.3.3. </span>Paging<a class="headerlink" href="#paging" title="Permalink to this headline">¶</a></h3>
<p>You can specify range of outputted records by <code class="docutils literal notranslate"><span class="pre">offset</span></code> and <code class="docutils literal notranslate"><span class="pre">limit</span></code>.
Here is an example to output only the 2nd record.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --offset 1 --limit 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">offset</span></code> is zero-based. <code class="docutils literal notranslate"><span class="pre">--offset</span> <span class="pre">1</span></code> means output range is
started from the 2nd record.</p>
<p><code class="docutils literal notranslate"><span class="pre">limit</span></code> specifies the max number of output records. <code class="docutils literal notranslate"><span class="pre">--limit</span> <span class="pre">1</span></code>
means the number of output records is 1 at a maximium. If no records
are matched, <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs no records.</p>
</div>
<div class="section" id="the-total-number-of-records">
<h3><span class="section-number">7.3.57.3.4. </span>The total number of records<a class="headerlink" href="#the-total-number-of-records" title="Permalink to this headline">¶</a></h3>
<p>You can use <code class="docutils literal notranslate"><span class="pre">--limit</span> <span class="pre">0</span></code> to retrieve the total number of recrods
without any contents of records.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --limit 0
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">--limit</span> <span class="pre">0</span></code> is also useful for retrieving only the number of matched
records.</p>
</div>
<div class="section" id="drilldown">
<h3><span class="section-number">7.3.57.3.5. </span>Drilldown<a class="headerlink" href="#drilldown" title="Permalink to this headline">¶</a></h3>
<p>You can get additional grouped results against the search result in
one <code class="docutils literal notranslate"><span class="pre">select</span></code>. You need to use two or more <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> s in SQL but
<code class="docutils literal notranslate"><span class="pre">select</span></code> in Groonga can do it in one <code class="docutils literal notranslate"><span class="pre">select</span></code>.</p>
<p>This feature is called as <a class="reference external" href="http://en.wikipedia.org/wiki/Drill_down">drilldown</a> in Groonga. It’s also
called as <a class="reference external" href="http://en.wikipedia.org/wiki/Faceted_search">faceted search</a> in other search
engine.</p>
<p>For example, think about the following situation.</p>
<p>You search entries that has <code class="docutils literal notranslate"><span class="pre">fast</span></code> word:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter &#39;content @ &quot;fast&quot;&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>You want to use <code class="docutils literal notranslate"><span class="pre">tag</span></code> for additional search condition like
<code class="docutils literal notranslate"><span class="pre">--filter</span> <span class="pre">'content</span> <span class="pre">&#64;</span> <span class="pre">&quot;fast&quot;</span> <span class="pre">&amp;&amp;</span> <span class="pre">tag</span> <span class="pre">==</span> <span class="pre">&quot;???&quot;</span></code>. But you don’t know
suitable tag until you see the result of <code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">&#64;</span> <span class="pre">&quot;fast&quot;</span></code>.</p>
<p>If you know the number of matched records of each available tag, you
can choose suitable tag. You can use drilldown for the case:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter &#39;content @ &quot;fast&quot;&#39; --drilldown tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ],
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">--drilldown</span> <span class="pre">tag</span></code> returns a list of pair of available tag and the
number of matched records. You can avoid “no hit search” case by
choosing a tag from the list. You can also avoid “too many search
results” case by choosing a tag that the number of matched records is
few from the list.</p>
<p>You can create the following UI with the drilldown results:</p>
<blockquote>
<div><ul class="simple">
<li><p>Links to narrow search results. (Users don’t need to input a
search query by their keyboard. They just click a link.)</p></li>
</ul>
</div></blockquote>
<p>Most EC sites use the UI. See side menu at Amazon.</p>
<p>Groonga supports not only counting grouped records but also finding
the maximum and/or minimum value from grouped records, summing values
in grouped records and so on. See
<a class="reference internal" href="#select-drilldown-related-parameters"><span class="std std-ref">Drilldown related parameters</span></a> for details.</p>
</div>
<div class="section" id="dynamic-column">
<h3><span class="section-number">7.3.57.3.6. </span>Dynamic column<a class="headerlink" href="#dynamic-column" title="Permalink to this headline">¶</a></h3>
<p>You can create zero or more columns dynamically while a <code class="docutils literal notranslate"><span class="pre">select</span></code>
execution. You can use them for drilldown by computed value, window
function and so on.</p>
<p>Here is an example that uses dynamic column for drilldown by computed
value. This example creates a new column named
<code class="docutils literal notranslate"><span class="pre">n_likes_class</span></code>. <code class="docutils literal notranslate"><span class="pre">n_likes_class</span></code> column has classified value of
<code class="docutils literal notranslate"><span class="pre">Entry.n_likes</span></code> value. This example classifies <code class="docutils literal notranslate"><span class="pre">Entry.n_likes</span></code>
column value <code class="docutils literal notranslate"><span class="pre">10</span></code> step and the lowest number in the class is the
classified value. If a <code class="docutils literal notranslate"><span class="pre">Entry.n_likes</span></code> value is between <code class="docutils literal notranslate"><span class="pre">0</span></code> and
<code class="docutils literal notranslate"><span class="pre">9</span></code> such as <code class="docutils literal notranslate"><span class="pre">3</span></code> and <code class="docutils literal notranslate"><span class="pre">5</span></code>, <code class="docutils literal notranslate"><span class="pre">n_likes_class</span></code> value (classified
value) is <code class="docutils literal notranslate"><span class="pre">0</span></code>. If <code class="docutils literal notranslate"><span class="pre">Entry.n_likes</span></code> value is between <code class="docutils literal notranslate"><span class="pre">10</span></code> and
<code class="docutils literal notranslate"><span class="pre">19</span></code> such as <code class="docutils literal notranslate"><span class="pre">10</span></code> and <code class="docutils literal notranslate"><span class="pre">15</span></code>, <code class="docutils literal notranslate"><span class="pre">n_likes_class</span></code> value (classified
value) is <code class="docutils literal notranslate"><span class="pre">10</span></code>.</p>
<p>You can use <a class="reference internal" href="../functions/number_classify.html"><span class="doc">number_classify</span></a> function for
the classification. You need to register <code class="docutils literal notranslate"><span class="pre">functions/number</span></code> plugin
by <a class="reference internal" href="plugin_register.html"><span class="doc">plugin_register</span></a> command to use
<a class="reference internal" href="../functions/number_classify.html"><span class="doc">number_classify</span></a> function.</p>
<p>This example does drilldown by <code class="docutils literal notranslate"><span class="pre">n_likes_class</span></code> value. The drilldown
result will help you to know data trend.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register functions/number
# [[0, 1337566253.89858, 0.000355720520019531], true]
select \
  --table Entries \
  --columns[n_likes_class].stage initial \
  --columns[n_likes_class].type UInt32 \
  --columns[n_likes_class].value &#39;number_classify(n_likes, 10)&#39; \
  --drilldown n_likes_class \
  --drilldown_sort_keys _nsubrecs \
  --output_columns n_likes,n_likes_class
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes_class&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         5,
#         0
#       ],
#       [
#         10,
#         10
#       ],
#       [
#         15,
#         10
#       ],
#       [
#         3,
#         0
#       ],
#       [
#         3,
#         0
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         10,
#         2
#       ],
#       [
#         0,
#         3
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>See <a class="reference internal" href="#select-dynamic-column-related-parameters"><span class="std std-ref">Dynamic column related parameters</span></a> for details.</p>
</div>
<div class="section" id="window-function">
<h3><span class="section-number">7.3.57.3.7. </span>Window function<a class="headerlink" href="#window-function" title="Permalink to this headline">¶</a></h3>
<p>You can compute each record value from values of grouped records. For
example, you can compute sums of each group and puts sums to each
record. The difference against drilldown is drilldown can compute sums
of each group but it puts sums to each group not record.</p>
<p>Here is the result with window function. Each record has sum:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Group No.</p></th>
<th class="head"><p>Target value</p></th>
<th class="head"><p>Sum result</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1</p></td>
<td><p>5</p></td>
<td><p>5</p></td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><p>10</p></td>
<td><p>25</p></td>
</tr>
<tr class="row-even"><td><p>2</p></td>
<td><p>15</p></td>
<td><p>25</p></td>
</tr>
<tr class="row-odd"><td><p>3</p></td>
<td><p>3</p></td>
<td><p>8</p></td>
</tr>
<tr class="row-even"><td><p>3</p></td>
<td><p>5</p></td>
<td><p>8</p></td>
</tr>
</tbody>
</table>
<p>Here is the result with drilldown. Each group has sum:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Group No.</p></th>
<th class="head"><p>Target values</p></th>
<th class="head"><p>Sum result</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1</p></td>
<td><p>5</p></td>
<td><p>5</p></td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><p>10, 15</p></td>
<td><p>25</p></td>
</tr>
<tr class="row-even"><td><p>3</p></td>
<td><p>3, 5</p></td>
<td><p>8</p></td>
</tr>
</tbody>
</table>
<p>Window function is useful for data analysis.</p>
<p>Here is an example that sums <code class="docutils literal notranslate"><span class="pre">Entries.n_likes</span></code> per
<code class="docutils literal notranslate"><span class="pre">Entries.tag</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register functions/number
# [[0, 1337566253.89858, 0.000355720520019531], true]
select \
  --table Entries \
  --columns[n_likes_sum_per_tag].stage initial \
  --columns[n_likes_sum_per_tag].type UInt32 \
  --columns[n_likes_sum_per_tag].value &#39;window_sum(n_likes)&#39; \
  --columns[n_likes_sum_per_tag].window.group_keys tag \
  --output_columns tag,n_likes,n_likes_sum_per_tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes_sum_per_tag&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         5,
#         5
#       ],
#       [
#         &quot;Groonga&quot;,
#         10,
#         25
#       ],
#       [
#         &quot;Groonga&quot;,
#         15,
#         25
#       ],
#       [
#         &quot;Senna&quot;,
#         3,
#         6
#       ],
#       [
#         &quot;Senna&quot;,
#         3,
#         6
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>See <a class="reference internal" href="#select-window-function-related-parameters"><span class="std std-ref">Window function related parameters</span></a> for details.</p>
</div>
</div>
<div class="section" id="parameters">
<h2><span class="section-number">7.3.57.4. </span>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p>This section describes all parameters. Parameters are categorized.</p>
<div class="section" id="required-parameters">
<h3><span class="section-number">7.3.57.4.1. </span>Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
<p>There is a required parameter, <code class="docutils literal notranslate"><span class="pre">table</span></code>.</p>
<div class="section" id="table">
<span id="select-table"></span><h4><span class="section-number">7.3.57.4.1.1. </span><code class="docutils literal notranslate"><span class="pre">table</span></code><a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h4>
<p>Specifies a table to be searched. <code class="docutils literal notranslate"><span class="pre">table</span></code> must be specified.</p>
<p>If nonexistent table is specified, an error is returned.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Nonexistent
# [
#   [
#     -22,
#     1337566253.89858,
#     0.000355720520019531,
#     &quot;[select][table] invalid name: &lt;Nonexistent&gt;&quot;,
#     [
#       [
#         &quot;grn_select&quot;,
#         &quot;proc_select.c&quot;,
#         3095
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
</div>
<div class="section" id="search-related-parameters">
<span id="select-search-related-parameters"></span><h3><span class="section-number">7.3.57.4.2. </span>Search related parameters<a class="headerlink" href="#search-related-parameters" title="Permalink to this headline">¶</a></h3>
<p>There are search related parameters. Typically, <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> and
<code class="docutils literal notranslate"><span class="pre">query</span></code> parameters are used for implementing a search
box. <code class="docutils literal notranslate"><span class="pre">filter</span></code> parameters is used for implementing complex search
feature.</p>
<p>If both <code class="docutils literal notranslate"><span class="pre">query</span></code> and <code class="docutils literal notranslate"><span class="pre">filter</span></code> are specified, selected records must
be matched against both <code class="docutils literal notranslate"><span class="pre">query</span></code> and <code class="docutils literal notranslate"><span class="pre">filter</span></code>. If both <code class="docutils literal notranslate"><span class="pre">query</span></code>
and <code class="docutils literal notranslate"><span class="pre">filter</span></code> aren’t specified, all records are selected.</p>
<div class="section" id="match-columns">
<span id="select-match-columns"></span><h4><span class="section-number">7.3.57.4.2.1. </span><code class="docutils literal notranslate"><span class="pre">match_columns</span></code><a class="headerlink" href="#match-columns" title="Permalink to this headline">¶</a></h4>
<p>Specifies the default target column for fulltext search by <code class="docutils literal notranslate"><span class="pre">query</span></code>
parameter value. A target column for fulltext search can be specified
in <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter. The difference between <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> and
<code class="docutils literal notranslate"><span class="pre">query</span></code> is whether weight and score function are supported or
not. <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> supports them but <code class="docutils literal notranslate"><span class="pre">query</span></code> doesn’t.</p>
<p>Weight is relative importance of target column. A higher weight target
column gets more hit score rather than a lower weight target column
when a record is matched by fulltext search. The default weight is 1.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast --output_columns &#39;_key, _score&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         1
#       ],
#       [
#         &quot;Mroonga&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">--match_columns</span> <span class="pre">content</span></code> means the default target column for
fulltext search is <code class="docutils literal notranslate"><span class="pre">content</span></code> column and its weight
is 1. <code class="docutils literal notranslate"><span class="pre">--output_columns</span> <span class="pre">'_key,</span> <span class="pre">_score'</span></code> means that the <code class="docutils literal notranslate"><span class="pre">select</span></code>
command outputs <code class="docutils literal notranslate"><span class="pre">_key</span></code> value and <code class="docutils literal notranslate"><span class="pre">_score</span></code> value for matched
records.</p>
<p>Pay attention to <code class="docutils literal notranslate"><span class="pre">_score</span></code> value. <code class="docutils literal notranslate"><span class="pre">_score</span></code> value is the number of
matched counts against <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter value. In the example,
<code class="docutils literal notranslate"><span class="pre">query</span></code> parameter value is <code class="docutils literal notranslate"><span class="pre">fast</span></code>. The fact that <code class="docutils literal notranslate"><span class="pre">_score</span></code> value
is 1 means that <code class="docutils literal notranslate"><span class="pre">fast</span></code> appers in <code class="docutils literal notranslate"><span class="pre">content</span></code> column only once.  The
fact that <code class="docutils literal notranslate"><span class="pre">_score</span></code> value is 2 means that <code class="docutils literal notranslate"><span class="pre">fast</span></code> appears in
<code class="docutils literal notranslate"><span class="pre">content</span></code> column twice.</p>
<p>To specify weight, <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">*</span> <span class="pre">weight</span></code> syntax is used. Here is a
weight usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns &#39;content * 2&#39; --query fast --output_columns &#39;_key, _score&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Mroonga&quot;,
#         4
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">--match_columns</span> <span class="pre">'content</span> <span class="pre">*</span> <span class="pre">2'</span></code> means the default target column for
fulltext search is <code class="docutils literal notranslate"><span class="pre">content</span></code> column and its weight is 2.</p>
<p>Pay attention to <code class="docutils literal notranslate"><span class="pre">_score</span></code> value. <code class="docutils literal notranslate"><span class="pre">_score</span></code> value is doubled because
weight is 2.</p>
<p>You can specify one or more columns as the default target columns for
fulltext search. If one or more columns are specified, fulltext search
is done for all columns and scores are accumulated. If one of the
columns is matched against <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter value, the record is
treated as matched.</p>
<p>To specify one or more columns, <code class="docutils literal notranslate"><span class="pre">column1</span> <span class="pre">*</span> <span class="pre">weight1</span> <span class="pre">||</span> <span class="pre">column2</span> <span class="pre">*</span>
<span class="pre">weight2</span> <span class="pre">||</span> <span class="pre">...</span></code> syntax is used. <code class="docutils literal notranslate"><span class="pre">*</span> <span class="pre">weight</span></code> can be omitted. If it is
omitted, 1 is used for weight. Here is a one or more columns usage
example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns &#39;_key * 10 || content&#39; --query groonga --output_columns &#39;_key, _score&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         11
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">--match_columns</span> <span class="pre">'_key</span> <span class="pre">*</span> <span class="pre">10</span> <span class="pre">||</span> <span class="pre">content'</span></code> means the default target
columns for fulltext search are <code class="docutils literal notranslate"><span class="pre">_key</span></code> and <code class="docutils literal notranslate"><span class="pre">content</span></code> columns and
<code class="docutils literal notranslate"><span class="pre">_key</span></code> column’s weight is 10 and <code class="docutils literal notranslate"><span class="pre">content</span></code> column’s weight
is 1. This weight allocation means <code class="docutils literal notranslate"><span class="pre">_key</span></code> column value is more
important rather than <code class="docutils literal notranslate"><span class="pre">content</span></code> column value. In this example, title
of blog entry is more important rather thatn content of blog entry.</p>
<p>You can also specify score function. See <a class="reference internal" href="../scorer.html"><span class="doc">Scorer</span></a> for
details.</p>
<p>Note that score function isn’t related to <a class="reference internal" href="#select-scorer"><span class="std std-ref">scorer</span></a>
parameter.</p>
<p>You can also specify index columns to <code class="docutils literal notranslate"><span class="pre">--match_columns</span></code>
parameter. In such a case, you can control what index column should be
used and what data column should be searched explicitly.</p>
<p>If data column is specified to <code class="docutils literal notranslate"><span class="pre">--match_columns</span></code>, Groonga searches
related index column automatically, but it is not defined as a spec
that which index column is actually selected. Thus, if multiple index
columns are created against one data column, there is no way to know
which index column will be selected in advance. (In most cases, latest
created index column will be selected, but it is undocumented
behavior.)</p>
<p>Here is a use case how to specify index column.</p>
<ul class="simple">
<li><p>index column for one data column</p></li>
<li><p>index column for multiple data column</p></li>
</ul>
<p>If you use index column for one data column, index column which
corresponds to data column is paired. Thus,
<code class="docutils literal notranslate"><span class="pre">TERMS_TABLE.INDEX_COLUMN</span></code> should be specified. On the otherhand, if
you use index column for multiple data column, all data column is
searched by default. If you want to use specific multiple index column
to search specific data column, Specify index column with data column
name such as <code class="docutils literal notranslate"><span class="pre">TERMS_TABLE.INDEX_COLUMN.DATA_COLUMN</span></code>. See example use
case <a class="reference internal" href="../../tutorial/match_columns.html#full-text-search-with-specific-index-name"><span class="std std-ref">Full text search with specific index name</span></a> for details.</p>
</div>
<div class="section" id="query">
<span id="select-query"></span><h4><span class="section-number">7.3.57.4.2.2. </span><code class="docutils literal notranslate"><span class="pre">query</span></code><a class="headerlink" href="#query" title="Permalink to this headline">¶</a></h4>
<p>Specifies the query text. Normally, it is used for fulltext search
with <code class="docutils literal notranslate"><span class="pre">match_columns</span></code> parameter. <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter is designed for
a fulltext search form in a Web page. A query text should be formatted
in <a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a>. The syntax is similar to common search
form like Google’s search form. For example, <code class="docutils literal notranslate"><span class="pre">word1</span> <span class="pre">word2</span></code> means
that groonga searches records that contain both <code class="docutils literal notranslate"><span class="pre">word1</span></code> and
<code class="docutils literal notranslate"><span class="pre">word2</span></code>. <code class="docutils literal notranslate"><span class="pre">word1</span> <span class="pre">OR</span> <span class="pre">word2</span></code> means that groonga searches records that
contain either <code class="docutils literal notranslate"><span class="pre">word1</span></code> or <code class="docutils literal notranslate"><span class="pre">word2</span></code>.</p>
<p>Here is a simple logical and search example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query &quot;fast groonga&quot;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain two words
<code class="docutils literal notranslate"><span class="pre">fast</span></code> and <code class="docutils literal notranslate"><span class="pre">groonga</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code>
table.</p>
<p>Here is a simple logical or search example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query &quot;groonga OR mroonga&quot;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain one of two words
<code class="docutils literal notranslate"><span class="pre">groonga</span></code> or <code class="docutils literal notranslate"><span class="pre">mroonga</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from
<code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>See <a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a> for other syntax.</p>
<p>It can be used for not only fulltext search but also other
conditions. For example, <code class="docutils literal notranslate"><span class="pre">column:value</span></code> means the value of
<code class="docutils literal notranslate"><span class="pre">column</span></code> column is equal to <code class="docutils literal notranslate"><span class="pre">value</span></code>. <code class="docutils literal notranslate"><span class="pre">column:&lt;value</span></code> means the
value of <code class="docutils literal notranslate"><span class="pre">column</span></code> column is less than <code class="docutils literal notranslate"><span class="pre">value</span></code>.</p>
<p>Here is a simple equality operator search example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --query _key:Groonga
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that <code class="docutils literal notranslate"><span class="pre">_key</span></code> column value is
<code class="docutils literal notranslate"><span class="pre">Groonga</span></code> from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>Here is a simple less than operator search example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --query n_likes:&lt;11
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value
is less than <code class="docutils literal notranslate"><span class="pre">11</span></code> from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>See <a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a> for other operations.</p>
</div>
<div class="section" id="filter">
<span id="select-filter"></span><h4><span class="section-number">7.3.57.4.2.3. </span><code class="docutils literal notranslate"><span class="pre">filter</span></code><a class="headerlink" href="#filter" title="Permalink to this headline">¶</a></h4>
<p>Specifies the filter text. Normally, it is used for complex search
conditions. <code class="docutils literal notranslate"><span class="pre">filter</span></code> can be used with <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter. If both
<code class="docutils literal notranslate"><span class="pre">filter</span></code> and <code class="docutils literal notranslate"><span class="pre">query</span></code> are specified, there are conbined with
logical and. It means that matched records should be matched against
both <code class="docutils literal notranslate"><span class="pre">filter</span></code> and <code class="docutils literal notranslate"><span class="pre">query</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">filter</span></code> parameter is designed for complex conditions. A filter text
should be formatted in <a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a>. The syntax is
similar to ECMAScript. For example, <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">==</span> <span class="pre">&quot;value&quot;</span></code> means that
the value of <code class="docutils literal notranslate"><span class="pre">column</span></code> column is equal to <code class="docutils literal notranslate"><span class="pre">&quot;value&quot;</span></code>. <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">&lt;</span>
<span class="pre">value</span></code> means that the value of <code class="docutils literal notranslate"><span class="pre">column</span></code> column is less than
<code class="docutils literal notranslate"><span class="pre">value</span></code>.</p>
<p>Here is a simple equality operator search example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter &#39;_key == &quot;Groonga&quot;&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that <code class="docutils literal notranslate"><span class="pre">_key</span></code> column value is
<code class="docutils literal notranslate"><span class="pre">Groonga</span></code> from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>Here is a simple less than operator search example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter &#39;n_likes &lt; 11&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value
is less than <code class="docutils literal notranslate"><span class="pre">11</span></code> from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>See <a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a> for other operators.</p>
</div>
<div class="section" id="load-table">
<span id="select-load-table"></span><h4><span class="section-number">7.3.57.4.2.4. </span><code class="docutils literal notranslate"><span class="pre">load_table</span></code><a class="headerlink" href="#load-table" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 9.0.1.</span></p>
</div>
<p>You can store specified a table a result of <code class="docutils literal notranslate"><span class="pre">select</span></code> with <code class="docutils literal notranslate"><span class="pre">--load_table</span></code>, <code class="docutils literal notranslate"><span class="pre">--load-columns</span></code> and <code class="docutils literal notranslate"><span class="pre">--load_values</span></code> arguments.
<code class="docutils literal notranslate"><span class="pre">--load_table</span></code> specifies a table name for storing a result of <code class="docutils literal notranslate"><span class="pre">select</span></code>.</p>
<p>You must specify a table that already exists.</p>
<p>This argument must use with <a class="reference internal" href="#select-load-columns"><span class="std std-ref">load_columns</span></a> and <a class="reference internal" href="#select-load-values"><span class="std std-ref">load_values</span></a>.</p>
<p>Here is an example that can store <code class="docutils literal notranslate"><span class="pre">_id</span></code> and <code class="docutils literal notranslate"><span class="pre">timestamp</span></code> that a result of <code class="docutils literal notranslate"><span class="pre">select</span></code> in a Logs table specified by <code class="docutils literal notranslate"><span class="pre">--load_table</span></code>.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Logs_20150203 TABLE_HASH_KEY ShortText
column_create Logs_20150203 timestamp COLUMN_SCALAR Time

table_create Logs TABLE_HASH_KEY ShortText
column_create Logs original_id COLUMN_SCALAR UInt32
column_create Logs timestamp_text COLUMN_SCALAR ShortText

load --table Logs_20150203
[
{
  &quot;_key&quot;: &quot;2015-02-03:1&quot;,
  &quot;timestamp&quot;: &quot;2015-02-03 10:49:00&quot;
},
{
  &quot;_key&quot;: &quot;2015-02-03:2&quot;,
  &quot;timestamp&quot;: &quot;2015-02-03 12:49:00&quot;
}
]
select \
  --table Logs_20150203 \
  --load_table Logs \
  --load_columns &quot;original_id, timestamp_text&quot; \
  --load_values &quot;_id, timestamp&quot;
# [
#   [
#     0,
#     0.0,
#     0.0
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;timestamp&quot;,
#           &quot;Time&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;2015-02-03:1&quot;,
#         1422928140.0
#       ],
#       [
#         2,
#         &quot;2015-02-03:2&quot;,
#         1422935340.0
#       ]
#     ]
#   ]
# ]
select --table Logs
# [
#   [
#     0,
#     0.0,
#     0.0
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;original_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;timestamp_text&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;2015-02-03:1&quot;,
#         1,
#         &quot;1422928140000000&quot;
#       ],
#       [
#         2,
#         &quot;2015-02-03:2&quot;,
#         2,
#         &quot;1422935340000000&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="load-columns">
<span id="select-load-columns"></span><h4><span class="section-number">7.3.57.4.2.5. </span><code class="docutils literal notranslate"><span class="pre">load_columns</span></code><a class="headerlink" href="#load-columns" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 9.0.1.</span></p>
</div>
<p>Specifies columns of a table that specifying <code class="docutils literal notranslate"><span class="pre">--load-table</span></code>.
Stores value of columns that specified with <a class="reference internal" href="#select-load-values"><span class="std std-ref">load_values</span></a> in columns that specified with this argument.
You must specify columns that already exists.</p>
<p>This argument must use with <a class="reference internal" href="#select-load-table"><span class="std std-ref">load_table</span></a> and <a class="reference internal" href="#select-load-values"><span class="std std-ref">load_values</span></a>.</p>
<p>See example of <code class="docutils literal notranslate"><span class="pre">--load_table</span></code> for how to use this argument.</p>
</div>
<div class="section" id="load-values">
<span id="select-load-values"></span><h4><span class="section-number">7.3.57.4.2.6. </span><code class="docutils literal notranslate"><span class="pre">load_values</span></code><a class="headerlink" href="#load-values" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 9.0.1.</span></p>
</div>
<p>Specifies columns of result of <code class="docutils literal notranslate"><span class="pre">select</span></code>.
Specifies columns for storing values into columns that specified with <a class="reference internal" href="#select-load-columns"><span class="std std-ref">load_columns</span></a>.
You must specify columns that already exists.</p>
<p>This argument must use with <a class="reference internal" href="#select-load-table"><span class="std std-ref">load_table</span></a> and <a class="reference internal" href="#select-load-columns"><span class="std std-ref">load_columns</span></a>.</p>
<p>See example of <code class="docutils literal notranslate"><span class="pre">--load_table</span></code> for how to use this argument.</p>
</div>
</div>
<div class="section" id="advanced-search-parameters">
<span id="select-advanced-search-parameters"></span><h3><span class="section-number">7.3.57.4.3. </span>Advanced search parameters<a class="headerlink" href="#advanced-search-parameters" title="Permalink to this headline">¶</a></h3>
<div class="section" id="match-escalation-threshold">
<span id="select-match-escalation-threshold"></span><h4><span class="section-number">7.3.57.4.3.1. </span><code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code><a class="headerlink" href="#match-escalation-threshold" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 8.0.1.</span></p>
</div>
<p>Specifies threshold to determine whether search storategy
escalation is used or not. The threshold is compared against the
number of matched records. If the number of matched records is equal
to or less than the threshold, the search storategy escalation is
used. See <a class="reference internal" href="../../spec/search.html"><span class="doc">検索</span></a> about the search storategy escalation.</p>
<p>The default threshold is 0. It means that search storategy escalation
is used only when no records are matched.</p>
<p>The default threshold can be customized by one of the followings.</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--with-match-escalation-threshold</span></code> option of configure</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--match-escalation-threshold</span></code> option of groonga command</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">match-escalation-threshold</span></code> configuration item in configuration
file</p></li>
</ul>
</div></blockquote>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code> usage example. The
first <code class="docutils literal notranslate"><span class="pre">select</span></code> doesn’t have <code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code>
parameter. The second <code class="docutils literal notranslate"><span class="pre">select</span></code> has <code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code>
parameter.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query groo
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
select Entries --match_columns content --query groo --match_escalation_threshold -1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         0
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The first <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain a word
<code class="docutils literal notranslate"><span class="pre">groo</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table. But no
records are matched because the <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> tokenizer tokenizes
<code class="docutils literal notranslate"><span class="pre">groonga</span></code> to <code class="docutils literal notranslate"><span class="pre">groonga</span></code> not <code class="docutils literal notranslate"><span class="pre">gr|ro|oo|on|ng|ga</span></code>. (The
<code class="docutils literal notranslate"><span class="pre">TokenBigramSplitSymbolAlpha</span></code> tokenizer tokenizes <code class="docutils literal notranslate"><span class="pre">groonga</span></code> to
<code class="docutils literal notranslate"><span class="pre">gr|ro|oo|on|ng|ga</span></code>. See <a class="reference internal" href="../tokenizers.html"><span class="doc">Tokenizers</span></a> for details.)
It means that <code class="docutils literal notranslate"><span class="pre">groonga</span></code> is indexed but <code class="docutils literal notranslate"><span class="pre">groo</span></code> isn’t indexed. So no
records are matched against <code class="docutils literal notranslate"><span class="pre">groo</span></code> by exact match. In the case, the
search storategy escalation is used because the number of matched
records (0) is equal to <code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code> (0). One record
is matched against <code class="docutils literal notranslate"><span class="pre">groo</span></code> by unsplit search.</p>
<p>The second <code class="docutils literal notranslate"><span class="pre">select</span></code> command also searches records that contain a
word <code class="docutils literal notranslate"><span class="pre">groo</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table. And
it also doesn’t find matched records. In this case, the search
storategy escalation is not used because the number of matched
records (0) is larger than <code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code> (-1). So no
more searches aren’t executed. And no records are matched.</p>
</div>
<div class="section" id="match-escalation">
<span id="select-match-escalation"></span><h4><span class="section-number">7.3.57.4.3.2. </span><code class="docutils literal notranslate"><span class="pre">match_escalation</span></code><a class="headerlink" href="#match-escalation" title="Permalink to this headline">¶</a></h4>
<p>Specifies how to use match escalation. See also
<a class="reference internal" href="#select-match-escalation"><span class="std std-ref">match_escalation</span></a> and <a class="reference internal" href="../../spec/search.html"><span class="doc">検索</span></a> about the match
escalation.</p>
<p>Here are available values:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Value</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">auto</span></code></p></td>
<td><p>Groonga uses <a class="reference internal" href="#select-match-escalation-threshold"><span class="std std-ref">match_escalation_threshold</span></a> to
determine whether match escalation is used or not.</p>
<p>This is the default.</p>
</td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">yes</span></code></p></td>
<td><p>Groonga always uses match escalation.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">no</span></code></p></td>
<td><p>Groonga never use match escalation.</p></td>
</tr>
</tbody>
</table>
<p><code class="docutils literal notranslate"><span class="pre">--match_escalation</span> <span class="pre">yes</span></code> is stronger than
<code class="docutils literal notranslate"><span class="pre">--match_escalation_threshold</span> <span class="pre">9999...999</span></code>. <code class="docutils literal notranslate"><span class="pre">--filter</span> <span class="pre">'true</span> <span class="pre">&amp;&amp;</span>
<span class="pre">column</span> <span class="pre">&#64;</span> <span class="pre">&quot;query&quot;</span></code> with <code class="docutils literal notranslate"><span class="pre">--match_escalation</span> <span class="pre">yes</span></code> uses match
escalation. <code class="docutils literal notranslate"><span class="pre">--filter</span> <span class="pre">'true</span> <span class="pre">&amp;&amp;</span> <span class="pre">column</span> <span class="pre">&#64;</span> <span class="pre">&quot;query&quot;</span></code> with
<code class="docutils literal notranslate"><span class="pre">--match_escalation_threshold</span> <span class="pre">9999...999</span></code> doesn’t use match
escalation.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">match_escalation</span></code> usage example. The first
<code class="docutils literal notranslate"><span class="pre">select</span></code> doesn’t have <code class="docutils literal notranslate"><span class="pre">match_escalation</span></code> parameter. The
second <code class="docutils literal notranslate"><span class="pre">select</span></code> has <code class="docutils literal notranslate"><span class="pre">match_escalation</span></code> parameter.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --filter &#39;true &amp;&amp; content @ &quot;groo&quot;&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         0
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ]
#     ]
#   ]
# ]
select Entries --filter &#39;true &amp;&amp; content @ &quot;groo&quot;&#39; --match_escalation yes
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The first <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain a word
<code class="docutils literal notranslate"><span class="pre">groo</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table. But no
records are matched because the <code class="docutils literal notranslate"><span class="pre">TokenBigram</span></code> tokenizer tokenizes
<code class="docutils literal notranslate"><span class="pre">groonga</span></code> to <code class="docutils literal notranslate"><span class="pre">groonga</span></code> not <code class="docutils literal notranslate"><span class="pre">gr|ro|oo|on|ng|ga</span></code>.</p>
<p>The second <code class="docutils literal notranslate"><span class="pre">select</span></code> command also searches records that contain a
word <code class="docutils literal notranslate"><span class="pre">groo</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table. And
it uses match escalation. So it can find matched records.</p>
</div>
<div class="section" id="query-expansion">
<span id="select-query-expansion"></span><h4><span class="section-number">7.3.57.4.3.3. </span><code class="docutils literal notranslate"><span class="pre">query_expansion</span></code><a class="headerlink" href="#query-expansion" title="Permalink to this headline">¶</a></h4>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.0.2: </span>Use <a class="reference internal" href="#select-query-expander"><span class="std std-ref">query_expander</span></a> instead.</p>
</div>
</div>
<div class="section" id="query-flags">
<span id="select-query-flags"></span><h4><span class="section-number">7.3.57.4.3.4. </span><code class="docutils literal notranslate"><span class="pre">query_flags</span></code><a class="headerlink" href="#query-flags" title="Permalink to this headline">¶</a></h4>
<p>It customs <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter syntax. You cannot update column value
by <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter by default. But if you specify
<code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN|ALLOW_UPDATE</span></code> as <code class="docutils literal notranslate"><span class="pre">query_flags</span></code>, you can update
column value by <code class="docutils literal notranslate"><span class="pre">query</span></code>.</p>
<p>Here are available values:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">ALLOW_PRAGMA</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ALLOW_UPDATE</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ALLOW_LEADING_NOT</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">QUERY_NO_SYNTAX_ERROR</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">NONE</span></code></p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">ALLOW_PRAGMA</span></code> enables pragma at the head of <code class="docutils literal notranslate"><span class="pre">query</span></code>. This is not
implemented yet.</p>
<p><code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN</span></code> enables search againt columns that are not included
in <code class="docutils literal notranslate"><span class="pre">match_columns</span></code>. To specify column, there are <code class="docutils literal notranslate"><span class="pre">COLUMN:...</span></code>
syntaxes.</p>
<p><code class="docutils literal notranslate"><span class="pre">ALLOW_UPDATE</span></code> enables column update by <code class="docutils literal notranslate"><span class="pre">query</span></code> with
<code class="docutils literal notranslate"><span class="pre">COLUMN:=NEW_VALUE</span></code> syntax. <code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN</span></code> is also required to
update column because the column update syntax specifies column.</p>
<p><code class="docutils literal notranslate"><span class="pre">ALLOW_LEADING_NOT</span></code> enables leading NOT condition with <code class="docutils literal notranslate"><span class="pre">-WORD</span></code>
syntax. The query searches records that doesn’t match
<code class="docutils literal notranslate"><span class="pre">WORD</span></code>. Leading NOT condition query is heavy query in many cases
because it matches many records. So this flag is disabled by
default. Be careful about it when you use the flag.</p>
<p><code class="docutils literal notranslate"><span class="pre">QUERY_NO_SYNTAX_ERROR</span></code> enables never causes syntax error for query.
This flag is useful when an application uses user input directly and doesn’t want to show syntax error to the user and in a log.
This flag is disabled by default.</p>
<p><code class="docutils literal notranslate"><span class="pre">NONE</span></code> is just ignores. You can use <code class="docutils literal notranslate"><span class="pre">NONE</span></code> for specifying no flags.</p>
<p>They can be combined by separated <code class="docutils literal notranslate"><span class="pre">|</span></code> such as
<code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN|ALLOW_UPDATE</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">ALLOW_PRAGMA|ALLOW_COLUMN</span></code>.</p>
<p>Here is a usage example of <code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN</span></code>.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --query content:@mroonga --query_flags ALLOW_COLUMN
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain <code class="docutils literal notranslate"><span class="pre">mroonga</span></code> in
<code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>Here is a usage example of <code class="docutils literal notranslate"><span class="pre">ALLOW_UPDATE</span></code>.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Users age COLUMN_SCALAR UInt32
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Users
[
{&quot;_key&quot;: &quot;alice&quot;, &quot;age&quot;: 18},
{&quot;_key&quot;: &quot;bob&quot;,   &quot;age&quot;: 20}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
select Users --query age:=19 --query_flags ALLOW_COLUMN|ALLOW_UPDATE
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;age&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;alice&quot;,
#         19
#       ],
#       [
#         2,
#         &quot;bob&quot;,
#         19
#       ]
#     ]
#   ]
# ]
select Users
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;age&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;alice&quot;,
#         19
#       ],
#       [
#         2,
#         &quot;bob&quot;,
#         19
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The first <code class="docutils literal notranslate"><span class="pre">select</span></code> command sets <code class="docutils literal notranslate"><span class="pre">age</span></code> column value of all records
to <code class="docutils literal notranslate"><span class="pre">19</span></code>. The second <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs updated <code class="docutils literal notranslate"><span class="pre">age</span></code>
column values.</p>
<p>Here is a usage example of <code class="docutils literal notranslate"><span class="pre">ALLOW_LEADING_NOT</span></code>.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query -mroonga --query_flags ALLOW_LEADING_NOT
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         4
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that don’t contain <code class="docutils literal notranslate"><span class="pre">mroonga</span></code>
in <code class="docutils literal notranslate"><span class="pre">content</span></code> column value from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
<p>Here is a usage example of <code class="docutils literal notranslate"><span class="pre">QUERY_NO_SYNTAX_ERROR</span></code>.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create --name Magazine --flags TABLE_HASH_KEY --key_type ShortText
# [[0,1546673320.275529,0.08708477020263672],true]
column_create --table Magazine --name title --type ShortText
# [[0,1546673346.042032,0.09989762306213379],true]
load --table Magazine
[
{&quot;_key&quot;:&quot;http://test.jp/magazine/webplus&quot;,&quot;title&quot;:&quot;WEB+&quot;},
{&quot;_key&quot;:&quot;http://test.jp/magazine/database&quot;,&quot;title&quot;:&quot;DataBase&quot;},
]
# [[0,1546673366.725134,0.0009036064147949219],2]
select Magazine --output_pretty yes --match_columns title --query &#39;WEB +&#39;  --query_flags ALLOW_PRAGMA|ALLOW_COLUMN|QUERY_NO_SYNTAX_ERROR
# [
#   [
#     0,
#     1546673389.499156,
#     0.04232335090637207
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;title&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;http://test.jp/magazine/webplus&quot;,
#         &quot;WEB+&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>If you don’t specify this flag, this query of example causes a syntax error as below.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create --name Magazine --flags TABLE_HASH_KEY --key_type ShortText
# [[0,1546673320.275529,0.08708477020263672],true]
column_create --table Magazine --name title --type ShortText
# [[0,1546673346.042032,0.09989762306213379],true]
load --table Magazine
[
{&quot;_key&quot;:&quot;http://test.jp/magazine/webplus&quot;,&quot;title&quot;:&quot;WEB+&quot;},
{&quot;_key&quot;:&quot;http://test.jp/magazine/database&quot;,&quot;title&quot;:&quot;DataBase&quot;},
]
# [[0,1546673366.725134,0.0009036064147949219],2]
select Magazine --output_pretty yes --match_columns title --query &#39;WEB +&#39;  --query_flags ALLOW_PRAGMA|ALLOW_COLUMN
# [
#   [
#     -63,
#     1546674147.89755,
#     0.0006532669067382812,
#     &quot;Syntax error: &lt;WEB +||&gt;&quot;,
#     [
#       [
#         &quot;yy_syntax_error&quot;,
#         &quot;grn_ecmascript.lemon&quot;,
#         37
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>Here is a usage example of <code class="docutils literal notranslate"><span class="pre">NONE</span></code>.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query &#39;mroonga OR _key:Groonga&#39; --query_flags NONE
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command searches records that contain one of two words
<code class="docutils literal notranslate"><span class="pre">mroonga</span></code> or <code class="docutils literal notranslate"><span class="pre">_key:Groonga</span></code> in <code class="docutils literal notranslate"><span class="pre">content</span></code> from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.
Note that <code class="docutils literal notranslate"><span class="pre">_key:Groonga</span></code> doesn’t mean that the value of <code class="docutils literal notranslate"><span class="pre">_key</span></code>
column is equal to <code class="docutils literal notranslate"><span class="pre">Groonga</span></code>. Because <code class="docutils literal notranslate"><span class="pre">ALLOW_COLUMN</span></code> flag is not
specified.</p>
<p>See also <a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a>.</p>
</div>
<div class="section" id="query-expander">
<span id="select-query-expander"></span><h4><span class="section-number">7.3.57.4.3.5. </span><code class="docutils literal notranslate"><span class="pre">query_expander</span></code><a class="headerlink" href="#query-expander" title="Permalink to this headline">¶</a></h4>
<p>It’s for query expansion. Query expansion substitutes specific words
to another words in query. Nomally, it’s used for synonym search.</p>
<p>It specifies a column that is used to substitute <code class="docutils literal notranslate"><span class="pre">query</span></code> parameter
value. The format of this parameter value is
“<code class="docutils literal notranslate"><span class="pre">${TABLE}.${COLUMN}</span></code>”. For example, “<code class="docutils literal notranslate"><span class="pre">Terms.synonym</span></code>” specifies
<code class="docutils literal notranslate"><span class="pre">synonym</span></code> column in <code class="docutils literal notranslate"><span class="pre">Terms</span></code> table.</p>
<p>Table for query expansion is called “substitution table”. Substitution
table’s key must be <code class="docutils literal notranslate"><span class="pre">ShortText</span></code>. So array table (<code class="docutils literal notranslate"><span class="pre">TABLE_NO_KEY</span></code>)
can’t be used for query expansion. Because array table doesn’t have
key.</p>
<p>Column for query expansion is called “substitution
column”. Substitution column’s value type must be
<code class="docutils literal notranslate"><span class="pre">ShortText</span></code>. Column type must be vector (<code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code>).</p>
<p>Query expansion substitutes key of substitution table in query with
values in substitution column. If a word in <code class="docutils literal notranslate"><span class="pre">query</span></code> is a key of
substitution table, the word is substituted with substitution column
value that is associated with the key. Substition isn’t performed
recursively. It means that substitution target words in substituted
query aren’t substituted.</p>
<p>Here is a sample substitution table to show a simple
<code class="docutils literal notranslate"><span class="pre">query_expander</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Thesaurus TABLE_PAT_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Thesaurus synonym COLUMN_VECTOR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Thesaurus
[
{&quot;_key&quot;: &quot;mroonga&quot;, &quot;synonym&quot;: [&quot;mroonga&quot;, &quot;tritonn&quot;, &quot;groonga mysql&quot;]},
{&quot;_key&quot;: &quot;groonga&quot;, &quot;synonym&quot;: [&quot;groonga&quot;, &quot;senna&quot;]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Thesaurus</span></code> substitution table has two synonyms, <code class="docutils literal notranslate"><span class="pre">&quot;mroonga&quot;</span></code> and
<code class="docutils literal notranslate"><span class="pre">&quot;groonga&quot;</span></code>. If an user searches with <code class="docutils literal notranslate"><span class="pre">&quot;mroonga&quot;</span></code>, Groonga
searches with <code class="docutils literal notranslate"><span class="pre">&quot;((mroonga)</span> <span class="pre">OR</span> <span class="pre">(tritonn)</span> <span class="pre">OR</span> <span class="pre">(groonga</span> <span class="pre">mysql))&quot;</span></code>. If an
user searches with <code class="docutils literal notranslate"><span class="pre">&quot;groonga&quot;</span></code>, Groonga searches with <code class="docutils literal notranslate"><span class="pre">&quot;((groonga)</span>
<span class="pre">OR</span> <span class="pre">(senna))&quot;</span></code>.</p>
<p>Normally, it’s good idea that substitution table uses a
normalizer. For example, if normalizer is used, substitute target word
is matched in case insensitive manner. See
<a class="reference internal" href="../normalizers.html"><span class="doc">Normalizers</span></a> for available normalizers.</p>
<p>Note that those synonym values include the key value such as
<code class="docutils literal notranslate"><span class="pre">&quot;mroonga&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;groonga&quot;</span></code>. It’s recommended that you include the
key value. If you don’t include key value, substituted value doesn’t
include the original substitute target value. Normally, including the
original value is better search result. If you have a word that you
don’t want to be searched, you should not include the original
word. For example, you can implement “stop words” by an empty vector
value.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">query_expander</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query &quot;mroonga&quot;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         1
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
select Entries --match_columns content --query &quot;mroonga&quot; --query_expander Thesaurus.synonym
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
select Entries --match_columns content --query &quot;((mroonga) OR (tritonn) OR (groonga mysql))&quot;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The first <code class="docutils literal notranslate"><span class="pre">select</span></code> command doesn’t use query expansion. So a record
that has <code class="docutils literal notranslate"><span class="pre">&quot;tritonn&quot;</span></code> isn’t found. The second <code class="docutils literal notranslate"><span class="pre">select</span></code> command uses
query expansion. So a record that has <code class="docutils literal notranslate"><span class="pre">&quot;tritonn&quot;</span></code> is found. The
third <code class="docutils literal notranslate"><span class="pre">select</span></code> command doesn’t use query expansion but it is same as
the second <code class="docutils literal notranslate"><span class="pre">select</span></code> command. The third one uses expanded query.</p>
<p>Each substitute value can contain any <a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a> syntax
such as <code class="docutils literal notranslate"><span class="pre">(...)</span></code> and <code class="docutils literal notranslate"><span class="pre">OR</span></code>. You can use complex substitution by
using those syntax.</p>
<p>Here is a complex substitution usage example that uses query syntax.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Thesaurus
[
{&quot;_key&quot;: &quot;popular&quot;, &quot;synonym&quot;: [&quot;popular&quot;, &quot;n_likes:&gt;=10&quot;]}
]
# [[0, 1337566253.89858, 0.000355720520019531], 1]
select Entries --match_columns content --query &quot;popular&quot; --query_expander Thesaurus.synonym
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">load</span></code> command registers a new synonym <code class="docutils literal notranslate"><span class="pre">&quot;popular&quot;</span></code>. It is
substituted with <code class="docutils literal notranslate"><span class="pre">((popular)</span> <span class="pre">OR</span> <span class="pre">(n_likes:&gt;=10))</span></code>. The substituted
query means that “popular” is containing the word “popular” or 10 or
more liked entries.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs records that <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value
is equal to or more than <code class="docutils literal notranslate"><span class="pre">10</span></code> from <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table.</p>
</div>
</div>
<div class="section" id="output-related-parameters">
<h3><span class="section-number">7.3.57.4.4. </span>Output related parameters<a class="headerlink" href="#output-related-parameters" title="Permalink to this headline">¶</a></h3>
<div class="section" id="output-columns">
<span id="select-output-columns"></span><h4><span class="section-number">7.3.57.4.4.1. </span><code class="docutils literal notranslate"><span class="pre">output_columns</span></code><a class="headerlink" href="#output-columns" title="Permalink to this headline">¶</a></h4>
<p>Specifies output columns separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">output_columns</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns &#39;_id, _key&#39; --limit 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command just outputs <code class="docutils literal notranslate"><span class="pre">_id</span></code> and <code class="docutils literal notranslate"><span class="pre">_key</span></code> column
values.</p>
<p><code class="docutils literal notranslate"><span class="pre">*</span></code> is a special value. It means that all columns that are not
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a>.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">*</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --output_columns &#39;_key, *&#39; --limit 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs <code class="docutils literal notranslate"><span class="pre">_key</span></code> pseudo column, <code class="docutils literal notranslate"><span class="pre">content</span></code>
column and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values but doesn’t output <code class="docutils literal notranslate"><span class="pre">_id</span></code> pseudo
column value.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">_id,</span> <span class="pre">_key,</span> <span class="pre">*</span></code>. It means that all column
values except <code class="docutils literal notranslate"><span class="pre">_score</span></code> are outputted.</p>
</div>
<div class="section" id="sortby">
<span id="select-sortby"></span><h4><span class="section-number">7.3.57.4.4.2. </span><code class="docutils literal notranslate"><span class="pre">sortby</span></code><a class="headerlink" href="#sortby" title="Permalink to this headline">¶</a></h4>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 6.0.3: </span>Use <a class="reference internal" href="#select-sort-keys"><span class="std std-ref">sort_keys</span></a> instead.</p>
</div>
</div>
<div class="section" id="sort-keys">
<span id="select-sort-keys"></span><h4><span class="section-number">7.3.57.4.4.3. </span><code class="docutils literal notranslate"><span class="pre">sort_keys</span></code><a class="headerlink" href="#sort-keys" title="Permalink to this headline">¶</a></h4>
<p>Specifies sort keys separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>. Each sort key is column
name.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">sort_keys</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --sort_keys &#39;n_likes, _id&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command sorts by <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value in ascending
order. For records that has the same <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> are sorted by <code class="docutils literal notranslate"><span class="pre">_id</span></code>
in ascending order. <code class="docutils literal notranslate"><span class="pre">&quot;Good-bye</span> <span class="pre">Senna&quot;</span></code> and <code class="docutils literal notranslate"><span class="pre">&quot;Good-bye</span> <span class="pre">Tritonn&quot;</span></code>
are the case.</p>
<p>If you want to sort in descending order, add <code class="docutils literal notranslate"><span class="pre">-</span></code> before column name.</p>
<p>Here is a descending order <code class="docutils literal notranslate"><span class="pre">sort_keys</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --sort_keys &#39;-n_likes, _id&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command sorts by <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value in descending
order. But ascending order is used for sorting by <code class="docutils literal notranslate"><span class="pre">_id</span></code>.</p>
<p>You can use <code class="docutils literal notranslate"><span class="pre">_score</span></code> pseudo column in <code class="docutils literal notranslate"><span class="pre">sort_keys</span></code> if you use
<code class="docutils literal notranslate"><span class="pre">query</span></code> or <code class="docutils literal notranslate"><span class="pre">filter</span></code> parameter.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --match_columns content --query fast --sort_keys -_score --output_columns &#39;_key, _score&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Mroonga&quot;,
#         2
#       ],
#       [
#         &quot;Groonga&quot;,
#         1
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command sorts matched records by hit score in
descending order and outputs record key and hit score.</p>
<p>If you use <code class="docutils literal notranslate"><span class="pre">_score</span></code> without <code class="docutils literal notranslate"><span class="pre">query</span></code> nor <code class="docutils literal notranslate"><span class="pre">filter</span></code> parameters,
it’s just ignored but get a warning in log file.</p>
</div>
<div class="section" id="offset">
<span id="select-offset"></span><h4><span class="section-number">7.3.57.4.4.4. </span><code class="docutils literal notranslate"><span class="pre">offset</span></code><a class="headerlink" href="#offset" title="Permalink to this headline">¶</a></h4>
<p>Specifies offset to determine output records range. Offset is
zero-based. <code class="docutils literal notranslate"><span class="pre">--offset</span> <span class="pre">1</span></code> means output range is started from the 2nd
record.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --sort_keys _id --offset 3 --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;Good-bye Senna&quot;
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs from the 4th record.</p>
<p>You can specify negative value. It means that <code class="docutils literal notranslate"><span class="pre">the</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">matched</span>
<span class="pre">records</span> <span class="pre">+</span> <span class="pre">offset</span></code>. If you have 3 matched records and specify
<code class="docutils literal notranslate"><span class="pre">--offset</span> <span class="pre">-2</span></code>, you get records from the 2nd (<code class="docutils literal notranslate"><span class="pre">3</span> <span class="pre">+</span> <span class="pre">-2</span> <span class="pre">=</span> <span class="pre">1</span></code>. <code class="docutils literal notranslate"><span class="pre">1</span></code>
means 2nd. Remember that offset is zero-based.) record to the 3rd
record.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --sort_keys _id --offset -2 --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;Good-bye Senna&quot;
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs from the 4th record because the total
number of records is <code class="docutils literal notranslate"><span class="pre">5</span></code>.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
</div>
<div class="section" id="limit">
<span id="select-limit"></span><h4><span class="section-number">7.3.57.4.4.5. </span><code class="docutils literal notranslate"><span class="pre">limit</span></code><a class="headerlink" href="#limit" title="Permalink to this headline">¶</a></h4>
<p>Specifies the max number of output records. If the number of
matched records is less than <code class="docutils literal notranslate"><span class="pre">limit</span></code>, all records are outputted.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">limit</span></code> usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --sort_keys _id --offset 2 --limit 3 --output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;Mroonga&quot;
#       ],
#       [
#         &quot;Good-bye Senna&quot;
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs the 3rd, the 4th and the 5th records.</p>
<p>You can specify negative value. It means that <code class="docutils literal notranslate"><span class="pre">the</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">matched</span>
<span class="pre">records</span> <span class="pre">+</span> <span class="pre">limit</span> <span class="pre">+</span> <span class="pre">1</span></code>. For example, <code class="docutils literal notranslate"><span class="pre">--limit</span> <span class="pre">-1</span></code> outputs all
records. It’s very useful value to show all records.</p>
<p>Here is a simple negative <code class="docutils literal notranslate"><span class="pre">limit</span></code> value usage example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --limit -1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs all records.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">10</span></code>.</p>
</div>
<div class="section" id="scorer">
<span id="select-scorer"></span><h4><span class="section-number">7.3.57.4.4.6. </span><code class="docutils literal notranslate"><span class="pre">scorer</span></code><a class="headerlink" href="#scorer" title="Permalink to this headline">¶</a></h4>
<p>TODO: write in English and add example.</p>
<p>検索条件にマッチする全てのレコードに対して適用するgrn_exprをscript形式で指定します。</p>
<p>scorerは、検索処理が完了し、ソート処理が実行される前に呼び出されます。従って、各レコードのスコアを操作する式を指定しておけば、検索結果のソート順序をカスタマイズできるようになります。</p>
</div>
</div>
<div class="section" id="dynamic-column-related-parameters">
<span id="select-dynamic-column-related-parameters"></span><h3><span class="section-number">7.3.57.4.5. </span>Dynamic column related parameters<a class="headerlink" href="#dynamic-column-related-parameters" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>This section describes dynamic column related parameters. You can use
dynamic column for window function but this section doesn’t describe
window function. See <a class="reference internal" href="#select-window-function-related-parameters"><span class="std std-ref">Window function related parameters</span></a>
for window function.</p>
<p>You can create zero or more columns and fill values into these columns
while a <code class="docutils literal notranslate"><span class="pre">select</span></code> execution. These columns are called as “dynamic
columns”. You can use dynamic columns as same as normal columns after
dynamic columns are created.</p>
<p>Dynamic column has performance merit because its values are computed
at once and reused computed values.</p>
<p>Dynamic column increases memory usage because its values are kept
while the <code class="docutils literal notranslate"><span class="pre">select</span></code> execution.</p>
<p>You need to use dynamic column in the following cases:</p>
<blockquote>
<div><ul class="simple">
<li><p>You want to name values like <code class="docutils literal notranslate"><span class="pre">AS</span></code> in SQL.</p></li>
<li><p>You want to use computed values for drilldown. Groonga doesn’t
support drilldown target value computation in drilldown.</p></li>
<li><p>You want to use window function.</p></li>
</ul>
</div></blockquote>
<p>There are some points to create dynamic columns. You must specify
<code class="docutils literal notranslate"><span class="pre">stage</span></code> to each dynamic column to control dynamic columns creation
points. It’s important that you choose proper point to get better
performance.</p>
<p>For example, it’s not a good idea that you create a dynamic column
that is only used for output for all records. The number of output
records will be a little even if there are many records in a
table. Because you will filter, sort and limit all records and output
only the limited records in many cases.</p>
<p>See <a class="reference internal" href="#select-columns-name-stage"><span class="std std-ref">columns[${NAME}].stage</span></a> for <code class="docutils literal notranslate"><span class="pre">stage</span></code> detail.</p>
<p>Here are parameters for dynamic column. They don’t include window
function related parameters. See
<a class="reference internal" href="#select-window-function-related-parameters"><span class="std std-ref">Window function related parameters</span></a> for window function
related parameters:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Default value</p></th>
<th class="head"><p>Required or optional</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].stage</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
<td><p>Required</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].flags</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].type</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
<td><p>Required</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].value</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">null</span></code></p></td>
<td><p>Required</p></td>
</tr>
</tbody>
</table>
<p>You need to specify multiple parameters for a dynamic
column. <code class="docutils literal notranslate"><span class="pre">${NAME}</span></code> is the name for each dynamic column. Parameters
that use the same <code class="docutils literal notranslate"><span class="pre">${NAME}</span></code> are treated as parameters for the same
dynamic column. Here is an example to specify parameters for 2 dynamic
columns (<code class="docutils literal notranslate"><span class="pre">name1</span></code> and <code class="docutils literal notranslate"><span class="pre">name2</span></code>):</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>--columns[name1].stage initial
--columns[name1].type UInt32
--columns[name1].value 29

--columns[name2].stage filtered
--columns[name2].type ShortText
--columns[name2].value &quot;29&quot;
</pre></div>
</div>
<div class="section" id="columns-name-stage">
<span id="select-columns-name-stage"></span><h4><span class="section-number">7.3.57.4.5.1. </span><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].stage</span></code><a class="headerlink" href="#columns-name-stage" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>Specifies when the dynamic column is created. This is a required
parameter to create a dynamic column.</p>
<p>Here are available stages:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initial</span></code></p></td>
<td><p>Dynamic column is created at first.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">filtered</span></code></p></td>
<td><p>Dynamic column is created after <a class="reference internal" href="#select-query"><span class="std std-ref">query</span></a> and
<a class="reference internal" href="#select-filter"><span class="std std-ref">filter</span></a> are evaluated.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">output</span></code></p></td>
<td><p>Dynamic column is created before <a class="reference internal" href="#select-output-columns"><span class="std std-ref">output_columns</span></a>
is evaluated.</p></td>
</tr>
</tbody>
</table>
<p>Here is the <code class="docutils literal notranslate"><span class="pre">select</span></code> process flow with dynamic column creation
points. You should choose stage as late as possible:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>Creates dynamic columns for <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage. All records have
these dynamic columns.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-query"><span class="std std-ref">query</span></a> and <a class="reference internal" href="#select-filter"><span class="std std-ref">filter</span></a>. You can
use dynamic columns created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage.</p></li>
<li><p>Creates dynamic columns for <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage. Only filtered
records have these dynamic columns.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-adjuster"><span class="std std-ref">adjuster</span></a>. You can use dynamic columns
created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage and <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-scorer"><span class="std std-ref">scorer</span></a>. You can use dynamic columns
created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage and <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-sort-keys"><span class="std std-ref">sort_keys</span></a>, <a class="reference internal" href="#select-offset"><span class="std std-ref">offset</span></a> and
<a class="reference internal" href="#select-limit"><span class="std std-ref">limit</span></a>. You can use dynamic columns created in
<code class="docutils literal notranslate"><span class="pre">initial</span></code> stage and <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-slice-related-parameters"><span class="std std-ref">Slice related parameters</span></a>. You can use
dynamic columns created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage and <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-drilldown-related-parameters"><span class="std std-ref">Drilldown related parameters</span></a> and
<a class="reference internal" href="#select-advanced-drilldown-related-parameters"><span class="std std-ref">Advanced drilldown related parameters</span></a>. You can use
dynamic columns created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage and <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.
Note that you can create dynamic columns in each drilldown.</p></li>
<li><p>Creates dynamic columns for <code class="docutils literal notranslate"><span class="pre">output</span></code> stage. Only
<a class="reference internal" href="#select-limit"><span class="std std-ref">limit</span></a> records have these dynamic columns.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-output-columns"><span class="std std-ref">output_columns</span></a>. You can use dynamic
columns created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage, <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage and
<code class="docutils literal notranslate"><span class="pre">output</span></code> stage.</p></li>
</ol>
</div></blockquote>
<p>Here is an example that creates <code class="docutils literal notranslate"><span class="pre">is_popular</span></code> column at <code class="docutils literal notranslate"><span class="pre">initial</span></code>
stage. You can use <code class="docutils literal notranslate"><span class="pre">is_popular</span></code> in all parameters such as <code class="docutils literal notranslate"><span class="pre">filter</span></code>
and <code class="docutils literal notranslate"><span class="pre">output_columns</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --columns[is_popular].stage initial \
  --columns[is_popular].type Bool \
  --columns[is_popular].value &#39;n_likes &gt;= 10&#39; \
  --filter is_popular \
  --output_columns _id,is_popular,n_likes
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;is_popular&quot;,
#           &quot;Bool&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         2,
#         true,
#         10
#       ],
#       [
#         3,
#         true,
#         15
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="columns-name-flags">
<span id="select-columns-name-flags"></span><h4><span class="section-number">7.3.57.4.5.2. </span><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].flags</span></code><a class="headerlink" href="#columns-name-flags" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>Specifies flags for the dynamic column. It’s the same as <code class="docutils literal notranslate"><span class="pre">flags</span></code>
parameter for <a class="reference internal" href="column_create.html"><span class="doc">column_create</span></a>. See <a class="reference internal" href="column_create.html#column-create-flags"><span class="std std-ref">flags</span></a> for
available flags.</p>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">COLUMN_SCALAR</span></code>.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].flags</span></code> example. It creates a vector
column by <code class="docutils literal notranslate"><span class="pre">COLUMN_VECTOR</span></code> flags. <code class="docutils literal notranslate"><span class="pre">plugin_register</span>
<span class="pre">functions/vector</span></code> is for using <a class="reference internal" href="../functions/vector_new.html"><span class="doc">vector_new</span></a>
function:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register functions/vector
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Entries \
  --columns[vector].stage initial \
  --columns[vector].flags COLUMN_VECTOR \
  --columns[vector].type UInt32 \
  --columns[vector].value &#39;vector_new(1, 2, 3)&#39; \
  --output_columns _id,vector
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;vector&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         [
#           1,
#           2,
#           3
#         ]
#       ],
#       [
#         2,
#         [
#           1,
#           2,
#           3
#         ]
#       ],
#       [
#         3,
#         [
#           1,
#           2,
#           3
#         ]
#       ],
#       [
#         4,
#         [
#           1,
#           2,
#           3
#         ]
#       ],
#       [
#         5,
#         [
#           1,
#           2,
#           3
#         ]
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="columns-name-type">
<span id="select-columns-name-type"></span><h4><span class="section-number">7.3.57.4.5.3. </span><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].type</span></code><a class="headerlink" href="#columns-name-type" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>Specifies value type for the dynamic column. It’s the same as <code class="docutils literal notranslate"><span class="pre">type</span></code>
parameter for <a class="reference internal" href="column_create.html"><span class="doc">column_create</span></a>. See <a class="reference internal" href="column_create.html#column-create-type"><span class="std std-ref">type</span></a> for
available types.</p>
<p>This is a required parameter.</p>
<p>Here is an example that creates a <code class="docutils literal notranslate"><span class="pre">ShortText</span></code> type column. Stored
value is casted to <code class="docutils literal notranslate"><span class="pre">ShortText</span></code> automatically. In this example,
number is casted to <code class="docutils literal notranslate"><span class="pre">ShortText</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --columns[n_likes_string].stage initial \
  --columns[n_likes_string].type ShortText \
  --columns[n_likes_string].value n_likes \
  --output_columns _id,n_likes,n_likes_string
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes_string&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         5,
#         &quot;5&quot;
#       ],
#       [
#         2,
#         10,
#         &quot;10&quot;
#       ],
#       [
#         3,
#         15,
#         &quot;15&quot;
#       ],
#       [
#         4,
#         3,
#         &quot;3&quot;
#       ],
#       [
#         5,
#         3,
#         &quot;3&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="columns-name-value">
<span id="select-columns-name-value"></span><h4><span class="section-number">7.3.57.4.5.4. </span><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].value</span></code><a class="headerlink" href="#columns-name-value" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>Specifies expression that generates values for the dynamic column. The
expression uses <a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a>. It’s the
same syntax in <a class="reference internal" href="#select-filter"><span class="std std-ref">filter</span></a>. For example, <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">+</span> <span class="pre">1</span></code>,
<code class="docutils literal notranslate"><span class="pre">string_length(&quot;Hello&quot;)</span></code>, <code class="docutils literal notranslate"><span class="pre">column</span> <span class="pre">*</span> <span class="pre">1.08</span></code> and so on are valid
expressions.</p>
<p>You need to specify <a class="reference internal" href="../window_function.html"><span class="doc">Window function</span></a> as <code class="docutils literal notranslate"><span class="pre">value</span></code>
value and other window function related parameters when you use window
function. See <a class="reference internal" href="#select-window-function-related-parameters"><span class="std std-ref">Window function related parameters</span></a> for
details.</p>
<p>This is a required parameter.</p>
<p>Here is an example that creates a new dynamic column that stores the
number of characters of content. This example uses
<a class="reference internal" href="../functions/string_length.html"><span class="doc">string_length</span></a> function in
<code class="docutils literal notranslate"><span class="pre">functions/string</span></code> plugin to compute the number of characters in a
string. <a class="reference internal" href="plugin_register.html"><span class="doc">plugin_register</span></a> is used to register
<code class="docutils literal notranslate"><span class="pre">functions/string</span></code> plugin:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>plugin_register functions/string
# [[0, 1337566253.89858, 0.000355720520019531], true]
select Entries \
  --columns[content_length].stage initial \
  --columns[content_length].type UInt32 \
  --columns[content_length].value &#39;string_length(content)&#39; \
  --output_columns _id,content,content_length
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;content_length&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;Welcome! This is my first post!&quot;,
#         31
#       ],
#       [
#         2,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         41
#       ],
#       [
#         3,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         64
#       ],
#       [
#         4,
#         &quot;I migrated all Senna system!&quot;,
#         28
#       ],
#       [
#         5,
#         &quot;I also migrated all Tritonn system!&quot;,
#         35
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
</div>
<div class="section" id="window-function-related-parameters">
<span id="select-window-function-related-parameters"></span><h3><span class="section-number">7.3.57.4.6. </span>Window function related parameters<a class="headerlink" href="#window-function-related-parameters" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>This section describes window function related parameters. You need to
use dynamic column for using window function. See
<a class="reference internal" href="#select-dynamic-column-related-parameters"><span class="std std-ref">Dynamic column related parameters</span></a> for dynamic column.</p>
<p>Window function in Groonga is similar to window function in
SQL. Normal function computes its result with only the current
record. On the other hand, window function computes its result with
multiple records. Window function is useful to data analysis because
it can process multiple records.</p>
<p>You can find supported window functions at
<a class="reference internal" href="../window_function.html"><span class="doc">Window function</span></a>. For example,
<a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> is a window function. It
sums numbers in the target records.</p>
<p>Window function processes records that are grouped by the specified
group keys. For example, window function processes three groups
(<code class="docutils literal notranslate"><span class="pre">Hello</span></code> group, <code class="docutils literal notranslate"><span class="pre">Groonga</span></code> group and <code class="docutils literal notranslate"><span class="pre">Senna</span></code> group) in the
following case. <a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> sums
<code class="docutils literal notranslate"><span class="pre">n_likes</span></code> values in each group:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Group No.</p></th>
<th class="head"><p>Group key value</p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">n_likes</span></code> value</p></th>
<th class="head"><p><a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> result</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Hello</span></code></p></td>
<td><p>5</p></td>
<td><p>5</p></td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Groonga</span></code></p></td>
<td><p>10</p></td>
<td><p>25</p></td>
</tr>
<tr class="row-even"><td><p>2</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Groonga</span></code></p></td>
<td><p>15</p></td>
<td><p>25</p></td>
</tr>
<tr class="row-odd"><td><p>3</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Senna</span></code></p></td>
<td><p>3</p></td>
<td><p>6</p></td>
</tr>
<tr class="row-even"><td><p>3</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Senna</span></code></p></td>
<td><p>3</p></td>
<td><p>6</p></td>
</tr>
</tbody>
</table>
<p>You can specify no group keys. In the case, window function processes
only one group that includes all
records. <a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> sums all
<code class="docutils literal notranslate"><span class="pre">n_likes</span></code> values in the following case:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Group No.</p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">n_likes</span></code> value</p></th>
<th class="head"><p><a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> result</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1</p></td>
<td><p>5</p></td>
<td><p>36</p></td>
</tr>
<tr class="row-odd"><td><p>1</p></td>
<td><p>10</p></td>
<td><p>36</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>15</p></td>
<td><p>36</p></td>
</tr>
<tr class="row-odd"><td><p>1</p></td>
<td><p>3</p></td>
<td><p>36</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>3</p></td>
<td><p>36</p></td>
</tr>
</tbody>
</table>
<p>Window function processes records in each group in the specified
order. You can specify no sort keys like the above group keys
example.</p>
<p>The behavior when you specify no sort keys depends on each window
function specification. For example,
<a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> uses different behavior
whether sort keys are specified or not. If you specify not sort keys,
<a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> sums values of all
records in the group and puts it to all target records like the above
group keys example. If you specify sort keys,
<a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> behaves as cumulative
sum. <a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> sums values of all
records in the group in sequence and puts the current sum to the
current record like the following:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 17%" />
<col style="width: 17%" />
<col style="width: 17%" />
<col style="width: 17%" />
<col style="width: 17%" />
<col style="width: 17%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Group No.</p></th>
<th class="head"><p>Group key value</p></th>
<th class="head"><p>Sort key value</p></th>
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">n_likes</span></code> value</p></th>
<th class="head"><p><a class="reference internal" href="../window_functions/window_sum.html"><span class="doc">window_sum</span></a> result</p></th>
<th class="head"><p>Note</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Hello</span></code></p></td>
<td><p>1</p></td>
<td><p>5</p></td>
<td><p>5</p></td>
<td><p>The first record in group No. 1. (<code class="docutils literal notranslate"><span class="pre">5</span> <span class="pre">=</span> <span class="pre">5</span></code>)</p></td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Groonga</span></code></p></td>
<td><p>90</p></td>
<td><p>10</p></td>
<td><p>10</p></td>
<td><p>The first record in group No. 2. (<code class="docutils literal notranslate"><span class="pre">10</span> <span class="pre">=</span> <span class="pre">10</span></code>)</p></td>
</tr>
<tr class="row-even"><td><p>2</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Groonga</span></code></p></td>
<td><p>91</p></td>
<td><p>15</p></td>
<td><p>25</p></td>
<td><p>The second record in group No. 2. (<code class="docutils literal notranslate"><span class="pre">10</span> <span class="pre">+</span> <span class="pre">15</span> <span class="pre">=</span> <span class="pre">25</span></code>)</p></td>
</tr>
<tr class="row-odd"><td><p>3</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Senna</span></code></p></td>
<td><p>200</p></td>
<td><p>3</p></td>
<td><p>8</p></td>
<td><p>The second record in group No. 3. (<code class="docutils literal notranslate"><span class="pre">5</span> <span class="pre">+</span> <span class="pre">3</span> <span class="pre">=</span> <span class="pre">8</span></code>)</p></td>
</tr>
<tr class="row-even"><td><p>3</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">Senna</span></code></p></td>
<td><p>100</p></td>
<td><p>5</p></td>
<td><p>5</p></td>
<td><p>The first record in group No. 3. (<code class="docutils literal notranslate"><span class="pre">5</span> <span class="pre">=</span> <span class="pre">5</span></code>)</p></td>
</tr>
</tbody>
</table>
<p>Here are parameters for window function. You need to specify both
window function related parameters and required dynamic columns
parameters. Because window function is implemented based on dynamic
column. See <a class="reference internal" href="#select-dynamic-column-related-parameters"><span class="std std-ref">Dynamic column related parameters</span></a> for
dynamic column related parameters:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Required or optional</p></th>
<th class="head"><p>Note</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].value</span></code></p></td>
<td><p>Required</p></td>
<td><p>Use <a class="reference internal" href="../window_function.html"><span class="doc">Window function</span></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.sort_keys</span></code></p></td>
<td><p>Required if <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.group_keys</span></code> isn’t specified.</p></td>
<td></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.group_keys</span></code></p></td>
<td><p>Required if <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.sort_keys</span></code> isn’t specified.</p></td>
<td></td>
</tr>
</tbody>
</table>
<div class="section" id="columns-name-window-sort-keys">
<span id="select-columns-name-window-sort-keys"></span><h4><span class="section-number">7.3.57.4.6.1. </span><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.sort_keys</span></code><a class="headerlink" href="#columns-name-window-sort-keys" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.6.</span></p>
</div>
<p>Specifies sort keys in each group. Window function processes records
in each group in the specified order.</p>
<p>Sort keys are separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>. Each sort key is column name. It’s
the same as <a class="reference internal" href="#select-sort-keys"><span class="std std-ref">sort_keys</span></a>.</p>
<p>You must specify <a class="reference internal" href="#select-columns-name-window-sort-keys"><span class="std std-ref">columns[${NAME}].window.sort_keys</span></a> or
<a class="reference internal" href="#select-columns-name-window-group-keys"><span class="std std-ref">columns[${NAME}].window.group_keys</span></a> to use window function.</p>
<p>Here is an example that computes cumulative sum per
<code class="docutils literal notranslate"><span class="pre">Entries.tag</span></code>. Each group is sorted by <code class="docutils literal notranslate"><span class="pre">Entries._key</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select \
  --table Entries \
  --columns[n_likes_cumulative_sum_per_tag].stage initial \
  --columns[n_likes_cumulative_sum_per_tag].type UInt32 \
  --columns[n_likes_cumulative_sum_per_tag].value &#39;window_sum(n_likes)&#39; \
  --columns[n_likes_cumulative_sum_per_tag].window.sort_keys _key \
  --columns[n_likes_cumulative_sum_per_tag].window.group_keys tag \
  --sort_keys _key \
  --output_columns tag,_key,n_likes,n_likes_cumulative_sum_per_tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes_cumulative_sum_per_tag&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         &quot;Senna&quot;,
#         &quot;Good-bye Senna&quot;,
#         3,
#         3
#       ],
#       [
#         &quot;Senna&quot;,
#         &quot;Good-bye Tritonn&quot;,
#         3,
#         6
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;Groonga&quot;,
#         10,
#         10
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;Mroonga&quot;,
#         15,
#         25
#       ],
#       [
#         &quot;Hello&quot;,
#         &quot;The first post!&quot;,
#         5,
#         5
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
<div class="section" id="columns-name-window-group-keys">
<span id="select-columns-name-window-group-keys"></span><h4><span class="section-number">7.3.57.4.6.2. </span><code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.group_keys</span></code><a class="headerlink" href="#columns-name-window-group-keys" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 7.0.0.</span></p>
</div>
<p>Specifies group keys. Window function processes records in each
group. If you specify no group keys, window function processes one
group that includes all records.</p>
<p>Group keys are separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>. Each group key is column name. It’s
the same as <a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a>.</p>
<p>You must specify <a class="reference internal" href="#select-columns-name-window-sort-keys"><span class="std std-ref">columns[${NAME}].window.sort_keys</span></a> or
<a class="reference internal" href="#select-columns-name-window-group-keys"><span class="std std-ref">columns[${NAME}].window.group_keys</span></a> to use window function.</p>
<p>Here is an example that computes sum per <code class="docutils literal notranslate"><span class="pre">Entries.tag</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select \
  --table Entries \
  --columns[n_likes_sum_per_tag].stage initial \
  --columns[n_likes_sum_per_tag].type UInt32 \
  --columns[n_likes_sum_per_tag].value &#39;window_sum(n_likes)&#39; \
  --columns[n_likes_sum_per_tag].window.group_keys tag \
  --sort_keys _key \
  --output_columns tag,_key,n_likes,n_likes_sum_per_tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes_sum_per_tag&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         &quot;Senna&quot;,
#         &quot;Good-bye Senna&quot;,
#         3,
#         6
#       ],
#       [
#         &quot;Senna&quot;,
#         &quot;Good-bye Tritonn&quot;,
#         3,
#         6
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;Groonga&quot;,
#         10,
#         25
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;Mroonga&quot;,
#         15,
#         25
#       ],
#       [
#         &quot;Hello&quot;,
#         &quot;The first post!&quot;,
#         5,
#         5
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
</div>
<div class="section" id="drilldown-related-parameters">
<span id="select-drilldown-related-parameters"></span><h3><span class="section-number">7.3.57.4.7. </span>Drilldown related parameters<a class="headerlink" href="#drilldown-related-parameters" title="Permalink to this headline">¶</a></h3>
<p>This section describes basic drilldown related parameters. Advanced
drilldown related parameters are described in another section.</p>
<div class="section" id="select-drilldown">
<span id="id2"></span><h4><span class="section-number">7.3.57.4.7.1. </span><code class="docutils literal notranslate"><span class="pre">drilldown</span></code><a class="headerlink" href="#select-drilldown" title="Permalink to this headline">¶</a></h4>
<p>Specifies keys for grouping separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>.</p>
<p>Matched records by specified search conditions are grouped by each
key. If you specify no search condition, all records are grouped by
each key.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --output_columns _key,tag \
  --drilldown tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;The first post!&quot;,
#         &quot;Hello&quot;
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;Groonga&quot;
#       ],
#       [
#         &quot;Mroonga&quot;,
#         &quot;Groonga&quot;
#       ],
#       [
#         &quot;Good-bye Senna&quot;,
#         &quot;Senna&quot;
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;,
#         &quot;Senna&quot;
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs the following information:</p>
<blockquote>
<div><ul class="simple">
<li><p>There is one record that has “Hello” tag.</p></li>
<li><p>There is two records that has “Groonga” tag.</p></li>
<li><p>There is two records that has “Senna” tag.</p></li>
</ul>
</div></blockquote>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> with search condition example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --output_columns _key,tag \
  --filter &#39;n_likes &gt;= 5&#39; \
  --drilldown tag
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;The first post!&quot;,
#         &quot;Hello&quot;
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;Groonga&quot;
#       ],
#       [
#         &quot;Mroonga&quot;,
#         &quot;Groonga&quot;
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs the following information:</p>
<blockquote>
<div><ul class="simple">
<li><p>In records that have 5 or larger as <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> value:</p>
<ul>
<li><p>There is one record that has “Hello” tag.</p></li>
<li><p>There is two records that has “Groonga” tag.</p></li>
</ul>
</li>
</ul>
</div></blockquote>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> with multiple group keys example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown tag,n_likes
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ],
#     [
#       [
#         4
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         5,
#         1
#       ],
#       [
#         10,
#         1
#       ],
#       [
#         15,
#         1
#       ],
#       [
#         3,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs the following information:</p>
<blockquote>
<div><ul class="simple">
<li><p>About <code class="docutils literal notranslate"><span class="pre">tag</span></code>:</p>
<ul>
<li><p>There is one record that has “Hello” tag.</p></li>
<li><p>There is two records that has “Groonga” tag.</p></li>
<li><p>There is two records that has “Senna” tag.</p></li>
</ul>
</li>
<li><p>About <code class="docutils literal notranslate"><span class="pre">n_likes</span></code>:</p>
<ul>
<li><p>There is one record that has “Hello” tag.</p></li>
<li><p>There is two records that has “Groonga” tag.</p></li>
<li><p>There is two records that has “Senna” tag.</p></li>
</ul>
</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="drilldown-sortby">
<span id="select-drilldown-sortby"></span><h4><span class="section-number">7.3.57.4.7.2. </span><code class="docutils literal notranslate"><span class="pre">drilldown_sortby</span></code><a class="headerlink" href="#drilldown-sortby" title="Permalink to this headline">¶</a></h4>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 6.0.3: </span>Use <a class="reference internal" href="#select-drilldown-sort-keys"><span class="std std-ref">drilldown_sort_keys</span></a> instead.</p>
</div>
</div>
<div class="section" id="drilldown-sort-keys">
<span id="select-drilldown-sort-keys"></span><h4><span class="section-number">7.3.57.4.7.3. </span><code class="docutils literal notranslate"><span class="pre">drilldown_sort_keys</span></code><a class="headerlink" href="#drilldown-sort-keys" title="Permalink to this headline">¶</a></h4>
<p>Specifies sort keys for drilldown outputs separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>. Each
sort key is column name.</p>
<p>You can refer the number of grouped records by <code class="docutils literal notranslate"><span class="pre">_nsubrecs</span></code>
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a>.</p>
<p>Here is a simple <code class="docutils literal notranslate"><span class="pre">drilldown_sort_keys</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown &#39;tag, n_likes&#39; \
  --drilldown_sort_keys &#39;-_nsubrecs, _key&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ]
#     ],
#     [
#       [
#         4
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         3,
#         2
#       ],
#       [
#         5,
#         1
#       ],
#       [
#         10,
#         1
#       ],
#       [
#         15,
#         1
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>Drilldown result is sorted by the number of grouped records (=
<code class="docutils literal notranslate"><span class="pre">_nsubrecs</span></code> ) in descending order. If there are grouped results that
the number of records in the group are the same, these grouped results
are sorted by grouped key (= <code class="docutils literal notranslate"><span class="pre">_key</span></code> ) in ascending order.</p>
<p>The sort keys are used in all group keys specified in <code class="docutils literal notranslate"><span class="pre">drilldown</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown &#39;tag, n_likes&#39; \
  --drilldown_sort_keys &#39;-_nsubrecs, _key&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ]
#     ],
#     [
#       [
#         4
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         3,
#         2
#       ],
#       [
#         5,
#         1
#       ],
#       [
#         10,
#         1
#       ],
#       [
#         15,
#         1
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The same sort keys are used in <code class="docutils literal notranslate"><span class="pre">tag</span></code> drilldown and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code>
drilldown.</p>
<p>If you want to use different sort keys for each drilldown, use
<a class="reference internal" href="#select-advanced-drilldown-related-parameters"><span class="std std-ref">Advanced drilldown related parameters</span></a>.</p>
</div>
<div class="section" id="drilldown-output-columns">
<span id="select-drilldown-output-columns"></span><h4><span class="section-number">7.3.57.4.7.4. </span><code class="docutils literal notranslate"><span class="pre">drilldown_output_columns</span></code><a class="headerlink" href="#drilldown-output-columns" title="Permalink to this headline">¶</a></h4>
<p>Specifies output columns for drilldown separated by <code class="docutils literal notranslate"><span class="pre">,</span></code>.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">drilldown_output_columns</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_output_columns _key
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;
#       ],
#       [
#         &quot;Groonga&quot;
#       ],
#       [
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command just outputs grouped key.</p>
<p>If grouped key is a referenced type column (= column that its type is
a table), you can access column of the table referenced by the
referenced type column.</p>
<p>Here are a schema definition and sample data to show drilldown against
referenced type column:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Tags TABLE_HASH_KEY ShortText --normalizer NormalizerAuto
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags label COLUMN_SCALAR ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Tags priority COLUMN_SCALAR Int32
# [[0, 1337566253.89858, 0.000355720520019531], true]
table_create Items TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Items tag COLUMN_SCALAR Tags
# [[0, 1337566253.89858, 0.000355720520019531], true]
load --table Tags
[
{&quot;_key&quot;: &quot;groonga&quot;, label: &quot;Groonga&quot;, priority: 10},
{&quot;_key&quot;: &quot;mroonga&quot;, label: &quot;Mroonga&quot;, priority: 5}
]
# [[0, 1337566253.89858, 0.000355720520019531], 2]
load --table Items
[
{&quot;_key&quot;: &quot;A&quot;, &quot;tag&quot;: &quot;groonga&quot;},
{&quot;_key&quot;: &quot;B&quot;, &quot;tag&quot;: &quot;groonga&quot;},
{&quot;_key&quot;: &quot;C&quot;, &quot;tag&quot;: &quot;mroonga&quot;}
]
# [[0, 1337566253.89858, 0.000355720520019531], 3]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Tags</span></code> table is a referenced table. <code class="docutils literal notranslate"><span class="pre">Items.tag</span></code> is a referenced
type column.</p>
<p>You can refer <code class="docutils literal notranslate"><span class="pre">Tags.label</span></code> by <code class="docutils literal notranslate"><span class="pre">label</span></code> in
<code class="docutils literal notranslate"><span class="pre">drilldown_output_columns</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Items \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_output_columns &#39;_key, label&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;label&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         &quot;groonga&quot;,
#         &quot;Groonga&quot;
#       ],
#       [
#         &quot;mroonga&quot;,
#         &quot;Mroonga&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>You can use <code class="docutils literal notranslate"><span class="pre">*</span></code> to refer all columns in referenced table (= <code class="docutils literal notranslate"><span class="pre">Tags</span></code>):</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Items \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_output_columns &#39;_key, *&#39;
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;label&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;priority&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;groonga&quot;,
#         &quot;Groonga&quot;,
#         10
#       ],
#       [
#         &quot;mroonga&quot;,
#         &quot;Mroonga&quot;,
#         5
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">*</span></code> is expanded to <code class="docutils literal notranslate"><span class="pre">label,</span> <span class="pre">priority</span></code>.</p>
<p>The default value of <code class="docutils literal notranslate"><span class="pre">drilldown_output_columns</span></code> is <code class="docutils literal notranslate"><span class="pre">_key,</span>
<span class="pre">_nsubrecs</span></code>. It means that grouped key and the number of records in
the group are output.</p>
<p>You can use more <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> in
<code class="docutils literal notranslate"><span class="pre">drilldown_output_columns</span></code> such as <code class="docutils literal notranslate"><span class="pre">_max</span></code>, <code class="docutils literal notranslate"><span class="pre">_min</span></code>, <code class="docutils literal notranslate"><span class="pre">_sum</span></code> and
<code class="docutils literal notranslate"><span class="pre">_avg</span></code> when you use <a class="reference internal" href="#select-drilldown-calc-types"><span class="std std-ref">drilldown_calc_types</span></a>. See
<code class="docutils literal notranslate"><span class="pre">drilldown_calc_types</span></code> document for details.</p>
</div>
<div class="section" id="drilldown-offset">
<span id="select-drilldown-offset"></span><h4><span class="section-number">7.3.57.4.7.5. </span><code class="docutils literal notranslate"><span class="pre">drilldown_offset</span></code><a class="headerlink" href="#drilldown-offset" title="Permalink to this headline">¶</a></h4>
<p>Specifies offset to determine range of drilldown output
records. Offset is zero-based. <code class="docutils literal notranslate"><span class="pre">--drilldown_offset</span> <span class="pre">1</span></code> means output
range is started from the 2nd record.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">drilldown_offset</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_sort_keys _key \
  --drilldown_offset 1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs from the 2nd record.</p>
<p>You can specify negative value. It means that <code class="docutils literal notranslate"><span class="pre">the</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">grouped</span>
<span class="pre">results</span> <span class="pre">+</span> <span class="pre">offset</span></code>. If you have 3 grouped results and specify
<code class="docutils literal notranslate"><span class="pre">--drilldown_offset</span> <span class="pre">-2</span></code>, you get grouped results from the 2st
(<code class="docutils literal notranslate"><span class="pre">3</span> <span class="pre">+</span> <span class="pre">-2</span> <span class="pre">=</span> <span class="pre">1</span></code>. <code class="docutils literal notranslate"><span class="pre">1</span></code> means 2nd. Remember that offset is zero-based.)
grouped result to the 3rd grouped result.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_sort_keys _key \
  --drilldown_offset -2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs from the 2nd grouped result because the
total number of grouped results is <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
<p>The default value of <code class="docutils literal notranslate"><span class="pre">drilldown_offset</span></code> is <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
</div>
<div class="section" id="drilldown-limit">
<span id="select-drilldown-limit"></span><h4><span class="section-number">7.3.57.4.7.6. </span><code class="docutils literal notranslate"><span class="pre">drilldown_limit</span></code><a class="headerlink" href="#drilldown-limit" title="Permalink to this headline">¶</a></h4>
<p>Specifies the max number of groups in a drilldown. If the number of
groups is less than <code class="docutils literal notranslate"><span class="pre">drilldown_limit</span></code>, all groups are outputted.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">drilldown_limit</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_sort_keys _key \
  --drilldown_offset 1 \
  --drilldown_limit 2
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs the 2rd and the 3rd groups.</p>
<p>You can specify negative value. It means that <code class="docutils literal notranslate"><span class="pre">the</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">groups</span> <span class="pre">+</span>
<span class="pre">drilldown_limit</span> <span class="pre">+</span> <span class="pre">1</span></code>. For example, <code class="docutils literal notranslate"><span class="pre">--drilldown_limit</span> <span class="pre">-1</span></code> outputs
all groups. It’s very useful value to show all groups.</p>
<p>Here is a negative <code class="docutils literal notranslate"><span class="pre">drilldown_limit</span></code> value example.</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldown tag \
  --drilldown_sort_keys _key \
  --drilldown_limit -1
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Hello&quot;,
#         1
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command outputs all groups.</p>
<p>The default value of <code class="docutils literal notranslate"><span class="pre">drilldown_limit</span></code> is <code class="docutils literal notranslate"><span class="pre">10</span></code>.</p>
</div>
<div class="section" id="drilldown-calc-types">
<span id="select-drilldown-calc-types"></span><h4><span class="section-number">7.3.57.4.7.7. </span><code class="docutils literal notranslate"><span class="pre">drilldown_calc_types</span></code><a class="headerlink" href="#drilldown-calc-types" title="Permalink to this headline">¶</a></h4>
<p>Specifies how to calculate (aggregate) values in grouped records by
a drilldown. You can specify multiple calculation types separated by
“<code class="docutils literal notranslate"><span class="pre">,</span></code>”. For example, <code class="docutils literal notranslate"><span class="pre">MAX,MIN</span></code>.</p>
<p>Calculation target values are read from a column of grouped
records. The column is specified by
<a class="reference internal" href="#select-drilldown-calc-target"><span class="std std-ref">drilldown_calc_target</span></a>.</p>
<p>You can read calculated value by <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> such
as <code class="docutils literal notranslate"><span class="pre">_max</span></code> and <code class="docutils literal notranslate"><span class="pre">_min</span></code> in <a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a>.</p>
<p>You can use the following calculation types:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type name</p></th>
<th class="head"><p><a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> name</p></th>
<th class="head"><p>Need <a class="reference internal" href="#select-drilldown-calc-target"><span class="std std-ref">drilldown_calc_target</span></a></p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">NONE</span></code></p></td>
<td><p>Nothing.</p></td>
<td><p>Not needs.</p></td>
<td><p>Just ignored.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">COUNT</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">_nsubrecs</span></code></p></td>
<td><p>Not needs.</p></td>
<td><p>Counting grouped records. It’s always enabled. So you don’t
need to specify it.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">MAX</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">_max</span></code></p></td>
<td><p>Needs.</p></td>
<td><p>Finding the maximum integer value from integer values in
grouped records.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">MIN</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">_min</span></code></p></td>
<td><p>Needs.</p></td>
<td><p>Finding the minimum integer value from integer values in
grouped records.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">SUM</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">_sum</span></code></p></td>
<td><p>Needs.</p></td>
<td><p>Summing integer values in grouped records.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">AVG</span></code></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">_avg</span></code></p></td>
<td><p>Needs.</p></td>
<td><p>Averaging integer/float values in grouped records.</p></td>
</tr>
</tbody>
</table>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">MAX</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types MAX \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_max
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         5
#       ],
#       [
#         2,
#         10
#       ],
#       [
#         3,
#         15
#       ],
#       [
#         4,
#         3
#       ],
#       [
#         5,
#         3
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_max&quot;,
#           &quot;Int64&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         5
#       ],
#       [
#         &quot;Groonga&quot;,
#         15
#       ],
#       [
#         &quot;Senna&quot;,
#         3
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command groups all records by <code class="docutils literal notranslate"><span class="pre">tag</span></code> column value,
finding the maximum <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value for each group and
outputs pairs of grouped key and the maximum <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value
for the group. It uses <code class="docutils literal notranslate"><span class="pre">_max</span></code> <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> to
read the maximum <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">MIN</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types MIN \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_min
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         5
#       ],
#       [
#         2,
#         10
#       ],
#       [
#         3,
#         15
#       ],
#       [
#         4,
#         3
#       ],
#       [
#         5,
#         3
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_min&quot;,
#           &quot;Int64&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         5
#       ],
#       [
#         &quot;Groonga&quot;,
#         10
#       ],
#       [
#         &quot;Senna&quot;,
#         3
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command groups all records by <code class="docutils literal notranslate"><span class="pre">tag</span></code> column value,
finding the minimum <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value for each group and
outputs pairs of grouped key and the minimum <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value
for the group. It uses <code class="docutils literal notranslate"><span class="pre">_min</span></code> <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> to
read the minimum <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column value.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">SUM</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types SUM \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_sum
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         5
#       ],
#       [
#         2,
#         10
#       ],
#       [
#         3,
#         15
#       ],
#       [
#         4,
#         3
#       ],
#       [
#         5,
#         3
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_sum&quot;,
#           &quot;Int64&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         5
#       ],
#       [
#         &quot;Groonga&quot;,
#         25
#       ],
#       [
#         &quot;Senna&quot;,
#         6
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command groups all records by <code class="docutils literal notranslate"><span class="pre">tag</span></code> column value,
sums all <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values for each group and outputs pairs
of grouped key and the summed <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values for the
group. It uses <code class="docutils literal notranslate"><span class="pre">_sum</span></code> <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> to read the
summed <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values.</p>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">AVG</span></code> example:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types AVG \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_avg
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         5
#       ],
#       [
#         2,
#         10
#       ],
#       [
#         3,
#         15
#       ],
#       [
#         4,
#         3
#       ],
#       [
#         5,
#         3
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_avg&quot;,
#           &quot;Float&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         5.0
#       ],
#       [
#         &quot;Groonga&quot;,
#         12.5
#       ],
#       [
#         &quot;Senna&quot;,
#         3.0
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command groups all records by <code class="docutils literal notranslate"><span class="pre">tag</span></code> column value,
averages all <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values for each group and outputs
pairs of grouped key and the averaged <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values for
the group. It uses <code class="docutils literal notranslate"><span class="pre">_avg</span></code> <a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> to read
the averaged <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> column values.</p>
<p>Here is an example that uses all calculation types:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns _id,n_likes \
  --drilldown tag \
  --drilldown_calc_types MAX,MIN,SUM,AVG \
  --drilldown_calc_target n_likes \
  --drilldown_output_columns _key,_nsubrecs,_max,_min,_sum,_avg
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         1,
#         5
#       ],
#       [
#         2,
#         10
#       ],
#       [
#         3,
#         15
#       ],
#       [
#         4,
#         3
#       ],
#       [
#         5,
#         3
#       ]
#     ],
#     [
#       [
#         3
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ],
#         [
#           &quot;_max&quot;,
#           &quot;Int64&quot;
#         ],
#         [
#           &quot;_min&quot;,
#           &quot;Int64&quot;
#         ],
#         [
#           &quot;_sum&quot;,
#           &quot;Int64&quot;
#         ],
#         [
#           &quot;_avg&quot;,
#           &quot;Float&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         1,
#         5,
#         5,
#         5,
#         5.0
#       ],
#       [
#         &quot;Groonga&quot;,
#         2,
#         15,
#         10,
#         25,
#         12.5
#       ],
#       [
#         &quot;Senna&quot;,
#         2,
#         3,
#         3,
#         6,
#         3.0
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command specifies multiple calculation types separated
by “<code class="docutils literal notranslate"><span class="pre">,</span></code>” like <code class="docutils literal notranslate"><span class="pre">MAX,MIN,SUM,AVG</span></code>. You can use <code class="docutils literal notranslate"><span class="pre">_nsubrecs</span></code>
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> in
<a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a> without specifying <code class="docutils literal notranslate"><span class="pre">COUNT</span></code> in
<code class="docutils literal notranslate"><span class="pre">drilldown_calc_types</span></code>. Because <code class="docutils literal notranslate"><span class="pre">COUNT</span></code> is always enabled.</p>
<p>The default value of <code class="docutils literal notranslate"><span class="pre">drilldown_calc_types</span></code> is <code class="docutils literal notranslate"><span class="pre">NONE</span></code>. It means
that only <code class="docutils literal notranslate"><span class="pre">COUNT</span></code> is enabled. Because <code class="docutils literal notranslate"><span class="pre">NONE</span></code> is just ignored and
<code class="docutils literal notranslate"><span class="pre">COUNT</span></code> is always enabled.</p>
</div>
<div class="section" id="drilldown-calc-target">
<span id="select-drilldown-calc-target"></span><h4><span class="section-number">7.3.57.4.7.8. </span><code class="docutils literal notranslate"><span class="pre">drilldown_calc_target</span></code><a class="headerlink" href="#drilldown-calc-target" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.3.</span></p>
</div>
<p>Specifies the target column for <a class="reference internal" href="#select-drilldown-calc-types"><span class="std std-ref">drilldown_calc_types</span></a>.</p>
<p>If you specify a calculation type that needs a target column such as
<code class="docutils literal notranslate"><span class="pre">MAX</span></code> in <a class="reference internal" href="#select-drilldown-calc-types"><span class="std std-ref">drilldown_calc_types</span></a> but you omit
<code class="docutils literal notranslate"><span class="pre">drilldown_calc_target</span></code>, the calculation result is always <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
<p>You can specify only one column name like <code class="docutils literal notranslate"><span class="pre">--drilldown_calc_target</span>
<span class="pre">n_likes</span></code>. You can’t specify multiple column name like
<code class="docutils literal notranslate"><span class="pre">--drilldown_calc_target</span> <span class="pre">_key,n_likes</span></code>.</p>
<p>You can use referenced value from the target record by combining
“<code class="docutils literal notranslate"><span class="pre">.</span></code>” like <code class="docutils literal notranslate"><span class="pre">--drilldown_calc_target</span>
<span class="pre">reference_column.nested_reference_column.value</span></code>.</p>
<p>See <a class="reference internal" href="#select-drilldown-calc-types"><span class="std std-ref">drilldown_calc_types</span></a> to know how to use
<code class="docutils literal notranslate"><span class="pre">drilldown_calc_target</span></code>.</p>
<p>The default value of <code class="docutils literal notranslate"><span class="pre">drilldown_calc_target</span></code> is <code class="docutils literal notranslate"><span class="pre">null</span></code>. It means
that no calculation target column is specified.</p>
</div>
<div class="section" id="drilldown-filter">
<span id="select-drilldown-filter"></span><h4><span class="section-number">7.3.57.4.7.9. </span><code class="docutils literal notranslate"><span class="pre">drilldown_filter</span></code><a class="headerlink" href="#drilldown-filter" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.3.</span></p>
</div>
<p>Specifies the filter condition against the drilled down result.</p>
<p>The syntax is <a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a>. It’s the same
as <a class="reference internal" href="#select-filter"><span class="std std-ref">filter</span></a>.</p>
<p>Here is an example to suppress tags that are occurred only once:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns _id,tag \
  --drilldown tag \
  --drilldown_filter &#39;_nsubrecs &gt; 1&#39; \
  --drilldown_output_columns _key,_nsubrecs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Senna&quot;
#       ]
#     ],
#     [
#       [
#         2
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;_nsubrecs&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;Groonga&quot;,
#         2
#       ],
#       [
#         &quot;Senna&quot;,
#         2
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
</div>
</div>
<div class="section" id="advanced-drilldown-related-parameters">
<span id="select-advanced-drilldown-related-parameters"></span><h3><span class="section-number">7.3.57.4.8. </span>Advanced drilldown related parameters<a class="headerlink" href="#advanced-drilldown-related-parameters" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 4.0.8.</span></p>
</div>
<p>You can get multiple drilldown results by specifying multiple group
keys by <a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a>. But you need to use the same
configuration for all drilldowns. For example,
<a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a> is used by all drilldowns.</p>
<p>You can use a configuration for each drilldown by the following
parameters:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].sort_keys</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].offset</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].limit</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_types</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_target</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].filter</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].stage=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].flags=COLUMN_SCALAR</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].type=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].value=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].window.sort_keys=null</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].window.group_keys=null</span></code></p></li>
</ul>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">${LABEL}</span></code> is a variable. You can use the following characters for
<code class="docutils literal notranslate"><span class="pre">${LABEL}</span></code>:</p>
<blockquote>
<div><ul class="simple">
<li><p>Alphabets</p></li>
<li><p>Digits</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">.</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">_</span></code></p></li>
</ul>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">${NAME}</span></code> is a variable. You can use the following characters for
<code class="docutils literal notranslate"><span class="pre">${NAME}</span></code>:</p>
<blockquote>
<div><ul class="simple">
<li><p>Alphabets</p></li>
<li><p>Digits</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">_</span></code></p></li>
</ul>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You can use more characters but it’s better that you use only these
characters.</p>
</div>
<p>Parameters that has the same <code class="docutils literal notranslate"><span class="pre">${LABEL}</span></code> value are grouped. Grouped
parameters are used for one drilldown.</p>
<p>For example, there are 2 groups for the following parameters:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label1].keys</span> <span class="pre">_key</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label1].output_columns</span> <span class="pre">_nsubrecs</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label2].keys</span> <span class="pre">tag</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--drilldowns[label2].output_columns</span> <span class="pre">_key,_nsubrecs</span></code></p></li>
</ul>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">drilldowns[label1].keys</span></code> and <code class="docutils literal notranslate"><span class="pre">drilldowns[label1].output_columns</span></code>
are grouped. <code class="docutils literal notranslate"><span class="pre">drilldowns[label2].keys</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[label2].output_columns</span></code> are also grouped.</p>
<p>In <code class="docutils literal notranslate"><span class="pre">label1</span></code> group, <code class="docutils literal notranslate"><span class="pre">_key</span></code> is used for group key and <code class="docutils literal notranslate"><span class="pre">_nsubrecs</span></code>
is used for output columns.</p>
<p>In <code class="docutils literal notranslate"><span class="pre">label2</span></code> group, <code class="docutils literal notranslate"><span class="pre">tag</span></code> is used for group key and
<code class="docutils literal notranslate"><span class="pre">_key,_nsubrecs</span></code> is used for output columns.</p>
<p>See document for corresponding <code class="docutils literal notranslate"><span class="pre">drilldown_XXX</span></code> parameter to know how
to use it for the following parameters:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].sort_keys</span></code>: <a class="reference internal" href="#select-drilldown-sort-keys"><span class="std std-ref">drilldown_sort_keys</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].offset</span></code>: <a class="reference internal" href="#select-drilldown-offset"><span class="std std-ref">drilldown_offset</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].limit</span></code>: <a class="reference internal" href="#select-drilldown-limit"><span class="std std-ref">drilldown_limit</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_types</span></code>: <a class="reference internal" href="#select-drilldown-calc-types"><span class="std std-ref">drilldown_calc_types</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_target</span></code>: <a class="reference internal" href="#select-drilldown-calc-target"><span class="std std-ref">drilldown_calc_target</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].filter</span></code>: <a class="reference internal" href="#select-drilldown-filter"><span class="std std-ref">drilldown_filter</span></a></p></li>
</ul>
</div></blockquote>
<p>See document for corresponding <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].XXX</span></code> parameter to
know how to use it for the following parameters:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].flags=COLUMN_SCALAR</span></code>:
<a class="reference internal" href="#select-columns-name-flags"><span class="std std-ref">columns[${NAME}].flags</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].type=null</span></code>:
<a class="reference internal" href="#select-columns-name-type"><span class="std std-ref">columns[${NAME}].type</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].value=null</span></code>:
<a class="reference internal" href="#select-columns-name-value"><span class="std std-ref">columns[${NAME}].value</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].window.sort_keys=null</span></code>:
<a class="reference internal" href="#select-columns-name-window-sort-keys"><span class="std std-ref">columns[${NAME}].window.sort_keys</span></a></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].window.group_keys=null</span></code>:
<a class="reference internal" href="#select-columns-name-window-group-keys"><span class="std std-ref">columns[${NAME}].window.group_keys</span></a></p></li>
</ul>
</div></blockquote>
<p>The following parameters are needed more description:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].stage=null</span></code></p></li>
</ul>
</div></blockquote>
<p>Output format is different a bit. It’s also needed more description.</p>
<div class="section" id="drilldowns-label-keys">
<span id="select-drilldowns-label-keys"></span><h4><span class="section-number">7.3.57.4.8.1. </span><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code><a class="headerlink" href="#drilldowns-label-keys" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 4.0.8.</span></p>
</div>
<p><a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a> can specify multiple keys for multiple
drilldowns. But it can’t specify multiple keys for one drilldown.</p>
<p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> can’t specify multiple keys for multiple
drilldowns. But it can specify multiple keys for one drilldown.</p>
<p>You can specify multiple keys separated by “<code class="docutils literal notranslate"><span class="pre">,</span></code>”.</p>
<p>Here is an example to group by multiple keys, <code class="docutils literal notranslate"><span class="pre">tag</span></code> and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code>
column values:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit -1 \
  --output_columns tag,n_likes \
  --drilldowns[tag.n_likes].keys tag,n_likes \
  --drilldowns[tag.n_likes].output_columns _value.tag,_value.n_likes,_nsubrecs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ]
#       ],
#       [
#         &quot;Hello&quot;,
#         5
#       ],
#       [
#         &quot;Groonga&quot;,
#         10
#       ],
#       [
#         &quot;Groonga&quot;,
#         15
#       ],
#       [
#         &quot;Senna&quot;,
#         3
#       ],
#       [
#         &quot;Senna&quot;,
#         3
#       ]
#     ],
#     {
#       &quot;tag.n_likes&quot;: [
#         [
#           4
#         ],
#         [
#           [
#             &quot;tag&quot;,
#             &quot;ShortText&quot;
#           ],
#           [
#             &quot;n_likes&quot;,
#             &quot;UInt32&quot;
#           ],
#           [
#             &quot;_nsubrecs&quot;,
#             &quot;Int32&quot;
#           ]
#         ],
#         [
#           &quot;Hello&quot;,
#           5,
#           1
#         ],
#         [
#           &quot;Groonga&quot;,
#           10,
#           1
#         ],
#         [
#           &quot;Groonga&quot;,
#           15,
#           1
#         ],
#         [
#           &quot;Senna&quot;,
#           3,
#           2
#         ]
#       ]
#     }
#   ]
# ]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">tag.n_likes</span></code> is used as the label for the drilldown parameters
group. You can refer grouped keys by <code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax in
<a class="reference internal" href="#select-drilldowns-label-output-columns"><span class="std std-ref">drilldowns[${LABEL}].output_columns</span></a>. <code class="docutils literal notranslate"><span class="pre">${KEY_NAME}</span></code> is a
column name to be used by group key. <code class="docutils literal notranslate"><span class="pre">tag</span></code> and <code class="docutils literal notranslate"><span class="pre">n_likes</span></code> are
<code class="docutils literal notranslate"><span class="pre">${KEY_NAME}</span></code> in this case.</p>
<p>Note that you can’t use <code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax when you just
specify one key as <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> like <code class="docutils literal notranslate"><span class="pre">--drilldowns[tag].keys</span>
<span class="pre">tag</span></code>. You should use <code class="docutils literal notranslate"><span class="pre">_key</span></code> for the case. It’s the same rule in
<a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a>.</p>
</div>
<div class="section" id="drilldowns-label-output-columns">
<span id="select-drilldowns-label-output-columns"></span><h4><span class="section-number">7.3.57.4.8.2. </span><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code><a class="headerlink" href="#drilldowns-label-output-columns" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 4.0.8.</span></p>
</div>
<p>It’s almost same as <a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a>. The
difference between <a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code> is how to refer group keys.</p>
<p><a class="reference internal" href="#select-drilldown-output-columns"><span class="std std-ref">drilldown_output_columns</span></a> uses <code class="docutils literal notranslate"><span class="pre">_key</span></code>
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> to refer group
key. <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code> also uses <code class="docutils literal notranslate"><span class="pre">_key</span></code>
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> to refer group key when you specify
only one group key by <a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a>.</p>
<p>Here is an example to refer single group key by <code class="docutils literal notranslate"><span class="pre">_key</span></code>
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldowns[tag.n_likes].keys tag \
  --drilldowns[tag.n_likes].output_columns _key
# [
#   [
#     0,
#     1542772065.869136,
#     0.0003108978271484375
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     {
#       &quot;tag.n_likes&quot;: [
#         [
#           3
#         ],
#         [
#           [
#             &quot;_key&quot;,
#             &quot;ShortText&quot;
#           ]
#         ],
#         [
#           &quot;Hello&quot;
#         ],
#         [
#           &quot;Groonga&quot;
#         ],
#         [
#           &quot;Senna&quot;
#         ]
#       ]
#     }
#   ]
# ]
</pre></div>
</div>
<p>But you can’t refer each group key by <code class="docutils literal notranslate"><span class="pre">_key</span></code>
<a class="reference internal" href="../columns/pseudo.html"><span class="doc">Pseudo column</span></a> in
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code>. You need to use
<code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax. <code class="docutils literal notranslate"><span class="pre">${KEY_NAME}</span></code> is a column name that is
used for group key in <a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a>.</p>
<p>Here is an example to refer each group key in multiple group keys by
<code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --limit 0 \
  --output_columns _id \
  --drilldowns[tag.n_likes].keys tag,n_likes \
  --drilldowns[tag.n_likes].output_columns _value.tag,_value.n_likes
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ]
#       ]
#     ],
#     {
#       &quot;tag.n_likes&quot;: [
#         [
#           4
#         ],
#         [
#           [
#             &quot;tag&quot;,
#             &quot;ShortText&quot;
#           ],
#           [
#             &quot;n_likes&quot;,
#             &quot;UInt32&quot;
#           ]
#         ],
#         [
#           &quot;Hello&quot;,
#           5
#         ],
#         [
#           &quot;Groonga&quot;,
#           10
#         ],
#         [
#           &quot;Groonga&quot;,
#           15
#         ],
#         [
#           &quot;Senna&quot;,
#           3
#         ]
#       ]
#     }
#   ]
# ]
</pre></div>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Why <code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax?</p>
<p>It’s implementation specific information.</p>
<p><code class="docutils literal notranslate"><span class="pre">_key</span></code> is a vector value. The vector value is consists of all
group keys. You can see byte sequence of the vector value by
referring <code class="docutils literal notranslate"><span class="pre">_key</span></code> in <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code>.</p>
<p>There is one grouped record in <code class="docutils literal notranslate"><span class="pre">_value</span></code> to refer each grouped
values when you specify multiple group keys to
<a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a>. So you can refer each group key
by <code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax.</p>
<p>On the other hand, there is no grouped record in <code class="docutils literal notranslate"><span class="pre">_value</span></code> when
you specify only one group key to
<a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a>. So you can’t refer group key by
<code class="docutils literal notranslate"><span class="pre">_value.${KEY_NAME}</span></code> syntax.</p>
</div>
</div>
<div class="section" id="drilldowns-label-columns-name-stage">
<span id="select-drilldowns-label-columns-name-stage"></span><h4><span class="section-number">7.3.57.4.8.3. </span><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].stage</span></code><a class="headerlink" href="#drilldowns-label-columns-name-stage" title="Permalink to this headline">¶</a></h4>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.5.</span></p>
</div>
<p>Specifies when the dynamic column is created. This is a required
parameter to create a dynamic column.</p>
<p>Here are available stages:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">initial</span></code></p></td>
<td><p>Dynamic column is created at first.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">filtered</span></code></p></td>
<td><p>Dynamic column is created after <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].filter</span></code>
is evaluated.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">output</span></code></p></td>
<td><p>Dynamic column is created before <a class="reference internal" href="#select-drilldowns-label-output-columns"><span class="std std-ref">drilldowns[${LABEL}].output_columns</span></a>
is evaluated.</p></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage and <code class="docutils literal notranslate"><span class="pre">output</span></code> stage will be able to use from 10.0.3 or later.</p>
</div>
<p>Here is one drilldown process flow with dynamic column creation
points. You should choose stage as late as possible:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>Evaluates <a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a>,
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_types</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].calc_target</span></code>.</p></li>
<li><p>Creates dynamic columns for <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage. All drilldown
result records have these dynamic columns.</p></li>
<li><p>Evaluates <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].filter</span></code>. You can use dynamic
columns created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage.</p></li>
<li><p>Creates dynamic columns for <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.
Only filtered records have these dynamic columns.</p></li>
<li><p>Evaluates <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].sort_keys</span></code>,
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].offset</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].limit</span></code>. You can use dynamic columns
created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage and <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage.</p></li>
<li><p>Creates dynamic columns for <code class="docutils literal notranslate"><span class="pre">output</span></code> stage.
Only <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].limit</span></code> records have these dynamic columns.</p></li>
<li><p>Evaluates <a class="reference internal" href="#select-drilldowns-label-output-columns"><span class="std std-ref">drilldowns[${LABEL}].output_columns</span></a>. You can
use dynamic columns created in <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage, <code class="docutils literal notranslate"><span class="pre">filtered</span></code> stage,
and <code class="docutils literal notranslate"><span class="pre">output</span></code> stage.</p></li>
</ol>
</div></blockquote>
<p>Here is a <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].stage</span></code> example. It
creates <code class="docutils literal notranslate"><span class="pre">is_popular</span></code> column at <code class="docutils literal notranslate"><span class="pre">initial</span></code> stage. You can use
<code class="docutils literal notranslate"><span class="pre">is_popular</span></code> in all parameters such as
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].filter</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --drilldowns[tag].keys tag \
  --drilldowns[tag].columns[is_popular].stage initial \
  --drilldowns[tag].columns[is_popular].type Bool \
  --drilldowns[tag].columns[is_popular].value &#39;_nsubrecs &gt; 1&#39; \
  --drilldowns[tag].filter is_popular \
  --drilldowns[tag].output_columns _key,is_popular,_nsubrecs
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ],
#     {
#       &quot;tag&quot;: [
#         [
#           2
#         ],
#         [
#           [
#             &quot;_key&quot;,
#             &quot;ShortText&quot;
#           ],
#           [
#             &quot;is_popular&quot;,
#             &quot;Bool&quot;
#           ],
#           [
#             &quot;_nsubrecs&quot;,
#             &quot;Int32&quot;
#           ]
#         ],
#         [
#           &quot;Groonga&quot;,
#           true,
#           2
#         ],
#         [
#           &quot;Senna&quot;,
#           true,
#           2
#         ]
#       ]
#     }
#   ]
# ]
</pre></div>
</div>
<div class="versionadded">
<p><span class="versionmodified added">New in version 4.0.8.</span></p>
</div>
</div>
<div class="section" id="output-format-for-drilldowns-label-style">
<span id="select-drilldowns-label-output-format"></span><h4><span class="section-number">7.3.57.4.8.4. </span>Output format for <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}]</span></code> style<a class="headerlink" href="#output-format-for-drilldowns-label-style" title="Permalink to this headline">¶</a></h4>
<p>There is a difference in output format between <a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a>
and <a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a>. <a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a> uses
array to output multiple drilldown results.
<a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a> uses pairs of label and drilldown
result.</p>
<p><a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a> uses the following output format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT1,
    DRILLDOWN_RESULT2,
    ...
  ]
]
</pre></div>
</div>
<p><a class="reference internal" href="#select-drilldowns-label-keys"><span class="std std-ref">drilldowns[${LABEL}].keys</span></a> uses the following output format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  HEADER,
  [
    SEARCH_RESULT,
    {
      &quot;LABEL1&quot;: DRILLDOWN_RESULT1,
      &quot;LABEL2&quot;: DRILLDOWN_RESULT2,
      ...
    }
  ]
]
</pre></div>
</div>
</div>
</div>
<div class="section" id="slice-related-parameters">
<span id="select-slice-related-parameters"></span><h3><span class="section-number">7.3.57.4.9. </span>Slice related parameters<a class="headerlink" href="#slice-related-parameters" title="Permalink to this headline">¶</a></h3>
<div class="versionadded">
<p><span class="versionmodified added">New in version 6.0.3.</span></p>
</div>
<p>This section describes slice related parameters.</p>
<p>TODO</p>
<p>Here are parameters for slice:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Name</p></th>
<th class="head"><p>Required</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].match_columns</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].query</span></code></p></td>
<td><p>Required if <code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].filter</span></code> isn’t specified.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].filter</span></code></p></td>
<td><p>Required if <code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].query</span></code> isn’t specified.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].query_expander</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].query_flags</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].sort_keys</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].output_columns</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].offset</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].limit</span></code></p></td>
<td><p>Optional</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">--slices[${LABEL}].table</span></code></p></td>
<td><p>Optional</p></td>
</tr>
</tbody>
</table>
<div class="section" id="slices-label-match-columns">
<span id="select-slices-label-match-columns"></span><h4><span class="section-number">7.3.57.4.9.1. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].match_columns</span></code><a class="headerlink" href="#slices-label-match-columns" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-query">
<span id="select-slices-label-query"></span><h4><span class="section-number">7.3.57.4.9.2. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].query</span></code><a class="headerlink" href="#slices-label-query" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-filter">
<span id="select-slices-label-filter"></span><h4><span class="section-number">7.3.57.4.9.3. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].filter</span></code><a class="headerlink" href="#slices-label-filter" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-query-expander">
<span id="select-slices-label-query-expander"></span><h4><span class="section-number">7.3.57.4.9.4. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].query_expander</span></code><a class="headerlink" href="#slices-label-query-expander" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-query-flags">
<span id="select-slices-label-query-flags"></span><h4><span class="section-number">7.3.57.4.9.5. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].query_flags</span></code><a class="headerlink" href="#slices-label-query-flags" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-sort-keys">
<span id="select-slices-label-sort-keys"></span><h4><span class="section-number">7.3.57.4.9.6. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].sort_keys</span></code><a class="headerlink" href="#slices-label-sort-keys" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-output-columns">
<span id="select-slices-label-output-columns"></span><h4><span class="section-number">7.3.57.4.9.7. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].output_columns</span></code><a class="headerlink" href="#slices-label-output-columns" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-offset">
<span id="select-slices-label-offset"></span><h4><span class="section-number">7.3.57.4.9.8. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].offset</span></code><a class="headerlink" href="#slices-label-offset" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-limit">
<span id="select-slices-label-limit"></span><h4><span class="section-number">7.3.57.4.9.9. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].limit</span></code><a class="headerlink" href="#slices-label-limit" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
<div class="section" id="slices-label-table">
<span id="select-slices-label-table"></span><h4><span class="section-number">7.3.57.4.9.10. </span><code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].table</span></code><a class="headerlink" href="#slices-label-table" title="Permalink to this headline">¶</a></h4>
<p>TODO</p>
</div>
</div>
<div class="section" id="cache-related-parameter">
<h3><span class="section-number">7.3.57.4.10. </span>Cache related parameter<a class="headerlink" href="#cache-related-parameter" title="Permalink to this headline">¶</a></h3>
<div class="section" id="cache">
<span id="select-cache"></span><h4><span class="section-number">7.3.57.4.10.1. </span><code class="docutils literal notranslate"><span class="pre">cache</span></code><a class="headerlink" href="#cache" title="Permalink to this headline">¶</a></h4>
<p>Specifies whether caching the result of this query or not.</p>
<p>If the result of this query is cached, the next same query returns
response quickly by using the cache.</p>
<p>It doesn’t control whether existing cached result is used or not.</p>
<p>Here are available values:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Value</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">no</span></code></p></td>
<td><p>Don’t cache the output of this query.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">yes</span></code></p></td>
<td><p>Cache the output of this query.
It’s the default value.</p></td>
</tr>
</tbody>
</table>
<p>Here is an example to disable caching the result of this query:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries --cache no
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_id&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;n_likes&quot;,
#           &quot;UInt32&quot;
#         ],
#         [
#           &quot;tag&quot;,
#           &quot;ShortText&quot;
#         ]
#       ],
#       [
#         1,
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         5,
#         &quot;Hello&quot;
#       ],
#       [
#         2,
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         10,
#         &quot;Groonga&quot;
#       ],
#       [
#         3,
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         15,
#         &quot;Groonga&quot;
#       ],
#       [
#         4,
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ],
#       [
#         5,
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         3,
#         &quot;Senna&quot;
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The default value is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
</div>
</div>
<div class="section" id="score-related-parameters">
<h3><span class="section-number">7.3.57.4.11. </span>Score related parameters<a class="headerlink" href="#score-related-parameters" title="Permalink to this headline">¶</a></h3>
<p>There is a score related parameter, <code class="docutils literal notranslate"><span class="pre">adjuster</span></code>.</p>
<div class="section" id="adjuster">
<span id="select-adjuster"></span><h4><span class="section-number">7.3.57.4.11.1. </span><code class="docutils literal notranslate"><span class="pre">adjuster</span></code><a class="headerlink" href="#adjuster" title="Permalink to this headline">¶</a></h4>
<p>Specifies one or more score adjust expressions. You need to use
<code class="docutils literal notranslate"><span class="pre">adjuster</span></code> with <code class="docutils literal notranslate"><span class="pre">query</span></code> or <code class="docutils literal notranslate"><span class="pre">filter</span></code>. <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> doesn’t work
with not searched request.</p>
<p>You can increase score of specific records by <code class="docutils literal notranslate"><span class="pre">adjuster</span></code>. You can
use <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> to set high score for important records.</p>
<p>For example, you can use <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> to increase score of records
that have <code class="docutils literal notranslate"><span class="pre">groonga</span></code> tag.</p>
<p>Here is the syntax:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>--adjuster &quot;SCORE_ADJUST_EXPRESSION1 + SCORE_ADJUST_EXPRESSION2 + ...&quot;
</pre></div>
</div>
<p>Here is the <code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> syntax:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>COLUMN @ &quot;KEYWORD&quot; * FACTOR
</pre></div>
</div>
<p>Note the following:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">COLUMN</span></code> must be indexed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">&quot;KEYWORD&quot;</span></code> must be a string.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">FACTOR</span></code> must be a positive integer.</p></li>
</ul>
</div></blockquote>
<p>Here is a sample <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> usage example that uses just one
<code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --filter true \
  --adjuster &#39;content @ &quot;groonga&quot; * 5&#39; \
  --output_columns _key,content,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         1
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         6
#       ],
#       [
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         1
#       ],
#       [
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         1
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         1
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">select</span></code> command matches all records. Then it applies
<code class="docutils literal notranslate"><span class="pre">adjuster</span></code>. The adjuster increases score of records that have
<code class="docutils literal notranslate"><span class="pre">&quot;groonga&quot;</span></code> in <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column by 5. There is only one
record that has <code class="docutils literal notranslate"><span class="pre">&quot;groonga&quot;</span></code> in <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column.  So the
record that its key is <code class="docutils literal notranslate"><span class="pre">&quot;Groonga&quot;</span></code> has score 6 (<code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">1</span> <span class="pre">+</span> <span class="pre">5</span></code>).</p>
<p>You can omit <code class="docutils literal notranslate"><span class="pre">FACTOR</span></code>. If you omit <code class="docutils literal notranslate"><span class="pre">FACTOR</span></code>, it is treated as 1.</p>
<p>Here is a sample <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> usage example that omits <code class="docutils literal notranslate"><span class="pre">FACTOR</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --filter true \
  --adjuster &#39;content @ &quot;groonga&quot;&#39; \
  --output_columns _key,content,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         1
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         2
#       ],
#       [
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         1
#       ],
#       [
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         1
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         1
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> in the <code class="docutils literal notranslate"><span class="pre">select</span></code> command doesn’t have <code class="docutils literal notranslate"><span class="pre">FACTOR</span></code>. So
the factor is treated as 1. There is only one record that has
<code class="docutils literal notranslate"><span class="pre">&quot;groonga&quot;</span></code> in <code class="docutils literal notranslate"><span class="pre">Entries.content</span></code> column. So the record that its
key is <code class="docutils literal notranslate"><span class="pre">&quot;Groonga&quot;</span></code> has score 2 (<code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">1</span> <span class="pre">+</span> <span class="pre">1</span></code>).</p>
<p>Here is a sample <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> usage example that uses multiple
<code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code>:</p>
<p>Execution example:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>select Entries \
  --filter true \
  --adjuster &#39;content @ &quot;groonga&quot; * 5 + content @ &quot;started&quot; * 3&#39; \
  --output_columns _key,content,_score
# [
#   [
#     0,
#     1337566253.89858,
#     0.000355720520019531
#   ],
#   [
#     [
#       [
#         5
#       ],
#       [
#         [
#           &quot;_key&quot;,
#           &quot;ShortText&quot;
#         ],
#         [
#           &quot;content&quot;,
#           &quot;Text&quot;
#         ],
#         [
#           &quot;_score&quot;,
#           &quot;Int32&quot;
#         ]
#       ],
#       [
#         &quot;The first post!&quot;,
#         &quot;Welcome! This is my first post!&quot;,
#         1
#       ],
#       [
#         &quot;Groonga&quot;,
#         &quot;I started to use Groonga. It&#39;s very fast!&quot;,
#         9
#       ],
#       [
#         &quot;Mroonga&quot;,
#         &quot;I also started to use Mroonga. It&#39;s also very fast! Really fast!&quot;,
#         4
#       ],
#       [
#         &quot;Good-bye Senna&quot;,
#         &quot;I migrated all Senna system!&quot;,
#         1
#       ],
#       [
#         &quot;Good-bye Tritonn&quot;,
#         &quot;I also migrated all Tritonn system!&quot;,
#         1
#       ]
#     ]
#   ]
# ]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">adjuster</span></code> in the <code class="docutils literal notranslate"><span class="pre">select</span></code> command has two
<code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> s. The final increased score is sum of
scores of these <code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> s. All
<code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> s in the <code class="docutils literal notranslate"><span class="pre">select</span></code> command are applied to
a record that its key is <code class="docutils literal notranslate"><span class="pre">&quot;Groonga&quot;</span></code>. So the final increased score
of the record is sum of scores of all <code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> s.</p>
<p>The first <code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> is <code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">&#64;</span> <span class="pre">&quot;groonga&quot;</span> <span class="pre">*</span> <span class="pre">5</span></code>.
It increases score by 5.</p>
<p>The second <code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> is <code class="docutils literal notranslate"><span class="pre">content</span> <span class="pre">&#64;</span> <span class="pre">&quot;started&quot;</span> <span class="pre">*</span> <span class="pre">3</span></code>.
It increases score by 3.</p>
<p>The final increased score is 9 (<code class="docutils literal notranslate"><span class="pre">=</span> <span class="pre">1</span> <span class="pre">+</span> <span class="pre">5</span> <span class="pre">+</span> <span class="pre">3</span></code>).</p>
<p>A <code class="docutils literal notranslate"><span class="pre">SCORE_ADJUST_EXPRESSION</span></code> has a factor for <code class="docutils literal notranslate"><span class="pre">&quot;KEYWORD&quot;</span></code>. This
means that increased scores of all records that has <code class="docutils literal notranslate"><span class="pre">&quot;KEYWORD&quot;</span></code> are
the same value. You can change increase score for each record that has
the same <code class="docutils literal notranslate"><span class="pre">&quot;KEYWORD&quot;</span></code>. It is useful to tune search score. See
<a class="reference internal" href="../columns/vector.html#weight-vector-column"><span class="std std-ref">Weight vector column</span></a> for details.</p>
</div>
</div>
</div>
<div class="section" id="return-value">
<span id="select-return-value"></span><h2><span class="section-number">7.3.57.5. </span>Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
<p>The command returns a response with the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT_1,
    DRILLDOWN_RESULT_2,
    ...,
    DRILLDOWN_RESULT_N
  ]
]
</pre></div>
</div>
<p>If the command fails, error details are in <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
<p>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> for <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
<p>There are zero or more <code class="docutils literal notranslate"><span class="pre">DRILLDOWN_RESULT</span></code>. If no <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> are specified, they are omitted like the
following:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  HEADER,
  [
    SEARCH_RESULT
  ]
]
</pre></div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> has two or more keys like <code class="docutils literal notranslate"><span class="pre">--drilldown</span> <span class="pre">&quot;_key,</span>
<span class="pre">column1,</span> <span class="pre">column2&quot;</span></code>, multiple <code class="docutils literal notranslate"><span class="pre">DRILLDOWN_RESULT</span></code> exist:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT_FOR_KEY,
    DRILLDOWN_RESULT_FOR_COLUMN1,
    DRILLDOWN_RESULT_FOR_COLUMN2
  ]
]
</pre></div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> is used, only one <code class="docutils literal notranslate"><span class="pre">DRILLDOWN_RESULT</span></code>
exist:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  HEADER,
  [
    SEARCH_RESULT,
    DRILLDOWN_RESULT_FOR_LABELED_DRILLDOWN
  ]
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">DRILLDOWN_RESULT</span></code> format is different between <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code>. It’s described later.</p>
<p><code class="docutils literal notranslate"><span class="pre">SEARCH_RESULT</span></code> is the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [N_HITS],
  COLUMNS,
  RECORDS
]
</pre></div>
</div>
<p>See <a class="reference internal" href="#select-simple-usage"><span class="std std-ref">Simple usage</span></a> for concrete example of the format.</p>
<p><code class="docutils literal notranslate"><span class="pre">N_HITS</span></code> is the number of matched records before <a class="reference internal" href="#select-limit"><span class="std std-ref">limit</span></a>
is applied.</p>
<p><code class="docutils literal notranslate"><span class="pre">COLUMNS</span></code> describes about output columns specified by
<a class="reference internal" href="#select-output-columns"><span class="std std-ref">output_columns</span></a>. It uses the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [COLUMN_NAME_1, COLUMN_TYPE_1],
  [COLUMN_NAME_2, COLUMN_TYPE_2],
  ...,
  [COLUMN_NAME_N, COLUMN_TYPE_N]
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">COLUMNS</span></code> includes one or more output column information. Each
output column information includes the followings:</p>
<blockquote>
<div><ul class="simple">
<li><p>Column name as string</p></li>
<li><p>Column type as string or <code class="docutils literal notranslate"><span class="pre">null</span></code></p></li>
</ul>
</div></blockquote>
<p>Column name is extracted from value specified as
<a class="reference internal" href="#select-output-columns"><span class="std std-ref">output_columns</span></a>.</p>
<p>Column type is Groonga’s type name or <code class="docutils literal notranslate"><span class="pre">null</span></code>. It doesn’t describe
whether the column value is vector or scalar. You need to determine it
by whether real column value is array or not.</p>
<p>See <a class="reference internal" href="../types.html"><span class="doc">Data types</span></a> for type details.</p>
<p><code class="docutils literal notranslate"><span class="pre">null</span></code> is used when column value type isn’t determined. For example,
function call in <a class="reference internal" href="#select-output-columns"><span class="std std-ref">output_columns</span></a> such as
<code class="docutils literal notranslate"><span class="pre">--output_columns</span> <span class="pre">&quot;snippet_html(content)&quot;</span></code> uses <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
<p>Here is an example of <code class="docutils literal notranslate"><span class="pre">COLUMNS</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [&quot;_id&quot;,     &quot;UInt32&quot;],
  [&quot;_key&quot;,    &quot;ShortText&quot;],
  [&quot;n_likes&quot;, &quot;UInt32&quot;],
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">RECORDS</span></code> includes column values for each matched record. Included
records are selected by <a class="reference internal" href="#select-offset"><span class="std std-ref">offset</span></a> and
<a class="reference internal" href="#select-limit"><span class="std std-ref">limit</span></a>. It uses the following format:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [
    RECORD_1_COLUMN_1,
    RECORD_1_COLUMN_2,
    ...,
    RECORD_1_COLUMN_N
  ],
  [
    RECORD_2_COLUMN_1,
    RECORD_2_COLUMN_2,
    ...,
    RECORD_2_COLUMN_N
  ],
  ...
  [
    RECORD_N_COLUMN_1,
    RECORD_N_COLUMN_2,
    ...,
    RECORD_N_COLUMN_N
  ]
]
</pre></div>
</div>
<p>Here is an example <code class="docutils literal notranslate"><span class="pre">RECORDS</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [
    1,
    &quot;The first post!&quot;,
    5
  ],
  [
    2,
    &quot;Groonga&quot;,
    10
  ],
  [
    3,
    &quot;Mroonga&quot;,
    15
  ]
]
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">DRILLDOWN_RESULT</span></code> format is different between <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> and
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">drilldown</span></code> uses the same format as <code class="docutils literal notranslate"><span class="pre">SEARCH_RESULT</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [N_HITS],
  COLUMNS,
  RECORDS
]
</pre></div>
</div>
<p>And <code class="docutils literal notranslate"><span class="pre">drilldown</span></code> generates one or more <code class="docutils literal notranslate"><span class="pre">DRILLDOWN_RESULT</span></code> when
<a class="reference internal" href="#select-drilldown"><span class="std std-ref">drilldown</span></a> has one ore more keys.</p>
<p><code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> uses the following format. Multiple
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> are mapped to one object (key-value
pairs):</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>{
  &quot;LABEL_1&quot;: [
    [N_HITS],
    COLUMNS,
    RECORDS
  ],
  &quot;LABEL_2&quot;: [
    [N_HITS],
    COLUMNS,
    RECORDS
  ],
  ...,
  &quot;LABEL_N&quot;: [
    [N_HITS],
    COLUMNS,
    RECORDS
  ]
}
</pre></div>
</div>
<p>Each <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code> corresponds to the following:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>&quot;LABEL&quot;: [
  [N_HITS],
  COLUMNS,
  RECORDS
]
</pre></div>
</div>
<p>The following value part is the same format as <code class="docutils literal notranslate"><span class="pre">SEARCH_RESULT</span></code>:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
  [N_HITS],
  COLUMNS,
  RECORDS
]
</pre></div>
</div>
<p>See also <a class="reference internal" href="#select-drilldowns-label-output-format"><span class="std std-ref">Output format for drilldowns[${LABEL}] style</span></a> for
<code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}]</span></code> style drilldown output format.</p>
</div>
<div class="section" id="see-also">
<h2><span class="section-number">7.3.57.6. </span>See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><ul class="simple">
<li><p><a class="reference internal" href="../grn_expr/query_syntax.html"><span class="doc">Query syntax</span></a></p></li>
<li><p><a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a></p></li>
</ul>
</div></blockquote>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">7.3.57. <code class="docutils literal notranslate"><span class="pre">select</span></code></a><ul>
<li><a class="reference internal" href="#summary">7.3.57.1. Summary</a></li>
<li><a class="reference internal" href="#syntax">7.3.57.2. Syntax</a></li>
<li><a class="reference internal" href="#usage">7.3.57.3. Usage</a><ul>
<li><a class="reference internal" href="#simple-usage">7.3.57.3.1. Simple usage</a></li>
<li><a class="reference internal" href="#search-conditions">7.3.57.3.2. Search conditions</a><ul>
<li><a class="reference internal" href="#search-condition-query">7.3.57.3.2.1. Search condition: <code class="docutils literal notranslate"><span class="pre">query</span></code></a></li>
<li><a class="reference internal" href="#search-condition-filter">7.3.57.3.2.2. Search condition: <code class="docutils literal notranslate"><span class="pre">filter</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#paging">7.3.57.3.3. Paging</a></li>
<li><a class="reference internal" href="#the-total-number-of-records">7.3.57.3.4. The total number of records</a></li>
<li><a class="reference internal" href="#drilldown">7.3.57.3.5. Drilldown</a></li>
<li><a class="reference internal" href="#dynamic-column">7.3.57.3.6. Dynamic column</a></li>
<li><a class="reference internal" href="#window-function">7.3.57.3.7. Window function</a></li>
</ul>
</li>
<li><a class="reference internal" href="#parameters">7.3.57.4. Parameters</a><ul>
<li><a class="reference internal" href="#required-parameters">7.3.57.4.1. Required parameters</a><ul>
<li><a class="reference internal" href="#table">7.3.57.4.1.1. <code class="docutils literal notranslate"><span class="pre">table</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#search-related-parameters">7.3.57.4.2. Search related parameters</a><ul>
<li><a class="reference internal" href="#match-columns">7.3.57.4.2.1. <code class="docutils literal notranslate"><span class="pre">match_columns</span></code></a></li>
<li><a class="reference internal" href="#query">7.3.57.4.2.2. <code class="docutils literal notranslate"><span class="pre">query</span></code></a></li>
<li><a class="reference internal" href="#filter">7.3.57.4.2.3. <code class="docutils literal notranslate"><span class="pre">filter</span></code></a></li>
<li><a class="reference internal" href="#load-table">7.3.57.4.2.4. <code class="docutils literal notranslate"><span class="pre">load_table</span></code></a></li>
<li><a class="reference internal" href="#load-columns">7.3.57.4.2.5. <code class="docutils literal notranslate"><span class="pre">load_columns</span></code></a></li>
<li><a class="reference internal" href="#load-values">7.3.57.4.2.6. <code class="docutils literal notranslate"><span class="pre">load_values</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#advanced-search-parameters">7.3.57.4.3. Advanced search parameters</a><ul>
<li><a class="reference internal" href="#match-escalation-threshold">7.3.57.4.3.1. <code class="docutils literal notranslate"><span class="pre">match_escalation_threshold</span></code></a></li>
<li><a class="reference internal" href="#match-escalation">7.3.57.4.3.2. <code class="docutils literal notranslate"><span class="pre">match_escalation</span></code></a></li>
<li><a class="reference internal" href="#query-expansion">7.3.57.4.3.3. <code class="docutils literal notranslate"><span class="pre">query_expansion</span></code></a></li>
<li><a class="reference internal" href="#query-flags">7.3.57.4.3.4. <code class="docutils literal notranslate"><span class="pre">query_flags</span></code></a></li>
<li><a class="reference internal" href="#query-expander">7.3.57.4.3.5. <code class="docutils literal notranslate"><span class="pre">query_expander</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#output-related-parameters">7.3.57.4.4. Output related parameters</a><ul>
<li><a class="reference internal" href="#output-columns">7.3.57.4.4.1. <code class="docutils literal notranslate"><span class="pre">output_columns</span></code></a></li>
<li><a class="reference internal" href="#sortby">7.3.57.4.4.2. <code class="docutils literal notranslate"><span class="pre">sortby</span></code></a></li>
<li><a class="reference internal" href="#sort-keys">7.3.57.4.4.3. <code class="docutils literal notranslate"><span class="pre">sort_keys</span></code></a></li>
<li><a class="reference internal" href="#offset">7.3.57.4.4.4. <code class="docutils literal notranslate"><span class="pre">offset</span></code></a></li>
<li><a class="reference internal" href="#limit">7.3.57.4.4.5. <code class="docutils literal notranslate"><span class="pre">limit</span></code></a></li>
<li><a class="reference internal" href="#scorer">7.3.57.4.4.6. <code class="docutils literal notranslate"><span class="pre">scorer</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#dynamic-column-related-parameters">7.3.57.4.5. Dynamic column related parameters</a><ul>
<li><a class="reference internal" href="#columns-name-stage">7.3.57.4.5.1. <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].stage</span></code></a></li>
<li><a class="reference internal" href="#columns-name-flags">7.3.57.4.5.2. <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].flags</span></code></a></li>
<li><a class="reference internal" href="#columns-name-type">7.3.57.4.5.3. <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].type</span></code></a></li>
<li><a class="reference internal" href="#columns-name-value">7.3.57.4.5.4. <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].value</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#window-function-related-parameters">7.3.57.4.6. Window function related parameters</a><ul>
<li><a class="reference internal" href="#columns-name-window-sort-keys">7.3.57.4.6.1. <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.sort_keys</span></code></a></li>
<li><a class="reference internal" href="#columns-name-window-group-keys">7.3.57.4.6.2. <code class="docutils literal notranslate"><span class="pre">columns[${NAME}].window.group_keys</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#drilldown-related-parameters">7.3.57.4.7. Drilldown related parameters</a><ul>
<li><a class="reference internal" href="#select-drilldown">7.3.57.4.7.1. <code class="docutils literal notranslate"><span class="pre">drilldown</span></code></a></li>
<li><a class="reference internal" href="#drilldown-sortby">7.3.57.4.7.2. <code class="docutils literal notranslate"><span class="pre">drilldown_sortby</span></code></a></li>
<li><a class="reference internal" href="#drilldown-sort-keys">7.3.57.4.7.3. <code class="docutils literal notranslate"><span class="pre">drilldown_sort_keys</span></code></a></li>
<li><a class="reference internal" href="#drilldown-output-columns">7.3.57.4.7.4. <code class="docutils literal notranslate"><span class="pre">drilldown_output_columns</span></code></a></li>
<li><a class="reference internal" href="#drilldown-offset">7.3.57.4.7.5. <code class="docutils literal notranslate"><span class="pre">drilldown_offset</span></code></a></li>
<li><a class="reference internal" href="#drilldown-limit">7.3.57.4.7.6. <code class="docutils literal notranslate"><span class="pre">drilldown_limit</span></code></a></li>
<li><a class="reference internal" href="#drilldown-calc-types">7.3.57.4.7.7. <code class="docutils literal notranslate"><span class="pre">drilldown_calc_types</span></code></a></li>
<li><a class="reference internal" href="#drilldown-calc-target">7.3.57.4.7.8. <code class="docutils literal notranslate"><span class="pre">drilldown_calc_target</span></code></a></li>
<li><a class="reference internal" href="#drilldown-filter">7.3.57.4.7.9. <code class="docutils literal notranslate"><span class="pre">drilldown_filter</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#advanced-drilldown-related-parameters">7.3.57.4.8. Advanced drilldown related parameters</a><ul>
<li><a class="reference internal" href="#drilldowns-label-keys">7.3.57.4.8.1. <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].keys</span></code></a></li>
<li><a class="reference internal" href="#drilldowns-label-output-columns">7.3.57.4.8.2. <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].output_columns</span></code></a></li>
<li><a class="reference internal" href="#drilldowns-label-columns-name-stage">7.3.57.4.8.3. <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}].columns[${NAME}].stage</span></code></a></li>
<li><a class="reference internal" href="#output-format-for-drilldowns-label-style">7.3.57.4.8.4. Output format for <code class="docutils literal notranslate"><span class="pre">drilldowns[${LABEL}]</span></code> style</a></li>
</ul>
</li>
<li><a class="reference internal" href="#slice-related-parameters">7.3.57.4.9. Slice related parameters</a><ul>
<li><a class="reference internal" href="#slices-label-match-columns">7.3.57.4.9.1. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].match_columns</span></code></a></li>
<li><a class="reference internal" href="#slices-label-query">7.3.57.4.9.2. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].query</span></code></a></li>
<li><a class="reference internal" href="#slices-label-filter">7.3.57.4.9.3. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].filter</span></code></a></li>
<li><a class="reference internal" href="#slices-label-query-expander">7.3.57.4.9.4. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].query_expander</span></code></a></li>
<li><a class="reference internal" href="#slices-label-query-flags">7.3.57.4.9.5. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].query_flags</span></code></a></li>
<li><a class="reference internal" href="#slices-label-sort-keys">7.3.57.4.9.6. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].sort_keys</span></code></a></li>
<li><a class="reference internal" href="#slices-label-output-columns">7.3.57.4.9.7. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].output_columns</span></code></a></li>
<li><a class="reference internal" href="#slices-label-offset">7.3.57.4.9.8. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].offset</span></code></a></li>
<li><a class="reference internal" href="#slices-label-limit">7.3.57.4.9.9. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].limit</span></code></a></li>
<li><a class="reference internal" href="#slices-label-table">7.3.57.4.9.10. <code class="docutils literal notranslate"><span class="pre">slices[${LABEL}].table</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#cache-related-parameter">7.3.57.4.10. Cache related parameter</a><ul>
<li><a class="reference internal" href="#cache">7.3.57.4.10.1. <code class="docutils literal notranslate"><span class="pre">cache</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#score-related-parameters">7.3.57.4.11. Score related parameters</a><ul>
<li><a class="reference internal" href="#adjuster">7.3.57.4.11.1. <code class="docutils literal notranslate"><span class="pre">adjuster</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#return-value">7.3.57.5. Return value</a></li>
<li><a class="reference internal" href="#see-also">7.3.57.6. See also</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="schema.html"
                        title="previous chapter"><span class="section-number">7.3.56. </span><code class="docutils literal notranslate"><span class="pre">schema</span></code></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="shutdown.html"
                        title="next chapter"><span class="section-number">7.3.58. </span><code class="docutils literal notranslate"><span class="pre">shutdown</span></code></a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="shutdown.html" title="7.3.58. shutdown"
             >next</a> |</li>
        <li class="right" >
          <a href="schema.html" title="7.3.56. schema"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v10.1.1-31-g1e46ba6 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="../../reference.html" ><span class="section-number">7. </span>Reference manual</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="../command.html" ><span class="section-number">7.3. </span>Command</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href=""><span class="section-number">7.3.57. </span><code class="docutils literal notranslate"><span class="pre">select</span></code></a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2009-2021, Brazil, Inc.
    </div>
  </body>
</html>