Added support for indexHint and forceIndexHint to UPSERT - APM-121 (#776)

Author: cpjulia

3.9/aql/operations-upsert.md

@@ -129,6 +129,35 @@ FOR i IN 1..1000
   IN users OPTIONS { exclusive: true }
 ```
 
+### `indexHint`
+
+The `indexHint` option will be used as a hint for the document lookup
+performed as part of the `UPSERT` operation, and can help in cases such as
+`UPSERT` not picking the best index automatically.
+
+```js
+UPSERT { a: 1234 }
+  INSERT { a: 1234, name: "AB" }
+  UPDATE { name: "ABC" } IN myCollection
+  OPTIONS { indexHint: "index_name" }
+```
+
+The index hint is passed through to an internal `FOR` loop that is used for the
+lookup. Also see [`indexHint` Option of the `FOR` Operation](operations-for.html#indexhint).
+
+### `forceIndexHint`
+
+Makes the index or indices specified in `indexHint` mandatory if enabled. The
+default is `false`. Also see
+[`forceIndexHint` Option of the `FOR` Operation](operations-for.html#forceindexhint).
+
+```js
+UPSERT { a: 1234 }
+  INSERT { a: 1234, name: "AB" }
+  UPDATE { name: "ABC" } IN myCollection
+  OPTIONS { indexHint: … , forceIndexHint: true }
+```
+
 Returning documents
 -------------------
 

3.9/release-notes-new-features39.md

@@ -97,6 +97,22 @@ and later used as a condition for `FILTER`.
 
 See [Pruning](aql/graphs-traversals.html#pruning)
 
+### Upsert with Index Hint
+
+Added support for the `indexHint` and `forceIndexHint` options to the `UPSERT`
+operation. It will be used as a hint for the document lookup that is performed
+as part of the `UPSERT` operation, and can help in cases such as `UPSERT` not
+picking the best index automatically.
+
+```js
+UPSERT { a: 1234 }
+  INSERT { a: 1234, name: "AB"}
+  UPDATE {name: "ABC"} IN myCollection
+  OPTIONS { indexHint: "index_name", forceIndexHint: true }
+```
+
+See [`UPSERT` Options](aql/operations-upsert.html#indexhint)
+
 ### Decay Functions
 
 Added three decay functions to AQL: