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 e67b1ffb69 Note gremlin-groovy prerequisite in Cache Management section
e67b1ffb69 is described below
commit e67b1ffb69f3caf3b0e5ec37ddbd5fbfdb564159
Author: Stephen Mallette <[email protected]>
AuthorDate: Thu Sep 10 20:12:42 2026 +0000
Note gremlin-groovy prerequisite in Cache Management section
The Cache Management section documents controls that only apply to the
gremlin-groovy ScriptEngine, which is not enabled by default. Add a note
clarifying this prerequisite and pointing to the scriptEngines Behavior
section for how to enable it, so a reader on a default configuration
understands why these controls have no effect otherwise.
Assisted-by: Kiro:claude-opus-4.8
---
docs/src/reference/gremlin-applications.asciidoc | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/src/reference/gremlin-applications.asciidoc
b/docs/src/reference/gremlin-applications.asciidoc
index d89d07f4ec..d39caf8690 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -1991,6 +1991,11 @@ to the TinkerPop dev list which outlines the full
history of this issue and rela
[[gremlin-server-cache]]
==== Cache Management
+NOTE: The cache controls described in this section apply to the
`gremlin-groovy` `ScriptEngine`, which is not enabled
+by default. If the server configuration does not already list `gremlin-groovy`
under `scriptEngines`, then these
+settings have no effect and Groovy script requests are rejected with a `400
Bad Request` response. See the
+<<server-scriptengines-behavior,scriptEngines Behavior>> Section for how to
enable it.
+
If Gremlin Server processes a large number of unique scripts, the global
function cache will grow beyond the memory
available to Gremlin Server and an `OutOfMemoryError` will loom. Script
parameterization goes a long way to solving
this problem and running out of memory should not be an issue for those cases.
If it is a problem or if there is no
