deephaven.filters

This module implement various filters that can be used in deephaven table’s filter operations.

class Filter(j_filter)[source]

Bases: deephaven._wrapper.JObjectWrapper

A Filter object represents a filter that can be used in Table’s filtering(where) operations.

classmethod from_(conditions)[source]

Creates filter(s) from the given condition(s).

Parameters

conditions (Union[str, List[str]]) – filter condition(s)

Return type

Union[Filter, List[Filter]]

Returns

filter(s)

Raises

DHError

j_object_type

alias of io.deephaven.api.filter.Filter

class RegexFilter(col, pattern)[source]

Bases: deephaven.filters.Filter

The RegexFilter is a filter that matches using a regular expression.

classmethod from_(conditions)

Creates filter(s) from the given condition(s).

Parameters

conditions (Union[str, List[str]]) – filter condition(s)

Return type

Union[Filter, List[Filter]]

Returns

filter(s)

Raises

DHError

j_object_type

alias of io.deephaven.engine.table.impl.select.RegexFilter

and_(filters)[source]

Creates a new filter that evaluates to true when all of the given filters evaluates to true.

Parameters

filters (List[filter]) – the component filters

Return type

Filter

Returns

a new Filter

not_(filter_)[source]

Creates a new filter that evaluates to true when the given filter evaluates to false.

Parameters

filter (Filter) – the filter to negate with

Return type

Filter

Returns

a new Filter

or_(filters)[source]

Creates a new filter that evaluates to true when any of the given filters evaluates to true.

Parameters

filters (List[filter]) – the component filters

Return type

Filter

Returns

a new Filter