<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>8.3.21. register — groonga v3.0.5 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: '3.0.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </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> <link rel="shortcut icon" href="../../_static/favicon.ico"/> <link rel="top" title="groonga v3.0.5 documentation" href="../../index.html" /> <link rel="up" title="8.3. Command" href="../command.html" /> <link rel="next" title="8.3.22. select" href="select.html" /> <link rel="prev" title="8.3.20. quit" href="quit.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/register.html"><img src="../../_static/jp.png" alt="日本語">日本語版はこちら</a></li> </ul> </div> </div> <div class="related"> <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="select.html" title="8.3.22. select" accesskey="N">next</a> |</li> <li class="right" > <a href="quit.html" title="8.3.20. quit" accesskey="P">previous</a> |</li> <li><a href="../../index.html">groonga v3.0.5 documentation</a> »</li> <li><a href="../../reference.html" >8. リファレンスマニュアル</a> »</li> <li><a href="../command.html" accesskey="U">8.3. Command</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="register"> <h1>8.3.21. register<a class="headerlink" href="#register" title="Permalink to this headline">¶</a></h1> <div class="section" id="summary"> <h2>8.3.21.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2> <p><tt class="docutils literal"><span class="pre">register</span></tt> command registers a plugin. You need to register a plugin before you use a plugin.</p> <p>You need just one <tt class="docutils literal"><span class="pre">register</span></tt> command for a plugin in the same database because registered plugin information is written into the database. When you restart your <tt class="docutils literal"><span class="pre">groonga</span></tt> process, <tt class="docutils literal"><span class="pre">groonga</span></tt> process loads all registered plugins without <tt class="docutils literal"><span class="pre">register</span></tt> command.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Registered plugins can't be removed for now.</p> </div> </div> <div class="section" id="syntax"> <h2>8.3.21.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2> <p><tt class="docutils literal"><span class="pre">register</span></tt> has a parameter <tt class="docutils literal"><span class="pre">path</span></tt>. It is required parameter:</p> <div class="highlight-none"><div class="highlight"><pre>register path </pre></div> </div> </div> <div class="section" id="usage"> <h2>8.3.21.3. Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2> <p>Here is a sample that registers <tt class="docutils literal"><span class="pre">QueryExpanderTSV</span></tt> query expander that is included in <tt class="docutils literal"><span class="pre">${PREFIX}/lib/groonga/plugins/query_expanders/tsv.so</span></tt>.</p> <p>Execution example:</p> <div class="highlight-none"><div class="highlight"><pre>register query_expanders/tsv # [[0, 1337566253.89858, 0.000355720520019531], true] </pre></div> </div> <p>You can omit <tt class="docutils literal"><span class="pre">${PREFIX}/lib/groonga/plugins/</span></tt> and suffix (<tt class="docutils literal"><span class="pre">.so</span></tt>). They are completed automatically.</p> <p>You can specify absolute path such as <tt class="docutils literal"><span class="pre">register</span> <span class="pre">/usr/lib/groonga/plugins/query_expanders/tsv.so</span></tt>.</p> </div> <div class="section" id="return-value"> <h2>8.3.21.4. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2> <p><tt class="docutils literal"><span class="pre">register</span></tt> returns <tt class="docutils literal"><span class="pre">true</span></tt> as body on success such as:</p> <div class="highlight-none"><div class="highlight"><pre>[HEADER, true] </pre></div> </div> <p>If <tt class="docutils literal"><span class="pre">register</span></tt> fails, error details are in <tt class="docutils literal"><span class="pre">HEADER</span></tt>.</p> <p>See <a class="reference internal" href="../command/output_format.html"><em>Output format</em></a> for <tt class="docutils literal"><span class="pre">HEADER</span></tt>.</p> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">8.3.21. register</a><ul> <li><a class="reference internal" href="#summary">8.3.21.1. Summary</a></li> <li><a class="reference internal" href="#syntax">8.3.21.2. Syntax</a></li> <li><a class="reference internal" href="#usage">8.3.21.3. Usage</a></li> <li><a class="reference internal" href="#return-value">8.3.21.4. Return value</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="quit.html" title="previous chapter">8.3.20. quit</a></p> <h4>Next topic</h4> <p class="topless"><a href="select.html" title="next chapter">8.3.22. <tt class="docutils literal"><span class="pre">select</span></tt></a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../../_sources/reference/commands/register.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <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="select.html" title="8.3.22. select" >next</a> |</li> <li class="right" > <a href="quit.html" title="8.3.20. quit" >previous</a> |</li> <li><a href="../../index.html">groonga v3.0.5 documentation</a> »</li> <li><a href="../../reference.html" >8. リファレンスマニュアル</a> »</li> <li><a href="../command.html" >8.3. Command</a> »</li> </ul> </div> <div class="footer"> © Copyright 2009-2013, Brazil, Inc. </div> </body> </html>