1 <article xmlns='http://docbook.org/ns/docbook'>
2 <title>koha-elasticsearch</title>
4 <productname>Koha</productname> is the first free software library automation package.
6 <orgname>The Koha Community</orgname>
7 <uri>http://koha-community.org/</uri>
11 <refentry xml:id="koha-elasticsearch">
14 <refentrytitle>koha-elasticsearch</refentrytitle>
15 <manvolnum>8</manvolnum>
19 <refname>koha-elasticsearch</refname>
20 <refpurpose>Manage Elasticsearch-related tasks for Koha instances.</refpurpose>
21 <refclass>UNIX/Linux</refclass>
24 <refsect1><title>Description</title>
25 <para>Provides Elasticsearch-related tasks for Koha instances. An action needs to
32 <command>koha-elasticsearch --rebuild</command>
33 <arg>-b|--biblios</arg>
34 <arg>-a|--authorities</arg>
35 <arg>-v|--verbose</arg>
36 <arg>-c n|--commit n</arg>
37 <arg>-v|--verbose</arg>
38 <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
42 <refsect1><title>Actions</title>
45 <term><option>--rebuild</option></term>
47 <para>Makes <refname>koha-elasticsearch</refname> rebuild Elasticsearch indexes based on the parameters.
48 By default it rebuilds both authority and bibliographic records. This behaviour can be controlled
49 with the <option>-a</option> and <option>-b</option> parameters.
56 <refsect1><title>Options</title>
59 <term><option>-a</option></term>
61 <para>In conjunction with <option>--rebuild</option>, it triggers authority record reindexing.</para>
65 <term><option>-b</option></term>
67 <para>In conjunction with <option>--rebuild</option> it triggers bibliographic record reindexing.</para>
71 <term><option>-c, --commit</option></term>
73 <para>Specifies how many records will be batched up before they are added to Elasticsearch (default: 5000).
74 Higher values lead to better performance, but take more RAM.</para>
78 <term><option>-v, --verbose</option></term>
80 <para>Be verbose. Useful for debugging indexing problems.</para>
84 <term><option>-h, --help</option></term>
86 <para>Display usage information.</para>
92 <refsect1><title>See also</title>
93 <simplelist type="inline">
94 <member><command>koha-rebuild-zebra(8)</command></member>