DataPointFilter

class ixmp4.data.db.iamc.datapoint.filter.DataPointFilter(*, year: int | None = None, time_series_id: int | None = None, region: RegionFilter | None = None, unit: UnitFilter | None = None, variable: VariableFilter | None = None, model: ModelFilter | None = None, scenario: ScenarioFilter | None = None, run: RunFilter | None = RunFilter(id=None, default_only=True, id__in=None), year__lte: int | None = None, year__lt: int | None = None, year__gt: int | None = None, year__gte: int | None = None, year__in: list[int] | None = None, time_series_id__in: list[int] | None = None)

Bases: BaseFilter

This class is used for filtering data points.

All parameters are optional. Use the field name (or the field alias) directly for equality comparisons. For performing an SQL IN operation use the field name followed by a double underscore and in.

Parameters

step_yearfilters.Integer, Optional

Filter for data point year, can also be called with “year”

time_series__idfilters.Id, Optional

Filter for the id of the time series, can also be called with “time_series_id”

regionRegionFilter, Optional

Filter for either region name or hierarchy

unitUnitFilter, Optional

Filter for unit name

variableVariableFilter, Optional

Filter for variable name

modelModelFilter, Optional

Filter for model name

scenarioScenarioFilter, Optional

Filter for the scenario name

runRunFilter, Optional

Filter for the run, options are id or default_only

Examples

Return all data points for a given year.

>>> DataPointFilter(year=2020)

Return all data points a number of years

>>> DataPointFilter(year__in=[2020, 2025])

Return all data point that map to a given variable

>>> DataPointFilter(variable=VariableFilter(name="variable 1"))

Note that for actual use providing the filter parameters as key word arguments is sufficient. Calling an endpoint could look like this:

>>> filter = {"variable": {"name": "variable 1"}, "year": 2020}
>>> iamc.tabulate(**filter)

