InputColumn

The InputColumn class represents a column of data that can be used as input when creating or updating tables in Deephaven. It is a flexible way to define columns with specific names and data types, supporting a wide range of data sources and types.

Note

InputColumn is often used with new_table and related table creation methods to supply data for new columns.

Syntax

InputColumn(
    name: str,
    data_type: DType,
    component_type: Optional[DType] = None,
    column_type: ColumnType = ColumnType.NORMAL,
    input_data: Optional[Any] = None,
) -> InputColumn

Parameters

Parameter	Type	Description
name	str	The name of the new column.
data_type	DType	The column data type.
component_type optional	Optional[DType]	The column component type. The default is `None`.
column_type optional	ColumnType	The column type: `ColumnType.NORMAL` or `ColumnType.PARTITIONING`. The default is `ColumnType.NORMAL`.
input_data optional	Optional[Any]	The column values, such as a list, tuple, NumPy ndarray, or pandas Series. The default is `None`, which creates an empty column.

Returns

An InputColumn object that can be used as an argument to table creation or update methods.

Examples

from deephaven.column import InputColumn
from deephaven.table_factory import new_table
from deephaven.dtypes import int32

# Create an InputColumn with integer data
ic = InputColumn(name="numbers", data_type=int32, input_data=[1, 2, 3, 4, 5])

# Use InputColumn to create a new table
result = new_table([ic])

from deephaven.column import InputColumn
from deephaven.table_factory import new_table
from deephaven.dtypes import double

# Create an InputColumn with floating-point data
ic = InputColumn(name="floats", data_type=double, input_data=[1.1, 2.2, 3.3])

# Use InputColumn to create a new table
result = new_table([ic])

InputColumn

Syntax

Parameters

Returns

Examples

See Also