Add changes for ArangoDB 3.4

Author: joowani

.travis.yml

@@ -8,7 +8,7 @@ python:
 services:
     - docker
 before_install:
-    - docker run --name arango -d -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd arangodb/arangodb:3.3.9
+    - docker run --name arango -d -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd arangodb/arangodb:3.4.0
     - docker cp tests/static/service.zip arango:/tmp/service.zip
 install:
     - pip install flake8 mock pytest pytest-cov python-coveralls sphinx sphinx_rtd_theme

arango/aql.py

@@ -18,6 +18,7 @@
     AQLFunctionCreateError,
     AQLFunctionDeleteError,
     AQLFunctionListError,
+    AQLCacheEntriesError,
     AQLCacheClearError,
     AQLCacheConfigureError,
     AQLCachePropertiesError
@@ -442,8 +443,8 @@ def response_handler(resp):
     def functions(self):
         """List the AQL functions defined in the database.
 
-        :return: Mapping of AQL function names to their javascript code.
-        :rtype: dict
+        :return: AQL functions.
+        :rtype: [dict]
         :raise arango.exceptions.AQLFunctionListError: If retrieval fails.
         """
         request = Request(
@@ -454,8 +455,17 @@ def functions(self):
         def response_handler(resp):
             if not resp.is_success:
                 raise AQLFunctionListError(resp, request)
+
             body = resp.body or {}
-            return {func['name']: func['code'] for func in map(dict, body)}
+
+            if 'result' not in body:  # pragma: no cover
+                return []
+
+            for item in body['result']:
+                if 'isDeterministic' in item:
+                    item['is_deterministic'] = item.pop('isDeterministic')
+
+            return body['result']
 
         return self._execute(request, response_handler)
 
@@ -466,8 +476,9 @@ def create_function(self, name, code):
         :type name: str | unicode
         :param code: Function definition in Javascript.
         :type code: str | unicode
-        :return: True if AQL function was created successfully.
-        :rtype: bool
+        :return: Whether the AQL function was newly created or an existing one
+            was replaced.
+        :rtype: dict
         :raise arango.exceptions.AQLFunctionCreateError: If create fails.
         """
         request = Request(
@@ -479,7 +490,7 @@ def create_function(self, name, code):
         def response_handler(resp):
             if not resp.is_success:
                 raise AQLFunctionCreateError(resp, request)
-            return True
+            return {'is_new': resp.body['isNewlyCreated']}
 
         return self._execute(request, response_handler)
 
@@ -495,9 +506,10 @@ def delete_function(self, name, group=False, ignore_missing=False):
         :type group: bool
         :param ignore_missing: Do not raise an exception on missing function.
         :type ignore_missing: bool
-        :return: True if AQL function was deleted successfully, False if
-            function was not found and **ignore_missing** was set to True.
-        :rtype: bool
+        :return: Number of AQL functions deleted if operation was successful,
+            False if function(s) was not found and **ignore_missing** was set
+            to True.
+        :rtype: dict | bool
         :raise arango.exceptions.AQLFunctionDeleteError: If delete fails.
         """
         request = Request(
@@ -511,7 +523,7 @@ def response_handler(resp):
                 return False
             if not resp.is_success:
                 raise AQLFunctionDeleteError(resp, request)
-            return True
+            return {'deleted': resp.body['deletedCount']}
 
         return self._execute(request, response_handler)
 
@@ -578,6 +590,25 @@ def response_handler(resp):
 
         return self._execute(request, response_handler)
 
+    def entries(self):
+        """Return the query cache entries.
+
+        :return: Query cache entries.
+        :rtype: list
+        :raise AQLCacheEntriesError: If retrieval fails.
+        """
+        request = Request(
+            method='get',
+            endpoint='/_api/query-cache/entries'
+        )
+
+        def response_handler(resp):
+            if not resp.is_success:
+                raise AQLCacheEntriesError(resp, request)
+            return resp.body
+
+        return self._execute(request, response_handler)
+
     def clear(self):
         """Clear the query cache.
 

arango/collection.py

@@ -376,10 +376,10 @@ def response_handler(resp):
                 raise CollectionStatisticsError(resp, request)
 
             stats = resp.body.get('figures', resp.body)
-            for field in ['compactors', 'datafiles', 'journals']:
-                if field in stats and 'fileSize' in stats[field]:
-                    stats[field]['file_size'] = stats[field].pop('fileSize')
-            if 'compactionStatus' in stats:
+            for f in ['compactors', 'datafiles', 'journals']:
+                if f in stats and 'fileSize' in stats[f]:  # pragma: no cover
+                    stats[f]['file_size'] = stats[f].pop('fileSize')
+            if 'compactionStatus' in stats:  # pragma: no cover
                 status = stats.pop('compactionStatus')
                 if 'bytesRead' in status:
                     status['bytes_read'] = status.pop('bytesRead')
@@ -388,15 +388,15 @@ def response_handler(resp):
                 if 'filesCombined' in status:
                     status['files_combined'] = status.pop('filesCombined')
                 stats['compaction_status'] = status
-            if 'documentReferences' in stats:
+            if 'documentReferences' in stats:  # pragma: no cover
                 stats['document_refs'] = stats.pop('documentReferences')
-            if 'lastTick' in stats:
+            if 'lastTick' in stats:  # pragma: no cover
                 stats['last_tick'] = stats.pop('lastTick')
-            if 'waitingFor' in stats:
+            if 'waitingFor' in stats:  # pragma: no cover
                 stats['waiting_for'] = stats.pop('waitingFor')
             if 'documentsSize' in stats:  # pragma: no cover
                 stats['documents_size'] = stats.pop('documentsSize')
-            if 'uncollectedLogfileEntries' in stats:
+            if 'uncollectedLogfileEntries' in stats:  # pragma: no cover
                 stats['uncollected_logfile_entries'] = \
                     stats.pop('uncollectedLogfileEntries')
             return stats
@@ -793,7 +793,7 @@ def response_handler(resp):
 
         return self._execute(request, response_handler)
 
-    def find_near(self, latitude, longitude, limit=None):
+    def find_near(self, latitude, longitude, limit=None):  # pragma: no cover
         """Return documents near a given coordinate.
 
         Documents returned are sorted according to distance, with the nearest
@@ -1219,7 +1219,7 @@ def response_handler(resp):
                     index['min_length'] = index.pop('minLength')
                 if 'geoJson' in index:
                     index['geo_json'] = index.pop('geoJson')
-                if 'ignoreNull' in index:
+                if 'ignoreNull' in index:  # pragma: no cover
                     index['ignore_none'] = index.pop('ignoreNull')
                 if 'selectivityEstimate' in index:
                     index['selectivity'] = index.pop('selectivityEstimate')
@@ -1255,7 +1255,7 @@ def response_handler(resp):
                 details['min_length'] = details.pop('minLength')
             if 'geoJson' in details:
                 details['geo_json'] = details.pop('geoJson')
-            if 'ignoreNull' in details:
+            if 'ignoreNull' in details:  # pragma: no cover
                 details['ignore_none'] = details.pop('ignoreNull')
             if 'selectivityEstimate' in details:
                 details['selectivity'] = details.pop('selectivityEstimate')
@@ -1496,7 +1496,13 @@ def response_handler(resp):
 
         return self._execute(request, response_handler)
 
-    def insert(self, document, return_new=False, sync=None, silent=False):
+    def insert(self,
+               document,
+               return_new=False,
+               sync=None,
+               silent=False,
+               overwrite=False,
+               return_old=False):
         """Insert a new document.
 
         :param document: Document to insert. If it contains the "_key" or "_id"
@@ -1511,14 +1517,25 @@ def insert(self, document, return_new=False, sync=None, silent=False):
         :param silent: If set to True, no document metadata is returned. This
             can be used to save resources.
         :type silent: bool
+        :param overwrite: If set to True, operation does not fail on duplicate
+            key and the existing document is replaced.
+        :type overwrite: bool
+        :param return_old: Include body of the old document if replaced.
+            Applies only when value of **overwrite** is set to True.
+        :type return_old: bool
         :return: Document metadata (e.g. document key, revision) or True if
             parameter **silent** was set to True.
         :rtype: bool | dict
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
         document = self._ensure_key_from_id(document)
 
-        params = {'returnNew': return_new, 'silent': silent}
+        params = {
+            'returnNew': return_new,
+            'silent': silent,
+            'overwrite': overwrite,
+            'returnOld': return_old
+        }
         if sync is not None:
             params['waitForSync'] = sync
 
@@ -1540,15 +1557,21 @@ def insert(self, document, return_new=False, sync=None, silent=False):
         def response_handler(resp):
             if not resp.is_success:
                 raise DocumentInsertError(resp, request)
-            return True if silent else resp.body
+            if silent:
+                return True
+            if '_oldRev' in resp.body:
+                resp.body['_old_rev'] = resp.body.pop('_oldRev')
+            return resp.body
 
         return self._execute(request, response_handler)
 
     def insert_many(self,
                     documents,
                     return_new=False,
                     sync=None,
-                    silent=False):
+                    silent=False,
+                    overwrite=False,
+                    return_old=False):
         """Insert multiple documents.
 
         If inserting a document fails, the exception object is placed in the
@@ -1566,14 +1589,25 @@ def insert_many(self,
         :param silent: If set to True, no document metadata is returned. This
             can be used to save resources.
         :type silent: bool
+        :param overwrite: If set to True, operation does not fail on duplicate
+            keys and the existing documents are replaced.
+        :type overwrite: bool
+        :param return_old: Include body of the old documents if replaced.
+            Applies only when value of **overwrite** is set to True.
+        :type return_old: bool
         :return: List of document metadata (e.g. document keys, revisions) and
             any exception, or True if parameter **silent** was set to True.
         :rtype: [dict | ArangoError] | bool
         :raise arango.exceptions.DocumentInsertError: If insert fails.
         """
         documents = [self._ensure_key_from_id(doc) for doc in documents]
 
-        params = {'returnNew': return_new, 'silent': silent}
+        params = {
+            'returnNew': return_new,
+            'silent': silent,
+            'overwrite': overwrite,
+            'returnOld': return_old
+        }
         if sync is not None:
             params['waitForSync'] = sync
 
@@ -1601,6 +1635,8 @@ def response_handler(resp):
             results = []
             for result in resp.body:
                 if '_id' in result:
+                    if '_oldRev' in result:
+                        result['_old_rev'] = result.pop('_oldRev')
                     results.append(result)
                 else:
                     sub_resp = Response(
@@ -1783,7 +1819,7 @@ def response_handler(resp):
                     )
                     if result['errorNum'] == 1200:
                         result = DocumentRevisionError(sub_resp, request)
-                    else:
+                    else:  # pragma: no cover
                         result = DocumentUpdateError(sub_resp, request)
                 else:
                     result['_old_rev'] = result.pop('_oldRev')
@@ -2006,7 +2042,7 @@ def response_handler(resp):
                     )
                     if result['errorNum'] == 1200:
                         result = DocumentRevisionError(sub_resp, request)
-                    else:
+                    else:  # pragma: no cover
                         result = DocumentReplaceError(sub_resp, request)
                 else:
                     result['_old_rev'] = result.pop('_oldRev')
@@ -2332,9 +2368,9 @@ def import_bulk(self,
             params['complete'] = halt_on_error
         if details is not None:
             params['details'] = details
-        if from_prefix is not None:
+        if from_prefix is not None:  # pragma: no cover
             params['fromPrefix'] = from_prefix
-        if to_prefix is not None:
+        if to_prefix is not None:  # pragma: no cover
             params['toPrefix'] = to_prefix
         if overwrite is not None:
             params['overwrite'] = overwrite
@@ -2495,7 +2531,9 @@ def update(self,
                check_rev=True,
                keep_none=True,
                sync=None,
-               silent=False):
+               silent=False,
+               return_old=False,
+               return_new=False):
         """Update a vertex document.
 
         :param vertex: Partial or full vertex document with updated values. It
@@ -2523,7 +2561,9 @@ def update(self,
         params = {
             'keepNull': keep_none,
             'overwrite': not check_rev,
-            'silent': silent
+            'silent': silent,
+            'returnNew': return_new,
+            'returnOld': return_old
         }
         if sync is not None:
             params['waitForSync'] = sync
@@ -2549,7 +2589,7 @@ def update(self,
         )
 
         def response_handler(resp):
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             elif not resp.is_success:
                 raise DocumentUpdateError(resp, request)
@@ -2611,7 +2651,7 @@ def replace(self, vertex, check_rev=True, sync=None, silent=False):
         )
 
         def response_handler(resp):
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             elif not resp.is_success:
                 raise DocumentReplaceError(resp, request)
@@ -2680,7 +2720,7 @@ def delete(self,
         def response_handler(resp):
             if resp.error_code == 1202 and ignore_missing:
                 return False
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentDeleteError(resp, request)
@@ -2759,7 +2799,7 @@ def get(self, edge, rev=None, check_rev=True):
         def response_handler(resp):
             if resp.error_code == 1202:
                 return None
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentGetError(resp, request)
@@ -2883,7 +2923,7 @@ def update(self,
         )
 
         def response_handler(resp):
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentUpdateError(resp, request)
@@ -2946,7 +2986,7 @@ def replace(self, edge, check_rev=True, sync=None, silent=False):
         )
 
         def response_handler(resp):
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentReplaceError(resp, request)
@@ -3015,7 +3055,7 @@ def delete(self,
         def response_handler(resp):
             if resp.error_code == 1202 and ignore_missing:
                 return False
-            if resp.status_code == 412:
+            if resp.status_code == 412:  # pragma: no cover
                 raise DocumentRevisionError(resp, request)
             if not resp.is_success:
                 raise DocumentDeleteError(resp, request)