#3588 fix: gRPC query and streaming query now propagate the language parameter

robfrank · claude · robfrank · commit 9ab1d79d653c · 2026-03-07T17:25:36.000+01:00
The language parameter was ignored in query() and queryStream() paths,
causing all queries to be executed as SQL regardless of the specified language.

- Added language field to ExecuteQueryRequest proto (field 9, backward-compatible)
- Server: executeQuery() and streamQuery() modes now use the language from the request
- Client: query(), queryStream(), and streamQuery() now pass language to the proto builders
- Enabled Gremlin and Cypher e2e tests that were disabled pending this fix

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/docs/plans/2026-03-07-grpc-query-language-support-design.md b/docs/plans/2026-03-07-grpc-query-language-support-design.md
@@ -0,0 +1,54 @@
+# gRPC Query Language Support
+
+## Problem
+
+The gRPC client (`RemoteGrpcDatabase`) ignores the `language` parameter for query operations. Only `command()` correctly propagates the language. This prevents using Cypher, Gremlin, or any non-SQL language through the gRPC query and streaming query paths.
+
+The bug spans three layers:
+
+1. **Proto**: `ExecuteQueryRequest` is missing a `language` field entirely
+2. **Client**: `query()` can't pass language (proto missing it); `queryStream()` and `streamQuery()` never call `.setLanguage()` despite the proto supporting it
+3. **Server**: `executeQuery()` hardcodes `db.query("sql", ...)`; all three `streamQuery` modes (`streamCursor`, `streamMaterialized`, `streamPaged`) hardcode `db.query("sql", ...)`
+
+## Design Decisions
+
+- Add a `language` field to `ExecuteQueryRequest` (additive, backward-compatible)
+- Keep using `db.query(language, ...)` on the server for the Query RPC (caller chose read-only)
+- Default to `"sql"` when the language field is empty/unset (backward-compatible)
+
+## Changes
+
+### 1. Proto (`grpc/src/main/proto/arcadedb-server.proto`)
+
+Add `string language = 9;` to `ExecuteQueryRequest`:
+
+```protobuf
+message ExecuteQueryRequest {
+  string database = 1;
+  string query = 2;
+  map<string, GrpcValue> parameters = 3;
+  DatabaseCredentials credentials = 4;
+  TransactionContext transaction = 5;
+  int32 limit = 6;
+  int32 timeout_ms = 7;
+  ProjectionSettings projectionSettings = 8;
+  string language = 9; // "sql" if empty (default)
+}
+```
+
+### 2. Server (`grpcw/.../ArcadeDbGrpcService.java`)
+
+**`executeQuery()`**: Replace hardcoded `"sql"` with language from request, defaulting to `"sql"` when empty.
+
+**`streamQuery()`**: Extract language from `StreamQueryRequest.getLanguage()` (proto field 7, already exists), resolve default, and pass to `streamCursor`/`streamMaterialized`/`streamPaged`. Each mode method gains a `String language` parameter.
+
+### 3. Client (`grpc-client/.../RemoteGrpcDatabase.java`)
+
+- `query()` path (line 556): Add `.setLanguage(language)` to `ExecuteQueryRequest` builder
+- `queryStream()` path (line 780): Add `.setLanguage(language)` to `StreamQueryRequest` builder
+- Private `streamQuery()` (line 1767): Add `.setLanguage("sql")` since it's SQL-only by design
+
+### Testing
+
+- Existing gRPC e2e tests verify backward compatibility (SQL still works)
+- Add test that runs a query with a non-SQL language through `query()` and `queryStream()` to verify language propagation
diff --git a/docs/plans/2026-03-07-grpc-query-language-support-impl.md b/docs/plans/2026-03-07-grpc-query-language-support-impl.md
@@ -0,0 +1,34 @@
+# gRPC Query Language Support - Implementation Plan
+
+## Step 1: Proto change
+
+- File: `grpc/src/main/proto/arcadedb-server.proto`
+- Add `string language = 9;` to `ExecuteQueryRequest` (after `projectionSettings`)
+- Rebuild proto: `cd grpc && mvn clean install -DskipTests`
+
+## Step 2: Server - `executeQuery()` language support
+
+- File: `grpcw/src/main/java/com/arcadedb/server/grpc/ArcadeDbGrpcService.java`
+- In `executeQuery()` (~line 823): extract language from `request.getLanguage()`, default to `"sql"`
+- Replace `db.query("sql", ...)` with `db.query(language, ...)`
+
+## Step 3: Server - `streamQuery()` language support
+
+- File: `grpcw/src/main/java/com/arcadedb/server/grpc/ArcadeDbGrpcService.java`
+- In `streamQuery()`: extract language from `request.getLanguage()`, default to `"sql"`
+- Add `String language` parameter to `streamCursor()`, `streamMaterialized()`, `streamPaged()`
+- Replace hardcoded `"sql"` in each mode's `db.query()` call
+- Build server: `cd grpcw && mvn clean install -DskipTests`
+
+## Step 4: Client - wire language through query paths
+
+- File: `grpc-client/src/main/java/com/arcadedb/remote/grpc/RemoteGrpcDatabase.java`
+- `query()` at line 556: add `.setLanguage(language)` to `ExecuteQueryRequest` builder
+- `queryStream()` at line 780: add `.setLanguage(language)` to `StreamQueryRequest` builder
+- Private `streamQuery()` at line 1767: add `.setLanguage("sql")` to `StreamQueryRequest` builder
+- Build client: `cd grpc-client && mvn clean install -DskipTests`
+
+## Step 5: Test
+
+- Add e2e test verifying a non-SQL query (e.g. Cypher `MATCH (n) RETURN n LIMIT 1`) works via gRPC `query()`
+- Run existing gRPC e2e tests to verify no regressions
diff --git a/e2e/src/test/java/com/arcadedb/e2e/RemoteGrpcDatabaseTest.java b/e2e/src/test/java/com/arcadedb/e2e/RemoteGrpcDatabaseTest.java
@@ -24,7 +24,6 @@
 import com.arcadedb.utility.CollectionUtils;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
 import java.util.List;
