Koha/debian/docs/koha-rebuild-zebra.xml
Tomas Cohen Arazi 997ad166c6 [SIGNED-OFF] Bug 15113: koha-rebuild-zebra should check USE_INDEXER_DAEMON and skip if enabled
This patch changes the behaviour of the koha-rebuild-zebra script in the following way:

USE_INDEXER_DAEMON=no
- Keeps the current behaviour

USE_INDEXER_DAEMON=yes
- It skips incremental indexing to avoid races.

Caveats:
- A --force option is introduced for useing in a specific situtation that might need it
 (i.e. the administrator knows what he's doing).
- If --full is passed, the reindexing is not skipped.

The documentation files and messages are adjusted accordingly.

This patch should help users that want to use the indexing daemon, in which case they wouldn't need
to change their default 5 min cronjob (it will be just skipped). Ultimately, koha-common could have
USE_INDEXER_DAEMON = yes by default, but that's subject for another bug report.

To test:
- Play with the different option switches and USE_INDEXER_DAEMON
- Things work as expected
- Sign off

Regards

Signed-off-by: Hector Castro <hector.hecaxmmx@gmail.com>
Works as expected

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

Signed-off-by: Your Full Name <your_email>
2016-04-19 17:47:42 +00:00

97 lines
3.5 KiB
XML

<article xmlns='http://docbook.org/ns/docbook'>
<title>koha-rebuild-zebra</title>
<info>
<productname>Koha</productname> is the first free software library automation package.
<author>
<orgname>The Koha Community</orgname>
<uri>http://koha-community.org/</uri>
</author>
</info>
<refentry xml:id="koha-rebuild-zebra">
<refmeta>
<refentrytitle>koha-rebuild-zebra</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>koha-rebuild-zebra</refname>
<refpurpose>Rebuild the Zebra database for Koha instances.</refpurpose>
<refclass>UNIX/Linux</refclass>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>koha-rebuild-zebra</command> <arg><option>-u</option>|<option>--usmarc</option></arg> <arg><option>--force</option></arg> <arg><option>-f</option>|<option>--full</option></arg> <arg><option>-a</option>|<option>--authorities</option></arg> <arg><option>-b</option>|<option>--biblios</option></arg> <arg><option>-q</option>|<option>--quiet</option></arg> <arg><option>-v</option>|<option>--verbose</option></arg> <arg><option>...</option></arg> <arg choice="req" rep="repeat"><replaceable>instancename</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
<term><option>-u, --usmarc</option></term>
<listitem>
<para>Runs the process as USMARC rather than the default of MARCXML.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--force</option></term>
<listitem>
<para>Force incremental indexing when <option>USE_INDEXER_DAEMON=yes</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f, --full</option></term>
<listitem>
<para>Does a reindex of the whole collection. Will run even if <option>USE_INDEXER_DAEMON=yes</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a, --authorities</option></term>
<listitem>
<para>Only run the indexing process for authority records.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b, --biblios</option></term>
<listitem>
<para>Only run the indexing process for biblio records.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q, --quiet</option></term>
<listitem>
<para>Sometimes be a bit quieter for scripts/cronjobs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v, --verbose</option></term>
<listitem>
<para>Be verbose. Useful for debugging indexing problems.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-...</option></term>
<listitem>
<para>Anything else is passed directly to rebuild_zebra.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Description</title>
<para>Rebuild the Zebra database for Koha instances. It will run incremental updates by default. It will be skipped if <option>USE_INDEXER_DAEMON=yes</option> in /etc/default/koha-common, unless <option>--force</option> or <option>--full</option> are used.</para>
</refsect1>
<refsect1><title>See also</title>
<simplelist type="inline">
<member><command>koha-restart-zebra(8)</command></member>
<member><command>koha-start-zebra(8)</command></member>
<member><command>koha-stop-zebra(8)</command></member>
</simplelist>
</refsect1>
</refentry>
</article>