ArangoDB API changes for Version 3.0

Overview

Breaking changes to existing API:

Cap-constraints are withdrawn
first() and last() are withdrawn

.first() and .last() are withdrawn
Automatic creation of collections with first use
Pre Version 1.4 API compatibility withdrawn
Query-parameters "policy" and "rev" withdrawn in replace()/update()
/_api/edge withdrawn use /_api/document instead Attributes _from and _to for edges must be passed inside the document body and not as URL parameters from and to
.BY_EXAMPLE_HASH , .BY_EXAMPLE_SKIPLIST, .BY_CONDITION_SKIPLIST deleted. SimpleQuery.byCondition withdrawn.
arangodump arguments translateIDs, failOnUnknown withdrawn.
.exists now throws an error if there is a revision conflict
replacing an edge in an edge collection now requires the specification of both the _from and _to attributes. In 2.8 it was not required to specify _from and _to when replacing an edge.
/_api/collection/figures will not return the following result attributes:
- shapefiles.count
- shapes.fileSize
- shapes.count
- shapes.size
- attributes.count
- attributes.size
the checksum attribute returned by GET /_api/collection//figures now is returned as a string value. It was returned as a number value in previous versions. Additionally the checksum calculation algorithm was changed in 3.0, so 3.0 will create different checksums than previous versions for the same data.
the HTTP API for modifying documents (/_api/document) does not return the error attribute with a value of false in case an operation succeeds.
calling either collection.edges(), collection.outEdges(), collection.inEdges() with an array of edge ids will now make the edge ids unique before returning the connected edges. This is probably desired anyway, as results will be returned only once per distinct input edge id. However, it may break client applications that rely on the old behavior.

New capabilities:

Babies for document queries.
_from and _to in edges can be changed.
_key, _from, _to can be indexed like normal attributes.

Explanations

Breaking changes

Cap-constraints are withdrawn

For 3.1 we plan to implement full MVCC and then at the latest it is no longer well-defined what a cap constraint means. Furthermore, in cluster mode it is really hard to implement as defined.
.first() and .last() are withdrawn

Harmonization between single server and cluster. Cluster implementation would be very difficult and inefficient. Even the single server implementation simplifies without this (one doubly linked list less) and saves memory.
Automatic creation of collections with first use

Never worked in cluster, harmonization between single server and cluster, In cluster would be undefined, since number of shards, shard keys, replication factor and replication quorum would not be specified.
Pre Version 1.4 API compatibility withdrawn
Query-parameters "policy" and "rev" withdrawn in PUT /_api/document/

"policy" was non-sensical (just do not specify "rev")
/_api/edge withdrawn

Works now all over /_api/document This is much cleaner and one can use the new baby-capabilities for edges. Less code, drivers can be adjusted relatively easily by switching to /_api/document.
.BY_EXAMPLE_HASH , .BY_EXAMPLE_SKIPLIST, .BY_CONDITION_SKIPLIST deleted

These were never documented.

.{byExample,byExampleHash,byExampleSkiplist,byConditionSkiplist} are still there and now do AQL internally. byExampleHash and byExampleSkiplist just call byExample.

SimpleQuery.byCondition withdrawn.
arangodump arguments translateIDs, failOnUnknown withdrawn.
.exists now throws an error if there is a revision conflict

With the old behaviour (return false) one cannot distinguish whether a document does not exist at all or whether the queries revision is outdated.

New capabilities:

Babies for document queries.

Higher performance, necessary for synchronous replication, good for clean API abstraction for transactions.
_from and _to in edges can be changed.

Comes with the VelocyPack change.
_key, _from, _to can be indexed like normal attributes.

Comes with the VelocyPack change.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!