HTTP Interface for the AQL query cache
This section describes the API methods for controlling the AQL query cache.
Clears any results in the AQL query cache
clears the AQL query cache
DELETE /_api/query-cache
clears the query cache
Return Codes
- 200: The server will respond with HTTP 200 when the cache was cleared successfully.
- 400: The server will respond with HTTP 400 in case of a malformed request.
Returns the global properties for the AQL query cache
returns the global configuration for the AQL query cache
GET /_api/query-cache/properties
Returns the global AQL query cache configuration. The configuration is a JSON object with the following properties:
mode: the mode the AQL query cache operates in. The mode is one of the following values: off, on or demand.
maxResults: the maximum number of query results that will be stored per database-specific cache.
Return Codes
- 200: Is returned if the properties can be retrieved successfully.
- 400: The server will respond with HTTP 400 in case of a malformed request,
Globally adjusts the AQL query result cache properties
changes the configuration for the AQL query cache
PUT /_api/query-cache/properties
After the properties have been changed, the current set of properties will be returned in the HTTP response.
Note: changing the properties may invalidate all results in the cache. The global properties for AQL query cache. The properties need to be passed in the attribute properties in the body of the HTTP request. properties needs to be a JSON object with the following properties:
A JSON object with these properties is required:
- mode: the mode the AQL query cache should operate in. Possible values are off, on or demand.
- maxResults: the maximum number of query results that will be stored per database-specific cache.
Return Codes
- 200: Is returned if the properties were changed successfully.
- 400: The server will respond with HTTP 400 in case of a malformed request,