1
0
Fork 0

Doc - Add missing deprecation note for traversal module (#8293)

This commit is contained in:
Simran 2019-03-01 08:30:03 +01:00 committed by GitHub
parent f7dec4eacb
commit e7cdfaa2cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 7 deletions

View File

@ -1,5 +1,10 @@
Getting started
===============
Using Traversal Objects
=======================
{% hint 'warning' %}
The JavaScript module `@arangodb/graph/traversal` (*traversal module* for short)
is deprecated from version 3.4.0 on. The preferred way to traverse graphs is with AQL.
{% endhint %}
To use a traversal object, we first need to require the *traversal* module:

View File

@ -738,19 +738,17 @@ This change will be visible only on systems which allow assigning names to
threads.
Deprecated features
===================
The following features and APIs are deprecated in ArangoDB 3.4, and will be
removed in future versions of ArangoDB:
* the JavaScript-based traversal REST API at `/_api/traversal`:
* the JavaScript-based traversal REST API at `/_api/traversal` and the
underlaying traversal module `@arangodb/graph/traversal`:
This API has several limitations (including low result set sizes) and has
effectively been unmaintained since the introduction of AQL's general
*TRAVERSAL* clause.
effectively been unmaintained since the introduction of native AQL traversal.
It is recommended to migrate client applications that use the REST API at
`/_api/traversal` to use AQL-based traversal queries instead.