mirror of https://gitee.com/bigwinds/arangodb
65 lines
2.5 KiB
Groff
65 lines
2.5 KiB
Groff
.TH arangoimp 1 "Do 23. Jan 09:57:20 CET 2014" "" "ArangoDB"
|
|
.SH NAME
|
|
arangoimp - a bulk importer for the ArangoDB database
|
|
.SH SYNOPSIS
|
|
arangoimp [options]
|
|
.SH DESCRIPTION
|
|
The arangoimp binary can be used to bulk import data from a file into the
|
|
ArangoDB database. Input data be present in the input file in either CSV
|
|
format with column headlines, or in JSON format. If JSON format is used,
|
|
each line in the input file must contain exactly one JSON document with
|
|
the attribute name/value pairs to import.
|
|
.SH OPTIONS
|
|
For a complete list of options, please refer to the ArangoDB
|
|
online manual, available at http://www.arangodb.org/
|
|
|
|
The most important startup options are:
|
|
|
|
.IP "--batch-size <uint64>"
|
|
maximum size of data batches that are sent to the server
|
|
.IP "--configuration <string>"
|
|
read configuration from file <string>
|
|
.IP "--collection <string>"
|
|
name of collection to import into
|
|
.IP "--create-collection <bool>"
|
|
set to "true" if collection should be created by the import
|
|
.IP "--file <string>"
|
|
input file with the data to import
|
|
.IP "--overwrite <bool>"
|
|
set to "true" to remove all data from the collection prior to the import
|
|
.IP "--quote <string>"
|
|
optional quote character to be used
|
|
.IP "--separator <string>"
|
|
separator character or string to be used. the default value is ","
|
|
.IP "--type <string>"
|
|
set to "json", "tsv" or "csv", depending on the input file format
|
|
.IP "--server.endpoint <string>"
|
|
server endpoint to connect to, consisting of protocol, ip address and port
|
|
.IP "--server.database <string>"
|
|
database name to use when connection (default: "_system")
|
|
.IP "--server.username <string>"
|
|
username to use when connecting (default "root")
|
|
.IP "--server.password <string>"
|
|
password to use when connecting. Don't specify this option to get a password prompt
|
|
.IP "--server.disable-authentication <boolean>"
|
|
disable the password prompt and authentication when connecting to the server
|
|
.SH EXAMPLES
|
|
.EX
|
|
shell> arangoimp --file heroes.json --type json --collection superheroes --create-collection true
|
|
imports JSON data from file heroes.json into collection superhoeres. creates the collection if it does not exist
|
|
.EE
|
|
|
|
.EX
|
|
shell> arangoimp --file export.csv --type csv --collection mydata
|
|
imports CSV data from export.csv into existing collection mydata
|
|
.EE
|
|
|
|
.EX
|
|
shell> arangoimp --file values.json --collection mydata --server.endpoint tcp://127.0.0.1:8529 --server.database mydb
|
|
imports JSON data from file values.json into collection mydata, using a different server endpoint and database
|
|
.EE
|
|
|
|
|
|
.SH AUTHOR
|
|
Copyright triAGENS GmbH, Cologne, Germany
|