Difference between revisions of "API:bin/epadmin"

From EPrints Documentation
Jump to: navigation, search
(reindex)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/epadmin.pm|package_name=bin/epadmin}}[[Category:API|BIN/EPADMIN]][[Category:API:bin/epadmin|BIN/EPADMIN]][[Category:API:bin/epadmin|BIN/EPADMIN]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/epadmin|package_name=bin/epadmin}}[[Category:API|BIN/EPADMIN]][[Category:API:bin/epadmin|BIN/EPADMIN]][[Category:API:bin/epadmin|BIN/EPADMIN]]<div><!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
'''epadmin''' - EPrints repository admin tool
+
epadmin - EPrints repository admin tool
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_synopsis -->
 
<!-- Pod2Wiki=head_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
'''epadmin''' <em>command</em> <em>repository_id</em> ['''options''']
+
epadmin '''options''' <em>command</em> [repository_id]
  
 
Where <em>command</em> is one of:
 
Where <em>command</em> is one of:
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* cleanup_cachemaps
<span style='display:none'>User Comments</span>
+
* config_core
<!-- Edit below this comment -->
+
* config_db
 
+
* create
 
+
* create_db
<!-- Pod2Wiki= -->
+
* create_tables
</div>
+
* create_user
<!-- Pod2Wiki=item_cleanup_cachemaps -->
+
* erase_data
===cleanup_cachemaps===
+
* erase_eprints
 +
* erase_fulltext_index
 +
* help
 +
* profile
 +
* rebuild_triples
 +
* recommit
 +
* reorder
 +
* redo_files_modified
 +
* redo_mime_type
 +
* redo_thumbnails
 +
* refresh_abstracts
 +
* refresh_views
 +
* reindex
 +
* reload
 +
* set_developer_mode
 +
* show_config
 +
* show_plugins
 +
* test
 +
* unit_tests
 +
* update
 +
* upgrade
 +
Type <code>epadmin help command</code> for further help.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_commands -->
<!-- Pod2Wiki=item_config_core -->
+
==COMMANDS==
===config_core===
+
 
+
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_create -->
<!-- Pod2Wiki=item_config_db -->
+
===config_db===
+
 
+
<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_create -->
+
 
===create===
 
===create===
 +
<pre>  epadmin create</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Create a new repository instance based on question-and-answer.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_create_db -->
+
===create_db===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_create_test -->
<!-- Pod2Wiki=item_create_tables -->
+
===create_test===
===create_tables===
+
<pre>  epadmin create_test</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Create a test repository instance called "test".
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_create_user -->
+
===create_user===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_cleanup_cachemaps -->
<!-- Pod2Wiki=item_erase_data -->
+
===cleanup_cachemaps===
===erase_data===
+
<pre>  epadmin cleanup_cachemaps repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Drop any orphaned cache tables.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_erase_eprints -->
+
===erase_eprints===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_config_core -->
<!-- Pod2Wiki=item_erase_fulltext_index -->
+
===config_core===
===erase_fulltext_index===
+
<pre>  epadmin config_core repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Set hostname, contact email and repository name.  
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_help -->
+
===help===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_config_db -->
<!-- Pod2Wiki=item_profile -->
+
===config_db===
===profile===
+
<pre>  epadmin config_db repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Set database connection properties and, optionally, to create database and database user.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_rebuild_triples -->
 
===rebuild_triples===
 
 
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_create_db -->
<!-- Pod2Wiki=item_recommit -->
+
===create_db===
===recommit===
+
<pre>  epadmin create_db repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Create a database and database user with the current settings.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_create_user -->
<!-- Pod2Wiki=item_redo_mime_type -->
+
===create_user===
===redo_mime_type===
+
<pre>  epadmin create_user repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Create a new user. You need to do this to create your first admin account.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_redo_thumbnails -->
 
===redo_thumbnails===
 
 
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_delete -->
<!-- Pod2Wiki=item_refresh_abstracts -->
+
===delete===
===refresh_abstracts===
+
<pre>  epadmin delete repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Destroy repository_id and all of its content. Only use if you are absolutely sure you know what you're doing.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_refresh_views -->
+
===refresh_views===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_help -->
<!-- Pod2Wiki=item_rehash -->
+
===help===
===rehash===
+
<pre>  epadmin help [command]</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Show help for <code>epadmin</code>. Specify a <code>command</code> to get detailed help on a particular command
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_reindex -->
 
