Using the GraphQL Source Component
The GraphQL Source Component is an SSIS data flow source component that can be used to read from endpoints. There are two pages that can be configured and worked with in the GraphQL Source component.
- General
- Columns
General Page
The General page can be used to configure the general configuration settings for the GraphQL Source component.
- 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.
- Query
-
The Query 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.
- 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.
- Arguments
-
The Arguments can be chosen based on the metadata selected by the Filed Selection.
- 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 Source component, based on the endpoint it is connected to, and other properties that were specified in the General page.
On the top left of the grid, the checkbox is used to toggle the selection of all available fields. This is a productive way to check or uncheck all available fields.
The Columns page grid consists of:
- Field: Column that will be retrieved from the endpoint.
- Data Type: The data type of this field.