This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
The following commit(s) were added to refs/heads/master by this push:
new e8d94cd804 Document how clients select a named traversal source
e8d94cd804 is described below
commit e8d94cd8046e1ed863923bea8cb3a4b59371d204
Author: Stephen Mallette <[email protected]>
AuthorDate: Thu Jul 23 15:41:45 2026 +0000
Document how clients select a named traversal source
Explain that a client routes a query to a named TraversalSource (such as
gReadOnly) through the request-level g alias rather than by naming the
source
in the query itself, since a gremlin-lang traversal must begin with g. Also
note that a graphs-only server configuration is valid because the remaining
settings fall back to sensible defaults.
Assisted-by: Kiro:claude-opus-4.8
---
docs/src/reference/gremlin-applications.asciidoc | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/src/reference/gremlin-applications.asciidoc
b/docs/src/reference/gremlin-applications.asciidoc
index 65dfac297a..aefd18fac5 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -519,6 +519,17 @@ Each entry supports:
Graphs with explicit `traversalSources` entries are excluded from
auto-creation.
+NOTE: A client does not write a query directly against these names — for
example, `gReadOnly.V()` will not
+work, because a `gremlin-lang` traversal must begin with `g`. Instead, a
client chooses which named
+`TraversalSource` to run against through the request-level `g` alias and still
writes the traversal as
+`g.V()...`. The drivers expose this alias as the traversal source argument
supplied when creating a remote
+connection (see <<connecting-via-drivers>>): supplying `gReadOnly` in place of
`g` routes the request to the
+read-only source declared above, while the query itself remains unchanged.
+
+TIP: A server configuration that declares only `graphs` (with or without
explicit `traversalSources`) is
+valid on its own. The remaining server settings — such as host, port, thread
pools, and serializers — fall
+back to sensible defaults when they are omitted.
+
[[server-lifecycle-hooks]]
==== LifeCycleHooks
