RubyGems - rroonga - Versions diffs - 5.0.4-x64-mingw32 → 5.0.5-x64-mingw32 - Mend

rroonga 5.0.4-x64-mingw32 → 5.0.5-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (750) hide show

data/vendor/local/share/doc/groonga/en/html/reference/commands/io_flush.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.3.16. io_flush &mdash; Groonga v5.0.4-139-g6629adb documentation</title>
+    <title>7.3.18. io_flush &mdash; Groonga v5.0.6-226-gd7da7e7 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '5.0.4-139-g6629adb',
+        VERSION:     '5.0.6-226-gd7da7e7',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,12 +25,12 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
-    <link rel="top" title="Groonga v5.0.4-139-g6629adb documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v5.0.6-226-gd7da7e7 documentation" href="../../index.html" />
     <link rel="up" title="7.3. Command" href="../command.html" />
-    <link rel="next" title="7.3.17. load" href="load.html" />
-    <link rel="prev" title="7.3.15. dump" href="dump.html" />
+    <link rel="next" title="7.3.19. load" href="load.html" />
+    <link rel="prev" title="7.3.17. dump" href="dump.html" />
   </head>
-  <body>
+  <body role="document">
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../../index.html">
@@ -48,33 +48,33 @@
 </div>
-    <div class="related">
+    <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="load.html" title="7.3.17. load"
+          <a href="load.html" title="7.3.19. load"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="dump.html" title="7.3.15. dump"
+          <a href="dump.html" title="7.3.17. dump"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v5.0.4-139-g6629adb documentation</a> &raquo;</li>
-          <li><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
-          <li><a href="../command.html" accesskey="U">7.3. Command</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+          <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
+          <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> &raquo;</li>
       </ul>
     </div>
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-          <div class="body">
+          <div class="body" role="main">
   <div class="section" id="io-flush">
-<h1>7.3.16. <tt class="docutils literal"><span class="pre">io_flush</span></tt><a class="headerlink" href="#io-flush" title="Permalink to this headline">¶</a></h1>
+<h1>7.3.18. <code class="docutils literal"><span class="pre">io_flush</span></code><a class="headerlink" href="#io-flush" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
-<h2>7.3.16.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.18.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
 <p class="last">This command is an experimental feature.</p>
@@ -82,41 +82,265 @@
 <div class="versionadded">
 <p><span class="versionmodified">New in version 5.0.5.</span></p>
 </div>
-<p>TODO</p>
+<p><code class="docutils literal"><span class="pre">io_flush</span></code> flushes all changes in memory to disk
+explicitly. Normally, you don't need to use <code class="docutils literal"><span class="pre">io_flush</span></code>
+explicitly. Because flushing is done automatically by OS. And flushing
+by OS is effective.</p>
+<p>You need to use <code class="docutils literal"><span class="pre">io_flush</span></code> explicitly when your system may often
+crash unexpectedly or you may not shutdown your Groonga process in a
+normal way. (For example, using <a class="reference internal" href="shutdown.html"><em>shutdown</em></a> is a normal shutdown
+process.) It's better that you use <code class="docutils literal"><span class="pre">io_flush</span></code> after you change your
+Groonga database for the case. Here are commands that change your
+Groonga database:</p>
+<blockquote>
+<div><ul class="simple">
+<li><a class="reference internal" href="load.html"><em>load</em></a></li>
+<li><a class="reference internal" href="delete.html"><em>delete</em></a></li>
+<li><a class="reference internal" href="truncate.html"><em>truncate</em></a></li>
+<li><a class="reference internal" href="table_create.html"><em>table_create</em></a></li>
+<li><a class="reference internal" href="table_remove.html"><em>table_remove</em></a></li>
+<li><a class="reference internal" href="table_rename.html"><em>table_rename</em></a></li>
+<li><a class="reference internal" href="column_create.html"><em>column_create</em></a></li>
+<li><a class="reference internal" href="column_remove.html"><em>column_remove</em></a></li>
+<li><a class="reference internal" href="column_rename.html"><em>column_rename</em></a></li>
+<li><a class="reference internal" href="plugin_register.html"><em>plugin_register</em></a></li>
+<li><a class="reference internal" href="plugin_unregister.html"><em>plugin_unregister</em></a></li>
+</ul>
+</div></blockquote>
+<p>If you're using <a class="reference internal" href="select.html#select-scorer"><span>scorer</span></a> parameter in <a class="reference internal" href="select.html"><em>select</em></a> to
+change existing column values, <a class="reference internal" href="select.html"><em>select</em></a> is added to the above
+list.</p>
+<p>Note that <code class="docutils literal"><span class="pre">io_flush</span></code> may be a heavy process. If there are many
+changes in memory, flushing them to disk is a heavy process.</p>
 </div>
 <div class="section" id="syntax">
-<h2>7.3.16.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
-<p><tt class="docutils literal"><span class="pre">io_flush</span></tt> command has two parameters.</p>
-<div class="highlight-none"><div class="highlight"><pre>io_flush [target_name]
+<h2>7.3.18.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<p>This command takes two parameters.</p>
+<p>All parameters are optional:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush [target_name=null]
          [recursive=yes]
 </pre></div>
 </div>
 </div>
 <div class="section" id="usage">
-<h2>7.3.16.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
-<p>TODO</p>
+<h2>7.3.18.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<p>You can flush all changes in memory to disk with no arguments:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>If you know what is changed, you can narrow flush targets. Here is a
+correspondence table between command and flush targets.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="33%" />
+<col width="33%" />
+<col width="33%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Command</th>
+<th class="head">Flush targets</th>
+<th class="head"><code class="docutils literal"><span class="pre">io_flush</span></code> arguments</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><a class="reference internal" href="load.html"><em>load</em></a> and <a class="reference internal" href="delete.html"><em>delete</em></a></td>
+<td><p class="first">Target table and its columns.</p>
+<p>If there are one or more reference columns in these columns,
+referenced tables are also flush targets.</p>
+<p class="last">If there are one or more indexed columns in these columns,
+tables of corresponding index columns and corresponding index
+columns are also flush targets.</p>
+</td>
+<td><p class="first">Table and its columns:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME
+</pre></div>
+</div>
+<p>A referenced table:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name REFERENCED_TABLE_NAME --recursive no
+</pre></div>
+</div>
+<p>A table of an index column:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no
+</pre></div>
+</div>
+<p>An index column:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
+</pre></div>
+</div>
+</td>
+</tr>
+<tr class="row-odd"><td><a class="reference internal" href="truncate.html"><em>truncate</em></a></td>
+<td><p class="first">Target table and its columns.</p>
+<p>If there are one or more reference columns in these columns,
+referenced tables are also flush targets.</p>
+<p>If there are one or more indexed columns in these columns,
+tables of corresponding index columns and corresponding index
+columns are also flush targets.</p>
+<p class="last">Database is also flush target.</p>
+</td>
+<td><p class="first">Table and its columns:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME
+</pre></div>
+</div>
+<p>A referenced table:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name REFERENCED_TABLE_NAME --recursive no
+</pre></div>
+</div>
+<p>A table of an index column:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no
+</pre></div>
+</div>
+<p>An index column:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
+</pre></div>
+</div>
+<p>Database:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no
+</pre></div>
+</div>
+</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="table_create.html"><em>table_create</em></a></td>
+<td>Target table and database.</td>
+<td><p class="first">Table:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME
+</pre></div>
+</div>
+<p>Database:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no
+</pre></div>
+</div>
+</td>
+</tr>
+<tr class="row-odd"><td><a class="reference internal" href="table_remove.html"><em>table_remove</em></a> and <a class="reference internal" href="table_rename.html"><em>table_rename</em></a></td>
+<td>Database.</td>
+<td><p class="first">Database:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no
+</pre></div>
+</div>
+</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="column_create.html"><em>column_create</em></a></td>
+<td>Target column and database.</td>
+<td><p class="first">Table:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --target_name TABLE_NAME.COLUMN_NAME
+</pre></div>
+</div>
+<p>Database:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no
+</pre></div>
+</div>
+</td>
+</tr>
+<tr class="row-odd"><td><a class="reference internal" href="column_remove.html"><em>column_remove</em></a> and <a class="reference internal" href="column_rename.html"><em>column_rename</em></a></td>
+<td>Database.</td>
+<td><p class="first">Database:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no
+</pre></div>
+</div>
+</td>
+</tr>
+<tr class="row-even"><td><a class="reference internal" href="plugin_register.html"><em>plugin_register</em></a> and <a class="reference internal" href="plugin_unregister.html"><em>plugin_unregister</em></a></td>
+<td>Database.</td>
+<td><p class="first">Database:</p>
+<div class="last highlight-none"><div class="highlight"><pre>io_flush --recursive no
+</pre></div>
+</div>
+</td>
+</tr>
+</tbody>
+</table>
 </div>
 <div class="section" id="parameters">
