Difference between revisions of "API:bin/epadmin"

From EPrints Documentation
Jump to: navigation, search
Line 170: Line 170:
 
<!-- Pod2Wiki=item_reorder -->
 
<!-- Pod2Wiki=item_reorder -->
 
===reorder===
 
===reorder===
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_redo_mime_type -->
 +
===redo_mime_type===
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 230: Line 240:
 
<!-- Pod2Wiki=item_reload -->
 
<!-- Pod2Wiki=item_reload -->
 
===reload===
 
===reload===
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_reload_metafields -->
 
===reload_metafields===
 
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 547: Line 547:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
<!-- Pod2Wiki=item_b_epadmin_redo_thumbnails_i_repository_id_i_eprintid -->
+
<!-- Pod2Wiki=item_b_epadmin_redo_mime_type_i_repository_id_dataset_objectid -->
==='''epadmin''' redo_thumbnails <em>repository_id</em> [ <em>eprintid</em>, ... ]===
+
==='''epadmin''' redo_mime_type <em>repository_id</em> dataset [ objectid, ... ]===
  
Regenerate all the thumbnail and image-preview files and any other things which are triggered if the document file changed. Optionally supply a list of eprint ids to re-generate thumbnails for.
+
Re-run the file format identification. Dataset may be one of 'document' or 'file'. If 'document' only re-does the identification of the main files in documents.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 559: Line 559:
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
<!-- Pod2Wiki=item_b_epadmin_reload_metafields_i_repository_id -->
+
<!-- Pod2Wiki=item_b_epadmin_redo_thumbnails_i_repository_id_i_eprintid -->
==='''epadmin''' reload_metafields <em>repository_id</em>===
+
==='''epadmin''' redo_thumbnails <em>repository_id</em> [ <em>eprintid</em>, ... ]===
  
Reload the metafields dataset, based on the current configuration.
+
Regenerate all the thumbnail and image-preview files and any other things which are triggered if the document file changed. Optionally supply a list of eprint ids to re-generate thumbnails for.
  
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Revision as of 12:28, 1 December 2011

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.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


Contents

NAME

epadmin - EPrints repository admin tool

User Comments


SYNOPSIS

epadmin command repository_id [options]

Where command is one of:

User Comments


cleanup_cachemaps

User Comments


config_core

User Comments


config_db

User Comments


create

User Comments


create_db

User Comments


create_tables

User Comments


create_user

User Comments


erase_data

User Comments


erase_eprints

User Comments


erase_fulltext_index

User Comments


help

User Comments


profile

User Comments


rebuild_triples

User Comments


recommit

User Comments


reorder

User Comments


redo_mime_type

User Comments


redo_thumbnails

User Comments


refresh_abstracts

User Comments


refresh_views

User Comments


rehash

User Comments


reindex

User Comments


reload

User Comments


schema

User Comments


set_developer_mode

User Comments


test

User Comments


unit_tests

User Comments


update

User Comments


upgrade

User Comments


ARGUMENTS

User Comments


epadmin create

START HERE! This option will walk you through the tasks needed to create your repository.

User Comments


epadmin test repository_id

A null operation which just checks your configuration files are OK and that you can connect to the database. If no repository_id is specified loads each repository in turn. Use --verbose to generate more information.

User Comments


epadmin cleanup_cachemaps repository_id

Drop any orphaned cache tables.

User Comments


epadmin config_core repository_id

Set hostname, contact email and repository name.

User Comments


epadmin config_db repository_id

Set database connection properties and, optionally, to create database and database user.

User Comments


epadmin create_db repository_id

Create a database and database user with the current settings.

User Comments


epadmin create_tables repository_id

Create the database tables.

User Comments


epadmin create_user repository_id

Create a new user. You need to do this to create your first admin account.

User Comments


epadmin schema repository_id

Use this to produce a schema for the EP3 XML read/written by your repository.

User Comments


