Merge branch 'master' of github.com:arangodb/arangodb-java-driver

hkernbach · hkernbach · commit 9bd6b7cfeb4b · 2019-08-19T13:34:34.000+02:00
diff --git a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md
@@ -35,6 +35,17 @@ then returns collection information from the server.
     automatically and one of the servers holding copies take over, usually
     without an error being reported.
 
+  - **minReplicationFactor**: `Integer`
+
+    (optional, default is 1): in a cluster, this
+    attribute determines how many copies of each shard are required
+    to be in sync on the different DBServers. If we have less then these
+    many copies in the cluster a shard will refuse to write. The
+    minReplicationFactor can not be larger than replicationFactor.
+    Please note: during server failures this might lead to writes
+    not being possible until the failover is sorted out and might cause
+    write slow downs in trade of data durability.
+
   - **satellite**: `Boolean`
 
     If the true the collection is created as a satellite collection.
diff --git a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md
@@ -55,6 +55,10 @@ Retrieves the document with the given \_key from the collection.
 
     Whether or not catch possible thrown exceptions
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
@@ -135,6 +139,10 @@ generated automatically.
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
@@ -190,6 +198,10 @@ generated automatically.
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
@@ -254,6 +266,10 @@ such a document and no precondition is violated.
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
@@ -317,6 +333,10 @@ documents in values.
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
@@ -385,6 +405,10 @@ such a document and no precondition is violated.
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
@@ -448,6 +472,10 @@ documents in values.
     will be returned for the created document. This option can be used to save
     some network traffic.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 **Examples**
 
 ```Java
diff --git a/docs/Drivers/Java/Reference/Collection/Indexes.md b/docs/Drivers/Java/Reference/Collection/Indexes.md
@@ -17,6 +17,11 @@ Creates a hash index for the collection if it does not already exist.
 
 - **options**: `HashIndexOptions`
 
+  - **name**: `String`
+
+    Specify a custom name during index creation (optional). When running AQL queries you might then refer
+    to these name as your preferred index for lookups (e.g. Index Hints).
+
   - **unique**: `Boolean`
 
     If true, then create a unique index
@@ -59,6 +64,11 @@ Creates a skip-list index for the collection if it does not already exist.
 
 - **options**: `SkipListIndexOptions`
 
+  - **name**: `String`
+
+    Specify a custom name during index creation (optional). When running AQL queries you might then refer
+    to these name as your preferred index for lookups (e.g. Index Hints).
+
   - **unique**: `Boolean`
 
     If true, then create a unique index
@@ -103,6 +113,11 @@ Creates a geo index for the collection if it does not already exist.
 
 - **options**: `GeoIndexOptions`
 
+  - **name**: `String`
+
+    Specify a custom name during index creation (optional). When running AQL queries you might then refer
+    to these name as your preferred index for lookups (e.g. Index Hints).
+
   - **geoJson**: `Boolean`
 
     If a geo-spatial index on a location is constructed and geoJson is true,
@@ -141,6 +156,11 @@ Creates a fulltext index for the collection if it does not already exist.
 
 - **options**: `FulltextIndexOptions`
 
+  - **name**: `String`
+
+    Specify a custom name during index creation (optional). When running AQL queries you might then refer
+    to these name as your preferred index for lookups (e.g. Index Hints).
+
   - **minLength**: `Integer`
 
     Minimum character length of words to index. Will default to a server-defined
@@ -179,6 +199,11 @@ Creates a persistent index for the collection if it does not already exist.
 
 - **options**: `PersistentIndexOptions`
 
+  - **name**: `String`
+
+    Specify a custom name during index creation (optional). When running AQL queries you might then refer
+    to these name as your preferred index for lookups (e.g. Index Hints).
+
   - **unique**: `Boolean`
 
     If true, then create a unique index
@@ -203,6 +228,49 @@ IndexEntity index = collection.ensurePersistentIndex(Arrays.asList("a", "b.c"));
 // the index has been created with the handle `index.getId()`
 ```
 
