SQL Server Sink
- Robin Rielley
- robin
Plugin version: 1.10.0
Writes records to a SQL Server table. Each record will be written to a row in the table.
Use this sink when you need to write to a SQL Server table. For example, you periodically build a recommendation model for products on your online store. The model is stored in a FileSet and you want to export the contents of the FileSet to a SQL Server table where it can be served to your users.
Column names would be autodetected from input schema.
For information about using this plugin in pipelines, see Microsoft SQL Server Best Practices.
Configuration
Property | Macro Enabled? | Version Introduced | Description |
|---|---|---|---|
Use Connection | No | 6.7.0/1.8.0 | Optional. Whether to use a connection. If a connection is used, you do not need to provide the credentials. |
Connection | Yes | 6.7.0/1.8.0 | Optional. Name of the connection to use. Project and service account information will be provided by the connection. You also can use the macro function ${conn(connection-name)}. |
JDBC Driver Name | No |
| Required. Name of the JDBC driver to use. Default is sqlserver42. |
Host | Yes |
| Required. Host that SQL Server is running on. Default is localhost. |
Port | Yes |
| Required. Port that SQL Server is listening to. If the port number is specified in the connection string, no request to SQLbrowser is made. When the Port and Instance Name are both specified, the connection is made to the specified port. However, the Instance Name is validated and an error is thrown if it does not match the port. Default is 1433. |
Authentication Type | No |
| Optional. Indicates which SQL authentication method will be used for the connection. Use 'SQL Login' to connect to a SQL Server using username and password properties. Use 'Active Directory Password' to connect to an Azure SQL Database/Data Warehouse using an Azure AD principal name and password. Default is SQL Login. |
Username | Yes |
| Optional. User identity for connecting to the specified database. |
Password | Yes |
| Optional. Password to use to connect to the specified database. |
Connection Arguments | No |
| Optional. A list of arbitrary string key/value pairs as connection arguments. These arguments will be passed to the JDBC driver as connection arguments for JDBC drivers that may need additional configurations. |
Reference Name | No |
| Required. Name used to uniquely identify this sink for lineage, annotating metadata, etc. |
Database | Yes |
| Required. SQL Server database name. |
Table Name | Yes |
| Required. Name of the table to export to. |
Schema Name | Yes | 6.7.0/1.8.0 | Optional. Name of database schema of table. |
Instance Name | No |
| Optional. SQL Server instance name to connect to. When it is not specified, a connection is made to the default instance. For the case where both the instanceName and port are specified, see the notes for port. If you specify a Virtual Network Name in the Server connection property, you cannot use instanceName connection property. |
Query Timeout | No |
| Optional. Number of seconds to wait before a timeout has occurred on a query. The default value is -1, which means infinite timeout. Setting this to 0 also implies to wait indefinitely. Default is -1. |
Connect Timeout | No |
| Optional. Time in seconds to wait for a connection to the server before terminating the attempt and generating an error. Default is 0. |
Column Encryption | No |
| Optional. Whether to encrypt data sent between the client and server for encrypted database columns in the SQL server. Default is Disabled. |
Encrypt | No |
| Optional. Whether to encrypt all data sent between the client and server. This requires that the SQL server has a certificate installed. Default is No. |
Trust Server Certificate | No |
| Optional. Whether to trust the SQL server certificate without validating it when using SSL encryption for data sent between the client and server. Default is No. |
Workstation ID | No |
| Optional. Used to identify the specific workstation in various SQL Server profiling and logging tools. |
Failover Partner | No |
| Optional. Name or network address of the SQL Server instance that acts as a failover partner. |
Packet Size | No |
| Optional. Network packet size in bytes to use when communicating with the SQL Server. Default is -1. |
Current Language | No |
| Optional. Language to use for SQL sessions. The language determines datetime formats and system messages. See sys.syslanguages for the list of installed languages. |
Example
You want to write output records to "users" table of SQL Server database named "prod" that is running on "localhost", port 1433, as "sa" user with "Test11" password. Ensure that the driver for SQL Server is installed. You can also provide driver name for some specific driver, otherwise "sqlserver42" will be used, and then configure the plugin with:
Property | Value |
|---|---|
Reference Name |
|
Driver Name |
|
Host |
|
Port |
|
Database |
|
Table Name |
|
Username |
|
Password |
|
Data Type Mapping
SQL Server Data Type | CDAP Schema Data Type | Comments |
|---|---|---|
BIGINT | long |
|
BINARY | bytes |
|
BIT | boolean |
|
CHAR | string |
|
DATE | date |
|
DATETIME | timestamp |
|
DATETIME2 | timestamp |
|
DATETIMEOFFSET | string | DATETIMEOFFSET string literal in the following format: |
DECIMAL | decimal |
|
FLOAT | double |
|
IMAGE | bytes |
|
INT | int |
|
MONEY | decimal |
|
NCHAR | string |
|
NTEXT | string |
|
NUMERIC | decimal |
|
NVARCHAR | string |
|
NVARCHAR(MAX) | string |
|
REAL | float |
|
SMALLDATETIME | timestamp |
|
SMALLINT | int |
|
SMALLMONEY | decimal |
|
TEXT | string |
|
TIME | time | TIME data type has the accuracy of 100 nanoseconds which is not supported. Values of this type will be rounded to microsecond. |
TINYINT | int |
|
UDT | bytes | UDT types are mapped according to the type they are an alias of. For example, is there is an 'SSN' type that was created as'CREATE TYPE SSN FROM varchar(11);', that type would get mapped to a CDAP string. Common Language Runtime UDTs are mapped to CDAP bytes. |
UNIQUEIDENTIFIER | string |
|
VARBINARY | bytes |
|
VARBINARY(MAX) | bytes |
|
VARCHAR | string |
|
VARACHAR(MAX) | string |
|
XML | string |
|
SQLVARIANT | string |
|
GEOMETRY | bytes |
|
GEOGRAPHY | bytes |
|
GEOMETRY | string | Values of this type can be set from Well Known Text strings, such as "POINT(3 40 5 6)". |
GEOGRAPHY | string | Values of this type can be set from Well Known Text strings, such as "POINT(3 40 5 6)". |
TIMESTAMP |
| TIMESTAMP data type is not supported for the sink |
Created in 2020 by Google Inc.