HexRunProjectOperator
HexRuns a Hex Project, and optionally waits until completion.
Access Instructions
Install the Hex provider package into your Airflow environment.
Import the module into your DAG file and instantiate it with your desired params.
Parameters
project_idstrHex Project ID
hex_conn_idstrconnection run the operator with
synchronousboolif true, wait for the project run to complete otherwise request a run but do not wait for completion. Useful for long-running projects that block the DAG from completing.
wait_secondsintinterval to wait, in seconds, between successive API polls.
timeoutintmaximum time to wait for a sync to complete before aborting the run. if kill_on_timeout is true, also attempt to end the project run
kill_on_timeoutboolif true attempt to stop the project if the timeout is reached. If false, the project will continue running indefinitely in the background until completion.
input_paramtersadditional input parameters, a json-serializable dictionary of variable_name: value pairs.
input_parametersdict
update_cacheWhen true, this run will update the cached state of the published app with the latest run results. Additionally, any SQL cells that have caching enabled will be re-executed as part of this run. Note that this cannot be set to true if custom input parameters are provided.
Documentation
Runs a Hex Project, and optionally waits until completion.