epadmin erase_fulltext_index repository_id

This erases all the .words and .indexcodes cache files from your repository, forcing the indexer to rerun the tools used to extract full text from your documents.

This is useful if you only setup the fulltext indexing after your repository is already live, or if you discover there has been a problem.

User Comments


epadmin rebuild_triples repository_id [dataset_id [item_id item_id ...]]

Queue all the records to have their RDF triple cache rebuilt. This may tie-up the indexer for some time on a large repository. Do this if you have made changes to the way RDF triples are produced from an EPrint.

User Comments


epadmin recommit repository_id dataset_id [eprint_id eprint_id ...]

Recommit all the records in the given dataset. What this does is cause the automatic values to be re-calculated. If a list of eprint_ids is given then just recommit those.

User Comments


epadmin reindex repository_id dataset_id [eprint_id eprint_id ...]

Schedule the dataset for reindexing. The indexer will do the actual indexing and it may take some time. This only schedules the reindexing. If a list of eprint_ids is given then just reindex those.

User Comments


epadmin reorder repository_id dataset_id [eprint_id eprint_id ...]

Regenerate the order values for the dataset. If a list of eprint_ids is given then just recalculate ordervalues for those.

User Comments


epadmin rehash repository_id [document_id]

Recalculate the hashes of the files in this document and write it to a probity log file. If a document id is given then just generate the hash for that document.

User Comments


epadmin reload repository_id

Cause the web server to reload the repository configuration.

User Comments


epadmin set_developer_mode repository_id <on|off>

While set to on developer mode causes the web server to reload the repository configuration on every page request. This makes development much quicker but must not be left switched on in a production environment since it increases server load dramatically.

User Comments


epadmin refresh_views repository_id

Tell the webserver that all views pages must be regenerated. The webserver will update them next time they are requested. Also causes config to be reloaded.

User Comments


epadmin refresh_abstracts repository_id

Tell the webserver that all abstract summary pages must be regenerated. The webserver will update them next , but won't update them again unless something on the EPrint changes or you re-run refresh abstracts. Also causes config to be reloaded.

User Comments


epadmin redo_mime_type repository_id dataset [ objectid, ... ]

Re-run the file format identification. Dataset may be one of 'document' or 'file'. If 'document' only re-does the identification of the main files in documents.

User Comments


epadmin redo_thumbnails repository_id [ eprintid, ... ]

Regenerate all the thumbnail and image-preview files and any other things which are triggered if the document file changed. Optionally supply a list of eprint ids to re-generate thumbnails for.

User Comments


epadmin erase_data repository_id

Erases and recreates the database. Removes all documents and files. Does not touch the configuration files.

User Comments


epadmin erase_eprints repository_id

Erases all the documents and eprints (including their files). Recreates the eprint and document tables. Leaves configuration files and the users and subjects tables alone.

User Comments


epadmin unit_tests

Run unit tests, printing the results to STDOUT. If everything passed will exit with a return code of 0.

User Comments


epadmin profile test

Run a performance profile of test using Devel::NYTProf.

User Comments


epadmin remove_field repository_id dataset field_id

Remove the database entries for the given field, can not be undone!

User Comments


epadmin update repository_id

This will add tables and columns to your SQL database to bring it in-line with your current configuration. It will not remove data. Use with caution on a live database. Database backup is recommended befire use on live systems.

User Comments


epadmin upgrade repository_id

After upgrading EPrints, use this to update the database tables. It will advise any other tasks that are required.

User Comments


epadmin --help

User Comments


OPTIONS

User Comments


--help

Print a brief help message and exit.

User Comments


--man

Print the full manual page and then exit.

User Comments


--quiet

This option does not do anything.

User Comments


--verbose

Explain in detail what is going on. May be repeated for greater effect.

User Comments


--force

Be more forceful (don't ask for confirmation).

User Comments


--version

Output version information and exit.

User Comments


COPYRIGHT

User Comments