Configure the Deephaven console service

This guide shows how to disable console code execution and autocomplete with configuration properties.

The console service is a gRPC service that executes code and returns autocompletion results. For background, see Protocol Buffers and Remote Procedure Calls. For the full service definition, see console.proto.

Configuration

Set these properties as JVM flags, such as -Ddeephaven.console.disable=true, or in a configuration file.

  • deephaven.console.disable: Set to true to disable console-based code execution. The default is false.
  • deephaven.console.autocomplete.disable: Set to true to disable autocomplete for both Groovy and Python. The default is false.

Disabling console code execution prevents API clients, including the web UI, from starting REPL sessions and from subscribing to server logs. It also stops the server from returning console types and from advertising query-scope variables to clients. Fields explicitly exported through application mode remain available. REPL sessions run with the same privileges on the host as the server process.

Python autocomplete requirements

Python autocomplete requires the Jedi package. The Deephaven server uses Jedi to complete Python code that the web UI requests.

Install the optional dependencies with the pip extra named autocomplete, which includes Jedi: pip install "deephaven-core[autocomplete]".

Without Jedi, Python autocomplete is disabled. The first time the web UI requests Python autocomplete, the server logs an error. To silence the error without installing Jedi, set -Ddeephaven.console.autocomplete.disable=true.