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.573

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.573
File Size Uploaded
deephaven_coreplus_client-1.20240517.573.tar.gz 51.2 kB Details

Built distribution (wheel)

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

Total release size: 114.6 kB

Release files / deephaven_coreplus_client-1.20240517.573.tar.gz

Download URL deephaven_coreplus_client-1.20240517.573.tar.gz
Size 51.2 kB
Tags Source
SHA-256 checksum
How to use checksums
eeb668141ca3b8dad86f5c61a54f377ab82b04ebbe1841824f8c923d4b801223
BLAKE2b-256 checksum
How to use checksums
64ceadbdd38264e09c970dfabc8f3d12227f611b5ed48d1805cb0f5c66ba9a8f
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.573-py3-none-any.whl

Download URL deephaven_coreplus_client-1.20240517.573-py3-none-any.whl
Size 63.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
679a9c4962aab5601a9fc446c0f0ba0783e0ee6d9eb24300311c069c3f8bd1dc
BLAKE2b-256 checksum
How to use checksums
b4a053f4aaae6e4657a0c792e51ba1fa0e2b2b820eb15e1aef10e095f777eabe
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