Show / Hide Table of Contents

Namespace Deephaven.OpenAPI.Client

Classes

AbstractOpenApiListener

This class provides a no-op implementation of the interface methods in IOpenApiListener. It is provided as a convenience to callers who only want to implement specific methods.

AbstractWorkerListener

This class provides a no-op implementation of the interface methods in IWorkerListener. It is provided as a convenience to callers who only want to implement specific methods.

Aggregate

Use an Aggregate object to specify each aggregate that comprises an AggregateCombo object. There are a variety of factory methods here; however, it is typically easier to use the convenience methods in DeephavenImports, like so:

using static Deephaven.OpenAPI.Client.DeephavenImports;
...
var t2 = t.View(close)
  .By(AggCombo(
    AggAvg(close.As("AvgClose")),
    AggSum(close.As("SumClose")),
    AggMin(close.As("MinClose")),
    AggMax(close.As("MaxClose")),
    AggCount("Count")));

AggregateCombo

This class specifies a combined aggregate operation, which allows the caller to specify multiple aggregate operations on a source table. For convenience, the caller may the AggCombo(Aggregate[]) method, with a static import. Example:

using static Deephaven.OpenAPI.Client.DeephavenImports;
...
var t2 = t.View(close)
  .By(AggCombo(
    AggAvg(close.As("AvgClose")),
    AggSum(close.As("SumClose")),
    AggMin(close.As("MinClose")),
    AggMax(close.As("MaxClose")),
    AggCount("Count")));

DatabaseCatalog

A catalog of available Deephaven database tables.

DatabaseCatalogTable

DeephavenImports

IQueryTable_FluentExtensions

IQueryTable_GetColumnExtensions

These extension methods hold all the N-ary overloads for GetColumns, and the translation from Task to blocking call.

IQueryTable_TaskColumnExtensions

These extension methods forward a "Task"-style request from an IColumn representation to an Iris string representation

IQueryTable_TaskExtensions

These extension methods turn a Task-returning method into a blocking method.

LogMessage

A log message originating from a Deephaven service.

OpenApi

A factory interface for initiating a connection to the Open API.

OpenApiClient_Extensions

OpenApiEventDispatcher

An implementation of IWorkerListener that dispatches worker updates as events instead of requiring the user to implement listener methods.

PrintUtils

QueryScope_Extensions

RowRange

An object representing a range of table rows by the first and last row index (inclusive).

RowRangeSet

An object representing a set of row ranges, each of which has a first and last row index (inclusive).

SortPair

An object representing a sort request on a column. Columns can be sorted in ascending or descending order, and by absolute value if requested.

SortPair_Extensions

WorkerEventDispatcher

An implementation of IWorkerListener that dispatches worker updates as events instead of requiring the user to implement listener methods.

WorkerOptions

An object representing the options available when starting a new worker process.

Interfaces

IOpenApiClient

An interface representing an Open API session, from which you can login, access workers and persistent queries.

IOpenApiListener

An interface that clients can use to listen for callbacks from the server.

IPersistentQueryConfig

An interface to a persistent query configuration. Persistent Queries are uniquely identified by the Serial identifier and the current status reflected by the Status property.

IPersistentQueryConfigInternal

IQueryScope

IQueryTable

ITableData

An interface to table data provided in response to a one-time request (i.e. a "snapshot" of the table).

ITableSnapshot

ITableUpdate

IWorkerListener

An interface that clients can use to listen for callbacks from the Worker.

IWorkerSession

An interface to a Deephaven worker. From a worker session, new queries can be originated by specifying a root table in a number of ways.

Enums

PersistentQueryStatus

This enumeration represents the possible states of a persistent query.

SortDirection

The possible sort directions.

Delegates

QueryTableSnapshotHandler

QueryTableUpdateHandler

Back to top Generated by DocFX