add sqlserver doc

apache · Sep 9, 2022 · 8c3ed2d · 8c3ed2d
1 parent 4d37d02
commit 8c3ed2d
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 11 deletions.
diff --git a/docs/en/connector-v2/sink/Jdbc.md b/docs/en/connector-v2/sink/Jdbc.md
@@ -3,13 +3,16 @@
 > JDBC sink connector
 
 ## Description
-Write data through jdbc. Support Batch mode and Streaming mode, support concurrent writing, support exactly-once semantics (using XA transaction guarantee).
+
+Write data through jdbc. Support Batch mode and Streaming mode, support concurrent writing, support exactly-once
+semantics (using XA transaction guarantee).
 
 ## Key features
 
 - [x] [exactly-once](../../concept/connector-v2-features.md)
 
-Use `Xa transactions` to ensure `exactly-once`. So only support `exactly-once` for the database which is support `Xa transactions`. You can set `is_exactly_once=true` to enable it.
+Use `Xa transactions` to ensure `exactly-once`. So only support `exactly-once` for the database which is
+support `Xa transactions`. You can set `is_exactly_once=true` to enable it.
 
 - [ ] [schema projection](../../concept/connector-v2-features.md)
 
@@ -32,61 +35,85 @@ Use `Xa transactions` to ensure `exactly-once`. So only support `exactly-once` f
 | transaction_timeout_sec      | Int     | No       | -1            |
 
 ### driver [string]
+
 The jdbc class name used to connect to the remote data source, if you use MySQL the value is com.mysql.cj.jdbc.Driver.
-Warn: for license compliance, you have to provide MySQL JDBC driver yourself, e.g. copy mysql-connector-java-xxx.jar to $SEATNUNNEL_HOME/lib for Standalone.
+Warn: for license compliance, you have to provide MySQL JDBC driver yourself, e.g. copy mysql-connector-java-xxx.jar to
+$SEATNUNNEL_HOME/lib for Standalone.
 
 ### user [string]
+
 userName
 
 ### password [string]
+
 password
 
 ### url [string]
+
 The URL of the JDBC connection. Refer to a case: jdbc:postgresql://localhost/test
 
 ### query [string]
+
 Query statement
 
 ### connection_check_timeout_sec [int]
 
 The time in seconds to wait for the database operation used to validate the connection to complete.
 
 ### max_retries[int]
+
 The number of retries to submit failed (executeBatch)
 
 ### batch_size[int]
-For batch writing, when the number of buffers reaches the number of `batch_size` or the time reaches `batch_interval_ms`, the data will be flushed into the database
+
+For batch writing, when the number of buffers reaches the number of `batch_size` or the time reaches `batch_interval_ms`
+, the data will be flushed into the database
 
 ### batch_interval_ms[int]
-For batch writing, when the number of buffers reaches the number of `batch_size` or the time reaches `batch_interval_ms`, the data will be flushed into the database
+
+For batch writing, when the number of buffers reaches the number of `batch_size` or the time reaches `batch_interval_ms`
+, the data will be flushed into the database
 
 ### is_exactly_once[boolean]
-Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to set `xa_data_source_class_name`.
+
+Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to
+set `xa_data_source_class_name`.
 
 ### xa_data_source_class_name[string]
-The xa data source class name of the database Driver, for example, mysql is `com.mysql.cj.jdbc.MysqlXADataSource`, and please refer to appendix for other data sources
+
+The xa data source class name of the database Driver, for example, mysql is `com.mysql.cj.jdbc.MysqlXADataSource`, and
+please refer to appendix for other data sources
 
 ### max_commit_attempts[int]
+
 The number of retries for transaction commit failures
 
 ### transaction_timeout_sec[int]
-The timeout after the transaction is opened, the default is -1 (never timeout). Note that setting the timeout may affect exactly-once semantics
+
+The timeout after the transaction is opened, the default is -1 (never timeout). Note that setting the timeout may affect
+exactly-once semantics
 
 ## tips
-In the case of is_exactly_once = "true", Xa transactions are used. This requires database support, and some databases require some setup. For example, postgres needs to set `max_prepared_transactions > 1`
+
+In the case of is_exactly_once = "true", Xa transactions are used. This requires database support, and some databases
+require some setup. For example, postgres needs to set `max_prepared_transactions > 1`
 Such as `ALTER SYSTEM set max_prepared_transactions to 10`.
 
 ## appendix
+
 there are some reference value for params above.
 
 | datasource | driver                   | url                                       | xa_data_source_class_name           | maven                                                         |
 |------------|--------------------------|-------------------------------------------|-------------------------------------|---------------------------------------------------------------|
 | mysql      | com.mysql.cj.jdbc.Driver | jdbc:mysql://localhost:3306/test          | com.mysql.cj.jdbc.MysqlXADataSource | https://mvnrepository.com/artifact/mysql/mysql-connector-java |
-| postgresql | org.postgresql.Driver    | jdbc:postgresql://localhost:5432/postgres | org.postgresql.xa.PGXADataSource    | https://mvnrepository.com/artifact/org.postgresql/postgresql  |                                                             |
+| postgresql | org.postgresql.Driver    | jdbc:postgresql://localhost:5432/postgres | org.postgresql.xa.PGXADataSource    | https://mvnrepository.com/artifact/org.postgresql/postgresql  |
 | dm         | dm.jdbc.driver.DmDriver  | jdbc:dm://localhost:5236                  | dm.jdbc.driver.DmdbXADataSource     | https://mvnrepository.com/artifact/com.dameng/DmJdbcDriver18  |
+| sqlserver  | com.microsoft.sqlserver.jdbc.SQLServerDriver  | jdbc:microsoft:sqlserver://localhost:1433       | com.microsoft.sqlserver.jdbc.SQLServerXADataSource     | https://mvnrepository.com/artifact/com.microsoft.sqlserver/mssql-jdbc  |
 
 ## Example
+
 Simple
+
 ```
 jdbc {
     url = "jdbc:mysql://localhost/test"
@@ -99,6 +126,7 @@ jdbc {
 ```
 
 Exactly-once
+
 ```
 jdbc {
 

diff --git a/docs/en/connector-v2/source/Jdbc.md b/docs/en/connector-v2/source/Jdbc.md
@@ -73,8 +73,9 @@ there are some reference value for params above.
 | datasource | driver                   | url                                       | maven                                                         |
 |------------|--------------------------|-------------------------------------------|---------------------------------------------------------------|
 | mysql      | com.mysql.cj.jdbc.Driver | jdbc:mysql://localhost:3306/test          | https://mvnrepository.com/artifact/mysql/mysql-connector-java |
-| postgresql | org.postgresql.Driver    | jdbc:postgresql://localhost:5432/postgres | https://mvnrepository.com/artifact/org.postgresql/postgresql  |                                                             |
+| postgresql | org.postgresql.Driver    | jdbc:postgresql://localhost:5432/postgres | https://mvnrepository.com/artifact/org.postgresql/postgresql  |
 | dm         | dm.jdbc.driver.DmDriver  | jdbc:dm://localhost:5236                  | https://mvnrepository.com/artifact/com.dameng/DmJdbcDriver18  |
+| sqlserver  | com.microsoft.sqlserver.jdbc.SQLServerDriver  | jdbc:microsoft:sqlserver://localhost:1433       | https://mvnrepository.com/artifact/com.microsoft.sqlserver/mssql-jdbc  |
 
 ## Example
 simple: