API:EPrints/Index

From EPrints Documentation
Revision as of 01:31, 10 January 2022 by Pod2wiki (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Index - Methods for indexing objects for later searching.

User Comments


DESCRIPTION

This module contains methods used to add and remove information from the free-text search indexes.

User Comments


METHODS

User Comments


remove

$ok = EPrints::Index::remove( $session, $dataset, $objectid, $fieldids )

Remove all indexes to the fields $fieldids within the specified objectid that is from the $dataset.

User Comments


remove_all

$ok = EPrints::Index::remove_all( $session, $dataset, $objectid )

Remove all indexes to the specified $objectid part of the $dataset.

User Comments


purge_index

EPrints::Index::purge_index( $session, $dataset )

Remove all the current index information for the given $dataset. Only really useful if used in conjunction with rebuilding the indexes.

User Comments


add

$ok = EPrints::Index::add( $session, $dataset, $objectid, $fieldid, $value )

Add indexes to the fieldid in the specified $objectid. The index keys will be taken from $value.

User Comments


update_ordervalues

EPrints::Index::update_ordervalues( $session, $dataset, $data, $changed )

Update the order values for an object. $data is a structure returned by:

$dataobj->get_data

$changed is a hash of changed fields.

User Comments


insert_ordervalues

EPrints::Index::insert_ordervalues( $session, $dataset, $data )

Create the order values for an object. $data is a structure returned by:

$dataobj->get_data
 

User Comments


delete_ordervalues

EPrints::Index::delete_ordervalues( $session, $dataset, $id )

Remove the ordervalues for item $id from the ordervalues table of $dataset.

User Comments


$pidfilepath

$pidfilepath = EPrints::Index::pidfile

Return the filepath for the indexer PID file.

User Comments


$tickfilepath

$tickfilepath = EPrints::Index::tickfile

Return the filepath for the indexer tick file.

User Comments


$logfilepath

$logfilepath = EPrints::Index::logfile

Return the filepath for the indexer log file.

User Comments


$binfilepath

$binfilepath = EPrints::Index::binfile

Return the filepath for the indexer bin script file.

User Comments


$suicidefilepath

$suicidefilepath = EPrints::Index::suicidefile

Return the filepath for the indexer suicide file.

User Comments


indexlog

EPrints::Index::indexlog( $txt )

Print out and index log line with $txt to the STDERR.

User Comments


COPYRIGHT

© Copyright 2022 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

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

LICENSE

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/.

User Comments