+## ArangoCollection.ensureTtlIndex
+
+`ArangoCollection.ensureTtlIndex(Iterable<String> fields, TtlIndexOptions options) : IndexEntity`
+
+Creates a ttl index for the collection if it does not already exist.
+
+**Arguments**
+
+- **fields**: `Iterable<String>`
+
+  A list of attribute paths
+
+- **options**: `PersistentIndexOptions`
+
+  - **name**: `String`
+
+    Specify a custom name during index creation (optional). When running AQL queries you might then refer
+    to these name as your preferred index for lookups (e.g. Index Hints).
+
+  - **expireAfter**: `Integer`
+
+    The time (in seconds) after a document's creation after which the documents count as "expired".
+
+  - **inBackground**: `Boolean`
+
+    Indexes created with the 'inBackground' option, will not hold an exclusive collection
+    lock for the entire index creation period (rocksdb only).
+
+**Examples**
+
+```Java
+ArangoDB arango = new ArangoDB.Builder().build();
+ArangoDatabase db = arango.db("myDB");
+ArangoCollection collection = db.collection("some-collection");
+
+final TtlIndexOptions options = new TtlIndexOptions();
+		options.name("myTtlIndex");
+		options.expireAfter(3600);
+
+IndexEntity index = collection.ensureTtlIndex(Arrays.asList("a", "b.c"), options);
+// the index has been created with the handle `index.getId()`
+```
+
 ## ArangoCollection.getIndex
 
 `ArangoCollection.getIndex(String id) : IndexEntity`
diff --git a/docs/Drivers/Java/Reference/Database/Queries.md b/docs/Drivers/Java/Reference/Database/Queries.md
@@ -151,6 +151,10 @@ a new _ArangoCursor_ instance for the result list.
     query statistics, warnings and profiling data will only be available after
     the query is finished. The default value is false.
 
+  - **streamTransactionId**: `String`
+
+    If set, the operation will be executed within the transaction
+
 - **type**: `Class<T>`
 
   The type of the result (POJO class, `VPackSlice`, `String` for JSON, or `Collection`/`List`/`Map`)
