Skip to main content

Deephaven Core+ Python Client

The Deephaven Core+ Python client allows you to connect to Persistent Queries using the Core+ engine in the Deephaven Enterprise system. You may connect to either a new temporary Persistent Query, or one of the existing persistent queries that you have access to on the server.

The Python client wheel is located on a Deephaven server in /usr/illumon/coreplus/latest/py/wheel/, with a name of the form deephaven_coreplus_client-1.20231218.039-py3-none-any.whl. To use the wheel, use pip (e.g., pip install deephaven_coreplus_client-1.20231218.039-py3-none-any.whl). pip automatically installs dependencies referenced by the wheel, including the underlying pydeephaven client from Deephaven Community Core.

The first step in either case is to create a SessionManager, the Deephaven installation exposes a connection.json file that is the simplest way to create a session. Simply specify the URL from your Deephaven installation. Alternatively, you may provide a JSON string, using the json= named parameter.

from deephaven_enterprise.client.session_manager import SessionManager

connection_info = "https://deephaven-host.int.illumon.com:8000/iris/connection.json"
session_mgr: SessionManager = SessionManager(connection_info)

After the session is created, you may authenticate with a password:

session_mgr.password("username", "password")

Or using a private key:

session_mgr.private_key("/path-to-private-key/priv-username.base64.txt")

At this point, you can then connect to an existing Persistent Query. The session object extends from the Deephaven Community pydeephaven.session.Session. The Deephaven Community Python API documentation provides more information on interacting with the worker session.

session = session_mgr.connect_to_persistent_query("Community Python")
qc = session.open_table("tt")
print("Table size: ", qc.size)
session.close()

Instead of connecting to an existing Persistent Query, you can instead make a new temporary persistent query to host your worker.

session = session_mgr.connect_to_new_worker(name=None, heap_size_gb=1.0)

# We can run arbitrary script code
session.run_script('from deephaven import time_table\n'
                   'tt = time_table("PT1s").update("Remote=false")')

table = session.time_table(period=1000_000_000).update("Remote=true")
session.bind_table("remote", table)

session.close()

You can interact with the session through the Community Python API and view tables with the Deephaven Web UI. By default, the temporary queries are stopped and deleted after you close the session object.

Metadata

Release files for deephaven-coreplus-client 1.20240517.576

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for deephaven-coreplus-client 1.20240517.576
File Size Uploaded
deephaven_coreplus_client-1.20240517.576.tar.gz 51.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for deephaven-coreplus-client 1.20240517.576
File Interpreter ABI Platform
deephaven_coreplus_client-1.20240517.576-py3-none-any.whl Python 3 none any Details

Total release size: 114.6 kB

Release files / deephaven_coreplus_client-1.20240517.576.tar.gz

Download URL deephaven_coreplus_client-1.20240517.576.tar.gz
Size 51.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d609633bb774b53d8e46678cbb95655799f686f3252dd49e8a6b0849720c434b
BLAKE2b-256 checksum
How to use checksums
355960d41a8dab3565393f62f915259ee764278449347994b194494fadf5b381
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.12.12

Release files / deephaven_coreplus_client-1.20240517.576-py3-none-any.whl

Download URL deephaven_coreplus_client-1.20240517.576-py3-none-any.whl
Size 63.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
89dd25b234b6f1a16cbb8b3c7dde789506da9130161439bcd22dbff706d11c84
BLAKE2b-256 checksum
How to use checksums
77cd1b79b1f22dffb58a81e518f9acbec7f1c4288d00b4edaa87c86c227f5b02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.12.12
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page