Skip to main content
Version: 2.0.0

tdk plan list

List plans across every project you can view.

tdk plan list \
--proj quickstart \
--status status-example \
--fn read_world \
--coll sales_data \
--name sales_data \
--last \
--at 2024-05-20T10:00:00Z \
--monitor \
--format table \
--max-result 100
FlagTypeRequiredDescription
--projstringOptionalName of the project to filter plans by.
--statusstring (repeatable)OptionalFilter plans by status. The possible statuses are 'Finished/F, Stalled/L, Running/R, Scheduled/S, Unexpected/U'. This field is case-insensitive.
--fnstringOptionalName of the function to filter plans by.
--collstringOptionalName of the collection to filter plans by.
--name, -nstringOptionalA plan name wildcard to match for the list. For example, 'my_plan*' will match all plans with names starting with 'my_plan'.
--lastflagOptionalIf set, only the last plan of the list will be shown.
--atstringOptionalIf provided, only plans started before that time will be shown. Must be either a valid timestamp in the form of a unix timestamp (milliseconds since epoch without a dot, e.g. '1750074554472') or a valid date-time format. The valid formats are 'YYYY-MM-DD', 'YYYY-MM-DDTHH', 'YYYY-MM-DDTHH:MM', 'YYYY-MM-DDTHH:MM:SS', and 'YYYY-MM-DDTHH:MM:SS.sss'. A 'Z' character can be added at the end to indicate UTC time (e.g., '2023-10-01T12Z' or '2023-10-01T12:00:00.000Z') or it can be omitted to indicate local time (e.g., '2023-10-01T12' or '2023-10-01T12:00:00.000').
--monitorflagOptionalIf set, the command will monitor the listed plans until they all reach a final state.
-o, --formattable | json | yamlOptionalOutput format. Defaults to table.
--max-resultstringOptionalMaximum number of rows to list. Use 0 for no limit. Defaults to 100.