Skip to content

Commit 36ed6c2

Browse files
committed
docs: update documentation at arangodb
Signed-off-by: Otavio Santana <[email protected]>
1 parent 1198026 commit 36ed6c2

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

jnosql-arangodb/src/main/java/org/eclipse/jnosql/databases/arangodb/communication/ArangoDBDocumentManager.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import org.eclipse.jnosql.communication.document.DocumentEntity;
1818
import org.eclipse.jnosql.communication.document.DocumentManager;
1919

20+
import java.util.Collections;
2021
import java.util.Map;
2122
import java.util.stream.Stream;
2223

@@ -29,7 +30,7 @@ public interface ArangoDBDocumentManager extends DocumentManager {
2930
/**
3031
* Executes ArangoDB query language, AQL.
3132
* <p>FOR u IN users FILTER u.status == @status RETURN u </p>
32-
*
33+
* This conversion will happen at Eclipse JNoSQL side.
3334
* @param query the query
3435
* @param params the named queries
3536
* @return the query result
@@ -40,7 +41,8 @@ public interface ArangoDBDocumentManager extends DocumentManager {
4041
/**
4142
* Executes ArangoDB query language, AQL.
4243
* <p>FOR u IN users FILTER u.status == @status RETURN u </p>
43-
*
44+
* The serialization will happen at the ArangoDB side using the {@link com.arangodb.ArangoDatabase#query(String, Class)}.
45+
* This serialization will not have any converter support.
4446
* @param query the query
4547
* @param params named query
4648
* @param type The type of the result
@@ -51,7 +53,9 @@ public interface ArangoDBDocumentManager extends DocumentManager {
5153
<T> Stream<T> aql(String query, Map<String, Object> params, Class<T> type);
5254

5355
/**
54-
* Executes ArangoDB query language, AQL.
56+
* Executes ArangoDB query language, AQL and uses the {@link Collections#emptyMap()} as params.
57+
* The serialization will happen at the ArangoDB side using the {@link com.arangodb.ArangoDatabase#query(String, Class)}.
58+
* This serialization will not have any converter support.
5559
* <p>FOR u IN users FILTER u.status == @status RETURN u </p>
5660
*
5761
* @param query the query

0 commit comments

Comments
 (0)