-<h2>7.3.16.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
-<p>This section describes parameters of <tt class="docutils literal"><span class="pre">io_flush</span></tt>.</p>
+<h2>7.3.18.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<p>This section describes all parameters.</p>
+<div class="section" id="required-parameters">
+<h3>7.3.18.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There is no required parameters.</p>
+</div>
 <div class="section" id="optional-parameters">
-<h3>7.3.16.4.1. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
+<h3>7.3.18.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
 <p>There are optional parameters.</p>
 <div class="section" id="target-name">
-<h4>7.3.16.4.1.1. <tt class="docutils literal"><span class="pre">target_name</span></tt><a class="headerlink" href="#target-name" title="Permalink to this headline">¶</a></h4>
-<p>TODO</p>
+<span id="io-flush-target-name"></span><h4>7.3.18.4.2.1. <code class="docutils literal"><span class="pre">target_name</span></code><a class="headerlink" href="#target-name" title="Permalink to this headline">¶</a></h4>
+<p>Specifies a flush target object name. Target object is one of
+database, table or column.</p>
+<p>If you omit this parameter, database is flush target object:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>If you specify table name, the table is flush target object:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>table_create Users TABLE_HASH_KEY ShortText
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+io_flush --target_name Users
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>If you specify column name, the column is flush target object:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>column_create Users age COLUMN_SCALAR UInt8
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+io_flush --target_name Users.age
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
 </div>
 <div class="section" id="recursive">
-<h4>7.3.16.4.1.2. <tt class="docutils literal"><span class="pre">recursive</span></tt><a class="headerlink" href="#recursive" title="Permalink to this headline">¶</a></h4>
-<p>TODO</p>
+<span id="io-flush-recursive"></span><h4>7.3.18.4.2.2. <code class="docutils literal"><span class="pre">recursive</span></code><a class="headerlink" href="#recursive" title="Permalink to this headline">¶</a></h4>
+<p>Specifies whether child objects of the flush target object are also
+flush target objects.</p>
+<p>Child objects of database is all tables and all columns.</p>
+<p>Child objects of table is all its columns.</p>
+<p>Child objects of column is nothing.</p>
+<p><code class="docutils literal"><span class="pre">recursive</span></code> value must be <code class="docutils literal"><span class="pre">yes</span></code> or <code class="docutils literal"><span class="pre">no</span></code>. <code class="docutils literal"><span class="pre">yes</span></code> means that all
+of the specified flush target object and child objects are flush
+target objects. <code class="docutils literal"><span class="pre">no</span></code> means that only the specified flush target
+object is flush target object.</p>
+<p>The following <code class="docutils literal"><span class="pre">io_flush</span></code> flushes all changes in database, all tables
+and all columns:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --recursive yes
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>The following <code class="docutils literal"><span class="pre">io_flush</span></code> flushes all changes only in database:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --recursive no
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p>If you specify other value (not <code class="docutils literal"><span class="pre">yes</span></code> neither <code class="docutils literal"><span class="pre">no</span></code>) or omit
+<code class="docutils literal"><span class="pre">recursive</span></code> parameter, <code class="docutils literal"><span class="pre">yes</span></code> is used.</p>
+<p><code class="docutils literal"><span class="pre">yes</span></code> is used in the following case because invalid <code class="docutils literal"><span class="pre">recursive</span></code>
+argument is specified:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush --recursive invalid
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
+<p><code class="docutils literal"><span class="pre">yes</span></code> is used in the following case because <code class="docutils literal"><span class="pre">recursive</span></code> parameter
+isn't specified:</p>
+<p>Execution example:</p>
+<div class="highlight-none"><div class="highlight"><pre>io_flush
+# [[0, 1337566253.89858, 0.000355720520019531], true]
+</pre></div>
+</div>
 </div>
 </div>
 </div>
 <div class="section" id="return-value">
-<h2>7.3.16.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.18.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<p>The command returns <code class="docutils literal"><span class="pre">true</span></code> as body on success such as:</p>
 <div class="highlight-none"><div class="highlight"><pre>[HEADER, true]
 </pre></div>
 </div>
