Google BigQuery Invoke Routine Activity¶

Introduction¶

A Google BigQuery Invoke Routine activity, using its Google BigQuery connection, invokes a routine (such as a stored procedure, user-defined function, or table function) for datasets in Google BigQuery and is intended to be used as a target in an operation.

Create a Google BigQuery Invoke Routine Activity¶

An instance of a Google BigQuery Invoke Routine activity is created from a Google BigQuery connection using its Invoke Routine activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.

An existing Google BigQuery Invoke Routine activity can be edited from these locations:

• The design canvas (see Component Actions Menu in Design Canvas).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).

Configure a Google BigQuery Invoke Routine Activity¶

Follow these steps to configure a Google BigQuery Invoke Routine activity:

• Step 1: Enter a Name and Select the Dataset
  Provide a name for the activity and select the dataset.

• Step 2: Select the Routine
  Select the routine.

• Step 3: Review the Data Schemas
  Any request or response schemas are displayed.

Step 1: Enter a Name and Select the Dataset¶

In this step, provide a name for the activity and select the dataset. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each Google BigQuery Invoke Routine activity and must not contain forward slashes / or colons :.

• Select the Dataset: This section displays datasets available in the Google BigQuery endpoint.

  • Selected Dataset: After a dataset is selected, it is listed here.

  • Search: Enter any part of the dataset name into the search box to filter the list of datasets. The search is not case-sensitive. If datasets are already displayed within the table, the table results are filtered in real time with each keystroke. To reload datasets from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload datasets from the Google BigQuery endpoint. This may be useful if datasets have been added to Google BigQuery. This action refreshes all metadata used to build the table of datasets displayed in the configuration.

  • Selecting a Dataset: Within the table, click anywhere on a row to select a dataset. Only one dataset can be selected. The information available for each dataset is fetched from the Google BigQuery endpoint:

    • Name: The name of the dataset.

    • Description: The description of the dataset.

  Tip

  If the table does not populate with available datasets, the Google BigQuery connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select the Routine¶

In this step, select the routine. Each user interface element of this step is described below.

• Select the Routine: This section displays routines available in the Google BigQuery endpoint.

  • Selected Dataset: The dataset selected in the previous step is listed here.

  • Selected Routine: After a routine is selected, it is listed here.

  • Search: Enter any part of the routine name into the search box to filter the list of routines. The search is not case-sensitive. If routines are already displayed within the table, the table results are filtered in real time with each keystroke. To reload routines from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload routines from the Google BigQuery endpoint. This may be useful if routines have been added to Google BigQuery. This action refreshes all metadata used to build the table of routines displayed in the configuration.

  • Selecting a Routine: Within the table, click anywhere on a row to select a routine. Only one routine can be selected. The information available for each routine is fetched from the Google BigQuery endpoint:

    • Name: The name of the routine.

    • Description: The description of the routine.

  Tip

  If the table does not populate with available routines, the Google BigQuery connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Review the Data Schemas¶

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  The Google BigQuery connector uses the Google SDK version 25.4.0. Refer to the SDK documentation for information on the schema nodes and fields.

  The Invoke Routine activity uses JSON in its response schema.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Google BigQuery endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps¶

After configuring a Google BigQuery Invoke Routine activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Google BigQuery Invoke Routine activities can be used as a target with these operation patterns:

• Transformation Pattern
• Two-transformation Pattern (as the first or second target)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.