API:bin/epadmin

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

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

recommit

User Comments

reorder

User Comments

redo_thumbnails

User Comments

refresh_abstracts

User Comments

refresh_views

User Comments

rehash

User Comments

reindex

User Comments

reload

User Comments

reload_metafields

User Comments

schema

User Comments

test

User Comments

unit_tests

User Comments

update_database_structure

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.

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 recommit repository_id dataset_id

Recommit all the records in the given dataset. What this does is cause the automatic values to be re-calculated.

User Comments

epadmin reindex repository_id dataset_id

Schedule the dataset for reindexing. The indexer will do the actual indexing and it may take some time. This only schedules the reindexing.

User Comments

epadmin reorder repository_id dataset_id

Regenerate the order values for the dataset.

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 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_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 reload_metafields repository_id

Reload the metafields dataset, based on the current configuration.

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 update_database_structure 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