AqlFunctionApiClient Class |
A client to interact with ArangoDB HTTP API endpoints
for AQL user functions management.
Inheritance HierarchySystemObject
ArangoDBNetStandardApiClientBase
ArangoDBNetStandard.AqlFunctionApiAqlFunctionApiClient
ArangoDBNetStandardApiClientBase
ArangoDBNetStandard.AqlFunctionApiAqlFunctionApiClient
Namespace: ArangoDBNetStandard.AqlFunctionApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe AqlFunctionApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AqlFunctionApiClient(IApiClientTransport) |
Create an instance of AqlFunctionApiClient
using the provided transport layer and the default JSON serialization.
|
| AqlFunctionApiClient(IApiClientTransport, IApiClientSerialization) |
Create an instance of AqlFunctionApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
| DeleteAqlFunctionAsync |
Removes an existing AQL user function or function group, identified by name.
DELETE /_api/aqlfunction/{name}
|
| DeleteClearAqlQueryCacheAsync |
Clears the query results cache for the current database
DELETE /_api/query-cache
|
| DeleteClearSlowAqlQueriesAsync |
Clears the list of slow AQL queries in the currently
selected database or in all databases.
DELETE /_api/query/slow
|
| DeleteKillRunningAqlQueryAsync |
Kills an AQL query in the currently selected database
or in all databases.
DELETE /_api/query/{query-id}
|
 | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
| GetAqlFunctionsAsync |
Get all registered AQL user functions.
|
| GetCachedAqlQueryResultsAsync |
Gets a list of the stored results in the AQL query results cache.
GET /_api/query-cache/entries
|
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetCurrentlyRunningAqlQueriesAsync |
Gets a list of currently running AQL queries.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetQueryCacheGlobalPropertiesAsync |
Gets the global configuration for the AQL query results cache.
|
| GetQueryTrackingConfigurationAsync |
Gets the current query tracking configuration.
GET /_api/query/properties
|
| GetSlowAqlQueriesAsync |
Gets a list of slow running AQL queries in the currently
selected database or in all databases.
GET /_api/query/slow
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PostAqlFunctionAsync |
Create a new AQL user function.
POST /_api/aqlfunction
|
| PostExplainAqlQueryAsync |
Explain an AQL query and return information about it
POST /_api/explain
|
| PostParseAqlQueryAsync |
Parse an AQL query and return information about it
POST /_api/query
|
| PutAdjustQueryCacheGlobalPropertiesAsync |
Changes the configuration for the AQL query results cache
PUT /_api/query-cache/properties
|
| PutChangeQueryTrackingConfigurationAsync |
Changes the configuration for the AQL query tracking.
PUT /_api/query/properties
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _apiPath |
The root path of the API.
|
| _transport |
The transport client used to communicate with the ArangoDB host.
|
See Also