Persistent Query API

The Persistent Query Controller (the controller, for short) is listed as iris_controller in monit, and runs on the controller pod in Kubernetes. It is the service responsible for managing Persistent Queries. For instance, when it is time to start a scheduled Persistent Query, it is the controller that starts the PQ and monitors its state. The Query Monitor (Web) and Query Config (Java Swing) panels obtain information about Persistent Queries in the system from the controller using the PersistentQueryControllerClient for Legacy or the PersistentQueryControllerClient for Core+.

Persistent query services and objects

The PersistentQueryControllerClient provides a method (getDataCopy()) that returns a Map of persistent query serials and PersistentQueryInfo objects.

For management of persistent queries from Core+ Python workers, you can use the standard Core+ client. When executed in the context of a worker, authentication is automatic.

import io.deephaven.enterprise.dnd.ControllerClientFactory;

client = ControllerClientFactory.makeControllerClientFactory().getSubscribed();
for (PQ in client.getDataCopy().values()) {
    println (PQ.getConfig().getName());
}

Each PersistentQueryInfo object represent a PQ's current state, and includes methods to get additional details about it:

• getState() retrieves a PersistentQueryState, which provides the details about the running PQ, such as workerHost and workerPort.
• getConfig() retrieves a PersistentQueryConfiguration, which provides the details about the PQ, such as owner, worker settings, etc.

import com.illumon.iris.controller.PersistentQueryControllerClient;

client = PersistentQueryControllerClient.getControllerClient("Console Script",log, true);
for (PQ in client.getData().values()) {
    println (PQ.getConfig().getName());

Level = jpy.get_type("com.fishlib.io.log.LogLevel").INFO
Logger = jpy.get_type("com.fishlib.io.logger.NullLoggerImpl")
pqc = jpy.get_type("com.illumon.iris.controller.PersistentQueryControllerClient")

client = pqc.getControllerClient("Console Script", Logger(Level), True)
PQs = client.getData().values().toArray()
for PQ in PQs:
    print(PQ.getConfig().getName())

For Core+ workers:

import io.deephaven.enterprise.dnd.ControllerClientFactory;

client = ControllerClientFactory.makeControllerClientFactory().getSubscribed();
for (PQ in client.getDataCopy().values()) {
    println (PQ.getConfig().getName());
}

from deephaven_enterprise.client.session_manager import SessionManager

sm = SessionManager()

for serial, pq in sm.controller_client.map().items():
    print(pq.config.name)

Each PersistentQueryInfo object represent a PQ's current state, and includes methods to get additional details about it:

• getState() retrieves a PersistentQueryState, which provides the details about the running PQ, such as workerHost and workerPort.
• getConfig() retrieves a PersistentQueryConfiguration, which provides the details about the PQ, such as owner, worker settings, etc.

Appendix A - Constant values for Persistent Query configuration types and type-specific fields

com.illumon.iris.pqimport.BinaryImportPersistentQuery

com.illumon.iris.pqimport.CsvImportPersistentQuery

com.illumon.iris.pqimport.DownsampleImportPersistentQuery

com.illumon.iris.pqimport.ImportPersistentQuery

com.illumon.iris.pqimport.JdbcImportPersistentQuery

com.illumon.iris.pqimport.MergeImportPersistentQuery

com.illumon.iris.pqimport.MergePersistentQuery

com.illumon.iris.pqimport.ValidatePersistentQuery

com.illumon.iris.pqimport.XmlImportPersistentQuery

com.illumon.util.IngesterPersistentQueryConstants (also available from io.deephaven.shadow.enterprise.com.illumon.util.IngesterPersistentQueryConstants)

Appendix B - Restart users enum and constant values

io.deephaven.proto.controller.RestartUsersEnum (Core+)

com.illumon.dataobjects.generated.DefaultPersistentQueryConfiguration (Legacy)

Related documentation

• Programmatic PQ management