HTTP interface for the query results cache

The query results cache HTTP API lets you control the cache for AQL query results

See The AQL query results cache for a description of the feature and the configuration options.

The AQL query results cache is only available for single servers, i.e. servers that are not part of a cluster setup.

List the entries of the AQL query results cache

GET /_db/{database-name}/_api/query-cache/entries

Returns an array containing the AQL query results currently stored in the query results cache of the selected database.

Path Parameters

database-name* string
The name of the database.

Query Parameters

HTTP Headers

Responses

200 OK
The list of cached query results.
- array of objects
  The entries of the query results cache.
  bindVars object
  The bind parameters. This attribute is omitted if the --query.tracking-with-bindvars startup option is set to false.
  dataSources* array of strings
  The collections and Views involved in the query.
  hash* string
  The hash value calculated from the the query string, certain query options, and the bind variables.
  hits* integer
  How many times the result has been served from the cache so far.
  query* string
  The query string.
  results* integer
  The number of documents/rows in the query result.
  runTime* number
  The total duration of the query in seconds.
  size* integer
  The size of the query result and bind parameters (in bytes).
  started* string
  The date and time at which the query result has been added to the cache (in ISO 8601 format).
400 Bad Request
The request is malformed.

Retrieve the entries stored in the AQL query results cache of the current database:

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/query-cache/entries'

Show output

Clear the AQL query results cache

DELETE /_db/{database-name}/_api/query-cache

Clears all results stored in the AQL query results cache for the current database.

Path Parameters

database-name* string
The name of the database.

Query Parameters

HTTP Headers

Responses

200 OK
The results cache has been cleared.
- code* integer
  The HTTP response status code.
- error* boolean
  A flag indicating that no error occurred.
400 Bad Request
The request is malformed.

Clear the AQL query results cache of the current database:

curl -X DELETE --header 'accept: application/json' --dump - 'http://localhost:8529/_api/query-cache'

Show output

Get the AQL query results cache configuration

GET /_db/{database-name}/_api/query-cache/properties

Returns the global AQL query results cache configuration.

Path Parameters

database-name* string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.

Query Parameters

HTTP Headers

Responses

200 OK
The result cache configuration is returned successfully.
- includeSystem boolean
  Whether results of queries that involve system collections are stored in the query results cache.
- maxEntrySize
  The maximum individual result size of queries that are stored per database-specific cache (in bytes).
- maxResults integer
  The maximum number of query results that are stored per database-specific cache.
- maxResultsSize integer
  The maximum cumulated size of query results that are stored per database-specific cache (in bytes).
- mode string
  The mode the AQL query results cache operates in.
  Possible values: "off", "on", "demand"
400 Bad Request
The request is malformed.

Retrieve the global configuration of the AQL query results cache:

curl --header 'accept: application/json' --dump - 'http://localhost:8529/_api/query-cache/properties'

Show output

Set the AQL query results cache configuration

PUT /_db/{database-name}/_api/query-cache/properties

Adjusts the global properties for the AQL query results cache.

Changing the properties may invalidate all results currently in the cache.

Path Parameters

database-name* string
The name of a database. Which database you use doesn’t matter as long as the user account you authenticate with has at least read access to this database.

Query Parameters

HTTP Headers

Request Body application/json object

includeSystem boolean
Whether to store results of queries that involve system collections in the cache.
maxEntrySize integer
The maximum individual size of query results that are stored per database-specific cache (in bytes).
maxResults integer
The maximum number of query results that are stored per database-specific cache.
maxResultsSize integer
The maximum cumulated size of query results that are stored per database-specific cache (in bytes).
mode string
The mode the AQL query cache shall operate in.
Possible values: "off", "on", "demand"

Responses

200 OK
The result cache configuration has been changed successfully.
- includeSystem boolean
  Whether results of queries that involve system collections are stored in the query results cache.
- maxEntrySize
  The maximum individual result size of queries that are stored per database-specific cache (in bytes).
- maxResults integer
  The maximum number of query results that are stored per database-specific cache.
- maxResultsSize integer
  The maximum cumulated size of query results that are stored per database-specific cache (in bytes).
- mode string
  The mode the AQL query results cache operates in.
  Possible values: "off", "on", "demand"
400 Bad Request
The request is malformed.

Change some properties of the global configuration of the AQL query results cache:

curl -X PUT --header 'accept: application/json' --data-binary @- --dump - 'http://localhost:8529/_api/query-cache/properties' <<'EOF'
{
  "mode": "demand",
  "maxResults": 32
}
EOF

Show output