Column Date HWM#
- class etl_entities.hwm.column.date_hwm.ColumnDateHWM(*, name: str, description: str = '', source: str | None = None, value: date | None = None, expression: Any = None, modified_time: datetime = None)#
Date HWM type
- Parameters:
- name
str
HWM unique name
- value
datetime.date
orNone
, default:None
HWM value
- description
str
, default:""
Description of HWM
- sourceAny, default:
None
HWM source, e.g. table name
- expressionAny, default:
None
Expression used to generate HWM value, e.g.
column
,CAST(column as TYPE)
- modified_time
datetime.datetime
, default: current datetime HWM value modification time
- name
Examples
from datetime import date from etl_entities.hwm import ColumnDateHWM hwm = ColumnDateHWM( name="long_unique_name", source="myschema.mytable", expression="my_date_column", value=date(year=2021, month=12, day=3), )
- __add__(value: ColumnValueType) ColumnHWMType #
Increase HWM value and return copy of HWM
- Parameters:
- value
Any
orNone
Should be compatible with
value
attribute type.For example, you cannot add
str
toint
value, but you can addint
toint
.
- value
- Returns:
- resultColumnHWM
HWM with new value
Examples
# assume val2 == val1 + inc hwm1 = ColumnHWM(value=val1, ...) hwm2 = ColumnHWM(value=val2, ...) # same as ColumnHWM(value=hwm1.value + inc, ...) assert hwm1 + inc == hwm2
- __eq__(other)#
Checks equality of two HWM instances
- Parameters:
- other
etl_entities.hwm.column_hwm.ColumnHWM
You can compare two
etl_entities.hwm.column_hwm.ColumnHWM
instances, obj:etl_entities.hwm.column_hwm.ColumnHWM with anobject
, if its value is comparable with thevalue
attribute of HWM
- other
- Returns:
- resultbool
True
if both inputs are the same,False
otherwise.
- __lt__(other)#
Checks current HWM value is less than another one.
- Returns:
- resultbool
True
if current HWM value is less than provided value,False
otherwise.
- Raises:
- NotImplementedError:
If someone tries to compare HWMs with different fields, like
name
,source
orexpression
- __sub__(value: ColumnValueType) ColumnHWMType #
Decrease HWM value, and return copy of HWM
- Parameters:
- value
Any
orNone
Should be compatible with
value
attribute type.For example, you cannot subtract
str
fromint
value, but you can subtractint
fromint
.
- value
- Returns:
- resultColumnHWM
HWM copy with new value
Examples
# assume val2 == val1 - dec hwm1 = ColumnHWM(value=val1, ...) hwm2 = ColumnHWM(value=val2, ...) # same as ColumnHWM(value=hwm1.value - dec, ...) assert hwm1 - dec == hwm2
- copy(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, update: DictStrAny | None = None, deep: bool = False) Model #
Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters:
include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model
- Returns:
new model instance
- classmethod deserialize(inp: dict) HWMType #
Return HWM from dict representation
- Returns:
- resultHWM
Deserialized HWM
Examples
from etl_entities.hwm import ColumnIntHWM assert ColumnIntHWM.deserialize( { "value": "1", "type": "int", "column": "column_name", "name": "name", } ) == ColumnIntHWM(value=1, ...) ColumnIntHWM.deserialize({"type": "date"}) # raises ValueError
- dict(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny #
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- json(*, include: AbstractSetIntStr | MappingIntStrAny | None = None, exclude: AbstractSetIntStr | MappingIntStrAny | None = None, by_alias: bool = False, skip_defaults: bool | None = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Callable[[Any], Any] | None = None, models_as_dict: bool = True, **dumps_kwargs: Any) str #
Generate a JSON representation of the model, include and exclude arguments as per dict().
encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().
- set_value(value: ValueType | None) HWMType #
Replaces current HWM value with the passed one, and return HWM.
Note
Changes HWM value in place instead of returning new one
- Returns:
- resultHWM
Self
Examples
from etl_entities.hwm import ColumnIntHWM hwm = ColumnIntHWM(value=1, ...) hwm.set_value(2) assert hwm.value == 2