===reindex===
 
 
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_redo_files_modified -->
<!-- Pod2Wiki=item_reload -->
+
===redo_files_modified===
===reload===
+
<pre>  epadmin redo_files_modified repository_id [ dataset objectid, ... ]</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Call [[API:EPrints/DataObj/Document#files_modified|EPrints::DataObj::Document/files_modified]] for every document.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_schema -->
+
===schema===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_redo_mime_type -->
<!-- Pod2Wiki=item_set_developer_mode -->
+
===redo_mime_type===
===set_developer_mode===
+
<pre>  epadmin redo_mime_type repository_id dataset [ objectid, ... ]</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Redo file format identification. Dataset may be <code>eprint</code>, <code>document</code> or <code>file</code>.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_test -->
+
===test===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_redo_thumbnails -->
<!-- Pod2Wiki=item_unit_tests -->
+
===redo_thumbnails===
===unit_tests===
+
<pre>  epadmin redo_thumbnails repository_id [ eprintid, ... ]</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
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.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_update -->
+
===update===
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_refresh_views -->
<!-- Pod2Wiki=item_upgrade -->
+
===refresh_views===
===upgrade===
+
<pre>  epadmin refresh_views repository_id</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
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.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=head_arguments -->
 
==ARGUMENTS==
 
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_refresh_abstracts -->
<!-- Pod2Wiki=item_b_epadmin_create -->
+
===refresh_abstracts===
==='''epadmin''' create===
+
<pre>  epadmin refresh_abstracts repository_id</pre>
  
START HERE! This option will walk you through the tasks needed to create your repository.
+
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_reload -->
<!-- Pod2Wiki=item_b_epadmin_test_i_repository_id -->
+
===reload===
==='''epadmin''' test <em>repository_id</em>===
+
<pre> epadmin reload repository_id</pre>
  
A null operation which just checks your configuration files are OK and that you can connect to the database. If no <em>repository_id</em> is specified loads each repository in turn. Use --verbose to generate more information.
+
Cause the web server to reload the repository configuration.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_create_tables -->
<!-- Pod2Wiki=item_b_epadmin_cleanup_cachemaps_i_repository_id -->
+
===create_tables===
==='''epadmin''' cleanup_cachemaps <em>repository_id</em>===
+
<pre>  epadmin create_tables repository_id</pre>
 
+
Drop any orphaned cache tables.
+
 
+
<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_b_epadmin_config_core_i_repository_id -->
+
==='''epadmin''' config_core <em>repository_id</em>===
+
 
+
Set hostname, contact email and repository name.
+
 
+
<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_b_epadmin_config_db_i_repository_id -->
+
==='''epadmin''' config_db <em>repository_id</em>===
+
 
+
Set database connection properties and, optionally, to create database and database user.
+
 
+
<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_b_epadmin_create_db_i_repository_id -->
+
==='''epadmin''' create_db <em>repository_id</em>===
+
 
+
Create a database and database user with the current settings.
+
 
+
<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_b_epadmin_create_tables_i_repository_id -->
+
==='''epadmin''' create_tables <em>repository_id</em>===
+
  
 
Create the database tables.
 
Create the database tables.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_erase_data -->
<!-- Pod2Wiki=item_b_epadmin_create_user_i_repository_id -->
+
===erase_data===
==='''epadmin''' create_user <em>repository_id</em>===
+
<pre> epadmin erase_data repository_id</pre>
  
Create a new user. You need to do this to create your first admin account.
+
Erases and recreates the database. Removes all documents and files. Does not touch the configuration files.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_erase_eprints -->
<!-- Pod2Wiki=item_b_epadmin_schema_i_repository_id -->
+
===erase_eprints===
==='''epadmin''' schema <em>repository_id</em>===
+
<pre> epadmin erase_eprints repository_id</pre>
  
Use this to produce a schema for the EP3 XML read/written by your repository.  
+
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_erase_fulltext_index -->
<!-- Pod2Wiki=item_b_epadmin_erase_fulltext_index_i_repository_id -->
+
===erase_fulltext_index===
==='''epadmin''' erase_fulltext_index <em>repository_id</em>===
+
<pre> epadmin erase_fulltext_index repository_id</pre>
  
 
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 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.
Line 432: Line 247:
 
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.
 
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_show_config -->
<!-- Pod2Wiki=item_b_epadmin_rebuild_triples_i_repository_id_i_dataset_id_i_item_id_i_item_id -->
+
===show_config===
==='''epadmin''' rebuild_triples <em>repository_id</em> [<em>dataset_id</em> [<em>item_id</em> <em>item_id</em> ...]]===
+
<pre> epadmin show_config repository_id key1 [key2 ...]</pre>
  
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.  
+
Dump the given configuration section identified by key1. Use extra keys to get a lower-level configuration setting.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_show_plugins -->
<!-- Pod2Wiki=item_b_epadmin_recommit_i_repository_id_i_dataset_id_i_eprint_id_i_eprint_id -->
+
===show_plugins===
==='''epadmin''' recommit <em>repository_id</em> <em>dataset_id</em> [<em>eprint_id</em> <em>eprint_id</em> ...]===
+
<pre> epadmin show_plugins repository_id [filters]</pre>
  
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.
+
Dump a list of all enabled plugins. You can constrain this list by providing filters e.g.:
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<pre> type=Import</pre>
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_b_epadmin_reindex_i_repository_id_i_dataset_id_i_eprint_id_i_eprint_id -->
+
==='''epadmin''' reindex <em>repository_id</em> <em>dataset_id</em> [<em>eprint_id</em> <em>eprint_id</em> ...]===
+
 
+
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.
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_test -->
<!-- Pod2Wiki=item_b_epadmin_reorder_i_repository_id_i_dataset_id_i_eprint_id_i_eprint_id -->
+
===test===
==='''epadmin''' reorder <em>repository_id</em> <em>dataset_id</em> [<em>eprint_id</em> <em>eprint_id</em> ...]===
+
<pre> epadmin test repository_id</pre>
  
Regenerate the order values for the dataset. If a list of eprint_ids is given then just recalculate ordervalues for those.
+
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_profile -->
<!-- Pod2Wiki=item_b_epadmin_rehash_i_repository_id_i_document_id -->
+
===profile===
==='''epadmin''' rehash <em>repository_id</em> [<em>document_id</em>]===
+
<pre> epadmin profile test</pre>
  
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.
+
Run a performance profile of test using {{API:PodLink|file=Devel/NYTProf|package_name=Devel::NYTProf|section=|text=Devel::NYTProf}}.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_unit_tests -->
<!-- Pod2Wiki=item_b_epadmin_reload_i_repository_id -->
+
===unit_tests===
==='''epadmin''' reload <em>repository_id</em>===
+
<pre> epadmin unit_tests</pre>
  
Cause the web server to reload the repository configuration.
+
Run unit tests, printing the results to STDOUT. If everything passed will exit with a return code of 0.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_rehash -->
<!-- Pod2Wiki=item_b_epadmin_set_developer_mode_i_repository_id_on_off -->
+
===rehash===
==='''epadmin''' set_developer_mode <em>repository_id</em> &lt;on|off&gt;===
+
<pre> epadmin rehash repository_id [document_id]</pre>
  
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.
+
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_update -->
<!-- Pod2Wiki=item_b_epadmin_refresh_views_i_repository_id -->
+
===update===
==='''epadmin''' refresh_views <em>repository_id</em>===
+
<pre> epadmin update repository_id</pre>
  
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.
+
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 before use on live systems.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_recommit -->
<!-- Pod2Wiki=item_b_epadmin_refresh_abstracts_i_repository_id -->
+
===recommit===
==='''epadmin''' refresh_abstracts <em>repository_id</em>===
+
<pre> epadmin recommit repository_id dataset_id [eprint_id eprint_id ...]</pre>
  
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.
+
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_reorder -->
<!-- Pod2Wiki=item_b_epadmin_redo_mime_type_i_repository_id_dataset_objectid -->
+
===reorder===
==='''epadmin''' redo_mime_type <em>repository_id</em> dataset [ objectid, ... ]===
+
<pre> epadmin reorder repository_id dataset_id [eprint_id eprint_id ...]</pre>
  
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.
+
Regenerate the order values for the dataset. If a list of eprint_ids is given then just recalculate ordervalues for those.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_rebuild_triples -->
<!-- Pod2Wiki=item_b_epadmin_redo_thumbnails_i_repository_id_i_eprintid -->
+
===rebuild_triples===
==='''epadmin''' redo_thumbnails <em>repository_id</em> [ <em>eprintid</em>, ... ]===
+
<pre> epadmin rebuild_triples repository_id [dataset_id item_id item_id ...]]</pre>
  
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.
+
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.  
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_reindex -->
<!-- Pod2Wiki=item_b_epadmin_erase_data_i_repository_id -->
+
===reindex===
==='''epadmin''' erase_data <em>repository_id</em>===
+
<pre> epadmin reindex repository_id dataset_id [eprint_id eprint_id ...]</pre>
  
Erases and recreates the database. Removes all documents and files. Does not touch the configuration files.
+
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.
 
+
Please note it only works on the indexable dataset, e.g. eprint, document, but not the '''file''' dataset.
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_remove_field -->
<!-- Pod2Wiki=item_b_epadmin_erase_eprints_i_repository_id -->
+
==='''epadmin''' erase_eprints <em>repository_id</em>===
+
  
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.
+
===remove_field===
 
+
<pre>  epadmin remove_field repository_id dataset field_id</pre>
<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_b_epadmin_unit_tests -->
+
==='''epadmin''' unit_tests===
+
 
+
Run unit tests, printing the results to STDOUT. If everything passed will exit with a return code of 0.
+
 
+
<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_b_epadmin_profile_i_test -->
+
==='''epadmin''' profile <em>test</em>===
+
 
+
Run a performance profile of <em>test</em> using {{API:PodLink|file=Devel/NYTProf|package_name=Devel::NYTProf|section=|text=Devel::NYTProf}}.
+
 
+
<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_b_epadmin_remove_field_i_repository_id_i_dataset_i_field_id -->
+
==='''epadmin''' remove_field <em>repository_id</em> <em>dataset</em> <em>field_id</em>===
+
  
 
Remove the database entries for the given field, can not be undone!
 
Remove the database entries for the given field, can not be undone!
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_set_developer_mode -->
<!-- Pod2Wiki=item_b_epadmin_update_i_repository_id -->
+
===set_developer_mode===
==='''epadmin''' update <em>repository_id</em>===
+
<pre> epadmin set_developer_mode repository_id &lt;on|off&gt;</pre>
  
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.
+
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.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_upgrade -->
<!-- Pod2Wiki=item_b_epadmin_upgrade_i_repository_id -->
+
===upgrade===
==='''epadmin''' upgrade <em>repository_id</em>===
+
<pre> epadmin upgrade repository_id</pre>
  
 
After upgrading EPrints, use this to update the database tables. It will advise any other tasks that are required.
 
After upgrading EPrints, use this to update the database tables. It will advise any other tasks that are required.
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
<!-- Pod2Wiki=item_b_epadmin_help -->
 
==='''epadmin''' --help===
 
 
<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=head_options -->
 
<!-- Pod2Wiki=head_options -->
 
==OPTIONS==
 
==OPTIONS==
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''--help'''
<span style='display:none'>User Comments</span>
+
: Print a brief help message and exit.
<!-- Edit below this comment -->
+
  
 +
* '''--man'''
 +
: Print the full manual page and then exit.
  
<!-- Pod2Wiki= -->
+
* '''--quiet'''
</div>
+
: This option does not do anything.
<!-- Pod2Wiki=item_b_help -->
+
==='''--help'''===
+
  
Print a brief help message and exit.
+
* '''--verbose'''
 +
: Explain in detail what is going on. May be repeated for greater effect.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* '''--force'''
<span style='display:none'>User Comments</span>
+
: Be more forceful (don't ask for confirmation).
<!-- Edit below this comment -->
+
  
 +
* '''--version'''
 +
: Output version information and exit.
  
<!-- Pod2Wiki= -->
+
<pre></pre>
</div>
+
<!-- Pod2Wiki=item_b_man -->
+
==='''--man'''===
+
  
Print the full manual page and then exit.
 
 
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_copyright -->
<!-- Pod2Wiki=item_b_quiet -->
+
==COPYRIGHT==
==='''--quiet'''===
+
Copyright 2000-2011 University of Southampton.
  
This option does not do anything.
+
This file is part of EPrints http://www.eprints.org/.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
EPrints 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 General Public License for more details.
  
<!-- Pod2Wiki= -->
+
You should have received a copy of the GNU General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
</div>
+
<!-- Pod2Wiki=item_b_verbose -->
+
==='''--verbose'''===
+
 
+
Explain in detail what is going on. May be repeated for greater effect.
+
  
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=_postamble_ -->
<!-- Pod2Wiki=item_b_force -->
+
==='''--force'''===
+
 
+
Be more forceful (don't ask for confirmation).
+
 
+
<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 -->
 
<!-- Edit below this comment -->
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_b_version -->
 
==='''--version'''===
 
 
Output version information and exit.
 
 
<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=head_copyright -->
 
==COPYRIGHT==
 
<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=_postamble_ --><!-- Edit below this comment -->
 

Latest revision as of 09:49, 6 June 2017

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


NAME

epadmin - EPrints repository admin tool


SYNOPSIS

epadmin options command [repository_id]

Where command is one of:

  • cleanup_cachemaps
  • config_core
  • config_db
  • create
  • create_db
  • create_tables
  • create_user
  • erase_data
  • erase_eprints
  • erase_fulltext_index
  • help
  • profile
  • rebuild_triples
  • recommit
  • reorder
  • redo_files_modified
  • redo_mime_type
  • redo_thumbnails
  • refresh_abstracts
  • refresh_views
  • reindex
  • reload
  • set_developer_mode
  • show_config
  • show_plugins
  • test
  • unit_tests
  • update
  • upgrade

Type epadmin help command for further help.


COMMANDS

create

  epadmin create

Create a new repository instance based on question-and-answer.


create_test

  epadmin create_test

Create a test repository instance called "test".


cleanup_cachemaps

  epadmin cleanup_cachemaps repository_id

Drop any orphaned cache tables.


config_core

  epadmin config_core repository_id

Set hostname, contact email and repository name.


config_db

  epadmin config_db repository_id

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


create_db

  epadmin create_db repository_id

Create a database and database user with the current settings.


create_user

  epadmin create_user repository_id

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


delete

  epadmin delete repository_id

Destroy repository_id and all of its content. Only use if you are absolutely sure you know what you're doing.


help

  epadmin help [command]

Show help for epadmin. Specify a command to get detailed help on a particular command


redo_files_modified

  epadmin redo_files_modified repository_id [ dataset objectid, ... ]

Call EPrints::DataObj::Document/files_modified for every document.


redo_mime_type

  epadmin redo_mime_type repository_id dataset [ objectid, ... ]

Redo file format identification. Dataset may be eprint, document or file.


redo_thumbnails

  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.


refresh_views

  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.


refresh_abstracts

  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.


reload

  epadmin reload repository_id

Cause the web server to reload the repository configuration.


create_tables

  epadmin create_tables repository_id

Create the database tables.


erase_data

  epadmin erase_data repository_id

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


erase_eprints

  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.


erase_fulltext_index

  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.


show_config

  epadmin show_config repository_id key1 [key2 ...]

Dump the given configuration section identified by key1. Use extra keys to get a lower-level configuration setting.


show_plugins

  epadmin show_plugins repository_id [filters]

Dump a list of all enabled plugins. You can constrain this list by providing filters e.g.:

  type=Import


test

  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.


profile

  epadmin profile test

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


unit_tests

  epadmin unit_tests

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


rehash

  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.


update

  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 before use on live systems.


recommit

  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.


reorder

  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.


rebuild_triples

  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.


reindex

  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. Please note it only works on the indexable dataset, e.g. eprint, document, but not the file dataset.


remove_field

  epadmin remove_field repository_id dataset field_id

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


set_developer_mode

  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.


upgrade

  epadmin upgrade repository_id

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


OPTIONS

  • --help
Print a brief help message and exit.
  • --man
Print the full manual page and then exit.
  • --quiet
This option does not do anything.
  • --verbose
Explain in detail what is going on. May be repeated for greater effect.
  • --force
Be more forceful (don't ask for confirmation).
  • --version
Output version information and exit.


COPYRIGHT

Copyright 2000-2011 University of Southampton.

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

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints 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 General Public License for more details.

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