Skip to content

Docs: Formatting #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Dec 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,8 +277,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a

### Fixed

- fixed default Json parsing, include null values (Issue #163)
- fixed Json parsing of negative long (Issue #151)
- fixed default JSON parsing, include null values (Issue #163)
- fixed JSON parsing of negative long (Issue #151)

## [4.3.0] - 2017-11-23

Expand Down Expand Up @@ -386,7 +386,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
- added `ArangoDBException#getException()`
- added protocol switch (`ArangoDB.Builder#useProtocol(Protocol)`)
- `Protocol#VST` = VeclocyStream (default)
- `Protocol#HTTP_JSON` = Json over HTTP
- `Protocol#HTTP_JSON` = JSON over HTTP
- `Protocol#HTTP_VPACK` = VelocyPack over HTTP

## [4.1.12] - 2017-04-13
Expand Down Expand Up @@ -472,13 +472,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
### Fixed

- fixed URL encoding bug (#97)
- fixed update/replaceDocumets with Json (#98)
- fixed update/replaceDocumets with JSON (#98)

## [4.1.7] - 2017-01-26

### Fixed

- fixed `importDocuments`, `insertDocuments` to work with raw Jsons (issue #91)
- fixed `importDocuments`, `insertDocuments` to work with raw JSONs (issue #91)

## [4.1.6] - 2017-01-18

Expand Down Expand Up @@ -523,7 +523,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a

### Added

- added `VelocyPack` UTC_DATE parsing to Json String (ISO 8601)
- added `VelocyPack` UTC_DATE parsing to JSON String (ISO 8601)
- added configuration methods for `VPackParser` in `ArangoDB.Builder`
- added `VPackJsonSerializer` for `VPackParser`

Expand Down
20 changes: 10 additions & 10 deletions docs/Drivers/Java/GettingStarted/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@

## Supported versions

<table>
<tr><th>arangodb-java-driver</th><th>ArangoDB</th><th>network protocol</th><th>Java version</th></tr>
<tr><td>5.x.x+</td><td>3.0.0+</td><td>VelocyStream, HTTP</td><td>1.6+</td></tr>
<tr><td>4.2.x+</td><td>3.0.0+</td><td>VelocyStream, HTTP</td><td>1.6+</td></tr>
<tr><td>4.1.x</td><td>3.1.0+</td><td>VelocyStream</td><td>1.6+</td></tr>
<tr><td>3.1.x</td><td>3.1.0+</td><td>HTTP</td><td>1.6+</td></tr>
<tr><td>3.0.x</td><td>3.0.x</td><td>HTTP</td><td>1.6+</td></tr>
<tr><td>2.7.4</td><td>2.7.x, 2.8.x</td><td>HTTP</td><td>1.6+</td></tr>
</table>
arangodb-java-driver | ArangoDB | network protocol | Java version
---------------------|--------------|--------------------|-------------
5.x.x+ | 3.0.0+ | VelocyStream, HTTP | 1.6+
4.2.x+ | 3.0.0+ | VelocyStream, HTTP | 1.6+
4.1.x | 3.1.0+ | VelocyStream | 1.6+
3.1.x | 3.1.0+ | HTTP | 1.6+
3.0.x | 3.0.x | HTTP | 1.6+
2.7.4 | 2.7.x, 2.8.x | HTTP | 1.6+

**Note**: VelocyStream is only supported in ArangoDB 3.1 and above.

Expand All @@ -31,7 +30,8 @@ ArangoDB 3.x.x
</dependencies>
```

If you want to test with a snapshot version (e.g. 4.6.0-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
If you want to test with a snapshot version (e.g. 4.6.0-SNAPSHOT),
add the staging repository of oss.sonatype.org to your pom.xml:

```XML
<repositories>
Expand Down
50 changes: 33 additions & 17 deletions docs/Drivers/Java/Reference/Collection/BulkImport.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,9 @@ This function implements the

## ArangoCollection.importDocuments

```
ArangoCollection.importDocuments(Collection<?> values, DocumentImportOptions options) : DocumentImportEntity
```
`ArangoCollection.importDocuments(Collection<?> values, DocumentImportOptions options) : DocumentImportEntity`

```
ArangoCollection.importDocuments(String values, DocumentImportOptions options) : DocumentImportEntity
```
`ArangoCollection.importDocuments(String values, DocumentImportOptions options) : DocumentImportEntity`

Bulk imports the given values into the collection.

Expand All @@ -27,39 +23,56 @@ Bulk imports the given values into the collection.

- **fromPrefix**: `String`

An optional prefix for the values in \_from attributes. If specified, the value is automatically prepended to each \_from input value. This allows specifying just the keys for \_from.
An optional prefix for the values in \_from attributes. If specified,
the value is automatically prepended to each \_from input value.
This allows specifying just the keys for \_from.

- **toPrefix**: `String`

An optional prefix for the values in \_to attributes. If specified, the value is automatically prepended to each \_to input value. This allows specifying just the keys for \_to.
An optional prefix for the values in \_to attributes. If specified,
the value is automatically prepended to each \_to input value.
This allows specifying just the keys for \_to.

- **overwrite**: `Boolean`

If this parameter has a value of true, then all data in the collection will be removed prior to the import. Note that any existing index definitions will be preseved.
If this parameter has a value of true, then all data in the collection
will be removed prior to the import. Note that any existing index definitions
will be preserved.

- **waitForSync**: `Boolean`

Wait until documents have been synced to disk before returning.

- **onDuplicate**: `OnDuplicate`

Controls what action is carried out in case of a unique key constraint violation. Possible values are:
Controls what action is carried out in case of a unique key constraint violation.
Possible values are:

- **error**: this will not import the current document because of the unique key constraint violation. This is the default setting.
- **error**: this will not import the current document because of the
unique key constraint violation. This is the default setting.

- **update**: this will update an existing document in the database with the data specified in the request. Attributes of the existing document that are not present in the request will be preseved.
- **update**: this will update an existing document in the database with
the data specified in the request. Attributes of the existing document
that are not present in the request will be preserved.

- **replace**: this will replace an existing document in the database with the data specified in the request.
- **replace**: this will replace an existing document in the database with
the data specified in the request.

- **ignore**: this will not update an existing document and simply ignore the error caused by the unique key constraint violation. Note that update, replace and ignore will only work when the import document in the request contains the \_key attribute. update and replace may also fail because of secondary unique key constraint violations.
- **ignore**: this will not update an existing document and simply ignore
the error caused by the unique key constraint violation. Note that update,
replace and ignore will only work when the import document in the request
contains the \_key attribute. update and replace may also fail because of
secondary unique key constraint violations.

- **complete**: `Boolean`

If set to true, it will make the whole import fail if any error occurs. Otherwise the import will continue even if some documents cannot be imported.
If set to true, it will make the whole import fail if any error occurs.
Otherwise the import will continue even if some documents cannot be imported.

- **details**: `Boolean`

If set to true, the result will include an attribute details with details about documents that could not be imported.
If set to true, the result will include an attribute details with details
about documents that could not be imported.

**Examples**

Expand All @@ -71,5 +84,8 @@ ArangoCollection collection = db.collection("some-collection");
BaseDocument doc1 = new BaseDocument();
BaseDocument doc2 = new BaseDocument();
BaseDocument doc3 = new BaseDocument();
collection.importDocuments(Arrays.asList(doc1, doc2, doc3), new DocumentImportOptions());
collection.importDocuments(
Arrays.asList(doc1, doc2, doc3),
new DocumentImportOptions()
);
```
Loading