From 49c7d5618bf0f16d4f0f872429a626f7f6878af6 Mon Sep 17 00:00:00 2001
From: xiaopengm <602012854@qq.com>
Date: Wed, 10 May 2023 10:09:03 +0800
Subject: [PATCH] [feature][plugin][sybase] datax support sybase plugins. #1780
add sybasewriter markdown
---
sybasewriter/doc/sybasewriter.md | 228 +++++++++++++++++++++++++++++++
1 file changed, 228 insertions(+)
create mode 100644 sybasewriter/doc/sybasewriter.md
diff --git a/sybasewriter/doc/sybasewriter.md b/sybasewriter/doc/sybasewriter.md
new file mode 100644
index 00000000..cccc62d6
--- /dev/null
+++ b/sybasewriter/doc/sybasewriter.md
@@ -0,0 +1,228 @@
+# DataX SybaseWriter
+
+
+---
+
+
+## 1 快速介绍
+
+SybaseWriter 插件实现了写入数据到 Sybase 主库的目的表的功能。在底层实现上， SybaseWriter 通过 JDBC 连接远程 Sybase 数据库，并执行相应的 insert into ... 或者 ( replace into ...) 的 sql 语句将数据写入 Sybase，内部会分批次提交入库，需要数据库本身采用 innodb 引擎。
+
+SybaseWriter 面向ETL开发工程师，他们使用 SybaseWriter 从数仓导入数据到 Sybase。同时 SybaseWriter 亦可以作为数据迁移工具为DBA等用户提供服务。
+
+
+## 2 实现原理
+
+SybaseWriter 通过 DataX 框架获取 Reader 生成的协议数据，根据你配置的 `writeMode` 生成
+
+
+* `insert into...`(当主键/唯一性索引冲突时会写不进去冲突的行)
+
+##### 或者
+
+* `replace into...`(没有遇到主键/唯一性索引冲突时，与 insert into 行为一致，冲突时会用新行替换原有行所有字段) 的语句写入数据到 Sybase。出于性能考虑，采用了 `PreparedStatement + Batch`，并且设置了：`rewriteBatchedStatements=true`，将数据缓冲到线程上下文 Buffer 中，当 Buffer 累计到预定阈值时，才发起写入请求。
+
+
+
+ 注意：目的表所在数据库必须是主库才能写入数据；整个任务至少需要具备 insert/replace into...的权限，是否需要其他权限，取决于你任务配置中在 preSql 和 postSql 中指定的语句。
+
+
+## 3 功能说明
+
+### 3.1 配置样例
+
+* 这里使用一份从内存产生到 Sybase 导入的数据。
+
+```json
+{
+ "job": {
+ "setting": {
+ "speed": {
+ "channel": 1
+ }
+ },
+ "content": [
+ {
+ "reader": {
+ "name": "streamreader",
+ "parameter": {
+ "column" : [
+ {
+ "value": "DataX",
+ "type": "string"
+ },
+ {
+ "value": 19880808,
+ "type": "long"
+ },
+ {
+ "value": "1988-08-08 08:08:08",
+ "type": "date"
+ },
+ {
+ "value": true,
+ "type": "bool"
+ },
+ {
+ "value": "test",
+ "type": "bytes"
+ }
+ ],
+ "sliceRecordCount": 1000
+ }
+ },
+ "writer": {
+ "name": "Sybasewriter",
+ "parameter": {
+ "writeMode": "insert",
+ "username": "root",
+ "password": "root",
+ "column": [
+ "id",
+ "name"
+ ],
+ "preSql": [
+ "delete from test"
+ ],
+ "connection": [
+ {
+ "jdbcUrl":"jdbc:sybase:Tds:192.168.1.92:5000/tempdb?charset=cp936",
+ "table": [
+ "test"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+}
+
+```
+
+
+### 3.2 参数说明
+
+* **jdbcUrl**
+
+ * 描述：目的数据库的 JDBC 连接信息。作业运行时，DataX 会在你提供的 jdbcUrl 后面追加如下属性：yearIsDateType=false&zeroDateTimeBehavior=convertToNull&rewriteBatchedStatements=true
+
+ 注意：1、在一个数据库上只能配置一个 jdbcUrl 值。这与 SybaseReader 支持多个备库探测不同，因为此处不支持同一个数据库存在多个主库的情况(双主导入数据情况)
+ 2、jdbcUrl按照Sybase官方规范，并可以填写连接附加控制信息，比如想指定连接编码为 gbk ，则在 jdbcUrl 后面追加属性 useUnicode=true&characterEncoding=gbk。具体请参看 Sybase官方文档或者咨询对应 DBA。
+
+
+ * 必选：是
+
+ * 默认值：无
+
+* **username**
+
+ * 描述：目的数据库的用户名
+
+ * 必选：是
+
+ * 默认值：无
+
+* **password**
+
+ * 描述：目的数据库的密码
+
+ * 必选：是
+
+ * 默认值：无
+
+* **table**
+
+ * 描述：目的表的表名称。支持写入一个或者多个表。当配置为多张表时，必须确保所有表结构保持一致。
+
+ 注意：table 和 jdbcUrl 必须包含在 connection 配置单元中
+
+ * 必选：是
+
+ * 默认值：无
+
+* **column**
+
+ * 描述：目的表需要写入数据的字段,字段之间用英文逗号分隔。例如: "column": ["id","name","age"]。如果要依次写入全部列，使用`*`表示, 例如: `"column": ["*"]`。
+
+ **column配置项必须指定，不能留空！**
+
+ 注意：1、我们强烈不推荐你这样配置，因为当你目的表字段个数、类型等有改动时，你的任务可能运行不正确或者失败
+ 2、 column 不能配置任何常量值
+
+ * 必选：是
+
+ * 默认值：否
+
+* **preSql**
+
+ * 描述：写入数据到目的表前，会先执行这里的标准语句。如果 Sql 中有你需要操作到的表名称，请使用 `@table` 表示，这样在实际执行 Sql 语句时，会对变量按照实际表名称进行替换。比如你的任务是要写入到目的端的100个同构分表(表名称为:datax_00,datax01, ... datax_98,datax_99)，并且你希望导入数据前，先对表中数据进行删除操作，那么你可以这样配置：`"preSql":["delete from 表名"]`，效果是：在执行到每个表写入数据前，会先执行对应的 delete from 对应表名称
+
+ * 必选：否
+
+ * 默认值：无
+
+* **postSql**
+
+ * 描述：写入数据到目的表后，会执行这里的标准语句。（原理同 preSql ）
+
+ * 必选：否
+
+ * 默认值：无
+
+* **writeMode**
+
+ * 描述：控制写入数据到目标表采用 `insert into` 或者 `replace into` 或者 `ON DUPLICATE KEY UPDATE` 语句
+
+ * 必选：是
+
+ * 所有选项：insert/replace/update
+
+ * 默认值：insert
+
+* **batchSize**
+
+ * 描述：一次性批量提交的记录数大小，该值可以极大减少DataX与Sybase的网络交互次数，并提升整体吞吐量。但是该值设置过大可能会造成DataX运行进程OOM情况。
+
+ * 必选：否
+
+ * 默认值：1024
+
+
+### 3.3 类型转换
+
+类似 SybaseReader ，目前 SybaseWriter 支持大部分 Sybase 类型，但也存在部分个别类型没有支持的情况，请注意检查你的类型。
+
+下面列出 SybaseWriter 针对 Sybase 类型转换列表:
+
+
+| DataX 内部类型| Sybase 数据类型 |
+| -------- | ----- |
+| Long |Tinyint,Smallint,Int,Money,Smallmoney|
+| Double |Float,Real,Numeric,Decimal|
+| String |Char,Varchar,Nchar,Nvarchar,Text|
+| Date |Timestamp,Datetime,Smalldatetime|
+| Boolean |bit, bool|
+| Bytes |Binary,Varbinary,Image|
+
+## 4 性能报告
+
+
+## 5 约束限制
+
+
+
+
+## FAQ
+
+***
+
+**Q: 目前已验证支持sybase的版本？**
+
+A: Sybase ASE 16/15.7
+
+**Q: SybaseReader同步报错，报错信息为XXX**
+
+A: 网络或者权限问题，请使用Sybase命令行或者可视化工具进行测试：
+如果上述命令也报错，那可以证实是环境问题，请联系你的DBA。