@@ -47,6 +47,7 @@ Template variables are passed through the query-server2 JSON protocol, not via C
4747```
4848
4949Example contextual query pattern:
50+
5051``` ql
5152/**
5253 * @name Find References
@@ -95,18 +96,21 @@ codeql execute query-server2 --save-cache --max-disk-cache=4096
9596## Advanced configuration options
9697
9798### Memory and threading
99+
98100- ` --threads=<num> ` : Number of evaluation threads (0 = one per core)
99101- ` --timeout=<seconds> ` : Query evaluation timeout
100102- ` --heap-ram=<MB> ` : Java heap memory allocation
101103- ` --off-heap-ram=<MB> ` : Additional off-heap memory
102104
103105### Caching and performance
106+
104107- ` --save-cache ` : Aggressively cache intermediate results
105108- ` --max-disk-cache=<MB> ` : Maximum disk cache size
106109- ` --keep-full-cache ` : Don't clean up cache after evaluation
107110- ` --tuple-counting ` : Display tuple counts for performance analysis
108111
109112### Debug and logging
113+
110114- ` --debug ` : Include additional debugging information
111115- ` --evaluator-log=<file> ` : Output structured performance logs
112116- ` --evaluator-log-minify ` : Minimize JSON log size
@@ -124,12 +128,14 @@ The query-server2 uses a JSON-based protocol over stdin/stdout for communication
124128## When to use query-server2 vs query run
125129
126130** Use ` codeql execute query-server2 ` when:**
131+
127132- Building IDE integrations or tools that execute many queries
128133- Need efficient handling of contextual queries with templates
129134- Require quick evaluation of query fragments via JSON protocol
130135- Want to minimize query execution latency in IDE environments
131136
132137** Use ` codeql query run ` when:**
138+
133139- Running single queries from command line
134140- Following TDD methodology for query development
135141- Scripting or automation scenarios
@@ -157,4 +163,4 @@ Run `codeql execute query-server2 --help --verbose` for much more information.
157163
158164- [ ` codeql query run ` ] ( ./codeql_query_run.prompt.md ) - Execute single CodeQL queries (alternative for simple use cases)
159165- [ ` codeql query compile ` ] ( ./codeql_query_compile.prompt.md ) - Compile queries before execution
160- ````
166+
0 commit comments