Editing API:bin/import

<!-- 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.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=bin/import|package_name=bin/import}}[[Category:API|BIN/IMPORT]][[Category:API:bin/import|BIN/IMPORT]][[Category:API:bin/import|BIN/IMPORT]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''import''' - Import a file using an import plugin.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_synopsis -->
==SYNOPSIS==
'''import''' <em>repository_id</em> ['''options'''] <em>dataset</em>

'''import''' <em>repository_id</em> ['''options'''] <em>dataset</em> <em>plugin</em> <em>filename</em> 

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_description -->
==DESCRIPTION==
This command imports a set of EPrints from a file into the given dataset.

 bin/import <REPOSITORYID> eprint --verbose
presents a list of all available import filters (as well as missing perl modules causing some deactivations)

<!-- Edit below this comment -->

<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_arguments -->

==ARGUMENTS==
* <em>repository_id</em> 
: The ID of the EPrint repository to import to.

* <em>dataset</em>
: 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.

* <em>plugin</em>
: 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.

* <em>filename</em>
: Filename to read from. To read from STDIN specify '-'.

<!-- Edit below this comment -->

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

* '''--argument key=value'''
: Add an argument to the import plugin. May be repeated. Effects depend on the import plugin.

* '''--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. Implies --enable-web-imports --enable-file-imports --force

* '''--enable-import-fields'''
: Allow the import to set fields that are set as not to be imported. This is typically used to specify the imported object id.

* '''--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.

* '''--xml'''
: Output to STDOUT the parsed objects in EPrints XML (does not import anything).

* '''--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. Combine with --enable-import-fields to update all field values.

* '''--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.

<pre>
  
</pre>

<!-- Edit below this comment -->
'''Please note''' that the ''--update'' option described above '''will not''' work in EPrint versions prior to v3.3.12 without an edit to the bin/import module. See here for details. [https://github.com/eprints/eprints/commit/a5eb05abd14606d26f746e1f2d499bd11104c3ae]

<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->
==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/.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=_postamble_ -->
<!-- Edit below this comment -->