Plexora

table_stream

Register a function as the implementation of a streamed table operation.

Generated from Plexora 0.0.55View source
from plexora.api import table_stream
table_stream(name: str)

Like table_operation, but for a result a JSON round trip cannot serve: a whole-table export, for instance, where the text is megabytes-to-gigabytes and materializing it as one string would hold the serialized copy alongside the frame it came from.

The registered function takes (dataset, payload) like any other table operation, but yields str or bytes chunks instead of returning a value.

Parameters

namestrrequired

The operation's name, namespaced by plugin, the same way as table_operation.

Returns

Callable

A decorator that registers the function it is applied to, and returns that function unchanged.

Raises

ValueError

If a different function is already registered under name.

On this page