Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

3.3: Doc Update - simple-by-example - Add warning (#8536)

This commit is contained in:
Simran 2019-03-22 19:49:42 +01:00 committed by GitHub
parent dd912dcaec
commit caf859c011
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md
View File

@ -1,9 +1,16 @@
@startDocuBlock JSA_put_api_simple_by_example
@brief returns all documents of a collection matching a given example
@RESTHEADER{PUT /_api/simple/by-example, Simple query by-example}
@HINTS
{% hint 'warning' %}
Till ArangoDB versions 3.2.13 and 3.3.7 this API is quite expensive.
A more lightweight alternative is to use the [HTTP Cursor API](../AqlQueryCursor/README.md).
Starting from versions 3.2.14 and 3.3.8 this performance impact is not
an issue anymore, as the internal implementation of the API has changed.
{% endhint %}
@RESTBODYPARAM{collection,string,required,string}
The name of the collection to query.
@ -27,7 +34,7 @@ not set, a server-controlled default value will be used. A *batchSize* value of
This will find all documents matching a given example.
Returns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.
Returns a cursor containing the result, see [HTTP Cursor](../AqlQueryCursor/README.md) for details.
@RESTRETURNCODES

9
Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md
View File

@ -1,9 +1,16 @@
@startDocuBlock JSA_put_api_simple_first_example
@brief returns one document of a collection matching a given example
@RESTHEADER{PUT /_api/simple/first-example, Find documents matching an example}
@HINTS
{% hint 'warning' %}
Till ArangoDB versions 3.2.13 and 3.3.7 this API is quite expensive.
A more lightweight alternative is to use the [HTTP Cursor API](../AqlQueryCursor/README.md).
Starting from versions 3.2.14 and 3.3.8 this performance impact is not
an issue anymore, as the internal implementation of the API has changed.
{% endhint %}
@RESTBODYPARAM{collection,string,required,string}
The name of the collection to query.