RubyGems - rroonga - Versions diffs - 7.1.1-x64-mingw32 → 9.0.2-x64-mingw32 - Mend

rroonga 7.1.1-x64-mingw32 → 9.0.2-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 (980) hide show

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

@@ -1,34 +1,26 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.3.24. load &#8212; Groonga v7.1.0-73-g6d02cfa documentation</title>
+    <meta charset="utf-8" />
+    <title>7.3.24. load &#8212; Groonga v9.0.2 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../../',
-        VERSION:     '7.1.0-73-g6d02cfa',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  false,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" 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.25. lock_acquire" href="lock_acquire.html" />
     <link rel="prev" title="7.3.23. io_flush" href="io_flush.html" />
-  </head>
-  <body>
+  </head><body>
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../../index.html">
@@ -58,7 +50,7 @@
         <li class="right" >
           <a href="io_flush.html" title="7.3.23. io_flush"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> &#187;</li>
       </ul>
@@ -70,87 +62,227 @@
           <div class="body" role="main">
   <div class="section" id="load">
-<h1>7.3.24. <code class="docutils literal"><span class="pre">load</span></code><a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h1>
+<h1>7.3.24. <code class="docutils literal notranslate"><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.24.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>
+<p><code class="docutils literal notranslate"><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.24.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
-<div class="highlight-none"><div class="highlight"><pre><span></span>load values table [columns [ifexists [input_type]]]
+<p>The required parameters are only <code class="docutils literal notranslate"><span class="pre">values</span></code> and <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>load values
+     table
+     [columns=null]
+     [ifexists=null]
+     [input_type=json]
+     [each=null]
+     [output_ids=no]
+     [output_errors=no]
+     [lock_table=no]
 </pre></div>
 </div>
