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, schema: faust.types.serializers.SchemaT = 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, recover_callbacks: Set[Callable[Awaitable[None]]] = None, options: Mapping[str, Any] = None, use_partitioner: bool = False, on_window_close: Callable[[Any, Any], None] = None, **kwargs: Any) → 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: Any) → str¶ Draw table as a terminal ANSI table.
- Return type
-
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¶ Clone this table using a new time-relativity configuration.
- Return type
-
property
get_relative_timestamp
¶ Return the current handler for extracting event timestamp. :rtype:
Optional
[Callable
[[Optional
[EventT
[]]],Union
[float
,datetime
]]]
-
get_timestamp
(event: faust.types.events.EventT = None) → float¶ Get timestamp from event.
- Return type
-
items
(event: faust.types.events.EventT = None) → ItemsView¶ Return table items view: iterate over
(key, value)
pairs.- Return type
ItemsView
[~KT, +VT_co]
-
key_index
= False¶
-
key_index_table
= None¶
-
keys
() → KeysView¶ Return table keys view: iterate over keys found in this table.
- Return type
KeysView
[~KT]
-
on_del_key
(key: Any) → None¶ Call when a key is deleted from this table.
- Return type
None
-
on_recover
(fun: Callable[Awaitable[None]]) → Callable[Awaitable[None]]¶ Call after table recovery.
-
on_set_key
(key: Any, value: Any) → None¶ Call when the value for a key in this table is set.
- 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¶ Configure the time-relativity of this windowed table.
- Return type
-
relative_to_field
(field: faust.types.models.FieldDescriptorT) → faust.types.tables.WindowWrapperT¶ Configure table to be time-relative to a field in the stream.
This means the window will use the timestamp from the event currently being processed in the stream.
Further it will not use the timestamp of the Kafka message, but a field in the value of the event.
For example a model field:
class Account(faust.Record): created: float table = app.Table('foo').hopping( ..., ).relative_to_field(Account.created)
- Return type
-
relative_to_now
() → faust.types.tables.WindowWrapperT¶ Configure table to be time-relative to the system clock.
- Return type
-
relative_to_stream
() → faust.types.tables.WindowWrapperT¶ Configure table to be time-relative to the stream.
This means the window will use the timestamp from the event currently being processed in the stream.
- Return type
-
values
(event: faust.types.events.EventT = None) → ValuesView¶ Return table values view: iterate over values in this table.
- Return type
ValuesView
[+VT_co]
-
-
using_window
(window: faust.types.windows.WindowT, *, key_index: bool = False) → faust.types.tables.WindowWrapperT[source]¶ Wrap table using a specific window type.
- Return type
-
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]¶ Wrap table in a hopping window.
- Return type
-
tumbling
(size: Union[datetime.timedelta, float, str], expires: Union[datetime.timedelta, float, str] = None, key_index: bool = False) → faust.types.tables.WindowWrapperT[source]¶ Wrap table in a tumbling window.
- Return type
-
on_key_get
(key: KT) → None[source]¶ Call when the value for a key in this table is retrieved.
- Return type
None
-
on_key_set
(key: KT, value: VT) → None[source]¶ Call when the value for a key in this table is set.
- Return type
None
-
as_ansitable
(title: str = '{table.name}', **kwargs: Any) → str[source]¶ Draw table as a a terminal ANSI table.
- Return type
-
logger
= <Logger faust.tables.table (WARNING)>¶
-
class