deephaven.column

This module implements the Column class and functions that work with Columns.

class Column(name, data_type, component_type=None, column_type=NORMAL)[source]

Bases: object

A Column object represents a column definition in a Deephaven Table.

class ColumnType(value)[source]

Bases: Enum

An enumeration.

NORMAL = io.deephaven.engine.table.ColumnDefinition$ColumnType(objectRef=0x5607dfcf3a00)

A regular column.

PARTITIONING = io.deephaven.engine.table.ColumnDefinition$ColumnType(objectRef=0x5607dfcf3a08)

A partitioning column.

class InputColumn(name, data_type, component_type=None, column_type=NORMAL, input_data=None)[source]

Bases: Column

An InputColumn represents a user defined column with some input data.

bool_col(name, data)[source]

Creates an input column containing Boolean data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

byte_col(name, data)[source]

Creates an input column containing primitive byte data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

char_col(name, data)[source]

Creates an input column containing primitive char data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

datetime_col(name, data)[source]

Creates an input column containing Deephaven Datetime instances.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of Datetime instances or values that can be converted to Datetime instances (e.g. Instant, int nanoseconds since the Epoch, str, datetime.datetime, numpy.datetime64, pandas.Timestamp).

Return type:

InputColumn

Returns:

a new input column

double_col(name, data)[source]

Creates an input column containing primitive double data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

float_col(name, data)[source]

Creates an input column containing primitive float data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

int_col(name, data)[source]

Creates an input column containing primitive int data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

jobj_col(name, data)[source]

Creates an input column containing Java objects.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of Java objects

Return type:

InputColumn

Returns:

a new input column

long_col(name, data)[source]

Creates an input column containing primitive long data.

Parameters:

  • name (str) – the column name

  • data (Any) – a python sequence of compatible data, could be numpy array or Pandas series

Return type:

InputColumn

Returns:

a new input column

pyobj_col(name, data)[source]

Creates an input column containing complex, non-primitive-like Python objects.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of Python objects

Return type:

InputColumn

Returns:

a new input column

short_col(name, data)[source]

Creates an input column containing primitive short data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column

string_col(name, data)[source]

Creates an input column containing string data.

Parameters:

  • name (str) – the column name

  • data (Any) – a sequence of compatible data, e.g. list, tuple, numpy array, Pandas series, etc.

Return type:

InputColumn

Returns:

a new input column