Editing API:bin/check xapian

<!-- Pod2Wiki=_preamble_ 
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/generate_views|package_name=bin/check_xapian}}[[Category:API]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''check_xapian''' - Checks that Xapian is successfully indexing eprint items.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_synopsis -->
==SYNOPSIS==
'''check_xapian''' ''repository_id'' ['''options''']

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
This script checks that eprint items have successfully been indexed by Xapian. It does this my using "/usr/bin/quest" to search the Xapian database filesystem for the title of the particular item. This requires the 'xapian-tools' package to be installed. If the title does not contain any special characters or quote marks it will attempt to search for the title within quote marks. If this is not the case or this returns no matching results, it will search for all the terms in the title in an attempt to find a result. The script will print a success message to the standard output if a result with the correct EPrint ID is returned othewise it will print a failure message to the standard error. A summary message will be printed before the script exits totalling the number of items found not to be indexed.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_arguments -->
==ARGUMENTS==
; '''repository_id'''
:The ID of the eprint repository to use.


<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_options -->
==OPTIONS==
; '''--all'''
:Check all eprint items rather than those last modified in the last 2 days.
; '''--idlist=1,2,3'''
:Check all items list in the comma-separated list of IDs.
; '''--facets'''
:Check search results using the facets matching protocol rather than the standard Xapian matching protocol.
; '''--days=n'''
:Check eprint items last modified in the last n days rathar than the last 2 days.
; '''--results=n'''
:Only check the top n results ordered by relevance. By default only check first 1000 results.
; '''--help'''
:Print a brief help message and exit.
; '''--man'''
:Print the full manual page and then exit.
; '''--path=/path/to/xapian/directory/'''
:Specify the directory of the Xapian database if it is not EPRINTS_PATH/archives/ARCHIVEID/var/xapian/.
; '''--quiet'''
:This option will supress all output unless an error occurs.
; '''--random'''
:Takes a random sample of 100 eprint items to check whether they are indexed. Can be used with --sample=n to specify a different random sample size. Can be used with --days to specify how recently the random sample should taken from.
; '''--reindex'''
:If a item is not found then schedule it for reindexing.
; '''--sample=n'''
:Used in conjuction with --random to specify the sample size of items to check. By default sample size is 100.
; '''--status=archive,deletion'''
:Used to specify the status of eprint (inbox, buffer, archive, deletion) to be check. If not specified eprints of all statuses will be checked. Specify multiple statuses through a comma-separated list. Ignored if used in conjunction with --idlist.
; '''--user=admin'''
:Used in conjuction with --reindex to specify the username of the user who should be set as the creator for indexing tasks. If not set the first admin or local_admin user created will be used.
; '''--verbose'''
:Explain in detail what is going on.
; '''--version'''
:Output version information and exit.

<pre></pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
Copyright 2022 University of Southampton. EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->