Incompatible changes in ArangoDB 3.2
It is recommended to check the following list of incompatible changes before upgrading to ArangoDB 3.2, and adjust any client programs if necessary.
AQL breaking change in cluster: The SHORTEST_PATH statement using edge-collection names instead of a graph name now requires to explicitly name the vertex-collection names within the AQL query in the cluster. It can be done by adding
WITH <name>at the beginning of the query.
FOR v,e IN OUTBOUND SHORTEST_PATH @start TO @target edges [...]
Now has to be:
WITH vertices FOR v,e IN OUTBOUND SHORTEST_PATH @start TO @target edges [...]
This change is due to avoid dead-lock sitations in clustered case. An error stating the above is included.
Removed undocumented internal HTTP API:
- PUT /_api/edges
The documented GET /_api/edges and the undocumented POST /_api/edges remains unmodified.
change undocumented behaviour in case of invalid revision ids in
If-None-Matchheaders from returning HTTP status code 400 (bad request) to returning HTTP status code 412 (precondition failed).
the REST API for fetching the list of currently running AQL queries and the REST API for fetching the list of slow AQL queries now return an extra bindVars attribute which contains the bind parameters used by the queries.
This affects the return values of the following API endpoints:
- GET /_api/query/current
- GET /_api/query/slow
The REST API for retrieving indexes (GET /_api/index) now returns the deduplicate attribute for each index
The REST API for creating indexes (POST /_api/index) now accepts the optional deduplicate attribute
collection.getIndexes()function now returns the deduplicate attribute for each index
collection.ensureIndex()function now accepts the optional deduplicate attribute
JWT tokens issued by the built-in JWT session storage now correctly specify the
expvalues in seconds rather than milliseconds as specified in the JSON Web Token standard.
This may result in previously expired tokens using milliseconds being incorrectly accepted. For this reason it is recommended to replace the signing
secretor set the new
maxExpoption to a reasonable value that is smaller than the oldest issued expiration timestamp.
For example setting
10**12would invalidate all incorrectly issued tokens before 9 September 2001 without impairing new tokens until the year 33658 (at which point these tokens are hopefully no longer relevant).
ArangoDB running in standalone mode will commit all services in the
ArangoDB coordinators in a cluster now perform a self-healing step during startup to ensure installed services are consistent accross all coordinators. We recommend backing up your services and configuration before upgrading to ArangoDB 3.2, especially if you have made use of the development mode.
Services installed before upgrading to 3.2 (including services installed on alpha releases of ArangoDB 3.2) are NOT picked up by the coordinator self-healing watchdog. This can be solved by either upgrading/replacing these services or by using the "commit" route of the Foxx service management HTTP API, which commits the exact services installed on a given coordinator to the cluster. New services will be picked up automatically.
The format used by Foxx to store internal service metadata in the database has been simplified and existing documents will be updated to the new format. If you have made any changes to the data stored in the
_appssystem collection, you may wish to export these changes as they will be overwritten.
There is now an official HTTP API for managing services. If you were previously using any of the undocumented APIs or the routes used by the administrative web interface we highly recommend migrating to the new API. The old undocumented HTTP API for mananaging services is deprecated and will be removed in a future version of ArangoDB.
Although changes to the filesystem outside of development mode were already strongly discouraged, this is a reminder that they are no longer supported. All files generated by services (whether by a setup script or during normal operation such as uploads) should either be stored outside the service directory or be considered extremely volatile.
Introduced distinction between
authorizedin Foxx requests. Cluster internal requests will never have an
arangoUserbut are authorized. In earlier versions of ArangoDB parts of the statistics were not accessible by the coordinators because the underlying Foxx service couldn't authorize the requests. It now correctly checks the new
req.arangoUserstill works as before. Endusers may use this new property as well to easily check if a request is authorized or not regardless of a specific user.
Command-line options changed
--server.maximal-queue-size is now an absolute maximum. If the queue is full, then 503 is returned. Setting it to 0 means "no limit". The default value for this option is now
the default value for
--ssl.protocolhas been changed from
the startup options
--database.revision-cache-target-sizeare now obsolete and do nothing
the startup option
--database.index-threadsoption is now obsolete
the minimum number of V8 contexts to create at startup can be configured via the new startup option
added command-line option
/_admin/executewith an authenticated user account. The default value is
false, which disables the execution of user-defined code. This is also the recommended setting for production. In test environments, it may be convenient to turn the option on in order to send arbitrary setup or teardown commands for execution on the server.
It is no longer supported to access the
_userscollecction in any way directly, except through the official
@arangodb/usersmodule or the
The access to the
_userscollection from outside of the arangod server process is now forbidden (Through drivers, arangosh or the REST API). Foxx services are still be able to access the
_userscollection for now, but this might change in future minor releases.
The internal format of the documents in the
_userscollection has changed from previous versions
_queuescollection only allows read-only access from outside of the arangod server process.
_queuesis only supported through the official
@arangodb/queuesmodule for Foxx apps.