Feature/add mis endpoints in query #696

bluepal-prasanthi-moparthi · 2025-08-06T07:37:22Z

This includes the following Query-related endpoints:

GET - _db/{database-name}/_api/query/properties
PUT - _db/{database-name}/_api/query/properties
GET - _db/{database-name}/_api/query/current
GET - _db/{database-name}/_api/query/slow
DELETE - _db/{database-name}/_api/query/slow
DELETE - _db/{database-name}/_api/query/{query-id}
GET - _db/{database-name}/_api/query/rules
GET - _db/{database-name}/_api/query-plan-cache
DELETE - _db/{database-name}/_api/query-plan-cache
GET - _db/{database-name}/_api/query-cache/entries
DELETE - _db/{database-name}/_api/query-cache
GET - _db/{database-name}/_api/query-cache/properties
PUT - _db/{database-name}/_api/query-cache/properties
POST - _db/{database-name}/_api/aqlfunction
DELETE - _db/{database-name}/_api/aqlfunction/{name}
GET - _db/{database-name}/_api/aqlfunction

… specified database

Copilot

Pull Request Overview

This PR adds 16 missing query-related endpoints to the ArangoDB Go driver v2, enabling comprehensive query management, caching, optimizer rules, and user-defined functions functionality. The implementation includes comprehensive test coverage for all new endpoints.

Adds query properties management (GET/PUT endpoints)
Implements query monitoring and control (current/slow queries, kill operations)
Adds query caching and plan caching management endpoints
Integrates user-defined function management capabilities

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
v2/utils/type.go	Adds ToJSONString utility function for debugging and logging
v2/tests/database_query_test.go	Comprehensive test suite for all 16 new query endpoints
v2/arangodb/utils.go	Adds RequiredFieldError utility for validation
v2/arangodb/database_query_impl.go	Core implementation of all query-related endpoints
v2/arangodb/database_query.go	Interface definitions and data structures for query operations
v2/CHANGELOG.md	Documents the addition of missing query endpoints

Copilot · 2025-08-07T07:16:05Z

v2/arangodb/database_query_impl.go

+		// Log the raw response for debugging (remove in production)
+		fmt.Printf("DEBUG: Raw response from %s: %s\n", endpoint, string(rawResult))


Debug logging statement should be removed from production code. Consider using a proper logging framework or removing this debug print statement.

Suggested change

// Log the raw response for debugging (remove in production)

fmt.Printf("DEBUG: Raw response from %s: %s\n", endpoint, string(rawResult))

// Raw response available in rawResult for debugging if needed

Copilot · 2025-08-07T07:16:06Z

v2/arangodb/database_query.go

+	GetAllOptimizerRules(ctx context.Context) ([]OptimizerRules, error)
+
+	// GetQueryPlanCache returns a list of cached query plans.
+	// The result is a list of QueryPlanChcheRespObject objects.


Typo in the comment on line 83: 'QueryPlanChcheRespObject' should be 'QueryPlanCacheRespObject'.

Suggested change

// The result is a list of QueryPlanChcheRespObject objects.

// The result is a list of QueryPlanCacheRespObject objects.

Copilot · 2025-08-07T07:16:06Z

v2/arangodb/database_query.go

