API:EPrints/DataObj/Cachemap
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
Contents
NAME
EPrints::DataObj::Cachemap - Cache tables
DESCRIPTION
This is an internal class that shouldn't be used outside EPrints::Database.
METHODS
create_from_data
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 )
get_system_field_info
$fields = EPrints::DataObj::Access->get_system_field_info
Core fields.
Class Methods
get_dataset_id
$dataset = EPrints::DataObj::Cachemap->get_dataset_id
Returns the iID of the EPrints::DataSet object to which this record belongs.
get_defaults
$defaults = EPrints::DataObj::Cachemap->get_defaults( $session, $data )
Return default values for this object based on the starting $data.
cleanup
$dropped = EPrints::DataObj::Cachemap->cleanup( $repository )
Clean up old caches for specified $repository.
Returns the number of caches dropped.
Object Methods
remove
$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.
get_sql_table_name
$sql_name = $cachemap->get_sql_table_name
Returns the name of the cache table for this cachemap record.
create_sql_table
$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.
SEE ALSO
EPrints::DataObj and EPrints::DataSet.
COPYRIGHT
© Copyright 2023 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/.
