Skip to main content
Version: 1.13.0

SQLServer

Overview

The SQLServer Load Node supports to write data into SQLServer database. This document describes how to set up the SQLServer Load Node to run SQL queries against SQLServer database.

Supported Version

Load NodeDriverGroup IdArtifact IdJAR
SQLServerSQL Servercom.microsoft.sqlservermssql-jdbcDownload

Dependencies

In order to set up the SQLServer Load Node, the following provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with Sort Connectors JAR bundles.

Maven dependency

<dependency>
<groupId>org.apache.inlong</groupId>
<artifactId>sort-connector-jdbc</artifactId>
<version>1.13.0-SNAPSHOT</version>
</dependency>

How to create an SQLServer Load Node

Usage for SQL API


-- SQLServer extract node
CREATE TABLE `sqlserver_extract_table`(
PRIMARY KEY (`id`) NOT ENFORCED,
`id` BIGINT,
`name` STRING,
`age` INT
) WITH (
'connector' = 'sqlserver-cdc-inlong',
'url' = 'jdbc:sqlserver://localhost:1433/read',
'username' = 'inlong',
'password' = 'inlong',
'table-name' = 'dbo.user'
)

-- SQLServer load node
CREATE TABLE `sqlserver_load_table`(
PRIMARY KEY (`id`) NOT ENFORCED,
`id` BIGINT,
`name` STRING,
`age` INT
) WITH (
'connector' = 'jdbc-inlong',
'url' = 'jdbc:sqlserver://localhost:1433;databaseName=column_type_test',
'username' = 'inlong',
'password' = 'inlong',
'table-name' = 'dbo.work1'
)

-- write data into SQLServer
INSERT INTO sqlserver_load_table
SELECT id, name , age FROM mysql_extract_table;

Usage for InLong Dashboard

TODO: It will be supported in the future.

Usage for InLong Manager Client

TODO: It will be supported in the future.

SQLServer Load Node Options

OptionRequiredDefaultTypeDescription
connectorrequired(none)StringSpecify what connector to use, here should be 'jdbc-inlong'.
urlrequired(none)StringThe JDBC database url.
table-namerequired(none)StringThe name of JDBC table to connect.
driveroptional(none)StringThe class name of the JDBC driver to use to connect to this URL, if not set, it will automatically be derived from the URL.
usernameoptional(none)StringThe JDBC user name. 'username' and 'password' must both be specified if any of them is specified.
passwordoptional(none)StringThe JDBC password.
connection.max-retry-timeoutoptional60sDurationMaximum timeout between retries. The timeout should be in second granularity and shouldn't be smaller than 1 second.
sink.buffer-flush.max-rowsoptional100IntegerThe max size of buffered records before flush. Can be set to zero to disable it.
sink.buffer-flush.intervaloptional1sDurationThe flush interval mills, over this time, asynchronous threads will flush data. Can be set to '0' to disable it. Note, 'sink.buffer-flush.max-rows' can be set to '0' with the flush interval set allowing for complete async processing of buffered actions.
sink.max-retriesoptional3IntegerThe max retry times if writing records to database failed.
sink.parallelismoptional(none)IntegerDefines the parallelism of the JDBC sink operator. By default, the parallelism is determined by the framework using the same parallelism of the upstream chained operator.
sink.ignore.changelogoptionalfalseBooleanIgnore all RowKind, ingest them as INSERT.
inlong.metric.labelsoptional(none)StringInlong metric label, format of value is groupId={groupId}&streamId={streamId}&nodeId={nodeId}.

Data Type Mapping

SQLServer typeFlink SQL type
char(n)CHAR(n)
varchar(n)
nvarchar(n)
nchar(n)
VARCHAR(n)
text
ntext
xml
STRING
BIGINT
BIGSERIAL
BIGINT
decimal(p, s)
money
smallmoney
DECIMAL(p, s)
numericNUMERIC
float
real
FLOAT
bitBOOLEAN
intINT
tinyintTINYINT
smallintSMALLINT
bigintBIGINT
time(n)TIME(n)
datetime2
datetime
smalldatetime
TIMESTAMP(n)
datetimeoffsetTIMESTAMP_LTZ(3)