This gem runs in .
Overview
This page describes how to configure Microsoft SQL Server (MSSQL) Source and Target gems, including connection setup, schema options, and available write modes. Use the MSSQL Source or Target gem to read from or write to the SQL server within your pipeline.Create an MSSQL gem
To create an MSSQL Source or Target gem in your pipeline:1
Add a Source or Target gem to the pipeline
- Open your pipeline in the Studio.
- Click on Source/Target in the canvas.
- Select Source or Target from the dropdown.
- Click on the gem to open the configuration.
2
Select MSSQL format
In the Type tab, select MSSQL. Then, click Next.
3
Set location details
In the Location tab, set your connection details and table location. To learn more, jump to Source location and Target location.
4
Set table properties
In the Properties tab, set the table properties. To learn more, jump to Source
properties and Target properties.
5
Preview data (Source only)
In the Preview tab, load a sample of the data and verify that it looks correct.
Source configuration
Use these settings to configure an MSSQL Source gem for reading data.Source location
| Parameter | Description | |
|---|---|---|
| Format type | Table format for the source. For MSSQL tables, set to mssql. | |
| Select or create connection | Select or create a new MSSQL connection in the Prophecy fabric you will use. | |
| Database | Database containing the table you want to read from. | |
| Schema | Schema within the database where the table is located. | |
| Name | Exact name of the MSSQL table to read data from. |
Source properties
Infer or manually configure the schema of your Source gem. Optionally, add a description for your table. Additional properties are not supported at this time.Target configuration
Use these settings to configure an MSSQL Target gem for writing data.Target location
| Parameter | Description | |
|---|---|---|
| Format type | Table format for the source. For MSSQL tables, set to mssql. | |
| Select or create connection | Select or create a new MSSQL connection in the Prophecy fabric you will use. | |
| Database | Database where the target table will be created or updated. | |
| Schema | Schema within the database where the target table resides or will be created. | |
| Name | Name of the MSSQL table to write data to. If the table doesn’t exist, it will be created automatically. |
Target properties
| Property | Description | Default |
|---|---|---|
| Description | Description of the table. | None |
| Write Mode | Whether to overwrite the table, append new data to the table, or throw an error if the table exists. | None |