+<p>If the command fails, error details are in <code class="docutils literal"><span class="pre">HEADER</span></code>.</p>
+<p>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> for <code class="docutils literal"><span class="pre">HEADER</span></code>.</p>
 </div>
 </div>
@@ -124,39 +348,42 @@
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar">
+      <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.16. <tt class="docutils literal"><span class="pre">io_flush</span></tt></a><ul>
-<li><a class="reference internal" href="#summary">7.3.16.1. Summary</a></li>
-<li><a class="reference internal" href="#syntax">7.3.16.2. Syntax</a></li>
-<li><a class="reference internal" href="#usage">7.3.16.3. Usage</a></li>
-<li><a class="reference internal" href="#parameters">7.3.16.4. Parameters</a><ul>
-<li><a class="reference internal" href="#optional-parameters">7.3.16.4.1. Optional parameters</a><ul>
-<li><a class="reference internal" href="#target-name">7.3.16.4.1.1. <tt class="docutils literal"><span class="pre">target_name</span></tt></a></li>
-<li><a class="reference internal" href="#recursive">7.3.16.4.1.2. <tt class="docutils literal"><span class="pre">recursive</span></tt></a></li>
+<li><a class="reference internal" href="#">7.3.18. <code class="docutils literal"><span class="pre">io_flush</span></code></a><ul>
+<li><a class="reference internal" href="#summary">7.3.18.1. Summary</a></li>
+<li><a class="reference internal" href="#syntax">7.3.18.2. Syntax</a></li>
+<li><a class="reference internal" href="#usage">7.3.18.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">7.3.18.4. Parameters</a><ul>
+<li><a class="reference internal" href="#required-parameters">7.3.18.4.1. Required parameters</a></li>
+<li><a class="reference internal" href="#optional-parameters">7.3.18.4.2. Optional parameters</a><ul>
+<li><a class="reference internal" href="#target-name">7.3.18.4.2.1. <code class="docutils literal"><span class="pre">target_name</span></code></a></li>
+<li><a class="reference internal" href="#recursive">7.3.18.4.2.2. <code class="docutils literal"><span class="pre">recursive</span></code></a></li>
 </ul>
 </li>
 </ul>
 </li>
-<li><a class="reference internal" href="#return-value">7.3.16.5. Return value</a></li>
+<li><a class="reference internal" href="#return-value">7.3.18.5. Return value</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
   <p class="topless"><a href="dump.html"
-                        title="previous chapter">7.3.15. <tt class="docutils literal"><span class="pre">dump</span></tt></a></p>
+                        title="previous chapter">7.3.17. <code class="docutils literal"><span class="pre">dump</span></code></a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="load.html"
-                        title="next chapter">7.3.17. <tt class="docutils literal"><span class="pre">load</span></tt></a></p>
-  <h3>This Page</h3>
-  <ul class="this-page-menu">
-    <li><a href="../../_sources/reference/commands/io_flush.txt"
-           rel="nofollow">Show Source</a></li>
-  </ul>
-<div id="searchbox" style="display: none">
+                        title="next chapter">7.3.19. <code class="docutils literal"><span class="pre">load</span></code></a></p>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../../_sources/reference/commands/io_flush.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
     <form class="search" action="../../search.html" method="get">
       <input type="text" name="q" />
@@ -173,24 +400,24 @@
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related">
+    <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="load.html" title="7.3.17. load"
+          <a href="load.html" title="7.3.19. load"
              >next</a> |</li>
         <li class="right" >
-          <a href="dump.html" title="7.3.15. dump"
+          <a href="dump.html" title="7.3.17. dump"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v5.0.4-139-g6629adb documentation</a> &raquo;</li>
-          <li><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
-          <li><a href="../command.html" >7.3. Command</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+          <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
+          <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> &raquo;</li>
       </ul>
     </div>
-    <div class="footer">
+    <div class="footer" role="contentinfo">
         &copy; Copyright 2009-2015, Brazil, Inc.
     </div>
   </body>

data/vendor/local/share/doc/groonga/en/html/reference/commands/load.html CHANGED Viewed

@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.3.17. load &mdash; Groonga v5.0.4-139-g6629adb documentation</title>
+    <title>7.3.19. load &mdash; Groonga v5.0.6-226-gd7da7e7 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
     <script type="text/javascript">
       var DOCUMENTATION_OPTIONS = {
         URL_ROOT:    '../../',
-        VERSION:     '5.0.4-139-g6629adb',
+        VERSION:     '5.0.6-226-gd7da7e7',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -25,12 +25,12 @@
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
     <link rel="shortcut icon" href="../../_static/favicon.ico"/>
-    <link rel="top" title="Groonga v5.0.4-139-g6629adb documentation" href="../../index.html" />
+    <link rel="top" title="Groonga v5.0.6-226-gd7da7e7 documentation" href="../../index.html" />
     <link rel="up" title="7.3. Command" href="../command.html" />
-    <link rel="next" title="7.3.18. lock_clear" href="lock_clear.html" />
-    <link rel="prev" title="7.3.16. io_flush" href="io_flush.html" />
+    <link rel="next" title="7.3.20. lock_clear" href="lock_clear.html" />
+    <link rel="prev" title="7.3.18. io_flush" href="io_flush.html" />
   </head>
-  <body>
+  <body role="document">
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../../index.html">
@@ -48,80 +48,80 @@
 </div>
-    <div class="related">
+    <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="lock_clear.html" title="7.3.18. lock_clear"
+          <a href="lock_clear.html" title="7.3.20. lock_clear"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="io_flush.html" title="7.3.16. io_flush"
+          <a href="io_flush.html" title="7.3.18. io_flush"
              accesskey="P">previous</a> |</li>
-        <li><a href="../../index.html">Groonga v5.0.4-139-g6629adb documentation</a> &raquo;</li>
-          <li><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
-          <li><a href="../command.html" accesskey="U">7.3. Command</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+          <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
+          <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> &raquo;</li>
       </ul>
     </div>
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-          <div class="body">
+          <div class="body" role="main">
   <div class="section" id="load">
-<h1>7.3.17. <tt class="docutils literal"><span class="pre">load</span></tt><a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h1>
+<h1>7.3.19. <code class="docutils literal"><span class="pre">load</span></code><a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
-<h2>7.3.17.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
-<p><tt class="docutils literal"><span class="pre">load</span></tt> loads data as records in the current database and updates values of each columns.</p>
+<h2>7.3.19.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
+<p><code class="docutils literal"><span class="pre">load</span></code> loads data as records in the current database and updates values of each columns.</p>
 </div>
 <div class="section" id="syntax">
-<h2>7.3.17.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.19.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-none"><div class="highlight"><pre>load values table [columns [ifexists [input_type]]]
 </pre></div>
 </div>
 </div>
 <div class="section" id="parameters">
-<h2>7.3.17.3. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.19.3. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
 <p>This section describes all parameters.</p>
-<p><tt class="docutils literal"><span class="pre">values</span></tt></p>
+<p><code class="docutils literal"><span class="pre">values</span></code></p>
 <blockquote>
 <div><p>Specifies values loaded to records.
-Values should satisfy <tt class="docutils literal"><span class="pre">input_type</span></tt> format.
-If you specify &quot;json&quot; as <tt class="docutils literal"><span class="pre">input_type</span></tt>, you can choose a format from below:</p>
+Values should satisfy <code class="docutils literal"><span class="pre">input_type</span></code> format.
+If you specify &quot;json&quot; as <code class="docutils literal"><span class="pre">input_type</span></code>, you can choose a format from below:</p>
 <dl class="docutils">
-<dt><tt class="docutils literal"><span class="pre">Format</span> <span class="pre">1:</span></tt></dt>
+<dt><code class="docutils literal"><span class="pre">Format</span> <span class="pre">1:</span></code></dt>
 <dd>[[COLUMN_NAME1, COLUMN_NAME2,..], [VALUE1, VALUE2,..], [VALUE1, VALUE2,..],..]</dd>
-<dt><tt class="docutils literal"><span class="pre">Format</span> <span class="pre">2:</span></tt></dt>
+<dt><code class="docutils literal"><span class="pre">Format</span> <span class="pre">2:</span></code></dt>
 <dd>[{COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2}, {COLUMN_NAME1: VALUE1, COLUMN_NAME2: VALUE2},..]</dd>
 </dl>
-<p><tt class="docutils literal"><span class="pre">[COLUMN_NAME1,</span> <span class="pre">COLUMN_NAME2,..]</span></tt> format in <tt class="docutils literal"><span class="pre">Format</span> <span class="pre">1</span></tt> is effective only when <tt class="docutils literal"><span class="pre">column</span></tt> parameter isn't specified.</p>
-<p>When a target table contains primary key, you must specify <tt class="docutils literal"><span class="pre">_key</span></tt> column (pseudo column associated primary key) as the one of <tt class="docutils literal"><span class="pre">COLUMN_NAME</span></tt>.</p>
-<p>If <tt class="docutils literal"><span class="pre">values</span></tt> isn't specified any values, they are read from the standard input until all opened parenthes match their closed ones.
-You don't have to enclose them with single-quotes or double-quotes, but if you specified values with <tt class="docutils literal"><span class="pre">values</span></tt> parameter, you should do.</p>
+<p><code class="docutils literal"><span class="pre">[COLUMN_NAME1,</span> <span class="pre">COLUMN_NAME2,..]</span></code> format in <code class="docutils literal"><span class="pre">Format</span> <span class="pre">1</span></code> is effective only when <code class="docutils literal"><span class="pre">column</span></code> parameter isn't specified.</p>
+<p>When a target table contains primary key, you must specify <code class="docutils literal"><span class="pre">_key</span></code> column (pseudo column associated primary key) as the one of <code class="docutils literal"><span class="pre">COLUMN_NAME</span></code>.</p>
+<p>If <code class="docutils literal"><span class="pre">values</span></code> isn't specified any values, they are read from the standard input until all opened parenthes match their closed ones.
+You don't have to enclose them with single-quotes or double-quotes, but if you specified values with <code class="docutils literal"><span class="pre">values</span></code> parameter, you should do.</p>
 <p>In following values, you also don't have to enclose any spaces (' ') with single-quotes or double-quotes.</p>
 </div></blockquote>
-<p><tt class="docutils literal"><span class="pre">table</span></tt></p>
+<p><code class="docutils literal"><span class="pre">table</span></code></p>
 <blockquote>
 <div>Specifies a table name you want to add records.</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">columns</span></tt></p>
+<p><code class="docutils literal"><span class="pre">columns</span></code></p>
 <blockquote>
 <div>Specifies column names in added records with comma separations.</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">ifexists</span></tt></p>
+<p><code class="docutils literal"><span class="pre">ifexists</span></code></p>
 <blockquote>
-<div>Specifies executed <tt class="docutils literal"><span class="pre">grn_expr</span></tt> string when the same primary key
+<div>Specifies executed <code class="docutils literal"><span class="pre">grn_expr</span></code> string when the same primary key
 as added records already exists in your table.
-If <tt class="docutils literal"><span class="pre">ifexists</span></tt> specifies <tt class="docutils literal"><span class="pre">grn_expr</span></tt> string (default: true) and
-its value is true, values in other (all columns excluding <tt class="docutils literal"><span class="pre">_key</span></tt>
+If <code class="docutils literal"><span class="pre">ifexists</span></code> specifies <code class="docutils literal"><span class="pre">grn_expr</span></code> string (default: true) and
+its value is true, values in other (all columns excluding <code class="docutils literal"><span class="pre">_key</span></code>
 column) columns is updated.</div></blockquote>
-<p><tt class="docutils literal"><span class="pre">input_type</span></tt></p>
+<p><code class="docutils literal"><span class="pre">input_type</span></code></p>
 <blockquote>
-<div>Specifies an input format for <tt class="docutils literal"><span class="pre">values</span></tt>. It supports JSON only.</div></blockquote>
+<div>Specifies an input format for <code class="docutils literal"><span class="pre">values</span></code>. It supports JSON only.</div></blockquote>
 </div>
 <div class="section" id="usage">
-<h2>7.3.17.4. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.19.4. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 <p>Here is an example to add records to &quot;Entry&quot; table.</p>
 <div class="highlight-none"><div class="highlight"><pre>load --table Entry --input_type json --values [{\&quot;_key\&quot;:\&quot;Groonga\&quot;,\&quot;body\&quot;:\&quot;It&#39;s very fast!!\&quot;}]
@@ -139,11 +139,11 @@ column) columns is updated.</div></blockquote>
 </div>
 </div>
 <div class="section" id="return-value">
-<h2>7.3.17.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.19.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="json-format">
-<h3>7.3.17.5.1. JSON format<a class="headerlink" href="#json-format" title="Permalink to this headline">¶</a></h3>
+<h3>7.3.19.5.1. JSON format<a class="headerlink" href="#json-format" title="Permalink to this headline">¶</a></h3>
 <blockquote>
-<div><p><tt class="docutils literal"><span class="pre">load</span></tt> returns the number of added records such as</p>
+<div><p><code class="docutils literal"><span class="pre">load</span></code> returns the number of added records such as</p>
 <div class="highlight-none"><div class="highlight"><pre>[NUMBER]
 </pre></div>
 </div>
@@ -151,7 +151,7 @@ column) columns is updated.</div></blockquote>
 </div>
 </div>
 <div class="section" id="see-also">
-<h2>7.3.17.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
+<h2>7.3.19.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 <p><a class="reference internal" href="../grn_expr.html"><em>grn_expr</em></a></p>
 </div>
 </div>
@@ -160,36 +160,38 @@ column) columns is updated.</div></blockquote>
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar">
+      <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.17. <tt class="docutils literal"><span class="pre">load</span></tt></a><ul>
-<li><a class="reference internal" href="#summary">7.3.17.1. Summary</a></li>
-<li><a class="reference internal" href="#syntax">7.3.17.2. Syntax</a></li>
-<li><a class="reference internal" href="#parameters">7.3.17.3. Parameters</a></li>
-<li><a class="reference internal" href="#usage">7.3.17.4. Usage</a></li>
-<li><a class="reference internal" href="#return-value">7.3.17.5. Return value</a><ul>
-<li><a class="reference internal" href="#json-format">7.3.17.5.1. JSON format</a></li>
+<li><a class="reference internal" href="#">7.3.19. <code class="docutils literal"><span class="pre">load</span></code></a><ul>
+<li><a class="reference internal" href="#summary">7.3.19.1. Summary</a></li>
+<li><a class="reference internal" href="#syntax">7.3.19.2. Syntax</a></li>
+<li><a class="reference internal" href="#parameters">7.3.19.3. Parameters</a></li>
+<li><a class="reference internal" href="#usage">7.3.19.4. Usage</a></li>
+<li><a class="reference internal" href="#return-value">7.3.19.5. Return value</a><ul>
+<li><a class="reference internal" href="#json-format">7.3.19.5.1. JSON format</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#see-also">7.3.17.6. See also</a></li>
+<li><a class="reference internal" href="#see-also">7.3.19.6. See also</a></li>
 </ul>
 </li>
 </ul>
   <h4>Previous topic</h4>
   <p class="topless"><a href="io_flush.html"
-                        title="previous chapter">7.3.16. <tt class="docutils literal"><span class="pre">io_flush</span></tt></a></p>
+                        title="previous chapter">7.3.18. <code class="docutils literal"><span class="pre">io_flush</span></code></a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="lock_clear.html"
-                        title="next chapter">7.3.18. <tt class="docutils literal"><span class="pre">lock_clear</span></tt></a></p>
-  <h3>This Page</h3>
-  <ul class="this-page-menu">
-    <li><a href="../../_sources/reference/commands/load.txt"
-           rel="nofollow">Show Source</a></li>
-  </ul>
-<div id="searchbox" style="display: none">
+                        title="next chapter">7.3.20. <code class="docutils literal"><span class="pre">lock_clear</span></code></a></p>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="../../_sources/reference/commands/load.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
+<div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
     <form class="search" action="../../search.html" method="get">
       <input type="text" name="q" />
@@ -206,24 +208,24 @@ column) columns is updated.</div></blockquote>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related">
+    <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="lock_clear.html" title="7.3.18. lock_clear"
+          <a href="lock_clear.html" title="7.3.20. lock_clear"
              >next</a> |</li>
         <li class="right" >
-          <a href="io_flush.html" title="7.3.16. io_flush"
+          <a href="io_flush.html" title="7.3.18. io_flush"
              >previous</a> |</li>
-        <li><a href="../../index.html">Groonga v5.0.4-139-g6629adb documentation</a> &raquo;</li>
-          <li><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
-          <li><a href="../command.html" >7.3. Command</a> &raquo;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v5.0.6-226-gd7da7e7 documentation</a> &raquo;</li>
+          <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &raquo;</li>
+          <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> &raquo;</li>
       </ul>
     </div>
-    <div class="footer">
+    <div class="footer" role="contentinfo">
         &copy; Copyright 2009-2015, Brazil, Inc.
     </div>
   </body>