Difference between revisions of "API:bin/epadmin"
| Line 140: | Line 140: | ||
<!-- Pod2Wiki=item_profile --> | <!-- Pod2Wiki=item_profile --> | ||
===profile=== | ===profile=== | ||
| + | |||
| + | <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_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%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 240: | Line 250: | ||
<!-- Pod2Wiki=item_schema --> | <!-- Pod2Wiki=item_schema --> | ||
===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 --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_set_developer_mode --> | ||
| + | ===set_developer_mode=== | ||
<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 268: | Line 288: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- 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%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 312: | Line 332: | ||
==='''epadmin''' test <em>repository_id</em>=== | ==='''epadmin''' test <em>repository_id</em>=== | ||
| − | 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. | + | 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. |
<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 411: | Line 431: | ||
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 --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_b_epadmin_rebuild_triples_i_repository_id_i_dataset_id_i_item_id_i_item_id --> | ||
| + | ==='''epadmin''' rebuild_triples <em>repository_id</em> [<em>dataset_id</em> [<em>item_id</em> <em>item_id</em> ...]]=== | ||
| + | |||
| + | 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%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 471: | Line 503: | ||
Cause the web server to reload the repository configuration. | 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 --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=item_b_epadmin_set_developer_mode_i_repository_id_on_off --> | ||
| + | ==='''epadmin''' set_developer_mode <em>repository_id</em> <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. | ||
<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 575: | Line 619: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_b_epadmin_remove_field_i_repository_id_i_dataset_i_field_id --> |
| − | ==='''epadmin''' | + | ==='''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! | ||
| + | |||
| + | <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_update_i_repository_id --> | ||
| + | ==='''epadmin''' update <em>repository_id</em>=== | ||
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. | 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. | ||
| Line 683: | Line 739: | ||
Output version information and exit. | 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%; '> | <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> | <span style='display:none'>User Comments</span> | ||
Revision as of 10:47, 25 August 2011
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
- 1 NAME
- 2 SYNOPSIS
- 2.1 cleanup_cachemaps
- 2.2 config_core
- 2.3 config_db
- 2.4 create
- 2.5 create_db
- 2.6 create_tables
- 2.7 create_user
- 2.8 erase_data
- 2.9 erase_eprints
- 2.10 erase_fulltext_index
- 2.11 help
- 2.12 profile
- 2.13 rebuild_triples
- 2.14 recommit
- 2.15 reorder
- 2.16 redo_thumbnails
- 2.17 refresh_abstracts
- 2.18 refresh_views
- 2.19 rehash
- 2.20 reindex
- 2.21 reload
- 2.22 reload_metafields
- 2.23 schema
- 2.24 set_developer_mode
- 2.25 test
- 2.26 unit_tests
- 2.27 update
- 2.28 upgrade
- 3 ARGUMENTS
- 3.1 epadmin create
- 3.2 epadmin test repository_id
- 3.3 epadmin cleanup_cachemaps repository_id
- 3.4 epadmin config_core repository_id
- 3.5 epadmin config_db repository_id
- 3.6 epadmin create_db repository_id
- 3.7 epadmin create_tables repository_id
- 3.8 epadmin create_user repository_id
- 3.9 epadmin schema repository_id
- 3.10 epadmin erase_fulltext_index repository_id
- 3.11 epadmin rebuild_triples repository_id [dataset_id [item_id item_id ...]]
- 3.12 epadmin recommit repository_id dataset_id [eprint_id eprint_id ...]
- 3.13 epadmin reindex repository_id dataset_id [eprint_id eprint_id ...]
- 3.14 epadmin reorder repository_id dataset_id [eprint_id eprint_id ...]
- 3.15 epadmin rehash repository_id [document_id]
- 3.16 epadmin reload repository_id
- 3.17 epadmin set_developer_mode repository_id <on|off>
- 3.18 epadmin refresh_views repository_id
- 3.19 epadmin refresh_abstracts repository_id
- 3.20 epadmin redo_thumbnails repository_id [ eprintid, ... ]
- 3.21 epadmin reload_metafields repository_id
- 3.22 epadmin erase_data repository_id
- 3.23 epadmin erase_eprints repository_id
- 3.24 epadmin unit_tests
- 3.25 epadmin profile test
- 3.26 epadmin remove_field repository_id dataset field_id
- 3.27 epadmin update repository_id
- 3.28 epadmin upgrade repository_id
- 3.29 epadmin --help
- 4 OPTIONS
- 5 COPYRIGHT
NAME
epadmin - EPrints repository admin tool
SYNOPSIS
epadmin command repository_id [options]
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_thumbnails
refresh_abstracts
refresh_views
rehash
reindex
reload
reload_metafields
schema
set_developer_mode
test
unit_tests
update
upgrade
ARGUMENTS
epadmin create
START HERE! This option will walk you through the tasks needed to create your repository.
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.
epadmin cleanup_cachemaps repository_id
Drop any orphaned cache tables.
epadmin config_core repository_id
Set hostname, contact email and repository name.
epadmin config_db repository_id
Set database connection properties and, optionally, to create database and database user.
epadmin create_db repository_id
Create a database and database user with the current settings.
epadmin create_tables repository_id
Create the database tables.
epadmin create_user repository_id
Create a new user. You need to do this to create your first admin account.
epadmin schema repository_id
Use this to produce a schema for the EP3 XML read/written by your repository.
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.
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.
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.
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.
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.
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.
epadmin reload repository_id
Cause the web server to reload the repository configuration.
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.
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.
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.
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.
epadmin reload_metafields repository_id
Reload the metafields dataset, based on the current configuration.
epadmin erase_data repository_id
Erases and recreates the database. Removes all documents and files. Does not touch the configuration files.
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.
epadmin unit_tests
Run unit tests, printing the results to STDOUT. If everything passed will exit with a return code of 0.
epadmin profile test
Run a performance profile of test using Devel::NYTProf.
epadmin remove_field repository_id dataset field_id
Remove the database entries for the given field, can not be undone!
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.
epadmin upgrade repository_id
After upgrading EPrints, use this to update the database tables. It will advise any other tasks that are required.
epadmin --help
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
