Help Manual - GraphQL Destination

Documentation on SSIS GraphQL Destination Component

Using the GraphQL Destination Component

The GraphQL Destination Component is an SSIS data flow destination component that can be used to write to endpoints. There are three pages that can be configured and worked with in the GraphQL Destination Component:

  • General
  • Columns
  • Error Handling

General

The General page can be used to configure the general configuration settings for the GraphQL Destination component.

GraphQL Destination Component - General.png

Connection Manager

A Connection Manager is required for the GraphQL Source component to connect to the endpoint. A list of available connection managers will populate the drop-down.

Mutation 

The Mutation that can be chosen from the drop down based on the connection configuration.

Expand 

The Expand option provides a Field Selection button to get the required fields and filters.

GraphQL Field Selection.png

Batch Size

The Batch Size option allows you to specify how many records you want to retrieve per service call.

Note: The Batch Size option is only available if the endpoint supports it.

Inputs

The Inputs can be chosen for the respective endpoints based on the Sources connected to the GraphQL Destination component.

Refresh Component Button

Clicking the Refresh Component button causes the component to retrieve the latest metadata and update each field to its most recent metadata.

Expression fx Button

Click the fx button to launch SSIS Expression Editor to enable dynamic updates of the property at run time.

Generate Documentation Button

Click the Generate Documentation button to generate a Word document that describes the component's metadata including relevant mapping, and so on.

Columns

The Columns page gives the metadata-related details for the GraphQL Destination component, based on the endpoint it is connected to, and other properties that were specified in the General page.

GraphQL Destination Component - Columns.png

The Columns page grid consists of:

  • Input Column: You can select an input column from an upstream component for the corresponding GraphQL field.
  • GraphQL Field: The field that you are writing data to.
  • Data Type: The data type of this field.
  • Unmap: This column can be used to unmap the field from the upstream input column, or otherwise it can be used to map the field to an upstream input column by matching its name if the field is not currently mapped.

Error Handling

The Error Handling page allows you to specify how errors should be handled when they happen.

GraphQL Destination Component - Error Handling.png

There are three options available.

  1. Fail on error
  2. Redirect rows to error output
  3. Ignore error

When the Redirect rows to error output option is selected, rows that failed to write to the GraphQL endpoint will be redirected to the 'Error Output({PrimaryInputName})' output of the Destination Component; rows from the Child Input that failed to find the parent records will be redirected to the 'Orphaned Children Error Output' output of the Destination Component. As indicated in the screenshot below, the blue output connection represents rows that were successfully written, and the red 'Error Output{PrimaryInputName}' and 'Orphaned Children Error Output'.>action.

Enable Columns for Default Output

The button "Default Output Columns..." can be pressed in order to get the default GraphQL fields in the default output.