filter_model(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_region(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_run(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_scenario(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_step_year(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_step_year__gt(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_step_year__gte(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_step_year__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_step_year__lt(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_step_year__lte(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_time_series__id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_time_series__id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_unit(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_variable(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

model: ModelFilter | None

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

region: RegionFilter | None

run: RunFilter | None

scenario: ScenarioFilter | None

sqla_model

alias of UniversalDataPoint

step_year: int | None

step_year__gt: int | None

step_year__gte: int | None

step_year__in: list[int] | None

step_year__lt: int | None

step_year__lte: int | None

time_series__id: int | None

time_series__id__in: list[int] | None

unit: UnitFilter | None

variable: VariableFilter | None

class ixmp4.data.db.iamc.datapoint.filter.ModelFilter(*, id: int | None = None, name: str | None = None, id__in: list[int] | None = None, name__in: list[str] | None = None, name__like: str | None = None, name__ilike: str | None = None, name__notlike: str | None = None, name__notilike: str | None = None)

Bases: BaseFilter

filter_id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__ilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function ilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__like(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function like>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notlike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notlike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

id: int | None

id__in: list[int] | None

join(exc: SelectType, session: Session) → SelectType

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name__ilike: str | None

name__in: list[str] | None

name__like: str | None

name__notilike: str | None

name__notlike: str | None

sqla_model

alias of Model

class ixmp4.data.db.iamc.datapoint.filter.RegionFilter(*, id: int | None = None, name: str | None = None, hierarchy: str | None = None, id__in: list[int] | None = None, name__in: list[str] | None = None, name__like: str | None = None, name__ilike: str | None = None, name__notlike: str | None = None, name__notilike: str | None = None, hierarchy__in: list[str] | None = None, hierarchy__like: str | None = None, hierarchy__ilike: str | None = None, hierarchy__notlike: str | None = None, hierarchy__notilike: str | None = None)

Bases: BaseFilter

filter_hierarchy(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_hierarchy__ilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function ilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_hierarchy__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_hierarchy__like(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function like>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_hierarchy__notilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_hierarchy__notlike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notlike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__ilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function ilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__like(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function like>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notlike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notlike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

hierarchy: str | None

hierarchy__ilike: str | None

hierarchy__in: list[str] | None

hierarchy__like: str | None

hierarchy__notilike: str | None

hierarchy__notlike: str | None

id: int | None

id__in: list[int] | None

join(exc: SelectType, session: Session) → SelectType

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name__ilike: str | None

name__in: list[str] | None

name__like: str | None

name__notilike: str | None

name__notlike: str | None

sqla_model

alias of Region

class ixmp4.data.db.iamc.datapoint.filter.RunFilter(*, id: int | None = None, default_only: bool | None = True, id__in: list[int] | None = None)

Bases: BaseFilter

default_only: bool | None

filter_default_only(exc: Select, c: Column[Any], v: bool | None, session: Session | None = None) → Select

filter_id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function FilterMeta.build_lookups.<locals>.lookup_func>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

id: int | None

id__in: list[int] | None

join(exc: SelectType, session: Session) → SelectType

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

sqla_model

alias of Run

class ixmp4.data.db.iamc.datapoint.filter.ScenarioFilter(*, id: int | None = None, name: str | None = None, id__in: list[int] | None = None, name__in: list[str] | None = None, name__like: str | None = None, name__ilike: str | None = None, name__notlike: str | None = None, name__notilike: str | None = None)

Bases: BaseFilter

filter_id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__ilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function ilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__like(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function like>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notlike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notlike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

id: int | None

id__in: list[int] | None

join(exc: SelectType, session: Session) → SelectType

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name__ilike: str | None

name__in: list[str] | None

name__like: str | None

name__notilike: str | None

name__notlike: str | None

sqla_model

alias of Scenario

class ixmp4.data.db.iamc.datapoint.filter.UnitFilter(*, id: int | None = None, name: str | None = None, id__in: list[int] | None = None, name__in: list[str] | None = None, name__like: str | None = None, name__ilike: str | None = None, name__notlike: str | None = None, name__notilike: str | None = None)

Bases: BaseFilter

filter_id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__ilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function ilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__like(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function like>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notlike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notlike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

id: int | None

id__in: list[int] | None

join(exc: SelectType, session: Session) → SelectType

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name__ilike: str | None

name__in: list[str] | None

name__like: str | None

name__notilike: str | None

name__notlike: str | None

sqla_model

alias of Unit

class ixmp4.data.db.iamc.datapoint.filter.VariableFilter(*, id: int | None = None, name: str | None = None, id__in: list[int] | None = None, name__in: list[str] | None = None, name__like: str | None = None, name__ilike: str | None = None, name__notlike: str | None = None, name__notilike: str | None = None)

Bases: BaseFilter

filter_id(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_id__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <built-in function eq>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__ilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function ilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__in(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function in_>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__like(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function like>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notilike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notilike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

filter_name__notlike(exc: ~sqlalchemy.sql.selectable.Select, f: str, v: ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool, func: ~collections.abc.Callable[[str, ~ixmp4.db.filters.Integer | ~ixmp4.db.filters.Float | ~ixmp4.db.filters.Id | ~ixmp4.db.filters.String | bool], ColumnElement[_T] | ~sqlalchemy.sql._typing._HasClauseElement[bool] | SQLCoreOperations[_T] | ~sqlalchemy.sql.roles.ExpressionElementRole[bool] | ~sqlalchemy.sql.roles.TypedColumnsClauseRole[bool] | ~typing.Callable[[], ColumnElement[_T]] | LambdaElement] = <function notlike>, session: ~sqlalchemy.orm.session.Session | None = None) → Select

id: int | None

id__in: list[int] | None

join(exc: SelectType, session: Session) → SelectType

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str | None

name__ilike: str | None

name__in: list[str] | None

name__like: str | None

name__notilike: str | None

name__notlike: str | None

sqla_model

alias of Variable