# SQLServer同步到DWS作业配置 #### 支持的源端和目的端数据库版本 表1支持的数据库版本 | 源端数据库 | 目的端数据库 | |:---|:---| | SQLServer数据库（企业版2016、2017、2019、2022版本，标准版2016 SP2及以上版本、2017、2019、2022版本） | DWS集群（8.1.3、8.2.0及以上版本（除DWS 3.0）） | #### 数据库账号权限要求 在使用Migration进行同步时，源端和目的端所使用的数据库账号需要满足以下权限要求，才能启动实时同步任务。不同类型的同步任务，需要的账号权限也不同，详细可参考下表进行赋权。 表2数据库账号权限 | 类型名称 | 权限要求 | |:---|:---| | 源数据库连接账号 | 需要具备sysadmin权限，或者view server state权限以及待同步数据库的db_datareader或db_owner权限。 - 启动数据库及表的CDC能力。 1. 启用数据库CDC。 ``` USE YourDatabaseName; EXEC sys.sp_cdc_enable_db; -- 查看数据库是否启动CDC SELECT is_cdc_enabled, name FROM sys.databases WHERE name = 'YourDatabaseName' ``` 2. 启用表CDC。 ``` EXEC sys.sp_cdc_enable_table @source_schema = N'dbo', -- Schema @source_name = N'YourTable',-- 表名 @role_name = NULL,-- 可选，CDC访问角色名称 @supports_net_changes = 0; -- 查看表是否启动CDC SELECT name,is_tracked_by_cdc FROM sys.tables WHERE name = 'YourTable'; ``` - 源端SQLServer需要给管理中心数据连接中配置的用户赋予以下全部权限。 - 给用户添加数据库CONNECT, VIEW DATABASE STATE 权限。 ``` USE YourDatabaseName; GRANT CONNECT, VIEW DATABASE STATE TO [YourUserName]; ``` - 给用户添加CDC schema的SELECT 权限。 ``` USE YourDatabaseName; GRANT SELECT ON SCHEMA::[cdc] TO [YourUserName]; ``` - 给用户添加表的SELECT权限。 ``` USE YourDatabaseName; GRANT SELECT ON OBJECT::[YourSchema].[YourTable] TO [YourUserName]; ``` | | 目标数据库连接账号 | 目标数据库的每张表必须具有如下权限：INSERT、SELECT、UPDATE、DELETE、CONNECT、CREATE。 | ![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) - 建议创建单独用于Migration任务连接的数据库账号，避免因为数据库账号密码修改，导致的任务连接失败。 - 连接源和目标数据库的账号密码修改后，请同步修改管理中心对应的连接信息，避免任务连接失败后自动重试，导致数据库账号被锁定影响使用。 #### 支持的同步对象范围 在使用Migration进行同步时，不同类型的链路，支持的同步对象范围不同，详细情况可参考下表。 表3同步对象范围 | 类型名称 | 使用须知 | |:---|:---| | 同步对象范围 | - 支持同步DML：包括INSERT、UPDATE、DELETE。 - 不支持同步DDL。 - 仅支持同步主键表。 - 不支持同步源数据库中开启TDE（Transparent Data Encryption）加密的数据库。 - 不支持列加密。 - 不支持同步自增属性列。 - 自动建表支持同步表结构、普通索引、约束（主键、空、非空）、注释。 | #### 注意事项 除了数据源版本、连接账号权限及同步对象范围外，您还需要注意的事项请参见下表。 表4注意事项 | 类型名称 | 使用和操作限制 | |:---|:---| | 数据库限制 | - 目标数据库中的库名、表名、字段名仅支持数字、字母和下划线，且字段名必须以字母或下划线开头，建议尽量使用常规字符避免任务失败。 - 源数据库如果开启客户端配置中的"强制协议加密（Force Protocol Encryption）"，必须同时开启"信任服务器证书（trust server certificate）"，如下图所示： 图1查看客户端属性 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002211027033.png "点击放大") | | 使用限制 | 通用： 实时同步过程中，不支持IP、端口、账号、密码修改。 全量同步阶段： 任务启动和全量数据同步阶段，请不要在源数据库执行DDL操作，否则可能导致任务异常。 增量同步阶段： - 支持DML：包括INSERT、UPDATE、DELETE。 - 不支持DDL操作，源数据库进行的DDL操作不会同步到目标数据库。 - 不支持大数据类型IMAGE、TEXT、NTEXT的删除操作。 - 同步过程不支持修改作业中的表。 常见故障排查： 在任务创建、启动、全量同步、增量同步、结束等过程中，如有遇到问题，可先参考[常见问题](https://support.huaweicloud.com/dataartsstudio_faq/dataartsstudio_03_7594.html)章节进行排查。 | | 其他限制 | - 支持目标数据库中的表比源数据库少列场景；也支持目标数据库中的表比源数据库多列场景，但是需要避免以下场景可能导致的任务失败。 - 目标数据库多的列要求非空且没有默认值，源数据库insert数据，同步到目标数据库后多的列为null，不符合目标数据库要求。 - 目标数据库多的列设置固定默认值，且有唯一约束。源数据库insert多条数据后，同步到目标数据库后多的列为固定默认值，不符合目标数据库要求。 - 不支持源数据库主备切换，源数据库主备切换会导致同步任务失败。 - 不支持源数据库Microsoft SQL Server为TLS 1.0、TLS 1.1协议的同步，如果需要同步，建议源库升级到TLS 1.2及以上版本。 - 目标数据库的block_size参数值必须大于源库中的对应参数值。 - Migration自动建表时，源库中char、varchar、nvarchar字符类型长度在目标库会按照字节长自动扩大（因为DWS目标库为字节长）。 | #### 操作步骤 本小节以Microsoft SQL Server到DWS的实时同步为示例，介绍如何配置Migration实时集成作业。配置作业前请务必阅读[使用前自检概览](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_7621.html)， 确认已做好所有准备工作。 1. 参见[新建实时集成作业](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_1603.html)创建一个实时集成作业并进入作业配置界面。 2. 选择数据连接类型：源端选SQLServer，目的端选DWS。 图2选择数据连接类型 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002160423886.png "点击放大") 3. 选择集成作业类型：同步类型默认为实时，同步场景包含整库场景。 图3选择集成作业类型 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002209491913.png "点击放大") ![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) 同步场景相关介绍请参见[同步场景](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_1601.html#dataartsstudio_01_1601__section1644461120563)。 4. 配置网络资源：选择已创建的SQLServer、DWS数据连接和已配置好网络连接的migration资源组。 图4选择数据连接及migration资源组 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002134336073.png "点击放大") ![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) 无可选数据连接时，可单击"新建"跳转至管理中心数据连接界面，单击"创建数据连接"创建数据连接，详情请参见[配置DataArts Studio数据连接参数](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_0009.html)进行配置。 无可选migration资源组时，可单击"新建"跳转至购买migration资源组页面创建migration资源组配置，详情请参见[购买创建数据集成资源组增量包](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_0145.html)进行配置。 5. 检测网络连通性：数据连接和migration资源组配置完成后需要测试整个迁移任务的网络连通性，可通过以下方式进行数据源和migration资源组之间的连通性测试。 - 单击展开"源端配置"触发连通性测试，会对整个迁移任务的连通性做校验。 - 单击源端和目的端数据源和migration资源组中的"测试"按钮进行检测。 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) 网络连通性检测异常可先参考[数据源和资源组网络不通如何排查？](https://support.huaweicloud.com/dataartsstudio_faq/dataartsstudio_03_7595.html)章节进行排查。 6. 配置源端参数。 选择需要迁移的SQLServer库表。 图5选择库表 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002195794693.png "点击放大") 库与表均支持自定义选择，即可选择一库一表，也可选择多库多表。 7. 配置目的端参数。 - 源库表和目标匹配策略。 各同步场景下源端库表和目标端库表的匹配策略请参考下表。 表5源库表和目标匹配策略 | 同步场景 | 配置方式 | |:---|:---| | 整库 | - Schema匹配策略。 - 与来源库同名：数据将同步至与来源SQLServer库名相同的DWS Schema中。 - 自定义：数据将同步至自行指定的DWS Schema中。 - 表匹配策略。 - 与来源表同名：数据将同步至与来源SQLServer表名相同的DWS表中。 - 自定义：数据将同步至自行指定的DWS表中。 图6整库场景下源库表和目标匹配策略 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002195920349.png "点击放大") 说明： 自定义匹配策略时，支持用内置变量#{source_db_name}和#{source_table_name}标志来源的库名和表名，其中表匹配策略必须包含#{source_table_name}。 | - DWS参数配置。 其余DWS目的端参数说明请参考下表。 图7DWS配置项 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002098696976.png "点击放大") 表6DWS配置项 | 配置项 | 默认值 | 单位 | 配置说明 | |:---|:---|:---|:---| | 写入模式 | UPSERT | - | - UPSERT MODE：批量更新入库模式。 - COPY MODE：DWS专有的高性能批量入库模式。 | | 批写最大数据量 | 50000 | 条 | 单批次写入DWS数据的条数，可根据表数据大小和作业内存使用适当调整。 | | 定时批写时间间隔 | 3 | 秒 | 支持配置每批次数据写入DWS的时间间隔。 | | 高级配置 | - | - | 通过配置各参数实现部分高级功能。 单击高级配置下的"查看编辑"，可在"表属性全局配置"对话框配置以下参数： - 存储模式：指定自动建表中数据的存储方式，支持行模式和列模式。 - 存储版本：存储模式为列模式时显示该参数，指定列存存储格式的版本。 支持以下格式： - DEFAULT：不设置colversion参数，使用DWS默认配置。 - 1.0：设置colversion=1.0，适用于8.1.0及以下DWS集群。 - 2.0：设置colversion=2.0，适用于8.1.1及以上DWS集群。 - 3.0：设置colversion=3.0，适用于9.0.X及以上版本，3.0版本为存算分离版本，默认创建列存表，存储模式配置不生效。 - 是否压缩：存储模式为列模式时显示该参数，指定自动建表中数据是否压缩。 - 扩大字符字段长度：当自动创建目的表时，目标表的字符类型字段长度设置为源表相应字段长度的4倍。如果源数据库与目标数据库字符编码不一样，且源表字符类型字段与目的表一样，在迁移数据时可能会有长度不足错误。默认勾选。 - 使用非空约束：当自动创建目的表时，如果选择使用非空约束，则目的表字段是否非空约束与原表具有相应非空约束的字段保持一致。默认勾选。 - 表自定义属性：通过自定义参数配置部分功能，参数详情可参考DWS高级配置一览表。 | 表7DWS高级配置一览表 | 参数名 | 参数类型 | 默认值 | 单位 | 参数说明 | |:---|:---|:---|:---|:---| | sink.buffer-flush.max-size | int | 512 | MB | 写入DWS时每批数据的最大字节数，可根据作业配置内存和数据大小适当调整。 | | sink.keyby.enable | boolean | true | - | 数据分流开关，在多并发场景下开启数据分流可将数据按规则分配给不同的工作进程写入目的端，可提高写入性能。 | | sink.keyby.mode | string | table | - | 数据分流模式，可选填写： - pk：按数据主键值进行分流。 - table：按表名进行分流。 说明： - 多并发场景下，若开启DDL功能，只能按表名分流，否则可能导致数据不一致。 - 确保不会有DDL时，可以选择按主键分流，多并发场景下可提高写入性能。 | | sink.field.name.case-sensitive | boolean | true | - | 同步数据大小写敏感开关，开启后在同步数据时对库名、表名、字段名大小写均敏感。 | | sink.verify.column-number | boolean | false | - | 校验数据列数的开关，链路默认以同名映射方式同步数据，不检验是否所有列均同步。 开启本开关后，若源端与目的端列数不同将认为是数据不一致的场景，导致作业异常。 | | sink.server.timezone | string | 本地时区 | - | 连接目的端数据库时指定的session时区，支持时区标准写法，例如UTC+8等。 | | logical.delete.enabled | boolean | false | - | 逻辑删除开关，开启本开关后，需要目的端包含删除标记列，在源端删除数据，不会将目的端对应的数据删除，而是将删除标记列设为true，表示该数据在源端已不存在。 | | logical.delete.column | string | logical_is_deleted | - | 逻辑删除标记列名称，默认为logical_is_deleted，支持用户自定义。 | | sink.ddl.isCreateIndex | string | true | - | 同步源端索引开关，开启后在自动建表时会同步源端的索引。 | | exclude.extend.char.length.field.type | string | - | - | 指定不需要扩展的字段类型，多个字段类型使用逗号分隔。 说明： 须确保已勾选DWS配置项中的扩大字符字段长度使该参数生效。 | | exclude.extend.char.length.field.name | string | - | - | 指定不需要扩展的字段名，多个字段名使用逗号分隔。 说明： 须确保已勾选DWS配置项中的扩大字符字段长度使该参数生效。 | 8. 刷新源表和目标表映射，检查映射关系是否正确，同时可根据需求修改表属性、添加附加字段，并通过"自动建表"能力在目的端DWS数据库中建出相应的表。 图8源表与目标表映射 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002195794705.png "点击放大") - 附加字段编辑：单击操作列"附加字段编辑"可为目的端的DWS表中增加自定义字段，同时附加字段也会额外加入到DWS表的建表中。用户可以在已有的源表字段基础上添加多个附加字段，并自定义字段名、选择字段类型、填写字段值。 - 字段名称：目的端DWS表新增字段的名称。 - 字段类型：目的端DWS表新增字段的类型。 - 字段值：目的端DWS表新增字段的取值来源。 表8附加字段取值方式 | 类型 | 示例 | |:---|:---| | 常量 | 支持数字、字母、中文、特殊字符。彩色表情字符可能导致作业提交失败，需谨慎使用。 | | 内置变量 | - 源端host ip地址：source.host。 - 源端schema名称：source.schema。 - 源端table名称：source.table。 - 目的端schema名称：target.schema。 - 目的端table名称：target.table。 | | 源表字段 | 源表中的任一字段。 配置附加字段的取值来源于源表字段时，请注意任务运行过程中不能修改对应源表字段的名称，否则可能导致作业异常。 | | udf方法 | - substring： 截取源端col列的子串, 范围在\[pos, pos+len)。 - date_format： 将源端col列按time_format格式化, 可选转换时区。 - now(\[tz\])： 获取指定时区的当前时间。 - if(cond_exp, str1, str2)： 满足条件表达式cond_exp时返回str1, 否则返回str2。 - concat： 拼接多个参数, 可为源端列或字符串。 - from_unixtime： 将unix时间戳按time_format格式化。 - unix_timestamp： 将时间转成unix时间戳，可显式定义时间格式及转换后精度。 | - 自动建表：单击"自动建表"可按照已配置映射规则在目的端数据库自动建表，成功后表建立方式会显示为使用已有表。 图9自动建表 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002525498778.png "点击放大") ![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png) - Migration仅支持自动建表，不支持自动建库和模式，需用户自行在目的端手动建出库和模式后再使用本功能建表。 - 自动建表时对应的字段类型映射关系请参见[字段映射关系](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_1615.html)章节。 9. 配置任务属性。 表9任务配置参数说明 | 参数 | 说明 | 默认值 | |:---|:---|:---| | 执行内存 | 作业执行分配内存，跟随处理器核数变化而自动变化。 | 8GB | | 处理器核数 | 范围：2-32。 每增加1处理核数，则自动增加4G执行内存和1并发数。 | 2 | | 并发数 | 作业执行支持并发数。该参数无需配置，跟随处理器核数变化而自动变化。 | 1 | | 自动重试 | 作业失败时是否开启自动重试。 | 否 | | 最大重试次数 | "自动重试"为是时显示该参数。 | 1 | | 重试间隔时间 | "自动重试"为是时显示该参数。 | 120秒 | | 是否写入脏数据 | 选择是否记录脏数据，默认不记录脏数据，当脏数据过多时，会影响同步任务的整体同步速度。 - 否：默认为否，不记录脏数据。 表示不允许脏数据存在。如果同步过程中产生脏数据，任务将失败退出。 - 是：允许脏数据，即任务产生脏数据时不影响任务执行。 允许脏数据并设置其阈值时： - 若产生的脏数据在阈值范围内，同步任务将忽略脏数据（即不会写入目标端），并正常执行。 - 若产生的脏数据超出阈值范围，同步任务将失败退出。 说明： 脏数据认定标准：脏数据是对业务没有意义，格式非法或者同步过程中出现问题的数据；单条数据写入目标数据源过程中发生了异常，则此条数据为脏数据。 因此只要是写入失败的数据均被归类于脏数据。 例如，源端是VARCHAR类型的数据写到INT类型的目标列中，则会因为转换不合理导致脏数据不会成功写入目的端。用户可以在同步任务配置时，配置同步过程中是否写入脏数据，配置脏数据条数（单个分片的最大错误记录数）保证任务运行，即当脏数据超过指定条数时，任务失败退出。 | 否 | | 脏数据策略 | "是否写入脏数据"为是时显示该参数，当前支持以下策略： - 不归档：不对脏数据进行存储，仅记录到任务日志中。 - 归档到OBS：将脏数据存储到OBS中，并打印到任务日志中。 | 不归档 | | 脏数据写入连接 | "脏数据策略"选择归档到OBS时显示该参数。 脏数据要写入的连接，目前只支持写入到OBS连接。 | - | | 脏数据目录 | 脏数据写入的OBS目录。 | - | | 脏数据阈值 | 是否写入脏数据为是时显示该参数。 用户根据实际设置脏数据阈值。 说明： - 脏数据阈值仅针对每个并发生效。比如阈值为100，并发为3，则该作业可容忍的脏数据条数最多为300。 - 输入-1表示不限制脏数据条数。 | 100 | | 是否开启心跳表功能 | 选择是否开启心跳表功能，默认不开启。 如果开启心跳表，实时集成作业将会在源端创建心跳表（如果不存在的话），作业运行阶段会定时往心跳表更新数据。 - 请确保数据源实例可写。 - 请确保账号有心跳表建表权限（如果心跳表不存在）、心跳表写入权限、心跳表抽取权限。 | 否 | | 模式或表空间 | 心跳表所在的模式或者表空间名。 | test_database | | 表名 | 心跳表表名。 如果表不存在，实时集成作业将会自动创建，请确保数据源连接所对应的账号有建表权限。 用户可以手动建表，建表格式参见[心跳表格式](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_7992.html)。 | test_hearbeat_table | | 心跳生成间隔 | 实时集成作业将按照此时间间隔生成并写入心跳数据到心跳表，单位秒。 | 10 | | 输出统计信息 | 选择是否开启输出统计信息功能，默认不开启。 输出统计信息开启，实时作业会将会每个批次的写入统计信息输出到指定的topic中。 用户可以消费该topic数据用于时效性分析及数据统计。 统计信息格式格式请参考[统计信息格式介绍](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_7827.html)。 | 否 | | 输出策略 | 统计信息的输出策略，目前支持写入到DMS Kafka或者日志。 | 输出到Kafka | | 输出连接 | 选择写入统计信息的连接。 说明： - 无可选数据连接时，可单击"新建"跳转至管理中心数据连接界面，单击"创建数据连接"创建数据连接，详情请参见[配置DataArts Studio数据连接参数](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_0009.html)进行配置。 - 请确保该连接对应的数据源与资源组是连通的，单击"测试连通性"校验数据源到资源组的连通性，网络连通性检测异常可先参考[数据源和资源组网络不通如何排查？](https://support.huaweicloud.com/dataartsstudio_faq/dataartsstudio_03_7595.html)章节进行排查。 | - | | 输出主题 | 统计信息要写入的Topic，只能填写一个。 | - | | 失败是否抛出异常 | 输出统计信息失败时作业是否抛出异常。 | 否 | | 添加自定义属性 | 支持通过自定义属性修改部分作业参数及开启部分高级功能，详情可参见[任务性能调优](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_7653.html)章节。 | - | 10. 提交并运行任务。 作业配置完毕后，单击作业开发页面左上角"提交"，完成作业提交。 图10提交作业 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002195920361.png "点击放大") 提交成功后，单击作业开发页面"启动"按钮，在弹出的启动配置对话框按照实际情况配置同步位点参数，单击"确定"启动作业。 图11启动配置 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002151886786.png "点击放大") 表10启动配置参数 | 参数 | 说明 | |:---|:---| | 同步模式 | - 增量同步：从指定时间位点开始同步增量数据。 - 全量+增量：先同步全量数据，随后实时同步增量数据。 | | 时间 | 增量同步需要设置该参数，指示增量同步起始的时间位点。 说明： 配置的位点时间早于CDC日志最早时间点时，默认会以日志最新时间点开始消费。 | 11. 监控作业。 通过单击作业开发页面导航栏的"前往监控"按钮，可前往作业监控页面查看运行情况、监控日志等信息，并配置对应的告警规则，详情请参见[实时集成任务运维](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_1622.html)。 图12前往监控 ![](https://support.huaweicloud.com/usermanual-dataartsstudio/zh-cn_image_0000002098536316.png "点击放大") #### 性能调优 若链路同步速度过慢，可参见[任务性能调优](https://support.huaweicloud.com/usermanual-dataartsstudio/dataartsstudio_01_7653.html)章节中对应链路文档进行排查及处理。