Editing API:bin/epadmin (section)

==COMMANDS==
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_create -->
===create===
<pre>  epadmin create</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_create_test -->
===create_test===
<pre>  epadmin create_test</pre>

Create a test repository instance called "test".

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_cleanup_cachemaps -->
===cleanup_cachemaps===
<pre>  epadmin cleanup_cachemaps repository_id</pre>

Drop any orphaned cache tables.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_config_core -->
===config_core===
<pre>  epadmin config_core repository_id</pre>

Set hostname, contact email and repository name. 

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_config_db -->
===config_db===
<pre>  epadmin config_db repository_id</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_create_db -->
===create_db===
<pre>  epadmin create_db repository_id</pre>

Create a database and database user with the current settings.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_create_user -->
===create_user===
<pre>  epadmin create_user repository_id</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_delete -->
===delete===
<pre>  epadmin delete repository_id</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_help -->
===help===
<pre>  epadmin help [command]</pre>

Show help for <code>epadmin</code>. Specify a <code>command</code> to get detailed help on a particular command

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_redo_files_modified -->
===redo_files_modified===
<pre>  epadmin redo_files_modified repository_id [ dataset objectid, ... ]</pre>

Call [[API:EPrints/DataObj/Document#files_modified|EPrints::DataObj::Document/files_modified]] for every document.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_redo_mime_type -->
===redo_mime_type===
<pre>  epadmin redo_mime_type repository_id dataset [ objectid, ... ]</pre>

Redo file format identification. Dataset may be <code>eprint</code>, <code>document</code> or <code>file</code>.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_redo_thumbnails -->
===redo_thumbnails===
<pre>  epadmin redo_thumbnails repository_id [ eprintid, ... ]</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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_refresh_views -->
===refresh_views===
<pre>  epadmin refresh_views 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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_refresh_abstracts -->
===refresh_abstracts===
<pre>  epadmin refresh_abstracts repository_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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_reload -->
===reload===
<pre>  epadmin reload repository_id</pre>

Cause the web server to reload the repository configuration.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_create_tables -->
===create_tables===
<pre>  epadmin create_tables repository_id</pre>

Create the database tables.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_erase_data -->
===erase_data===
<pre>  epadmin erase_data repository_id</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_erase_eprints -->
===erase_eprints===
<pre>  epadmin erase_eprints repository_id</pre>

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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_erase_fulltext_index -->
===erase_fulltext_index===
<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 is useful if you only setup the fulltext indexing after your repository is already live, or if you discover there has been a problem.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_show_config -->
===show_config===
<pre>  epadmin show_config repository_id key1 [key2 ...]</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_show_plugins -->
===show_plugins===
<pre>  epadmin show_plugins repository_id [filters]</pre>

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

<pre>  type=Import</pre>

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_test -->
===test===
<pre>  epadmin test repository_id</pre>

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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_profile -->
===profile===
<pre>  epadmin profile test</pre>

Run a performance profile of test using {{API:PodLink|file=Devel/NYTProf|package_name=Devel::NYTProf|section=|text=Devel::NYTProf}}.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_unit_tests -->
===unit_tests===
<pre>  epadmin unit_tests</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_rehash -->
===rehash===
<pre>  epadmin rehash repository_id [document_id]</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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_update -->
===update===
<pre>  epadmin update repository_id</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 before use on live systems.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_recommit -->
===recommit===
<pre>  epadmin recommit repository_id dataset_id [eprint_id eprint_id ...]</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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_reorder -->
===reorder===
<pre>  epadmin reorder repository_id dataset_id [eprint_id eprint_id ...]</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_rebuild_triples -->
===rebuild_triples===
<pre>  epadmin rebuild_triples repository_id [dataset_id item_id item_id ...]]</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. 

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_reindex -->
===reindex===
<pre>  epadmin reindex repository_id dataset_id [eprint_id eprint_id ...]</pre>

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.
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_remove_field -->

===remove_field===
<pre>  epadmin remove_field repository_id dataset field_id</pre>

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

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_set_developer_mode -->
===set_developer_mode===
<pre>  epadmin set_developer_mode repository_id &lt;on|off&gt;</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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_upgrade -->
===upgrade===
<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.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_options -->