Skip to main content
Version: 1.1.0

subscriber

def subscriber(
tables: TableInput | str | List[str],
destination: AzureDestination | LocalFileDestination | MariaDBDestination | MySQLDestination | OracleDestination | PostgresDestination | S3Destination | DestinationPlugin,
name: str = None,
trigger_by: str | List[str] | None = '*',
) -> callable

Categories: subscriber

Decorator to set the data and destination parameters of a function and convert it to a TabsdataFunction.

Parameters

parameter
tablesTableInput | str | List[str]

Where to obtain the data that will be provided as an input to the function. destination (AzureDestination | LocalFileDestination | MariaDBDestination | MySQLDestination | OracleDestination | PostgresDestination | S3Destination | DestinationPlugin): Where to store the output of the function.

parameter
namestr, optional

The name with which the function will be registered. If not provided, the current function name will be used.

parameter
trigger_bystr | list[str] | None, optional

The trigger that will cause the function to execute. It can be a table in the system, a list of tables, or None (in which case it must be triggered manually). Defaults to all dependencies.

Returns

callable: The function converted to a TabsdataFunction.