Skip to main content
Version: 2.0.0

tdk fn register

Register a function.

Dynamically imports the symbol named by --path (which must be a tabsdatak PublisherInfo / TransformerInfo / SubscriberInfo produced by a @publisher / @transformer / @subscriber decorator) and registers it via the v2 bundle producer (tabsdatak.common._archive.bundle.build_bundle).

With --update, behaves idempotently: if the function already exists in the collection it is updated; otherwise it is registered.

tdk fn register \
--proj quickstart \
--coll sales_data \
--description Ingests raw sales data from Postgres \
--path functions/read_world.py::read_world \
--dir-to-bundle ./qs-example \
--reuse-tables \
--enabled \
--update \
--storage-path /prod
FlagTypeRequiredDescription
--proj, -PstringOptionalProject to target; overrides the pinned project. Prompted for when a command needs one and neither is set.
--coll, -cstringOptionalName of the collection to which the function belongs.
--descriptionstringOptionalDescription of the function.
--pathstringRequiredPath to the function file. Must be of the form '/path/to/file.py::function_name'. Will be prompted for it if not provided.
--dir-to-bundlestringOptionalPath to the directory that should be stored in the bundle for execution in the backend. If not provided, the folder where the function file is will be used.
--reuse-tablesflagOptionalReuse previously created tables. If provided, any tables that the function produces that already exist in the system (but no longer have a function that generates them) will be reused, adding to their data history. If not provided, those tables will be recreated and their data history re-initialized.
--enabled, --disabledflagOptionalEnable or disable the feature
--updateflagOptionalIf provided, update the function if it already exists in the collection. If not present, the command falls through to the normal register flow.
--storage-pathstringOptionalOptional storage-prefix override for this function's output table data. When omitted, the collection's base_path is used.