gofr-dev · Umang01-hash · May 15, 2025 · May 15, 2025 · May 15, 2025 · May 15, 2025
diff --git a/docs/datasources/arangodb/page.md b/docs/datasources/arangodb/page.md
@@ -33,7 +33,7 @@ type ArangoDB interface {
 	GetEdges(ctx context.Context, dbName, graphName, edgeCollection, vertexID string, resp any) error
 
 	// Query executes an AQL query and binds the results
-	Query(ctx context.Context, dbName string, query string, bindVars map[string]any, result any) error
+	Query(ctx context.Context, dbName string, query string, bindVars map[string]any, result any, options ...map[string]any) error
 
    HealthCheck(context.Context) (any, error)
 }

diff --git a/pkg/gofr/container/datasources.go b/pkg/gofr/container/datasources.go
@@ -665,10 +665,12 @@ type ArangoDB interface {
 	//   - query: AQL query string to be executed.
 	//   - bindVars: Map of bind variables to be used in the query.
 	//   - result: Pointer to a slice of maps where the query results will be stored.
+	//	 - options : A flexible map[string]any to customize query behavior. Keys should be in camelCase
+	//     and correspond to fields in ArangoDB’s QueryOptions and QuerySubOptions structs.
 	//
 	// Returns an error if the database connection fails, the query execution fails, or
 	// the result parameter is not a pointer to a slice of maps.
-	Query(ctx context.Context, dbName string, query string, bindVars map[string]any, result any) error
+	Query(ctx context.Context, dbName string, query string, bindVars map[string]any, result any, options ...map[string]any) error
 
 	HealthChecker
 }

diff --git a/pkg/gofr/container/mock_datasources.go b/pkg/gofr/container/mock_datasources.go
diff --git a/pkg/gofr/datasource/arangodb/arango.go b/pkg/gofr/datasource/arangodb/arango.go
@@ -2,6 +2,7 @@ package arangodb
 
 import (
 	"context"
+	"encoding/json"
 	"errors"
 	"fmt"
 	"time"
@@ -153,18 +154,85 @@ func (c *Client) validateConfig() error {
 	return nil
 }
 
-// Query executes an AQL query and binds the results.
+// Query executes an AQL (ArangoDB Query Language) query on the specified database and stores the result.
 //
 // Parameters:
-//   - ctx: Request context for tracing and cancellation.
-//   - dbName: Name of the database where the query will be executed.
-//   - query: AQL query string to be executed.
-//   - bindVars: Map of bind variables to be used in the query.
-//   - result: Pointer to a slice of maps where the query results will be stored.
+//   - ctx: Context for request-scoped values, cancellation, and tracing.
+//   - dbName: Name of the ArangoDB database where the query will be executed.
+//   - query: The AQL query string to execute.
+//   - bindVars: Map of bind parameters used in the AQL query.
+//   - result: Pointer to a slice of maps where the query results will be unmarshaled.
+//     Must be a valid pointer to avoid runtime errors.
+//   - options: A flexible map[string]any to customize query behavior. Keys should be in camelCase
+//     and correspond to fields in ArangoDB’s QueryOptions and QuerySubOptions structs.
 //
-// Returns an error if the database connection fails, the query execution fails, or the
-// result parameter is not a pointer to a slice of maps.
-func (c *Client) Query(ctx context.Context, dbName, query string, bindVars map[string]any, result any) error {
+// Available option keys include (but are not limited to):
+//
+// QueryOptions:
+//   - count (bool): Include the total number of results in the result set.
+//   - batchSize (int): Number of results to return per batch.
+//   - cache (bool): Whether to cache the query results.
+//   - memoryLimit (int64): Maximum memory in bytes for query execution.
+//   - ttl (float64): Time-to-live for the cursor in seconds.
+//   - options (map[string]any): Nested options from QuerySubOptions.
+//
+// QuerySubOptions:
+//   - allowDirtyReads (bool)
+//   - allowRetry (bool)
+//   - failOnWarning (*bool)
+//   - fullCount (bool): Return full count ignoring LIMIT clause.
+//   - optimizer (map[string]any): Optimizer-specific directives.
+//   - maxRuntime (float64): Maximum query runtime in seconds.
+//   - stream (bool): Enable streaming cursor.
+//   - profile (uint): Enable query profiling (0-2).
+//   - skipInaccessibleCollections (*bool)
+//   - intermediateCommitCount (*int)
+//   - intermediateCommitSize (*int)
+//   - maxDNFConditionMembers (*int)
+//   - maxNodesPerCallstack (*int)
+//   - maxNumberOfPlans (*int)
+//   - maxTransactionSize (*int)
+//   - maxWarningCount (*int)
+//   - satelliteSyncWait (float64)
+//   - spillOverThresholdMemoryUsage (*int)
+//   - spillOverThresholdNumRows (*int)
+//   - maxPlans (int)
+//   - shardIds ([]string)
+//   - forceOneShardAttributeValue (*string)
+//
+// Returns an error if:
+//   - The database connection fails.
+//   - The query execution fails.
+//   - The result parameter is not a valid pointer to a slice of maps.
+//
+// Example:
+//
+//	var results []map[string]interface{}
+//
+//	query := `FOR u IN users FILTER u.age > @minAge RETURN u`
+//
+//	bindVars := map[string]interface{}{
+//	    "minAge": 21,
+//	}
+//
+//	options := map[string]any{
+//	    "count":     true,
+//	    "batchSize": 100,
+//	    "options": map[string]any{
+//	        "fullCount": true,
+//	        "profile":   2,
+//	    },
+//	}
+//
+//	err := Query(ctx, "myDatabase", query, bindVars, &results, options)
+//	if err != nil {
+//	    log.Fatalf("Query failed: %v", err)
+//	}
+//
+//	for _, doc := range results {
+//	    fmt.Printf("User: %+v\n", doc)
+//	}
+func (c *Client) Query(ctx context.Context, dbName, query string, bindVars map[string]any, result any, options ...map[string]any) error {
 	tracerCtx, span := c.addTrace(ctx, "query", map[string]string{"DB": dbName})
 	startTime := time.Now()
 
@@ -176,7 +244,17 @@ func (c *Client) Query(ctx context.Context, dbName, query string, bindVars map[s
 		return err
 	}
 
-	cursor, err := db.Query(tracerCtx, query, &arangodb.QueryOptions{BindVars: bindVars})
+	var queryOptions arangodb.QueryOptions
+
+	err = bindQueryOptions(&queryOptions, options)
+	if err != nil {
+		return err
+	}
+
+	queryOptions.BindVars = bindVars
+
+	cursor, err := db.Query(tracerCtx, query, &queryOptions)
+
 	if err != nil {
    		return err
 	}
@@ -206,6 +284,30 @@ func (c *Client) Query(ctx context.Context, dbName, query string, bindVars map[s
 	return nil
 }
 
+func bindQueryOptions(queryOptions *arangodb.QueryOptions, options []map[string]any) error {
+	if len(options) > 0 {
+		// Merge all options into a single map
+		mergedOpts := make(map[string]any)
+
+		for _, opts := range options {
+			for k, v := range opts {
+				mergedOpts[k] = v
+			}
+		}
+
+		bytes, err := json.Marshal(mergedOpts)
+		if err != nil {
+			return err
+		}
+
+		if err := json.Unmarshal(bytes, &queryOptions); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
 // addTrace adds tracing to context if tracer is configured.
 func (c *Client) addTrace(ctx context.Context, operation string, attributes map[string]string) (context.Context, trace.Span) {
 	if c.tracer != nil {

diff --git a/pkg/gofr/datasource/arangodb/arango_helper.go b/pkg/gofr/datasource/arangodb/arango_helper.go
@@ -16,14 +16,6 @@ func (c *Client) database(ctx context.Context, name string) (arangodb.Database,
 	return c.client.Database(ctx, name)
 }
 
-func (c *Client) databases(ctx context.Context) ([]arangodb.Database, error) {
-	return c.client.Databases(ctx)
-}
-
-func (c *Client) version(ctx context.Context) (arangodb.VersionInfo, error) {
-	return c.client.Version(ctx)
-}
-
 // createUser creates a new user in ArangoDB.
 func (c *Client) createUser(ctx context.Context, username string, options any) error {
 	tracerCtx, span := c.addTrace(ctx, "createUser", map[string]string{"user": username})

diff --git a/pkg/gofr/datasource/arangodb/arango_test.go b/pkg/gofr/datasource/arangodb/arango_test.go
@@ -256,3 +256,99 @@ func (*MockQueryCursor) Statistics() arangodb.CursorStats {
 func (*MockQueryCursor) Plan() arangodb.CursorPlan {
 	return arangodb.CursorPlan{}
 }
+
+func TestClient_Query_WithBatchSizeAndFullCount(t *testing.T) {
+	test := setupGraphTest(t)
+	defer test.Ctrl.Finish()
+
+	dbName := "testDB"
+	query := "FOR doc IN collection RETURN doc"
+	bindVars := map[string]any{"key": "value"}
+
+	var result []map[string]any
+
+	expectedResult := []map[string]any{
+		{"_key": "doc1", "value": "v1"},
+		{"_key": "doc2", "value": "v2"},
+	}
+
+	// Define QueryOptions with batchSize and fullCount
+	queryOpts := map[string]any{
+		"batchSize": 50,
+		"options": map[string]any{
+			"fullCount": true,
+		},
+	}
+
+	test.MockArango.EXPECT().Database(test.Ctx, dbName).Return(test.MockDB, nil)
+
+	test.MockDB.EXPECT().
+		Query(test.Ctx, query, gomock.Any()).
+		DoAndReturn(func(_ context.Context, _ string, opts *arangodb.QueryOptions) (arangodb.Cursor, error) {
+			require.NotNil(t, opts)
+			require.Equal(t, 50, opts.BatchSize)
+			require.True(t, opts.Options.FullCount)
+			require.Equal(t, bindVars, opts.BindVars)
+
+			return NewMockQueryCursor(test.Ctrl, expectedResult), nil
+		})
+
+	err := test.Client.Query(test.Ctx, dbName, query, bindVars, &result, queryOpts)
+	require.NoError(t, err)
+	require.Equal(t, expectedResult, result)
+}
+
+func TestClient_Query_WithMaxPlans(t *testing.T) {
+	test := setupGraphTest(t)
+	defer test.Ctrl.Finish()
+
+	dbName := "testDB"
+	query := "FOR doc IN collection RETURN doc"
+	bindVars := map[string]any{"key": "value"}
+
+	var result []map[string]any
+
+	expectedResult := []map[string]any{
+		{"_key": "doc1", "value": "v1"},
+	}
+
+	// Define QueryOptions with maxPlans sub-option
+	queryOpts := map[string]any{
+		"options": map[string]any{
+			"maxPlans": 5,
+		},
+	}
+
+	test.MockArango.EXPECT().Database(test.Ctx, dbName).Return(test.MockDB, nil)
+
+	test.MockDB.EXPECT().
+		Query(test.Ctx, query, gomock.Any()).
+		DoAndReturn(func(_ context.Context, _ string, opts *arangodb.QueryOptions) (arangodb.Cursor, error) {
+			require.NotNil(t, opts)
+			require.Equal(t, 5, opts.Options.MaxPlans)
+
+			return NewMockQueryCursor(test.Ctrl, expectedResult), nil
+		})
+
+	err := test.Client.Query(test.Ctx, dbName, query, bindVars, &result, queryOpts)
+	require.NoError(t, err)
+	require.Equal(t, expectedResult, result)
+}
+
+func TestClient_Query_InvalidResultType(t *testing.T) {
+	test := setupGraphTest(t)
+	defer test.Ctrl.Finish()
+
+	dbName := "testDB"
+	query := "FOR doc IN collection RETURN doc"
+	bindVars := map[string]any{"key": "value"}
+
+	var result int // Incorrect type
+
+	test.MockArango.EXPECT().Database(test.Ctx, dbName).Return(test.MockDB, nil)
+	test.MockDB.EXPECT().Query(test.Ctx, query, gomock.Any()).Return(NewMockQueryCursor(test.Ctrl, nil), nil)
+
+	err := test.Client.Query(test.Ctx, dbName, query, bindVars, &result)
+	require.Error(t, err)
+	require.Equal(t, errInvalidResultType, err)
+}