@@ -57,16 +56,23 @@ void simpleSQLQuery() {
   }
 
   @Test
-  @Disabled("Gremlin not supported yet")
   void simpleGremlinQuery() {
     final ResultSet result = database.query("gremlin", "g.V().limit(10)");
     assertThat(CollectionUtils.countEntries(result)).isEqualTo(10);
   }
 
   @Test
-  @Disabled("Cypher not supported yet")
   void simpleCypherQuery() {
     final ResultSet result = database.query("cypher", "MATCH(p:Beer) RETURN * LIMIT 10");
     assertThat(CollectionUtils.countEntries(result)).isEqualTo(10);
   }
+
+  @Test
+  void simpleOpenCypherQuery() {
+    database.transaction(() -> {
+      final ResultSet result = database.query("opencypher", "MATCH(p:Beer) RETURN * LIMIT 10");
+      assertThat(CollectionUtils.countEntries(result)).isEqualTo(10);
+    }, false, 10);
+  }
+
 }
diff --git a/grpc-client/src/main/java/com/arcadedb/remote/grpc/RemoteGrpcDatabase.java b/grpc-client/src/main/java/com/arcadedb/remote/grpc/RemoteGrpcDatabase.java
@@ -553,7 +553,10 @@ public ResultSet query(final String language, final String query, RemoteGrpcConf
     checkDatabaseIsOpen();
     stats.queries.incrementAndGet();
 
-    ExecuteQueryRequest.Builder requestBuilder = ExecuteQueryRequest.newBuilder().setDatabase(getName()).setQuery(query)
+    ExecuteQueryRequest.Builder requestBuilder = ExecuteQueryRequest.newBuilder()
+        .setDatabase(getName())
+        .setQuery(query)
+        .setLanguage(language)
         .setCredentials(buildCredentials());
 
     if (transactionId != null) {
@@ -776,6 +779,7 @@ public ResultSet queryStream(final String language, final String query, final Re
     stats.queries.incrementAndGet();
 
     StreamQueryRequest.Builder b = StreamQueryRequest.newBuilder().setDatabase(getName()).setQuery(query)
+        .setLanguage(language)
         .setCredentials(buildCredentials())
         .setBatchSize(batchSize > 0 ? batchSize : 100).setRetrievalMode(mode);
 
@@ -1763,6 +1767,7 @@ private static String langOrDefault(String language) {
 
   private Iterator<Record> streamQuery(final String query) {
     StreamQueryRequest request = StreamQueryRequest.newBuilder().setDatabase(getName()).setQuery(query)
+        .setLanguage("sql")
         .setCredentials(buildCredentials())
         .setBatchSize(100).build();
 
diff --git a/grpc/src/main/proto/arcadedb-server.proto b/grpc/src/main/proto/arcadedb-server.proto
@@ -286,6 +286,7 @@ message ExecuteQueryRequest {
   int32 timeout_ms = 7;
 
   ProjectionSettings projectionSettings = 8;
+  string language = 9; // "sql" if empty (default)
 }
 
 message ExecuteQueryResponse {
diff --git a/grpcw/src/main/java/com/arcadedb/server/grpc/ArcadeDbGrpcService.java b/grpcw/src/main/java/com/arcadedb/server/grpc/ArcadeDbGrpcService.java
@@ -818,9 +818,11 @@ public void executeQuery(ExecuteQueryRequest request, StreamObserver<ExecuteQuer
       // Execute the query
       long startTime = System.currentTimeMillis();
 
-      LogManager.instance().log(this, Level.FINE, "executeQuery(): query = %s", request.getQuery());
+      final String language = (request.getLanguage() == null || request.getLanguage().isEmpty()) ? "sql" : request.getLanguage();
 
-      ResultSet resultSet = database.query("sql", request.getQuery(),
+      LogManager.instance().log(this, Level.FINE, "executeQuery(): language = %s query = %s", language, request.getQuery());
+
+      ResultSet resultSet = database.query(language, request.getQuery(),
           GrpcTypeConverter.convertParameters(request.getParametersMap()));
 
       LogManager.instance()
@@ -1105,12 +1107,14 @@ public void streamQuery(StreamQueryRequest request, StreamObserver<QueryResult>
         beganHere = true;
       }
 
+      final String language = (request.getLanguage() == null || request.getLanguage().isEmpty()) ? "sql" : request.getLanguage();
+
       // --- Dispatch on mode (helpers do NOT manage transactions) ---
       switch (request.getRetrievalMode()) {
-        case MATERIALIZE_ALL -> streamMaterialized(db, request, batchSize, scso, cancelled, projectionConfig);
-        case PAGED -> streamPaged(db, request, batchSize, scso, cancelled, projectionConfig);
-        case CURSOR -> streamCursor(db, request, batchSize, scso, cancelled, projectionConfig);
-        default -> streamCursor(db, request, batchSize, scso, cancelled, projectionConfig);
+        case MATERIALIZE_ALL -> streamMaterialized(db, request, batchSize, scso, cancelled, projectionConfig, language);
+        case PAGED -> streamPaged(db, request, batchSize, scso, cancelled, projectionConfig, language);
+        case CURSOR -> streamCursor(db, request, batchSize, scso, cancelled, projectionConfig, language);
+        default -> streamCursor(db, request, batchSize, scso, cancelled, projectionConfig, language);
       }
 
       // If the client cancelled mid-stream, choose rollback unless caller explicitly
@@ -1171,14 +1175,14 @@ public void streamQuery(StreamQueryRequest request, StreamObserver<QueryResult>
    */
   private void streamCursor(Database db, StreamQueryRequest request, int batchSize,
                             ServerCallStreamObserver<QueryResult> scso,
-                            AtomicBoolean cancelled, ProjectionConfig projectionConfig) {
+                            AtomicBoolean cancelled, ProjectionConfig projectionConfig, String language) {
 
     long running = 0L;
 
     QueryResult.Builder batch = QueryResult.newBuilder();
     int inBatch = 0;
 
-    try (ResultSet rs = db.query("sql", request.getQuery(),
+    try (ResultSet rs = db.query(language, request.getQuery(),
         GrpcTypeConverter.convertParameters(request.getParametersMap()))) {
 
       while (rs.hasNext()) {
@@ -1242,11 +1246,11 @@ private void streamCursor(Database db, StreamQueryRequest request, int batchSize
    */
   private void streamMaterialized(Database db, StreamQueryRequest request, int batchSize,
                                   ServerCallStreamObserver<QueryResult> scso,
-                                  AtomicBoolean cancelled, ProjectionConfig projectionConfig) {
+                                  AtomicBoolean cancelled, ProjectionConfig projectionConfig, String language) {
 
     final List<GrpcRecord> all = new ArrayList<>();
 
-    try (ResultSet rs = db.query("sql", request.getQuery(),
+    try (ResultSet rs = db.query(language, request.getQuery(),
         GrpcTypeConverter.convertParameters(request.getParametersMap()))) {
 
       while (rs.hasNext()) {
@@ -1295,7 +1299,7 @@ private void streamMaterialized(Database db, StreamQueryRequest request, int bat
    */
   private void streamPaged(Database db, StreamQueryRequest request, int batchSize,
                            ServerCallStreamObserver<QueryResult> scso,
-                           AtomicBoolean cancelled, ProjectionConfig projectionConfig) {
+                           AtomicBoolean cancelled, ProjectionConfig projectionConfig, String language) {
 
     final String pagedSql = wrapWithSkipLimit(request.getQuery()); // see helper below
     int offset = 0;
@@ -1313,7 +1317,7 @@ private void streamPaged(Database db, StreamQueryRequest request, int batchSize,
       int count = 0;
       QueryResult.Builder b = QueryResult.newBuilder();
 
-      try (ResultSet rs = db.query("sql", pagedSql, params)) {
+      try (ResultSet rs = db.query(language, pagedSql, params)) {
         while (rs.hasNext()) {
           if (cancelled.get())
             return;

Original file line number	Diff line number	Diff line change
`@@ -286,6 +286,7 @@ message ExecuteQueryRequest {`
`286`	`286`	`int32 timeout_ms = 7;`
`287`	`287`
`288`	`288`	`ProjectionSettings projectionSettings = 8;`
	`289`	`+ string language = 9; // "sql" if empty (default)`
`289`	`290`	`}`
`290`	`291`
`291`	`292`	`message ExecuteQueryResponse {`