deephaven_enterprise.input_tables

class ColumnSpec(name, data_type, is_key, enum_values=None)[source]

Bases: object

Representation of input table column specification.

data_type()[source]

Gets the DType of the column.

Return type:

DType

Returns:

the DType of the column

enum_values()[source]

Gets the enum values for the column.

Return type:

list[Any]

Returns:

the enum values for the column

is_key()[source]

Gets whether the column is a keyed column.

Return type:

bool

Returns:

whether the column is a keyed column

name()[source]

Gets the name of the column.

Return type:

str

Returns:

the name of the column

class InputTableSpec(column_specs)[source]

Bases: object

Representation of input table specification.

Creates an InputTableSpec with the provided ColumnSpecs.

Parameters:

column_specs (list[ColumnSpec]) – the column specs to create the InputTableSpec

add_column_specs(column_specs)[source]

Returns an InputTableSpec that is equal to this one, except with the specified additional ColumnSpecs.

Parameters:

column_specs (list[ColumnSpec]) – specified ColumnSpecs to add to the InputTableSpec

Return type:

InputTableSpec

Returns:

an InputTableSpec that is equal to this one, except with the specified additional ColumnSpecs

column_specs()[source]

Gets the ColumnSpecs for this input table.

Return type:

dict[str, ColumnSpec]

Returns:

the ColumnSpecs for this input table

static get_column_specs_from_j_input_table_spec(j_input_table_spec)[source]

Extracts Java column specs from Java input table specs and returns them as Python ColumnSpecs.

Parameters:

j_input_table_spec (JType) – Java input table spec to extract column specs from

Return type:

dict[str, ColumnSpec]

Returns:

Python ColumnSpecs from the Java input table spec

remove_column_specs(column_names)[source]

Returns an InputTableSpec that is equal to this one, except without the specified columns.

Parameters:

column_names (list[str]) – specified columns to exclude from the returned InputTableSpec

Return type:

InputTableSpec

Returns:

an InputTableSpec that is equal to this one, except without the specified columns