Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for additional AQL/Query endpoints #352

Merged
merged 16 commits into from
Mar 24, 2022
Merged

Support for additional AQL/Query endpoints #352

merged 16 commits into from
Mar 24, 2022

Conversation

tjoubert
Copy link
Contributor

@tjoubert tjoubert commented Mar 5, 2022

Added support for the following endpoints:
POST: /_api/explain: Explain an AQL query
POST: /_api/query: Parse an AQL query
DELETE: /_api/query/slow: Clears the list of slow AQL queries
GET: /_api/query/slow: Returns the list of slow AQL queries
DELETE: /_api/query/{query-id}: Kills a running AQL query
DELETE: /_api/query-cache: Clears any results in the AQL query cache
GET: /_api/query-cache/entries: Returns the currently cached query results
GET: /_api/query-cache/properties: Returns the global properties for the AQL query cache
PUT: /_api/query-cache/properties: Globally adjusts the AQL query result cache properties
GET: /_api/query/current: Returns the currently running AQL queries
GET: /_api/query/properties: Returns the properties for the AQL query tracking
PUT: /_api/query/properties: Changes the properties for the AQL query tracking

POST: /_api/query: Parse an AQL query
DELETE: /_api/query/slow: Clears the list of slow AQL queries
GET: /_api/query/slow: Returns the list of slow AQL queries
DELETE: /_api/query/{query-id}: Kills a running AQL query
@tjoubert tjoubert changed the title Support for 5 additional endpoints Support for 5 additional AQL/Query endpoints Mar 5, 2022
@Zyqsempai
Copy link
Contributor

@rossmills99 @DiscoPYF PTAL

Copy link
Contributor

@Zyqsempai Zyqsempai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tjoubert
Copy link
Contributor Author

tjoubert commented Mar 7, 2022

@tjoubert Could you please update https://github.com/Actify-Inc/arangodb-net-standard/blob/master/project/roadmap.md correspondingly to previous and this PR's

@Zyqsempai, I've updated the roadmap doc. Thanks.

@DiscoPYF
Copy link
Collaborator

DiscoPYF commented Mar 7, 2022

Thank you for keeping the contributions going. I should be able to take a look later this week.

DELETE: /_api/query-cache: Clears any results in the AQL query cache
GET: /_api/query-cache/entries: Returns the currently cached query results
GET: /_api/query-cache/properties: Returns the global properties for the AQL query cache
PUT: /_api/query-cache/properties: Globally adjusts the AQL query result cache properties
@tjoubert tjoubert changed the title Support for 5 additional AQL/Query endpoints Support for additional AQL/Query endpoints Mar 11, 2022
Copy link
Collaborator

@DiscoPYF DiscoPYF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tjoubert Thank you for another great set of changes 🥳

I have left a bunch of minor comments. Let me know what you think.

AqlFunctionApiClient was originally for the AQL User Functions Management API but the name "AqlFunction" is generic enough that it makes sense to add other AQL queries endpoints. Ideally we could rename the class to AqlQueriesApiClient but that would be a breaking change for people using this class.

Another thing I noted: I think it would be clearer to keep a List<T> as return type for the endpoints instead of inheriting from List<T> with a response class, so that callers can clearly identify that the return type is a collection.

@DiscoPYF DiscoPYF merged commit 7b8c05f into ArangoDB-Community:master Mar 24, 2022
@tjoubert tjoubert deleted the feature-3.8/DE-171-support-for-additional-aql-api-endpoints branch May 24, 2022 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants