Skip to content

trigger_dataform

trigger_dataform(repo_location, repo_name, repo_workspace, project_id, compilation_result_id)

Description

Triggers a Dataform workflow in the specified project, location, repository and workspace. Returns the workflow invocation ID if successful.

Examples

Call or Deploy trigger_dataform ?
Call trigger_dataform directly

The easiest way to use bigfunctions

  • trigger_dataform function is deployed in 39 public datasets for all of the 39 BigQuery regions.
  • It can be called by anyone. Just copy / paste examples below in your BigQuery console. It just works!
  • (You need to use the dataset in the same region as your datasets otherwise you may have a function not found error)

Public BigFunctions Datasets

Region Dataset
eu bigfunctions.eu
us bigfunctions.us
europe-west1 bigfunctions.europe_west1
asia-east1 bigfunctions.asia_east1
... ...
Deploy trigger_dataform in your project

Why deploy?

  • You may prefer to deploy trigger_dataform in your own project to build and manage your own catalog of functions.
  • This is particularly useful if you want to create private functions (for example calling your internal APIs).
  • Get started by reading the framework page

Deployment

trigger_dataform function can be deployed with:

pip install bigfunctions
bigfun get trigger_dataform
bigfun deploy trigger_dataform

Trigger a Dataform workflow with a new compilation

select bigfunctions.eu.trigger_dataform('us-central1', 'my-repo', 'my-workspace', 'my-project')
select bigfunctions.us.trigger_dataform('us-central1', 'my-repo', 'my-workspace', 'my-project')
select bigfunctions.europe_west1.trigger_dataform('us-central1', 'my-repo', 'my-workspace', 'my-project')
+----------------------------------------------------------+
| invocation_result                                        |
+----------------------------------------------------------+
| {"workflow_invocation_id": "workflow_invocation_123456"} |
+----------------------------------------------------------+

Need help or Found a bug using trigger_dataform?
Get help using trigger_dataform

The community can help! Engage the conversation on Slack

We also provide professional suppport.

Report a bug about trigger_dataform

If the function does not work as expected, please

  • report a bug so that it can be improved.
  • or open the discussion with the community on Slack.

We also provide professional suppport.

Spread the word!

BigFunctions is fully open-source. Help make it a success by spreading the word!

Share on Add a on