From EPrints Documentation
Revision as of 10:29, 27 December 2021 by Pod2wiki (talk | contribs)
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


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


EPrints::DataObj::Cachemap - Cache tables

User Comments


This is an internal class that shouldn't be used outside EPrints::Database.

User Comments


User Comments

cachemapid (int)

The unique numerical ID of this cachemap object.

User Comments

created (int)

The time the cachemap record was created in seconds since start of last epoch.

User Comments

lastused (int)

The time the cachemap record was last used in seconds since start of last epoch.

User Comments

userid (itemref)

Reference to the userid of the user who caused the cachemap record to be created, if this is known.

User Comments

searchexap (longtext)

A serialisation of the search carried out that is stored in this cachemap record.

User Comments

oneshot (boolean)

DEPRECATED. A boolean to record whether the cache is for single use where it will be created, used and immediately deleted. Such as type of caching is no longer required.

User Comments


User Comments


EPrints::DataObj::Cachemap->create_from_data( $session, $data, $dataset )

Creates a new cachemap data object in the database.

$dataset is the dataset it will belong to.

$data is the data structured as with EPrints::DataObj#new_from_data.

This will create sub-objects as well.

Call this via:

$dataset->create_object( $session, $data )

User Comments


$fields = EPrints::DataObj::Access->get_system_field_info

Core fields.

User Comments

Class Methods

User Comments


$dataset = EPrints::DataObj::Cachemap->get_dataset_id

Returns the iID of the EPrints::DataSet object to which this record belongs.

User Comments


$defaults = EPrints::DataObj::Cachemap->get_defaults( $session, $data )

Return default values for this object based on the starting $data.

User Comments


$dropped = EPrints::DataObj::Cachemap->cleanup( $repository )

Clean up old caches for specified $repository.

Returns the number of caches dropped.

User Comments

Object Methods

User Comments


$rc = $cachemap->remove

Remove this record from the data set and the cache table from the database.

Returns a code based of success of removing record / cache table.

User Comments


$sql_name = $cachemap->get_sql_table_name

Returns the name of the cache table for this cachemap record.

User Comments


$ok = $cachemap->create_sql_table( $dataset )

Create the cachemap database table that can store IDs for the specified $dataset.

Returns code based on the success of creating cache table.

User Comments


EPrints::DataObj and EPrints::DataSet.

User Comments


© Copyright 2022 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.



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