Skip to main content
Version: Main branch

event

superduper.base.event

Source code

unpack_event​

unpack_event(r)
ParameterDescription
rSerialized event.

Helper function to deserialize event into Event class.

Create​

Create(self,
*,
context: str,
path: str,
data: Dict,
parent: list | None = None,
children: Optional[List] = None) -> None
ParameterDescription
contextthe component context of creation.
pathpath of the component to be created
datathe data of the component
parentthe parent of the component (if any)
childrenthe children of the component (if any)

Class for component creation events.

CreateTable​

CreateTable(self,
*,
identifier: str,
primary_id: str,
fields: Dict,
is_component: bool = False) -> None
ParameterDescription
identifierthe identifier of the table
primary_idthe primary id of the table
fieldsthe schema of the table
is_componentwhether the table is a component

Class for table creation events.

PutComponent​

PutComponent(self,
*,
context: str,
component: str,
identifier: str,
uuid: str,
service: str) -> None
ParameterDescription
contextthe component context of creation.
componentthe type of component to be created
identifierthe identifier of the component to be created
uuidthe uuid of the component to be created
servicethe service to put the component on

Class for putting component on cluster.

Update​

Update(self,
*,
context: str,
component: str,
data: Dict,
parent: list | None = None) -> None
ParameterDescription
contextthe component context of creation.
componentthe type of component to be created
datathe component data to be created
parentthe parent of the component (if any)

Update component event.

Signal​

Signal(self,
*,
msg: str,
context: str) -> None
ParameterDescription
msgsignal to send
contextthe context of component creation

Event used to send a signal to the scheduler.

Delete​

Delete(self,
*,
component: str,
identifier: str,
parents: List[str] = <factory>) -> None
ParameterDescription
componentthe type of component to be created
identifierthe identifier of the component to be deleted
parentsthe parents of the component (if any)

Class for component deletion events.

Change​

Change(self,
*,
type: str,
queue: str,
ids: List[str]) -> None
ParameterDescription
idslist of ids detected in databackend. the ids affected
typedelete
queuewhich table was affected

Class for streaming change events.

Event​

Event(self) -> None

Base class for all events.