Skip to main content

impulse_query_engine.analyze.query.solvers.solver_config

Configuration for solver column mappings.

Provides Pydantic models that map silver-layer column names to the internal column names used by the solver classes, making the solvers independent of a specific data-layer naming convention.

Each input table has its own :class:TableConfig section with an optional column_name_mapping (physical column → internal name) and filters (internal column → equality value).

Solvers apply the column_name_mapping when reading a table to rename physical columns to internal names. All subsequent processing — including filter application — uses the framework-internal column names exposed as properties on :class:SolverConfig.

TableConfig​

class TableConfig(BaseModel)

Per-table configuration for column renaming and equality filters.

Arguments:

  • column_name_mapping (dict[str, str]): Mapping from physical column names on the table to internal names used by the solver. An empty dict means no renaming (physical names already match internal names).
  • filters (dict[str, str]): Equality filters applied to the table after column renaming. Keys are internal column names; values are the literal values to match.

JoinKey​

class JoinKey(BaseModel)

A single column pair in the channel_mapping → channel_metrics join.

Used by :class:ChannelMappingConfig.join_keys to override the default alias-resolution composite key.

Both fields reference column names after column_name_mapping has been applied on the respective table; the two sides are independent, so a column may appear under different names on the two tables.

Arguments:

  • mapping_col (str): Column name on channel_mapping after its column_name_mapping has been applied.
  • metrics_col (str): Column name on channel_metrics after its column_name_mapping has been applied.

ChannelMappingConfig​

class ChannelMappingConfig(TableConfig)

TableConfig plus an optional alias-resolution join-key spec.

Arguments:

  • join_keys (list[JoinKey] or None): Custom composite key for the channel_mapping → channel_metrics join performed by DefaultSolver.filter_aliased_channel_metrics. When None (the default), the solver uses the backward-compatible pair [(source_channel, channel_name), (data_key, data_key)] sourced from :class:SolverConfig internal-name properties. Provide a custom list to change the join arity or column choice (e.g. a single-column join when data_key is not part of the channel identity in your silver layout).

SolverConfig​

class SolverConfig(BaseModel)

Per-table configuration for solver column name mappings and filters.

The framework uses a fixed set of internal column names (e.g. container_id, channel_id, tstart, tend, value). When a silver-layer table uses different physical column names, the per-table column_name_mapping renames them to the internal names so that solver code can always reference the same constants.

Arguments:

  • project_id (str or None): Optional project identifier applied as a filter on relevant tables (container_tags, channel_mapping) by solvers that support it.
  • container_tags (TableConfig): Column mappings and filters for the container tags (narrow/EAV) table.
  • container_metrics (TableConfig): Column mappings and filters for the container metrics table.
  • channel_tags (TableConfig): Column mappings and filters for the channel tags table.
  • channel_metrics (TableConfig): Column mappings and filters for the channel metrics table.
  • channel_mapping (ChannelMappingConfig): Column mappings, filters, and the alias-resolution join_keys override for the channel mapping (alias) table.
  • channels (TableConfig): Column mappings and filters for the channel data table.
  • unit_conversion (TableConfig): Column mappings and filters for the unit conversion table.

from_json​

def from_json(cls, json_path: str) -> "SolverConfig"

Load a SolverConfig from a JSON file.

Arguments:

  • json_path (str): Path to the JSON configuration file.

Returns:

SolverConfig: A new SolverConfig instance populated from the file.

from_dict​

def from_dict(cls, data: dict) -> "SolverConfig"

Create a SolverConfig from a dictionary.

This is a convenience alias for model_validate(data).

Arguments:

  • data (dict): Dictionary with configuration keys.

Returns:

SolverConfig: A new SolverConfig instance populated from data.

container_id_col​

def container_id_col() -> str

Internal column name for the container identifier.

channel_id_col​

def channel_id_col() -> str

Internal column name for the channel identifier.

channel_id_cols​

def channel_id_cols() -> list[str]

Composite key [container_id, channel_id].

tstart_col​

def tstart_col() -> str

Internal column name for the start timestamp.

tend_col​

def tend_col() -> str

Internal column name for the end timestamp.

start_ts_col​

def start_ts_col() -> str

Internal column name for the measurement-start epoch timestamp on container_metrics.

stop_ts_col​

def stop_ts_col() -> str

Internal column name for the measurement-stop epoch timestamp on container_metrics.

value_col​

def value_col() -> str

Internal column name for the signal value on the channels table.

tag_key_col​

def tag_key_col() -> str

Internal column name for the attribute key on the container_tags (EAV) table.

tag_value_col​

def tag_value_col() -> str

Internal column name for the attribute value on the container_tags (EAV) table.

alias_priority_col​

def alias_priority_col() -> str

Internal column name for the alias priority on the channel_mapping table.

source_channel_col​

def source_channel_col() -> str

Internal column name for the source-channel identifier on the channel_mapping table.

data_key_col​

def data_key_col() -> str

Internal column name for the data-key identifier.

Default present on both channel_mapping and channel_metrics; used by the default :meth:effective_alias_join_keys for both sides. Layouts where the two tables carry the data-key column under different physical names can either rename both to "data_key" via per-table column_name_mapping or override

channel_alias_col​

def channel_alias_col() -> str

Internal column name for the alias identifier on the channel_mapping table.

Referenced by the dedup window in

channel_name_col​

def channel_name_col() -> str

Internal column name for the channel-name identifier on the channel_metrics table.

project_id_col​

def project_id_col() -> str

Internal column name for the project identifier.

parent_id_col​

def parent_id_col() -> str

Internal column name for the parent/scope identifier.

conversion_factor_col​

def conversion_factor_col() -> str

Internal column name for the conversion factor on the unit_conversion table.

Also used as the column that carries the per-channel combined factor downstream from :meth:DefaultSolver._compute_conversion_factors into the grouped-map UDF.

source_unit_col​

def source_unit_col() -> str

Internal column name for the source unit on the channel_mapping table.

target_unit_col​

def target_unit_col() -> str

Internal column name for the target unit on the channel_mapping table.

unit_col​

def unit_col() -> str

Internal column name for the unit identifier.

Used in two places that happen to share the same default name:

  • On the unit_conversion table, as the key joined against channel_mapping.source_unit / target_unit to look up a conversion factor.
  • On the channel_metrics table (optional), as the authoritative physical unit of a channel. When present, takes precedence over channel_mapping.source_unit for aliased reads via the :meth:DefaultSolver.filter_aliased_channel_metrics coalesce.

Users with different internal names per table can rename physical columns to unit on each table independently via the per-table column_name_mapping.

group_id_col​

def group_id_col() -> str

Internal column name for the unit group id on the unit_conversion table.

effective_alias_join_keys​

def effective_alias_join_keys() -> list[tuple[str, str]]

Return the resolved alias-resolution join keys as (mapping_col, metrics_col) tuples.

Falls back to the default composite key [(source_channel_col, channel_name_col), (data_key_col, data_key_col)] when :attr:ChannelMappingConfig.join_keys is None. Otherwise returns the configured list.

Both members of each tuple are column names after column_name_mapping has been applied on the respective table.

col_map​

def col_map() -> dict[str, str]

Short-key → internal-column-name mapping for UDFs and caches.