1
0
Fork 0

backported documentation for issue #300

This commit is contained in:
Jan Steemann 2012-12-22 03:41:03 +01:00
parent d562c52fd7
commit 721fae0b22
1 changed files with 15 additions and 1 deletions

View File

@ -73,10 +73,24 @@
/// This import method allows uploading self-contained JSON documents. The
/// documents must be uploaded in the body of the HTTP POST request. Each line
/// of the body will be interpreted as one stand-alone document. Empty lines
/// in the body are allowed and will be skipped.
/// in the body are allowed but will be skipped. Using this format, the documents
/// are imported line-wise.
///
/// To use this method, the @LIT{type} URL parameter should be set to @LIT{documents}.
///
/// It is also possible to upload self-contained JSON documents that are
/// embedded into a JSON list. Each element from the list will be treated as a
/// document and be imported.
///
/// This format does not require each document to be on a separate line, and any
/// whitespace in the JSON data is allowed. It can be used to import a JSON-formatted
/// result list (e.g. from arangosh) back into ArangoDB.
/// Using this format requires ArangoDB to parse the complete list and keep it in
/// memory for the duration of the import. This might be more resource-intensive than
/// the line-wise processing.
///
/// To use this method, the @LIT{type} URL parameter should be set to @LIT{array}.
///
/// @EXAMPLES
///
/// @verbinclude api-import-documents