debian/docs/koha-elasticsearch.xml

   1 <article xmlns='http://docbook.org/ns/docbook'>
   2 <title>koha-elasticsearch</title>
   3 <info>
   4 <productname>Koha</productname> is the first free software library automation package.
   5 <author>
   6   <orgname>The Koha Community</orgname>
   7   <uri>http://koha-community.org/</uri>
   8 </author>
   9 </info>
  10
  11 <refentry xml:id="koha-elasticsearch">
  12
  13   <refmeta>
  14     <refentrytitle>koha-elasticsearch</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>koha-elasticsearch</refname>
  20     <refpurpose>Manage Elasticsearch-related tasks for Koha instances.</refpurpose>
  21     <refclass>UNIX/Linux</refclass>
  22   </refnamediv>
  23
  24   <refsect1><title>Description</title>
  25   <para>Provides Elasticsearch-related tasks for Koha instances. An action needs to
  26         be passed.</para>
  27   </refsect1>
  28
  29
  30   <refsynopsisdiv>
  31     <cmdsynopsis>
  32       <command>koha-elasticsearch --rebuild</command>
  33       <arg>-d|--delete</arg>
  34       <arg>-r|--reset</arg>
  35       <arg>-b|--biblios</arg>
  36       <arg>-a|--authorities</arg>
  37       <arg>-v|--verbose</arg>
  38       <arg>-c n|--commit n</arg>
  39       <arg>-v|--verbose</arg>
  40       <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
  41     </cmdsynopsis>
  42   </refsynopsisdiv>
  43
  44   <refsect1><title>Actions</title>
  45   <variablelist>
  46     <varlistentry>
  47       <term><option>--rebuild</option></term>
  48       <listitem>
  49         <para>Makes <refname>koha-elasticsearch</refname> rebuild Elasticsearch indexes based on the parameters.
  50               By default it rebuilds both authority and bibliographic records. This behaviour can be controlled
  51               with the <option>-a</option> and <option>-b</option> parameters.
  52         </para>
  53       </listitem>
  54     </varlistentry>
  55   </variablelist>
  56   </refsect1>
  57
  58   <refsect1><title>Options</title>
  59   <variablelist>
  60     <varlistentry>
  61       <term><option>-d</option></term>
  62       <listitem>
  63         <para>In conjunction with <option>--rebuild</option>, it deletes existing indexes before reindexing.</para>
  64       </listitem>
  65     </varlistentry>
  66     <varlistentry>
  67       <term><option>-r</option></term>
  68       <listitem>
  69         <para>In conjunction with <option>--rebuild</option>, it reloads the settings from the Elasticsearch
  70               files set in koha-conf.xml . This option implies delete.</para>
  71       </listitem>
  72     </varlistentry>
  73     <varlistentry>
  74       <term><option>-a</option></term>
  75       <listitem>
  76         <para>In conjunction with <option>--rebuild</option>, it triggers authority record reindexing.</para>
  77       </listitem>
  78     </varlistentry>
  79     <varlistentry>
  80       <term><option>-b</option></term>
  81       <listitem>
  82         <para>In conjunction with <option>--rebuild</option> it triggers bibliographic record reindexing.</para>
  83       </listitem>
  84     </varlistentry>
  85     <varlistentry>
  86       <term><option>-c, --commit</option></term>
  87       <listitem>
  88         <para>Specifies how many records will be batched up before they are added to Elasticsearch (default: 5000).
  89               Higher values lead to better performance, but take more RAM.</para>
  90       </listitem>
  91     </varlistentry>
  92     <varlistentry>
  93       <term><option>-v, --verbose</option></term>
  94       <listitem>
  95         <para>Be verbose. Useful for debugging indexing problems.</para>
  96       </listitem>
  97     </varlistentry>
  98     <varlistentry>
  99       <term><option>-h, --help</option></term>
 100       <listitem>
 101         <para>Display usage information.</para>
 102       </listitem>
 103     </varlistentry>
 104   </variablelist>
 105   </refsect1>
 106
 107   <refsect1><title>See also</title>
 108   <simplelist type="inline">
 109     <member><command>koha-rebuild-zebra(8)</command></member>
 110   </simplelist>
 111   </refsect1>
 112
 113 </refentry>
 114
 115 </article>