Skip to content

Commit adabde8

Browse files
authored
Documenting database.query options
1 parent d66ce98 commit adabde8

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -980,10 +980,13 @@ Performs a database query using the given _query_ and _bindVars_, then returns a
980980

981981
* **opts**: `Object` (optional)
982982

983-
Additional options that will be passed to the query API.
983+
Additional parameter object that will be passed to the query API.
984+
Possible keys are _count_ and _options_ (explained below)
984985

985986
If _opts.count_ is set to `true`, the cursor will have a _count_ property set to
986987
the query result count.
988+
Possible key options in _opts.options_ include: _failOnWarning_, _cache_, profile or _skipInaccessibleCollections_.
989+
For a complete list of query settings please reference the [arangodb.com documentation](https://docs.arangodb.com/3.3/AQL/Invocation/WithArangosh.html#setting-options).
987990

988991
If _query_ is an object with _query_ and _bindVars_ properties, those will be
989992
used as the values of the respective arguments instead.

0 commit comments

Comments
 (0)