+<p>This command is a special command. Other commands need to pass all
+parameters to one line but this command can accept <code class="docutils literal notranslate"><span class="pre">values</span></code> as
+followed data.</p>
+<p>If you use command line style, you can pass <code class="docutils literal notranslate"><span class="pre">values</span></code> like the
+following:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Bookmarks
+[
+{&quot;_key&quot;: &quot;http://groonga.org/&quot;, &quot;title&quot;: &quot;Groonga&quot;},
+{&quot;_key&quot;: &quot;http://mroonga.org/&quot;, &quot;title&quot;: &quot;Mroonga&quot;}
+]
+</pre></div>
+</div>
+<p><code class="docutils literal notranslate"><span class="pre">[...]</span></code> is value of <code class="docutils literal notranslate"><span class="pre">values</span></code>.</p>
+<p>If you use HTTP style, you can pass <code class="docutils literal notranslate"><span class="pre">values</span></code> as body:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>% curl \
+    --request POST \
+    --header &quot;Content-Type: application/json&quot; \
+    --data-raw &#39;[{&quot;_key&quot;: &quot;http://groonga.org/&quot;}]&#39; \
+    http://localhost:10041/d/load?table=Bookmarks&quot;
+</pre></div>
 </div>
-<div class="section" id="parameters">
-<h2>7.3.24.3. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
-<p>This section describes all parameters.</p>
-<p><code class="docutils literal"><span class="pre">values</span></code></p>
-<blockquote>
-<div><p>Specifies values loaded to records.
-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><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><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><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">columns</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><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><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><code class="docutils literal"><span class="pre">ifexists</span></code></p>
-<blockquote>
-<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 <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><code class="docutils literal"><span class="pre">input_type</span></code></p>
-<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.24.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><span></span>load --table Entry --input_type json --values [{\&quot;_key\&quot;:\&quot;Groonga\&quot;,\&quot;body\&quot;:\&quot;It&#39;s very fast!!\&quot;}]
-[1]
+<h2>7.3.24.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<p>Here are schema definitions 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]
 </pre></div>
 </div>
-<p>This example shows how to add values from standard input.</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>load --table Entry --input_type json
+<p>Here is an example to add records to <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table by parameter:</p>
+<p>Execution example:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load \
+  --table Entries \
+  --values &quot;[{\&quot;_key\&quot;:\&quot;Groonga\&quot;,\&quot;content\&quot;:\&quot;It&#39;s very fast!!\&quot;}]&quot;
+# [[0, 1337566253.89858, 0.000355720520019531], 1]
+</pre></div>
+</div>
+<p>Here is an example to add records to <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table from standard input:</p>
+<p>Execution example:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Entries
 [
-{&quot;_key&quot;: &quot;Groonga&quot;, &quot;body&quot;: &quot;It&#39;s very fast!!&quot;}
+{&quot;_key&quot;: &quot;Groonga&quot;, &quot;content&quot;: &quot;It&#39;s very fast!!&quot;}
 ]
-[1]
+# [[0, 1337566253.89858, 0.000355720520019531], 1]
 </pre></div>
 </div>
+<p>Here is an example to lock table while updating columns:</p>
+<p>Execution example:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>load --table Entries --lock_table yes
+[
+{&quot;_key&quot;: &quot;Groonga&quot;, &quot;content&quot;: &quot;It&#39;s very fast!!&quot;}
+]
+# [[0, 1337566253.89858, 0.000355720520019531], 1]
+</pre></div>
+</div>
+</div>
+<div class="section" id="parameters">
+<h2>7.3.24.4. 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>7.3.24.4.1. Required parameters<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There are some required parameters.</p>
+<div class="section" id="values">
+<span id="load-values"></span><h4>7.3.24.4.1.1. <code class="docutils literal notranslate"><span class="pre">values</span></code><a class="headerlink" href="#values" title="Permalink to this headline">¶</a></h4>
+<p>Specifies values to be loaded.</p>
+<p>Values should satisfy <code class="docutils literal notranslate"><span class="pre">input_type</span></code> format. If you specify <code class="docutils literal notranslate"><span class="pre">json</span></code>
+as <code class="docutils literal notranslate"><span class="pre">input_type</span></code>, you can choose a format from below:</p>
+<p>Bracket style:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
+[COLUMN_NAME1, COLUMN_NAME2, ...],
+[VALUE1, VALUE2, ...],
+[VALUE1, VALUE2, ...],
+...
+]
+</pre></div>
+</div>
+<p>Brace style:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[
+{&quot;COLUMN_NAME1&quot;: VALUE1, &quot;COLUMN_NAME2&quot;: VALUE2, ...},
+{&quot;COLUMN_NAME1&quot;: VALUE1, &quot;COLUMN_NAME2&quot;: VALUE2, ...},
+...
+]
+</pre></div>
+</div>
+<p><code class="docutils literal notranslate"><span class="pre">[COLUMN_NAME1,</span> <span class="pre">COLUMN_NAME2,</span> <span class="pre">...]</span></code> in bracket style is effective
+only when <a class="reference internal" href="#load-columns"><span class="std std-ref">columns</span></a> parameter isn’t specified.</p>
+<p>When a target table contains primary key, you must specify <code class="docutils literal notranslate"><span class="pre">_key</span></code>
+column (pseudo column associated primary key) as the one of
+<code class="docutils literal notranslate"><span class="pre">COLUMN_NAME</span></code>.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">values</span></code> isn’t specified any values, they are read from the
+standard input in command line style or body in HTTP style.</p>
+</div>
+<div class="section" id="table">
+<span id="load-table"></span><h4>7.3.24.4.1.2. <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 name you want to add records.</p>
+</div>
+</div>
+<div class="section" id="optional-parameters">
+<h3>7.3.24.4.2. Optional parameters<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h3>
+<p>There are some optional parameters.</p>
+<div class="section" id="columns">
+<span id="load-columns"></span><h4>7.3.24.4.2.1. <code class="docutils literal notranslate"><span class="pre">columns</span></code><a class="headerlink" href="#columns" title="Permalink to this headline">¶</a></h4>
+<p>Specifies column names in added records with comma separations.</p>
+</div>
+<div class="section" id="ifexists">
+<span id="load-ifexists"></span><h4>7.3.24.4.2.2. <code class="docutils literal notranslate"><span class="pre">ifexists</span></code><a class="headerlink" href="#ifexists" title="Permalink to this headline">¶</a></h4>
+<p>Specifies executed expression in
+<a class="reference internal" href="../grn_expr/script_syntax.html"><span class="doc">Script syntax</span></a> when the same primary key as
+added records already exists in your table.</p>
+<p>If <code class="docutils literal notranslate"><span class="pre">ifexists</span></code> specifies expression and its value is <code class="docutils literal notranslate"><span class="pre">true</span></code>, values
+in other (all columns excluding <code class="docutils literal notranslate"><span class="pre">_key</span></code> column) columns is updated.</p>
+</div>
+<div class="section" id="input-type">
+<span id="load-input-type"></span><h4>7.3.24.4.2.3. <code class="docutils literal notranslate"><span class="pre">input_type</span></code><a class="headerlink" href="#input-type" title="Permalink to this headline">¶</a></h4>
+<p>Specifies an input format for <code class="docutils literal notranslate"><span class="pre">values</span></code>. It supports only <code class="docutils literal notranslate"><span class="pre">json</span></code>
+for now. It means format of <code class="docutils literal notranslate"><span class="pre">values</span></code> is JSON.</p>
+<p>The default value is <code class="docutils literal notranslate"><span class="pre">json</span></code>.</p>
+</div>
+<div class="section" id="each">
+<span id="load-each"></span><h4>7.3.24.4.2.4. <code class="docutils literal notranslate"><span class="pre">each</span></code><a class="headerlink" href="#each" title="Permalink to this headline">¶</a></h4>
+<p>TODO</p>
+</div>
+<div class="section" id="output-ids">
+<span id="load-output-ids"></span><h4>7.3.24.4.2.5. <code class="docutils literal notranslate"><span class="pre">output_ids</span></code><a class="headerlink" href="#output-ids" title="Permalink to this headline">¶</a></h4>
+<p>TODO</p>
+</div>
+<div class="section" id="output-errors">
+<span id="load-output-errors"></span><h4>7.3.24.4.2.6. <code class="docutils literal notranslate"><span class="pre">output_errors</span></code><a class="headerlink" href="#output-errors" title="Permalink to this headline">¶</a></h4>
+<p>TODO</p>
+</div>
+<div class="section" id="lock-table">
+<span id="load-lock-table"></span><h4>7.3.24.4.2.7. <code class="docutils literal notranslate"><span class="pre">lock_table</span></code><a class="headerlink" href="#lock-table" title="Permalink to this headline">¶</a></h4>
+<div class="versionadded">
+<p><span class="versionmodified added">New in version 8.0.6.</span></p>
+</div>
+<p>Specifies whether locking table while updating columns.</p>
+<p>The default is <code class="docutils literal notranslate"><span class="pre">no</span></code>.</p>
+<p>If you may run destructive commands such as <code class="docutils literal notranslate"><span class="pre">load</span></code>, <code class="docutils literal notranslate"><span class="pre">delete</span></code> and
+so on concurrently, it may break database. For example, if you’re
+updating a record by <code class="docutils literal notranslate"><span class="pre">load</span></code> and deleting the updating record by
+<code class="docutils literal notranslate"><span class="pre">delete</span></code>, the <code class="docutils literal notranslate"><span class="pre">load</span></code> may refer the delete record.</p>
+<p>You can guard the update conflict by locking the target table but it
+reduces load performance.</p>
+<p>If you specify <code class="docutils literal notranslate"><span class="pre">yes</span></code> to this parameter, you can lock the target
+table while updating columns. Here is the update sequence of each
+record:</p>
+<blockquote>
+<div><ol class="arabic simple">
+<li><p>Lock the target table</p></li>
+<li><p>Add or refer a record to the target table</p></li>
+<li><p>Unlock the target table</p></li>
+<li><p>Lock the target table when <code class="docutils literal notranslate"><span class="pre">lock_table</span></code> is <code class="docutils literal notranslate"><span class="pre">yes</span></code></p></li>
+<li><p>Update columns of the target record</p></li>
+<li><p>Unlock the target table when <code class="docutils literal notranslate"><span class="pre">lock_table</span></code> is <code class="docutils literal notranslate"><span class="pre">yes</span></code></p></li>
+</ol>
+</div></blockquote>
+</div>
+</div>
 </div>
 <div class="section" id="return-value">
 <h2>7.3.24.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.24.5.1. JSON format<a class="headerlink" href="#json-format" title="Permalink to this headline">¶</a></h3>
-<blockquote>
-<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><span></span>[NUMBER]
+<p>The command returns a response with the following format:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[THE_NUMBER_OF_LOADED_RECORDS]
 </pre></div>
 </div>
-</div></blockquote>
+<p>The command returns a response with the following format with
+<a class="reference internal" href="../command/command_version.html"><span class="doc">Command version</span></a> 3 or later:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>{
+  &quot;n_loaded_records&quot;: THE_NUMBER_OF_LOADED_RECORDS,
+  &quot;loaded_ids&quot;: [
+    LOADED_RECORD&#39;S_ID1,
+    LOADED_RECORD&#39;S_ID2,
+    ...
+  ],
+  &quot;errors&quot;: [
+    {
+      &quot;return_code&quot;: RETURN_CODE_FOR_1ST_RECORD,
+      &quot;message&quot;: MESSAGE_FOR_1ST_RECORD
+    },
+    {
+      &quot;return_code&quot;: RETURN_CODE_FOR_2ND_RECORD,
+      &quot;message&quot;: MESSAGE_FOR_2ND_RECORD
+    },
+    ...
+  ]
+}
+</pre></div>
 </div>
+<p><code class="docutils literal notranslate"><span class="pre">loaded_ids</span></code> is only included when <a class="reference internal" href="#load-output-ids"><span class="std std-ref">output_ids</span></a> is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
+<p><code class="docutils literal notranslate"><span class="pre">errors</span></code> is only included when <a class="reference internal" href="#load-output-errors"><span class="std std-ref">output_errors</span></a> is <code class="docutils literal notranslate"><span class="pre">yes</span></code>.</p>
 </div>
 <div class="section" id="see-also">
 <h2>7.3.24.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"><span class="doc">grn_expr</span></a></p>
+<blockquote>
+<div><ul class="simple">
+<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>
@@ -160,17 +292,31 @@ column) columns is updated.</div></blockquote>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-  <h3><a href="../../index.html">Table Of Contents</a></h3>
+  <h3><a href="../../index.html">Table of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">7.3.24. <code class="docutils literal"><span class="pre">load</span></code></a><ul>
+<li><a class="reference internal" href="#">7.3.24. <code class="docutils literal notranslate"><span class="pre">load</span></code></a><ul>
 <li><a class="reference internal" href="#summary">7.3.24.1. Summary</a></li>
 <li><a class="reference internal" href="#syntax">7.3.24.2. Syntax</a></li>
-<li><a class="reference internal" href="#parameters">7.3.24.3. Parameters</a></li>
-<li><a class="reference internal" href="#usage">7.3.24.4. Usage</a></li>
-<li><a class="reference internal" href="#return-value">7.3.24.5. Return value</a><ul>
-<li><a class="reference internal" href="#json-format">7.3.24.5.1. JSON format</a></li>
+<li><a class="reference internal" href="#usage">7.3.24.3. Usage</a></li>
+<li><a class="reference internal" href="#parameters">7.3.24.4. Parameters</a><ul>
+<li><a class="reference internal" href="#required-parameters">7.3.24.4.1. Required parameters</a><ul>
+<li><a class="reference internal" href="#values">7.3.24.4.1.1. <code class="docutils literal notranslate"><span class="pre">values</span></code></a></li>
+<li><a class="reference internal" href="#table">7.3.24.4.1.2. <code class="docutils literal notranslate"><span class="pre">table</span></code></a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#optional-parameters">7.3.24.4.2. Optional parameters</a><ul>
+<li><a class="reference internal" href="#columns">7.3.24.4.2.1. <code class="docutils literal notranslate"><span class="pre">columns</span></code></a></li>
+<li><a class="reference internal" href="#ifexists">7.3.24.4.2.2. <code class="docutils literal notranslate"><span class="pre">ifexists</span></code></a></li>
+<li><a class="reference internal" href="#input-type">7.3.24.4.2.3. <code class="docutils literal notranslate"><span class="pre">input_type</span></code></a></li>
+<li><a class="reference internal" href="#each">7.3.24.4.2.4. <code class="docutils literal notranslate"><span class="pre">each</span></code></a></li>
+<li><a class="reference internal" href="#output-ids">7.3.24.4.2.5. <code class="docutils literal notranslate"><span class="pre">output_ids</span></code></a></li>
+<li><a class="reference internal" href="#output-errors">7.3.24.4.2.6. <code class="docutils literal notranslate"><span class="pre">output_errors</span></code></a></li>
+<li><a class="reference internal" href="#lock-table">7.3.24.4.2.7. <code class="docutils literal notranslate"><span class="pre">lock_table</span></code></a></li>
 </ul>
 </li>
+</ul>
+</li>
+<li><a class="reference internal" href="#return-value">7.3.24.5. Return value</a></li>
 <li><a class="reference internal" href="#see-also">7.3.24.6. See also</a></li>
 </ul>
 </li>
@@ -178,18 +324,18 @@ column) columns is updated.</div></blockquote>
   <h4>Previous topic</h4>
   <p class="topless"><a href="io_flush.html"
-                        title="previous chapter">7.3.23. <code class="docutils literal"><span class="pre">io_flush</span></code></a></p>
+                        title="previous chapter">7.3.23. <code class="docutils literal notranslate"><span class="pre">io_flush</span></code></a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="lock_acquire.html"
-                        title="next chapter">7.3.25. <code class="docutils literal"><span class="pre">lock_acquire</span></code></a></p>
+                        title="next chapter">7.3.25. <code class="docutils literal notranslate"><span class="pre">lock_acquire</span></code></a></p>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="../../search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -208,13 +354,13 @@ column) columns is updated.</div></blockquote>
         <li class="right" >
           <a href="io_flush.html" title="7.3.23. io_flush"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2009-2018, Brazil, Inc.
+        &#169; Copyright 2009-2019, Brazil, Inc.
     </div>
   </body>
 </html>

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

@@ -1,34 +1,26 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>7.3.25. lock_acquire &#8212; Groonga v7.1.0-73-g6d02cfa documentation</title>
+    <meta charset="utf-8" />
+    <title>7.3.25. lock_acquire &#8212; Groonga v9.0.2 documentation</title>
     <link rel="stylesheet" href="../../_static/groonga.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '../../',
-        VERSION:     '7.1.0-73-g6d02cfa',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '.html',
-        HAS_SOURCE:  false,
-        SOURCELINK_SUFFIX: '.txt'
-      };
-    </script>
+    <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
     <script type="text/javascript" src="../../_static/jquery.js"></script>
     <script type="text/javascript" src="../../_static/underscore.js"></script>
     <script type="text/javascript" src="../../_static/doctools.js"></script>
+    <script type="text/javascript" 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.26. lock_clear" href="lock_clear.html" />
     <link rel="prev" title="7.3.24. load" href="load.html" />
-  </head>
-  <body>
+  </head><body>
 <div class="header">
   <h1 class="title">
     <a id="top-link" href="../../index.html">
@@ -58,7 +50,7 @@
         <li class="right" >
           <a href="load.html" title="7.3.24. load"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> &#187;</li>
       </ul>
@@ -70,17 +62,17 @@
           <div class="body" role="main">
   <div class="section" id="lock-acquire">
-<h1>7.3.25. <code class="docutils literal"><span class="pre">lock_acquire</span></code><a class="headerlink" href="#lock-acquire" title="Permalink to this headline">¶</a></h1>
+<h1>7.3.25. <code class="docutils literal notranslate"><span class="pre">lock_acquire</span></code><a class="headerlink" href="#lock-acquire" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
 <h2>7.3.25.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
 <div class="versionadded">
-<p><span class="versionmodified">New in version 5.1.2.</span></p>
+<p><span class="versionmodified added">New in version 5.1.2.</span></p>
 </div>
-<p><code class="docutils literal"><span class="pre">lock_acquire</span></code> command acquires the lock of the target object. The
+<p><code class="docutils literal notranslate"><span class="pre">lock_acquire</span></code> command acquires the lock of the target object. The
 target object is one of database, table and column.</p>
 <div class="admonition note">
-<p class="first admonition-title">Note</p>
-<p class="last">This is a dangerous command. You must release locks by
+<p class="admonition-title">Note</p>
+<p>This is a dangerous command. You must release locks by
 <a class="reference internal" href="lock_release.html"><span class="doc">lock_release</span></a> that you acquire when these locks are no longer
 needed. If you forget to release these locks, your database may be
 broken.</p>
@@ -89,38 +81,38 @@ broken.</p>
 <div class="section" id="syntax">
 <h2>7.3.25.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
 <p>This command takes only one optional parameter:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>lock_acquire [target_name=null]
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>lock_acquire [target_name=null]
 </pre></div>
 </div>
-<p>If <code class="docutils literal"><span class="pre">target_name</span></code> parameters is omitted, database is used for the
+<p>If <code class="docutils literal notranslate"><span class="pre">target_name</span></code> parameters is omitted, database is used for the
 target object.</p>
 </div>
 <div class="section" id="usage">
 <h2>7.3.25.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
 <p>Here is an example to acquire the lock of the database:</p>
 <p>Execution example:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>lock_acquire
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>lock_acquire
 # [[0, 1337566253.89858, 0.000355720520019531], true]
 </pre></div>
 </div>
-<p>If the database is locked, you can't create a new table and
+<p>If the database is locked, you can’t create a new table and
 column. Release the lock of the database to show another examples.</p>
 <p>Execution example:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>lock_release
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>lock_release
 # [[0, 1337566253.89858, 0.000355720520019531], true]
 </pre></div>
 </div>
-<p>Here is an example to acquire the lock of <code class="docutils literal"><span class="pre">Entries</span></code> table:</p>
+<p>Here is an example to acquire the lock of <code class="docutils literal notranslate"><span class="pre">Entries</span></code> table:</p>
 <p>Execution example:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Entries TABLE_NO_KEY
 # [[0, 1337566253.89858, 0.000355720520019531], true]
 lock_acquire Entries
 # [[0, 1337566253.89858, 0.000355720520019531], true]
 </pre></div>
 </div>
-<p>Here is an example to acquire the lock of <code class="docutils literal"><span class="pre">Sites.title</span></code> column:</p>
+<p>Here is an example to acquire the lock of <code class="docutils literal notranslate"><span class="pre">Sites.title</span></code> column:</p>
 <p>Execution example:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>table_create Sites TABLE_HASH_KEY ShortText
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>table_create Sites TABLE_HASH_KEY ShortText
 # [[0, 1337566253.89858, 0.000355720520019531], true]
 column_create Sites title COLUMN_SCALAR ShortText
 # [[0, 1337566253.89858, 0.000355720520019531], true]
@@ -133,24 +125,24 @@ lock_acquire Sites.title
 <h2>7.3.25.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="target-name">
-<h3>7.3.25.4.1. <code class="docutils literal"><span class="pre">target_name</span></code><a class="headerlink" href="#target-name" title="Permalink to this headline">¶</a></h3>
+<h3>7.3.25.4.1. <code class="docutils literal notranslate"><span class="pre">target_name</span></code><a class="headerlink" href="#target-name" title="Permalink to this headline">¶</a></h3>
 <p>Specifies the name of table or column.</p>
-<p>If you don't specify it, database is used for the target object.</p>
+<p>If you don’t specify it, database is used for the target object.</p>
 <p>The default is none. It means that the target object is database.</p>
 </div>
 </div>
 <div class="section" id="return-value">
 <h2>7.3.25.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<p><code class="docutils literal"><span class="pre">lock_acquire</span></code> command returns whether lock is acquired or not:</p>
-<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT]
+<p><code class="docutils literal notranslate"><span class="pre">lock_acquire</span></code> command returns whether lock is acquired or not:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT]
 </pre></div>
 </div>
 <div class="section" id="header">
-<h3>7.3.25.5.1. <code class="docutils literal"><span class="pre">HEADER</span></code><a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h3>
-<p>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> about <code class="docutils literal"><span class="pre">HEADER</span></code>.</p>
+<h3>7.3.25.5.1. <code class="docutils literal notranslate"><span class="pre">HEADER</span></code><a class="headerlink" href="#header" title="Permalink to this headline">¶</a></h3>
+<p>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> about <code class="docutils literal notranslate"><span class="pre">HEADER</span></code>.</p>
 </div>
 <div class="section" id="succeeded-or-not">
-<h3>7.3.25.5.2. <code class="docutils literal"><span class="pre">SUCCEEDED_OR_NOT</span></code><a class="headerlink" href="#succeeded-or-not" title="Permalink to this headline">¶</a></h3>
+<h3>7.3.25.5.2. <code class="docutils literal notranslate"><span class="pre">SUCCEEDED_OR_NOT</span></code><a class="headerlink" href="#succeeded-or-not" title="Permalink to this headline">¶</a></h3>
 <p>If command succeeded, it returns true, otherwise it returns false on error.</p>
 </div>
 </div>
@@ -158,8 +150,8 @@ lock_acquire Sites.title
 <h2>7.3.25.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 <blockquote>
 <div><ul class="simple">
-<li><a class="reference internal" href="lock_release.html"><span class="doc">lock_release</span></a></li>
-<li><a class="reference internal" href="lock_clear.html"><span class="doc">lock_clear</span></a></li>
+<li><p><a class="reference internal" href="lock_release.html"><span class="doc">lock_release</span></a></p></li>
+<li><p><a class="reference internal" href="lock_clear.html"><span class="doc">lock_clear</span></a></p></li>
 </ul>
 </div></blockquote>
 </div>
@@ -171,19 +163,19 @@ lock_acquire Sites.title
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-  <h3><a href="../../index.html">Table Of Contents</a></h3>
+  <h3><a href="../../index.html">Table of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">7.3.25. <code class="docutils literal"><span class="pre">lock_acquire</span></code></a><ul>
+<li><a class="reference internal" href="#">7.3.25. <code class="docutils literal notranslate"><span class="pre">lock_acquire</span></code></a><ul>
 <li><a class="reference internal" href="#summary">7.3.25.1. Summary</a></li>
 <li><a class="reference internal" href="#syntax">7.3.25.2. Syntax</a></li>
 <li><a class="reference internal" href="#usage">7.3.25.3. Usage</a></li>
 <li><a class="reference internal" href="#parameters">7.3.25.4. Parameters</a><ul>
-<li><a class="reference internal" href="#target-name">7.3.25.4.1. <code class="docutils literal"><span class="pre">target_name</span></code></a></li>
+<li><a class="reference internal" href="#target-name">7.3.25.4.1. <code class="docutils literal notranslate"><span class="pre">target_name</span></code></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#return-value">7.3.25.5. Return value</a><ul>
-<li><a class="reference internal" href="#header">7.3.25.5.1. <code class="docutils literal"><span class="pre">HEADER</span></code></a></li>
-<li><a class="reference internal" href="#succeeded-or-not">7.3.25.5.2. <code class="docutils literal"><span class="pre">SUCCEEDED_OR_NOT</span></code></a></li>
+<li><a class="reference internal" href="#header">7.3.25.5.1. <code class="docutils literal notranslate"><span class="pre">HEADER</span></code></a></li>
+<li><a class="reference internal" href="#succeeded-or-not">7.3.25.5.2. <code class="docutils literal notranslate"><span class="pre">SUCCEEDED_OR_NOT</span></code></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#see-also">7.3.25.6. See also</a></li>
@@ -193,18 +185,18 @@ lock_acquire Sites.title
   <h4>Previous topic</h4>
   <p class="topless"><a href="load.html"
-                        title="previous chapter">7.3.24. <code class="docutils literal"><span class="pre">load</span></code></a></p>
+                        title="previous chapter">7.3.24. <code class="docutils literal notranslate"><span class="pre">load</span></code></a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="lock_clear.html"
-                        title="next chapter">7.3.26. <code class="docutils literal"><span class="pre">lock_clear</span></code></a></p>
+                        title="next chapter">7.3.26. <code class="docutils literal notranslate"><span class="pre">lock_clear</span></code></a></p>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
+    <div class="searchformwrapper">
     <form class="search" action="../../search.html" method="get">
-      <div><input type="text" name="q" /></div>
-      <div><input type="submit" value="Go" /></div>
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
     </form>
+    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
         </div>
@@ -223,13 +215,13 @@ lock_acquire Sites.title
         <li class="right" >
           <a href="load.html" title="7.3.24. load"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v7.1.0-73-g6d02cfa documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v9.0.2 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> &#187;</li>
           <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> &#187;</li>
       </ul>
     </div>
     <div class="footer" role="contentinfo">
-        &#169; Copyright 2009-2018, Brazil, Inc.
+        &#169; Copyright 2009-2019, Brazil, Inc.
     </div>
   </body>
 </html>