+}
+
+type QueryCacheProperties struct {
+	// IncludesSystem indicates whether the query cache includes system collections.


Comment inconsistency: the comment says 'IncludesSystem' but the field name is 'IncludeSystem'. The comment should match the field name.

Suggested change

// IncludesSystem indicates whether the query cache includes system collections.

// IncludeSystem indicates whether the query cache includes system collections.

Copilot · 2025-08-07T07:16:06Z

v2/arangodb/database_query_impl.go

+func validateQueryPropertiesFields(options QueryProperties) error {
+	if options.Enabled == nil {
+		return RequiredFieldError("enabled")
+	}
+	if options.TrackSlowQueries == nil {
+		return RequiredFieldError("trackSlowQueries")
+	}
+	if options.TrackBindVars == nil {
+		return RequiredFieldError("trackBindVars")
+	}
+	if options.MaxSlowQueries == nil {
+		return RequiredFieldError("maxSlowQueries")
+	}
+	if options.SlowQueryThreshold == nil {
+		return RequiredFieldError("slowQueryThreshold")
+	}
+	if options.MaxQueryStringLength == nil {
+		return RequiredFieldError("maxQueryStringLength")
+	}
+	return nil
+}
+
+func (d databaseQuery) UpdateQueryProperties(ctx context.Context, options QueryProperties) (QueryProperties, error) {
+	url := d.db.url("_api", "query", "properties")
+
+	// Validate all fields are set
+	if err := validateQueryPropertiesFields(options); err != nil {
+		return QueryProperties{}, err
+	}


[nitpick] The validation function requires all fields to be non-nil, but this may be overly restrictive for partial updates. Consider allowing optional fields or having separate validation for create vs update operations.

Suggested change

func validateQueryPropertiesFields(options QueryProperties) error {

if options.Enabled == nil {

return RequiredFieldError("enabled")

}

if options.TrackSlowQueries == nil {

return RequiredFieldError("trackSlowQueries")

}

if options.TrackBindVars == nil {

return RequiredFieldError("trackBindVars")

}

if options.MaxSlowQueries == nil {

return RequiredFieldError("maxSlowQueries")

}

if options.SlowQueryThreshold == nil {

return RequiredFieldError("slowQueryThreshold")

}

if options.MaxQueryStringLength == nil {

return RequiredFieldError("maxQueryStringLength")

}

return nil

}

func (d databaseQuery) UpdateQueryProperties(ctx context.Context, options QueryProperties) (QueryProperties, error) {

url := d.db.url("_api", "query", "properties")

// Validate all fields are set

if err := validateQueryPropertiesFields(options); err != nil {

return QueryProperties{}, err

}

// Validation for all fields is no longer required; partial updates are allowed.

func (d databaseQuery) UpdateQueryProperties(ctx context.Context, options QueryProperties) (QueryProperties, error) {

url := d.db.url("_api", "query", "properties")

// Partial updates are allowed; no need to validate all fields are set

Copilot · 2025-08-07T07:16:06Z

v2/tests/database_query_test.go

+				MaxSlowQueries:       utils.NewType(*res.MaxSlowQueries + *utils.NewType(1)),
+				SlowQueryThreshold:   utils.NewType(*res.SlowQueryThreshold + *utils.NewType(0.1)),
+				MaxQueryStringLength: utils.NewType(*res.MaxQueryStringLength + *utils.NewType(100)),


[nitpick] Complex pointer arithmetic with nested NewType calls makes the code hard to read. Consider simplifying: utils.NewType(*res.MaxSlowQueries + 1).

Suggested change

MaxSlowQueries: utils.NewType(*res.MaxSlowQueries + *utils.NewType(1)),

SlowQueryThreshold: utils.NewType(*res.SlowQueryThreshold + *utils.NewType(0.1)),

MaxQueryStringLength: utils.NewType(*res.MaxQueryStringLength + *utils.NewType(100)),

MaxSlowQueries: utils.NewType(*res.MaxSlowQueries + 1),

SlowQueryThreshold: utils.NewType(*res.SlowQueryThreshold + 0.1),

MaxQueryStringLength: utils.NewType(*res.MaxQueryStringLength + 100),

Copilot · 2025-08-07T07:16:07Z

v2/tests/database_query_test.go

+
+					for cursor.HasMore() {
+						var doc map[string]interface{}
+						cursor.ReadDocument(ctx, &doc)


The error from ReadDocument is being ignored, which could mask issues during cursor iteration. The error should be handled properly.

Suggested change

cursor.ReadDocument(ctx, &doc)

err := cursor.ReadDocument(ctx, &doc)

require.NoError(t, err)

bluepal-prasanthi-moparthi requested a review from jwierzbo August 6, 2025 07:37

cla-bot bot added the cla-signed label Aug 6, 2025

bluepal-prasanthi-moparthi added 20 commits August 6, 2025 17:26

Query: Add GET and PUT /_api/query/properties endpoints in V2

86d82a7

Query: Add endpoint to fetch list of currently executing queries from…

3ae8af9

… specified database

Query: Add endpoint to get list of slow queries

37d3c27

Query: Add end point to remove the list of slow queries

4d61e50

Query: Add endpoint to kill query w.r.to queryId

b52a4e7

Query: Add endpoint to list of all optimizer rules and their properties

9a20328

Add enp point for fetch list of all auery plan cache

b96d4e0

Add end point to clear the AQL query plan cache

48b8d4d

Add end point to fetch list of all query cache entries

3766ad0

Add end point to clear the AQL query cache

42af6e7

Add end point to fetch the query cache properties

dadcab4

Add end point to set the query cache properties

cb77ca5

Add endpoint to create user-defined function

cc762da

Add endpoint to remove and get user-defined function

5d190e1

Added pointers and required validations

a7804c6

fix: call AsArangoErrorWithCode on pointer to avoid compiler

45dd241

fix: test case

254dda5

fix: added query properties in testcases

7bae31c

fix: chaged all values to false

76bf110

Removed unwanted code

f6a6c13

bluepal-prasanthi-moparthi force-pushed the feature/add_mis_endpoints_in_query branch from 02974e4 to f6a6c13 Compare August 6, 2025 11:57

Add note in CHANGELOG file

c97f4b0

jwierzbo requested a review from Copilot August 7, 2025 07:14

Copilot AI reviewed Aug 7, 2025

View reviewed changes

addressed copilot comments

cba6a80

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature/add mis endpoints in query #696

Feature/add mis endpoints in query #696

Uh oh!

bluepal-prasanthi-moparthi commented Aug 6, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 7, 2025

Uh oh!

Copilot AI Aug 7, 2025

Uh oh!

Copilot AI Aug 7, 2025

Uh oh!

Copilot AI Aug 7, 2025

Uh oh!

Copilot AI Aug 7, 2025

Uh oh!

Copilot AI Aug 7, 2025

Uh oh!

Uh oh!

		// Log the raw response for debugging (remove in production)
		fmt.Printf("DEBUG: Raw response from %s: %s\n", endpoint, string(rawResult))

	// Log the raw response for debugging (remove in production)
	fmt.Printf("DEBUG: Raw response from %s: %s\n", endpoint, string(rawResult))
	// Raw response available in rawResult for debugging if needed

	// The result is a list of QueryPlanChcheRespObject objects.
	// The result is a list of QueryPlanCacheRespObject objects.

	// IncludesSystem indicates whether the query cache includes system collections.
	// IncludeSystem indicates whether the query cache includes system collections.

	cursor.ReadDocument(ctx, &doc)
	err := cursor.ReadDocument(ctx, &doc)
	require.NoError(t, err)

Feature/add mis endpoints in query #696

Are you sure you want to change the base?

Feature/add mis endpoints in query #696

Uh oh!

Conversation

bluepal-prasanthi-moparthi commented Aug 6, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!