Document the start_tool flow options

Options
Turribeach
Turribeach Dataiku DSS Core Designer, Neuron, Dataiku DSS Adv Designer, Registered, Neuron 2023 Posts: 1,728 Neuron
edited July 16 in Product Ideas

A user can trigger a flow consistency check using the following API code:

import dataiku
client = dataiku.api_client()
 
project_handle = client.get_project("some project key")
flow_handle = project_handle.get_flow()

tool = flow_handle.start_tool(type='CHECK_CONSISTENCY')
options = { "recheckAll": False,
            "datasets": {"consistencyWithData": True},
            "recipes": {"schemaConsistency": False, "otherExpensiveChecks": False},
          }
future = tool.update(options)
future_result = future.wait_for_result()

However none of the options of the start_tool appear to be fully documented:

https://developer.dataiku.com/latest/api-reference/python/flow.html#dataikuapi.dss.flow.DSSProjectFlow.start_tool

So this idea is to expand the documentation to cover all those options and explain exactly what they do.

1
1 votes

New · Last Updated

Setup Info
    Tags
      Help me…