Skip to main content

fused udf-schema

Print a UDF's parameter schema without executing it. Use this to inspect parameter names and types before calling fused run with --key=value arguments.

fused udf-schema CANVAS UDF [OPTIONS]

CANVAS is the canvas collection context (use "" for local files). UDF accepts the same forms as fused run:

  • A local Python file: udf.py
  • A Fused identifier: user@example.com/my_udf or my_udf
  • A GitHub URL
  • Inline source (a string containing at least one newline)

Options​

FlagDescription
--stdinRead UDF source from stdin instead of the UDF argument

Examples​

# Inspect a local UDF
fused udf-schema "" udf.py

# Inspect a UDF in a canvas
fused udf-schema my_canvas my_udf

# Inspect a UDF by Fused identifier
fused udf-schema "" user@example.com/my_udf

# Read from stdin
cat udf.py | fused udf-schema "" --stdin