faust.tables.table

Table (key/value changelog stream).

class faust.tables.table.Table(app: faust.types.app.AppT, *, name: str = None, default: Callable[Any] = None, store: Union[str, yarl.URL] = None, key_type: Union[Type[faust.types.models.ModelT], Type[bytes], Type[str]] = None, value_type: Union[Type[faust.types.models.ModelT], Type[bytes], Type[str]] = None, partitions: int = None, window: faust.types.windows.WindowT = None, changelog_topic: faust.types.topics.TopicT = None, help: str = None, on_recover: Callable[Awaitable[None]] = None, on_changelog_event: Callable[faust.types.events.EventT, Awaitable[None]] = None, recovery_buffer_size: int = 1000, standby_buffer_size: int = None, extra_topic_configs: Mapping[str, Any] = None, **kwargs) → None[source]

Table (non-windowed).

class WindowWrapper(table: faust.types.tables.TableT, *, relative_to: Union[faust.types.tables._FieldDescriptorT, Callable[Optional[faust.types.events.EventT], Union[float, datetime.datetime]], datetime.datetime, float, None] = None, key_index: bool = False, key_index_table: faust.types.tables.TableT = None) → None

Windowed table wrapper.

A windowed table does not return concrete values when keys are accessed, instead WindowSet is returned so that the values can be further reduced to the wanted time period.

ValueType

alias of WindowSet

as_ansitable(title: str = '{table.name}', **kwargs) → str
Return type:str
clone(relative_to: Union[faust.types.tables._FieldDescriptorT, Callable[Optional[faust.types.events.EventT], Union[float, datetime.datetime]], datetime.datetime, float, None]) → faust.types.tables.WindowWrapperT
Return type:WindowWrapperT[]
get_relative_timestamp
Return type:Optional[Callable[[Optional[EventT[]]], Union[float, datetime]]]
get_timestamp(event: faust.types.events.EventT = None) → float
Return type:float
items(event: faust.types.events.EventT = None) → ItemsView
Return type:ItemsView[~KT, +VT_co]
key_index = False
key_index_table = None
keys() → KeysView
Return type:KeysView[~KT]
name
Return type:str
on_del_key(key: Any) → None
Return type:None
on_recover(fun: Callable[Awaitable[None]]) → Callable[Awaitable[None]]
Return type:Callable[[], Awaitable[None]]
on_set_key(key: Any, value: Any) → None
Return type:None
relative_to(ts: Union[faust.types.tables._FieldDescriptorT, Callable[Optional[faust.types.events.EventT], Union[float, datetime.datetime]], datetime.datetime, float, None]) → faust.types.tables.WindowWrapperT
Return type:WindowWrapperT[]
relative_to_field(field: faust.types.models.FieldDescriptorT) → faust.types.tables.WindowWrapperT
Return type:WindowWrapperT[]
relative_to_now() → faust.types.tables.WindowWrapperT
Return type:WindowWrapperT[]
relative_to_stream() → faust.types.tables.WindowWrapperT
Return type:WindowWrapperT[]
values(event: faust.types.events.EventT = None) → ValuesView
Return type:ValuesView[+VT_co]
using_window(window: faust.types.windows.WindowT, *, key_index: bool = False) → faust.types.tables.WindowWrapperT[source]
Return type:WindowWrapperT[]
hopping(size: Union[datetime.timedelta, float, str], step: Union[datetime.timedelta, float, str], expires: Union[datetime.timedelta, float, str] = None, key_index: bool = False) → faust.types.tables.WindowWrapperT[source]
Return type:WindowWrapperT[]
tumbling(size: Union[datetime.timedelta, float, str], expires: Union[datetime.timedelta, float, str] = None, key_index: bool = False) → faust.types.tables.WindowWrapperT[source]
Return type:WindowWrapperT[]
on_key_get(key: KT) → None[source]

Handle that key is being retrieved.

Return type:None
on_key_set(key: KT, value: VT) → None[source]

Handle that value for a key is being set.

Return type:None
on_key_del(key: KT) → None[source]

Handle that a key is deleted.

Return type:None
as_ansitable(title: str = '{table.name}', **kwargs) → str[source]
Return type:str
logger = <Logger faust.tables.table (WARNING)>