API:bin/import
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
NAME
import - Import a file using an import plugin.
SYNOPSIS
import repository_id [options] dataset
import repository_id [options] dataset plugin filename
DESCRIPTION
This command imports a set of EPrints from a file into the given dataset.
ARGUMENTS
repository_id
The ID of the EPrint repository to import to.
dataset
The name of the dataset to import into, such as "eprint","archive", "subject" or "user".
Please note that for the "subject" dataset, you are probably better off using the import_subjects tool which will empty the dataset before importing.
plugin
The id of the input plugin to use. This should not include the leading "Import::". Examples: BibTeX, XML.
If this is ommited or an invalid plugin is requested, then 'import' will list all plugins compatible with the dataset and exit.
OPTIONS
--user USERID/USERNAME
For eprint datasets only. (not user or subject).
Sets the userid/username of the user in the system who will own the imported records.
Usually required for importing EPrint records. This may not be required if the import format contains the userid value, eg. an import in the EPrints 3 XML format.
If this is an integer then it is assumed to be the userid of the user, otherwise it is assumed to be the username.
You may wish to create one or more "bulk import" users and make imported eprint records belong to them.
--parse-only
Don't import, just check the file.
--migration
Turn on all the options needed to correctly import an XML data file exported from version 2, using the migration toolkit. This is the same as using --enable-import-ids --enable-import-datestamps --enable-file-imports --force
--enable-import-ids
By default import will generate a new eprintid, or userid for each record. This option tells it to use the id spcified in the imported data. This is generally used for importing into a new repository from an old one.
--enable-import-datestamps
Normally import will set the datestamp the the time the eprint was imported. This option causes it to take the datestamp from the imported data, if available.
--enable-file-imports
Allow the imported data to import files from the local filesystem. This can obviously be seen as a security hole if you don't trust the data you are importing. This sets the "enable_file_imports" configuration option for this session only.
--enable-web-imports
Allow the imported data to import files from the Web. This can obviously be seen as a security hole if you don't trust the data you are importing. This sets the "enable_web_imports" configuration option for this session only.
--update
Normally you can not import a new item with the same id as an existing item. With this option enabled existing items will be updated with the new item (implies --enable-import-ids).
--force
Don't ask any questions, just do it!
--help
Print a brief help message and exit.
--man
Print the full manual page and then exit.
--quiet
Be vewwy vewwy quiet. This option will supress all output unless an error occurs.
--verbose
Explain in detail what is going on. May be repeated for greater effect.
Shows why a plugin is disabled.
--version
Output version information and exit.