diff --git a/docs/Drivers/Java/Reference/Database/StreamTransactions.md b/docs/Drivers/Java/Reference/Database/StreamTransactions.md
@@ -0,0 +1,81 @@
+# Transactions
+
+See [HTTP Interface for Stream Transactions](https://docs.arangodb.com/latest/HTTP/transaction-stream-transaction.html).
+
+
+## ArangoDatabase.beginStreamTransaction
+
+`ArangoDatabase.beginStreamTransaction(StreamTransactionOptions options) : StreamTransactionEntity`
+
+Begins a server-side transaction and returns information about it.
+
+**Arguments**
+
+- **options**: `StreamTransactionOptions`
+
+  transaction options
+
+
+## ArangoDatabase.getStreamTransaction
+
+`ArangoDatabase.getStreamTransaction(String id) : StreamTransactionEntity`
+
+Gets information about a Stream Transaction.
+
+**Arguments**
+
+- **id**: `String`
+
+  transaction id
+
+
+## ArangoDatabase.commitStreamTransaction
+
+`ArangoDatabase.commitStreamTransaction(String id) : StreamTransactionEntity`
+
+Commits a Stream Transaction.
+
+**Arguments**
+
+- **id**: `String`
+
+  transaction id
+
+
+## ArangoDatabase.abortStreamTransaction
+
+`ArangoDatabase.abortStreamTransaction(String id) : StreamTransactionEntity`
+
+Aborts a Stream Transaction.
+
+**Arguments**
+
+- **id**: `String`
+
+  transaction id
+
+
+## Examples
+
+```Java
+ArangoDB arango = new ArangoDB.Builder().build();
+ArangoDatabase db = arango.db("myDB");
+
+StreamTransactionEntity tx1 = db.beginStreamTransaction(
+    new StreamTransactionOptions().readCollections("collection").writeCollections("collection"));
+db.collection("collection")
+    .insertDocument(new BaseDocument(), new DocumentCreateOptions().streamTransactionId(tx1.getId()));
+db.commitStreamTransaction(tx1.getId());
+StreamTransactionEntity tx = db.getStreamTransaction(tx1.getId());
+assertThat(tx.getStatus(), is(StreamTransactionEntity.StreamTransactionStatus.committed));
+
+StreamTransactionEntity tx2 = db.beginStreamTransaction(
+    new StreamTransactionOptions().readCollections("collection").writeCollections("collection"));
+final Map<String, Object> bindVars = new HashMap<>();
+bindVars.put("@collection", COLLECTION_NAME);
+bindVars.put("key", "myKey");
+ArangoCursor<BaseDocument> cursor = db
+        .query("FOR doc IN @@collection FILTER doc._key == @key RETURN doc", bindVars,
+                new AqlQueryOptions().streamTransactionId(tx2.getId()), BaseDocument.class);
+db.abortStreamTransaction(tx2.getId());
+```
diff --git a/docs/Drivers/Java/Reference/Graph/README.md b/docs/Drivers/Java/Reference/Graph/README.md
@@ -43,6 +43,17 @@ name of the graph and a definition of its edges.
     automatically and one of the servers holding copies take over, usually
     without an error being reported.
 
+  - **minReplicationFactor**: `Integer`
+
+    (optional, default is 1): in a cluster, this
+    attribute determines how many copies of each shard are required
+    to be in sync on the different DBServers. If we have less then these
+    many copies in the cluster a shard will refuse to write. The
+    minReplicationFactor can not be larger than replicationFactor.
+    Please note: during server failures this might lead to writes
+    not being possible until the failover is sorted out and might cause
+    write slow downs in trade of data durability.
+
   - **numberOfShards**: `Integer`
 
     The number of shards that is used for every collection within this graph.
diff --git a/docs/Drivers/Java/Reference/View/ArangoSearch.md b/docs/Drivers/Java/Reference/View/ArangoSearch.md
@@ -18,6 +18,24 @@ view information from the server.
 
 - **options**: `ArangoSearchCreateOptions`
 
+  - **commitIntervalMsec**: `Long`
+
+    Wait at least this many milliseconds between committing view data store changes
+    and making documents visible to queries (default: 1000, to disable use: 0). For
+    the case where there are a lot of inserts/updates, a lower value, until commit,
+    will cause the index not to account for them and memory usage would continue to
+    grow. For the case where there are a few inserts/updates, a higher value will
+    impact performance and waste disk space for each commit call without any added
+    benefits. Background: For data retrieval ArangoSearch views follow the concept
+    of "eventually-consistent", i.e. eventually all the data in ArangoDB will be
+    matched by corresponding query expressions. The concept of ArangoSearch view
+    "commit" operation is introduced to control the upper-bound on the time until
+    document addition/removals are actually reflected by corresponding query
+    expressions. Once a "commit" operation is complete all documents added/removed
+    prior to the start of the "commit" operation will be reflected by queries
+    invoked in subsequent ArangoDB transactions, in-progress ArangoDB transactions
+    will still continue to return a repeatable-read state.
+
   - **consolidationIntervalMsec**: `Long`
 
     Wait at least this many milliseconds between committing index data changes
@@ -54,10 +72,15 @@ view information from the server.
       Apply the "consolidation" operation if and only if (default: 300):
       `{segmentThreshold} < number_of_segments`
 
-    - **link**: `CollectionLink[]`
+    - **links**: `CollectionLink[]`
 
       A list of linked collections
 
+    - **primarySorts**: `CollectionLink[]`
+
+      A list of primary sort objects. When creating an ArangoSearch View, you
+      can optionally define a default sort order.
+
 **Examples**
 
 ```Java
