Rename query to gremlinExpression

Author: Cole-Greer

CHANGELOG.asciidoc

@@ -27,7 +27,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
 
 * Added Gremlator, a single page web application, that translates Gremlin into various programming languages like Javascript and Python.
 * Removed `uuid` dependency from `gremlin-javascript` in favor of the built-in `globalThis.crypto.randomUUID()`.
-* Added declarative `traversalSources` configuration to Gremlin Server YAML for creating `TraversalSource` instances with optional strategy configuration queries.
+* Added declarative `traversalSources` configuration to Gremlin Server YAML for creating `TraversalSource` instances with optional strategy configuration via `gremlinExpression`.
 * Added Java-based `lifecycleHooks` configuration to Gremlin Server YAML, replacing Groovy init script `LifeCycleHook` creation.
 * Added `TinkerFactoryDataLoader` `LifeCycleHook` implementation for loading sample datasets without Groovy.
 * Added auto-creation of `TraversalSource` bindings from `graphs` configuration (`graph` maps to `g`, others to `g_<name>`).

docs/src/reference/gremlin-applications.asciidoc

@@ -499,22 +499,22 @@ graphs: {
 ==== Declarative TraversalSources
 
 For more control, the `traversalSources` YAML section allows explicit `TraversalSource` creation with optional
-strategy configuration via a Gremlin query:
+strategy configuration via a Gremlin expression:
 
 [source,yaml]
 ----
 traversalSources: {
   g: {graph: graph},
-  gReadOnly: {graph: graph, query: "g.withStrategies(ReadOnlyStrategy)", language: "gremlin-lang"}}
+  gReadOnly: {graph: graph, gremlinExpression: "g.withStrategies(ReadOnlyStrategy)", language: "gremlin-lang"}}
 ----
 
 Each entry supports:
 
 * `graph` (required) — references a key in the `graphs` section
-* `query` (optional) — a Gremlin expression evaluated with a base traversal source bound as `g`; the result becomes
-  the final `TraversalSource`
-* `language` (optional) — which script engine to use for query evaluation; defaults to `gremlin-lang`, or the sole
-  configured engine if only one is present
+* `gremlinExpression` (optional) — a Gremlin expression evaluated with a base traversal source bound as `g`; the
+  result becomes the final `TraversalSource`
+* `language` (optional) — which script engine to use for expression evaluation; defaults to `gremlin-lang`, or the
+  sole configured engine if only one is present
 
 Graphs with explicit `traversalSources` entries are excluded from auto-creation.
 

docs/src/upgrade/release-4.x.x.asciidoc

@@ -80,14 +80,14 @@ A new `traversalSources` YAML section allows explicit `TraversalSource` creation
 ----
 traversalSources: {
   g: {graph: graph},
-  gReadOnly: {graph: graph, query: "g.withStrategies(ReadOnlyStrategy)", language: "gremlin-lang"}}
+  gReadOnly: {graph: graph, gremlinExpression: "g.withStrategies(ReadOnlyStrategy)", language: "gremlin-lang"}}
 ----
 
 Each entry specifies:
 
 - `graph` (required) — references a key in the `graphs` section
-- `query` (optional) — a Gremlin expression evaluated with a base traversal source bound as `g`
-- `language` (optional) — which script engine to use for the query (defaults to `gremlin-lang`, or the sole
+- `gremlinExpression` (optional) — a Gremlin expression evaluated with a base traversal source bound as `g`
+- `language` (optional) — which script engine to use for the expression (defaults to `gremlin-lang`, or the sole
   configured engine if only one is present)
 
 ===== Java-Based `lifecycleHooks`

gremlin-server/conf/gremlin-server-modern-readonly.yaml

@@ -21,7 +21,7 @@ evaluationTimeout: 30000
 graphs: {
   graph: conf/tinkergraph-empty.properties}
 traversalSources: {
-  g: {graph: graph, query: "g.withStrategies(ReadOnlyStrategy)"}}
+  g: {graph: graph, gremlinExpression: "g.withStrategies(ReadOnlyStrategy)"}}
 lifecycleHooks:
   - { className: org.apache.tinkerpop.gremlin.server.util.TinkerFactoryDataLoader, config: {graph: graph, dataset: modern}}
 serializers:

gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Settings.java

@@ -424,14 +424,14 @@ public static class TraversalSourceSettings {
         public String graph;
 
         /**
-         * An optional Gremlin query evaluated with a base traversal source bound as {@code g}.
-         * The result of the query becomes the final {@link TraversalSource}.
+         * An optional Gremlin expression evaluated with a base traversal source bound as {@code g}.
+         * The result of the expression becomes the final {@link TraversalSource}.
          */
-        public String query = null;
+        public String gremlinExpression = null;
 
         /**
-         * The script engine language to use for evaluating {@link #query}. If not specified, resolution
-         * falls back to the single configured engine or {@code gremlin-lang}.
+         * The script engine language to use for evaluating {@link #gremlinExpression}. If not specified,
+         * resolution falls back to the single configured engine or {@code gremlin-lang}.
          */
         public String language = null;
     }

gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/util/ServerGremlinExecutor.java

@@ -228,19 +228,19 @@ public ServerGremlinExecutor(final Settings settings, final ExecutorService grem
 
                 graphsWithExplicitTraversalSources.add(tsSettings.graph);
 
-                if (tsSettings.query != null && !tsSettings.query.isEmpty()) {
-                    // resolve which script engine to use for the query
+                if (tsSettings.gremlinExpression != null && !tsSettings.gremlinExpression.isEmpty()) {
+                    // resolve which script engine to use for the expression
                     final String language = resolveLanguage(tsSettings.language);
                     try {
-                        // bind a base traversal source as 'g' for the query to operate on
+                        // bind a base traversal source as 'g' for the expression to operate on
                         final SimpleBindings bindings = new SimpleBindings();
                         bindings.put("g", graph.traversal());
                         final TraversalSource ts = (TraversalSource) gremlinExecutor.eval(
-                                tsSettings.query, language, bindings).join();
+                                tsSettings.gremlinExpression, language, bindings).join();
                         this.graphManager.putTraversalSource(tsName, ts);
-                        logger.info("A {} is now bound to [{}] via query", ts.getClass().getSimpleName(), tsName);
+                        logger.info("A {} is now bound to [{}] via gremlinExpression", ts.getClass().getSimpleName(), tsName);
                     } catch (Exception ex) {
-                        logger.warn(String.format("Could not create TraversalSource [%s] from query - %s",
+                        logger.warn(String.format("Could not create TraversalSource [%s] from gremlinExpression - %s",
                                     tsName, ex.getMessage()), ex);
                     }
                 } else {
@@ -306,7 +306,7 @@ private void registerMetrics(final String engineName) {
     }
 
     /**
-     * Resolves the script engine language to use for evaluating a traversal source query. If an explicit language
+     * Resolves the script engine language to use for evaluating a traversal source gremlinExpression. If an explicit language
      * is provided, it is used directly. Otherwise, if exactly one script engine is configured, that engine is used.
      * Falls back to {@code gremlin-lang}.
      */

gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinDriverIntegrateTest.java

@@ -121,7 +121,7 @@ public Settings overrideSettings(final Settings settings) {
             case "shouldAliasTraversalSourceVariables":
                 final Settings.TraversalSourceSettings readOnlyG = new Settings.TraversalSourceSettings();
                 readOnlyG.graph = "graph";
-                readOnlyG.query = "g.withStrategies(ReadOnlyStrategy)";
+                readOnlyG.gremlinExpression = "g.withStrategies(ReadOnlyStrategy)";
                 settings.traversalSources.put("g", readOnlyG);
                 final Settings.TraversalSourceSettings writableG1 = new Settings.TraversalSourceSettings();
                 writableG1.graph = "graph";

gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/SettingsTest.java

@@ -92,12 +92,12 @@ public void traversalSourcesParsedFromYaml() throws Exception {
 
         final Settings.TraversalSourceSettings gSettings = settings.traversalSources.get("g");
         assertThat(gSettings.graph, is("graph"));
-        assertThat(gSettings.query, is(nullValue()));
+        assertThat(gSettings.gremlinExpression, is(nullValue()));
         assertThat(gSettings.language, is(nullValue()));
 
         final Settings.TraversalSourceSettings roSettings = settings.traversalSources.get("gReadOnly");
         assertThat(roSettings.graph, is("graph"));
-        assertThat(roSettings.query, is("g.withStrategies(ReadOnlyStrategy)"));
+        assertThat(roSettings.gremlinExpression, is("g.withStrategies(ReadOnlyStrategy)"));
         assertThat(roSettings.language, is("gremlin-groovy"));
     }
 

gremlin-server/src/test/resources/org/apache/tinkerpop/gremlin/server/gremlin-server-with-traversal-sources.yaml

@@ -21,7 +21,7 @@ graphs: {
   graph: conf/tinkergraph-empty.properties}
 traversalSources: {
   g: {graph: graph},
-  gReadOnly: {graph: graph, query: "g.withStrategies(ReadOnlyStrategy)", language: gremlin-groovy}}
+  gReadOnly: {graph: graph, gremlinExpression: "g.withStrategies(ReadOnlyStrategy)", language: gremlin-groovy}}
 lifecycleHooks:
   - { className: org.apache.tinkerpop.gremlin.server.util.TinkerFactoryDataLoader, config: {graph: graph, dataset: modern}}
   - { className: org.apache.tinkerpop.gremlin.server.util.TinkerFactoryDataLoader, config: {graph: graph, dataset: classic}}