Skip to content

Commit 189a56c

Browse files
committed
Update Changelog
1 parent c7ca2dd commit 189a56c

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

CHANGELOG

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,52 @@
1-
Release notes for the ArangoDB-PHP driver 3.0.x
1+
Release notes for the ArangoDB-PHP driver 3.1.0
22
===============================================
33

4-
This version of the driver is compatible with ArangoDB 3.0.x
4+
This version of the driver is compatible with ArangoDB 3.1.x
55
It is not compatible to earlier versions of ArangoDB (i.e. 2.x).
66
Please use ones of the `2.x` branches of the driver for 2.x-compatibility.
77

88

99

1010
Caution!!!
11+
==========
12+
13+
- Up until the 3.0.x Versions of this driver, there were still deprecated methods and parameter compatibility functions in the code, which unfortunately were not removed according to their deprecation annotations.
14+
That deprecated code was now finally removed with this version (3.1.0) of the driver, in order to clean up the codebase.
15+
- With this version of the driver, the method signature that used to accept an $options array or another non-array type, in it's place, has been changed and will now only accept the options as an array. The specific compatibility layer was deprecated a long time and has now been removed.
16+
17+
**Please check and change your code accordingly!**
1118

12-
There are still deprecated functions in the code, which should have been removed in the first 3.0 version of the driver, however, we missed this opportunity.
13-
These will now finally be removed with the 3.1 version of the driver, in order to clean up the codebase. Please check and change your code accordingly.
14-
All deprecated functions can now also be found in the docs inside the "Deprecated" view.
1519

1620
Changes
1721
=======
1822

23+
- Removed old deprecated methods:
24+
- AdminHandler::flushServerModuleCache()
25+
- CollectionHandler::add()
26+
- CollectionHandler::getCount()
27+
- CollectionHandler::getFigures()
28+
- CollectionHandler::delete()
29+
- DocumentHandler::getAllIds()
30+
- DocumentHandler::getByExample()
31+
- DocumentHandler::add()
32+
- DocumentHandler::delete()
33+
- DocumentHandler::deleteById()
34+
- EdgeHandler::add()
35+
- Graph::setVerticesCollection()
36+
- Graph::getVerticesCollection()
37+
- Graph::setEdgesCollection()
38+
- Graph::getEdgesCollection()
39+
- Handler::getCursorOptions()
40+
41+
- Removed the old-style compatibility layer for parameter-passing in various methods that was used prior to switching to the $options parameter.
42+
This means, that wherever an $option array is passed to methods and a non-array type was also allowed (bool, string), the $options parameter **must** now be an array - it will not accept bool values or string values like for example a policy definition, anymore.
43+
44+
- Performance might be a bit better due to the removal of the compatibility layer for $options.
45+
46+
- Cleaned up and enriched annotations
47+
48+
- Applied various smaller bug fixes
49+
1950
- GraphHandler: Optimized code to do less work when not necessary
2051
- GraphHandler: Implemented optional cache that caches the Vertex/Edge-Collections instead of making expensive calls to the DB.
2152
- GraphHandler: Is now batch-able. However, if any collections need to be fetched, they will be done out-of-batch.
@@ -26,8 +57,6 @@ Changes
2657

2758

2859

29-
Bug fixes
30-
=========
3160

3261

3362
============================================================================================================

0 commit comments

Comments
 (0)