大数据开发治理平台 DataWorks：PostgreSQL数据源

支持的版本

目前仅支持配置PostgreSQL数据源为PostgreSQL10、11、12、13、14、15版本。您可以通过如下语句查看PostgreSQL数据库的版本。

SHOW SERVER_VERSION;

使用限制

离线读写

PostgreSQL数据源支持Password认证方式（支持SCRAM-SHA-256认证方式），如果PostgreSQL数据库端更改了密码和密码认证方式，则需要更新数据源配置，并且重新测试连通性和手动运行相关任务验证。

"parameter": {
    "datasource": "abc",
    "column": [
        "id",
        "\"123Test\"", //添加转义符
],
"where": "",
"splitPk": "id",
"table": "public.wpw_test"
},

实时读

支持的字段类型

离线读写

支持大部分PostgreSQL类型，但也存在部分类型没有支持的情况，请注意检查您的数据类型。

数据同步前准备：PostgreSQL环境准备

在DataWorks上进行数据同步前，您需要参考本文提前在PostgreSQL侧进行数据同步环境准备，以便在DataWorks上进行PostgreSQL数据同步任务配置与执行时服务正常。以下为您介绍PostgreSQL同步前的相关环境准备。

准备工作1：创建账号并配置账号权限

您需要规划一个数据库的登录账号用于后续执行操作，此账号需要拥有数据库的REPLICATION、 LOGIN权限。

1. 创建账号。

   操作详情请参见创建账号和数据库。

2. 配置权限。

   检查账号是否有replication权限。

   select userepl from pg_user where usename='xxx'

   预期返回结果为True，返回False则表示无权限，您可以通过如下语句进行授权。

   ALTER USER <user> REPLICATION;

准备工作2：检查是否支持备库

SELECT pg_is_in_recovery()

目前仅支持主库，预期返回结果为False，返回True时表示是备库，实时同步不支持备库，需修改数据源配置信息为主库的信息，请参见配置PostgreSQL数据源。

准备工作3：检查wal_level是否为logical

show wal_level

wal_level指定了wal_log的级别，预期返回结果为logical，否则不支持逻辑复制机制。

准备工作4：检查是否可以启动wal_sender进程

-- 查询 max_wal_senders
show max_wal_senders;

-- 查询 pg_stat_replication 数量
select count(*) from pg_stat_replication

当max_wal_senders不为空，且max_wal_senders值大于pg_stat_replication数量时，则表示有空闲可用的wal_sender进程。PostgreSQL数据库会为同步数据程序启动wal_sender进程来给订阅者发送日志。

对于每一个需要同步的表，需要手动执行ALTER TABLE [tableName] REPLICA IDENTITY FULL语句进行授权，否则实时同步任务会报错。

PostgreSQL实时同步任务启动后，会在数据库中自动创建slot、publications，slot名称格式为：di_slot_ + 解决方案ID ，publication名称格式为：di_pub_ + 解决方案ID，当实时同步任务停止或下线后，需手动删除，否则可能会导致PostgreSQL WAL持续增长。

数据同步任务开发：PostgreSQL同步流程引导

PostgreSQL数据同步任务的配置入口和通用配置流程指导可参见下文的配置指导，详细的配置参数解释可在配置界面查看对应参数的文案提示。

创建数据源

在进行数据同步任务开发时，您需要在DataWorks上创建一个对应的数据源，操作流程请参见创建并管理数据源。

如果您的PostgreSQL数据库开启了SSL认证，那么您在添加DataWorks的PostgreSQL数据源时也需要开启SSL认证，具体操作流程请参见附录二：PostgreSQL数据源增加SSL认证。

单表离线同步任务配置指导

• 操作流程请参见通过向导模式配置离线同步任务、通过脚本模式配置离线同步任务。

• 脚本模式配置的全量参数和脚本Demo请参见下文的附录一：PostgreSQL脚本Demo与参数说明。

整库离线读、单表/整库全增量实时读等同步任务配置指导

操作流程请参见数据集成侧同步任务配置。

常见问题

• 主备同步数据恢复问题

  主备同步问题指PostgreSQL使用主从灾备，备库从主库不间断恢复数据。由于主备数据同步存在一定的时间差，特别在于某些特定情况，例如网络延迟等问题，导致备库同步恢复的数据与主库有较大差别，从备库同步的数据不是一份当前时间的完整镜像。

• 一致性约束

  PostgreSQL在数据存储划分中属于RDBMS系统，对外可以提供强一致性数据查询接口。例如一次同步任务启动运行过程中，当该库存在其他数据写入方写入数据时，由于数据库本身的快照特性，PostgreSQL Reader完全不会获取到写入的更新数据。

  上述是在PostgreSQL Reader单线程模型下数据同步一致性的特性，PostgreSQL Reader可以根据您配置的信息使用并发数据抽取，因此不能严格保证数据一致性。

  当PostgreSQL Reader根据splitPk进行数据切分后，会先后启动多个并发任务完成数据同步。多个并发任务相互之间不属于同一个读事务，同时多个并发任务存在时间间隔，因此这份数据并不是完整的、一致的数据快照信息。

  针对多线程的一致性快照需求，目前在技术上无法实现，只能从工程角度解决。工程化的方式存在取舍，在此提供以下解决思路，您可以根据自身情况进行选择。

  • 使用单线程同步，即不再进行数据切片。缺点是速度比较慢，但是能够很好保证一致性。

  • 关闭其它数据写入方，保证当前数据为静态数据，例如锁表、关闭备库同步等。缺点是可能影响在线业务。

• 数据库编码问题

  PostgreSQL在服务器端仅支持EUC_CN和UTF-8两种简体中文编码，PostgreSQL Reader底层使用JDBC进行数据抽取，JDBC天然适配各类编码，并在底层进行了编码转换。因此PostgreSQL Reader不需您指定编码，可以自动获取编码并转码。

  对于PostgreSQL底层写入编码和其设定的编码不一致的混乱情况，PostgreSQL Reader对此无法识别，也无法提供解决方案，导出结果有可能为乱码。

• 增量数据同步的方式

  PostgreSQL Reader使用JDBC SELECT语句完成数据抽取工作，因此可以使用SELECT…WHERE…进行增量数据抽取，方式如下：

  • 数据库在线应用写入数据库时，填充modify字段为更改时间戳，包括新增、更新、删除（逻辑删除）。对于该类应用，PostgreSQL Reader只需要where条件后跟上一同步阶段时间戳即可。

  • 对于新增流水型数据，PostgreSQL Reader在where条件后跟上一阶段最大自增ID即可。

  对于业务上无字段区分新增、修改数据的情况，PostgreSQL Reader无法进行增量数据同步，只能同步全量数据。

• SQL安全性

  PostgreSQL Reader提供querySql语句交给您自己实现SELECT抽取语句，PostgreSQL Reader本身对querySql不进行任何安全性校验。

附录一：PostgreSQL脚本Demo与参数说明

附录：离线任务脚本配置方式

如果您配置离线任务时使用脚本模式的方式进行配置，您需要在任务脚本中按照脚本的统一格式要求编写脚本中的reader参数和writer参数，脚本模式的统一要求请参见通过脚本模式配置离线同步任务，以下为您介绍脚本模式下的数据源的Reader参数和Writer参数的指导详情。

PostgreSQL Reader脚本Demo

{
    "type":"job",
    "version":"2.0",//版本号。
    "steps":[
        {
            "stepType":"postgresql",//插件名。
            "parameter":{
                "datasource":"",//数据源。
                "column":[//字段。
                    "col1",
                    "col2"
                ],
                "where":"",//筛选条件。
                "splitPk":"",//用splitPk代表的字段进行数据分片，数据同步会启动并发任务进行数据同步。
                "table":""//表名。
            },
            "name":"Reader",
            "category":"reader"
        },
        { 
            "stepType":"stream",
            "parameter":{},
            "name":"Writer",
            "category":"writer"
        }
    ],
    "setting":{
        "errorLimit":{
            "record":"0"//错误记录数。
        },
        "speed":{
            "throttle":true, //当throttle值为false时，mbps参数不生效，表示不限流；当throttle值为true时,表示限流。
            "concurrent":1, //作业并发数。
            "mbps":"12"//限流，此处1mbps = 1MB/s。
        }
    },
    "order":{
        "hops":[
            {
                "from":"Reader",
                "to":"Writer"
            }
        ]
    }
}

PostgreSQL Reader脚本参数

PostgreSQL Writer脚本Demo

{
  "type":"job",
  "version":"2.0",//版本号。
  "steps":[ 
    {
      "stepType":"stream",
      "parameter":{},
      "name":"Reader",
      "category":"reader"
    },
    {
      "stepType":"postgresql",//插件名。
      "parameter":{
        "datasource":"",//数据源。
        "column":[// 字段。
          "col1",
          "col2"
        ],
        "table":"",//表名。
        "preSql":[],//执行数据同步任务之前率先执行的SQL语句。
        "postSql":[],//执行数据同步任务之后率先执行的SQL语句。
      },
      "name":"Writer",
      "category":"writer"
    }
  ],
  "setting":{
    "errorLimit":{
      "record":"0"//错误记录数
    },
    "speed":{
      "throttle":true,//当throttle值为false时，mbps参数不生效，表示不限流；当throttle值为true时,表示限流。
      "concurrent":1, //作业并发数。
      "mbps":"12"//限流，此处1mbps = 1MB/s。
    }
  },
  "order":{
    "hops":[
      {
        "from":"Reader",
        "to":"Writer"
      }
    ]
  }
}

PostgreSQLe Writer脚本参数

{
    "job":
    {
        "content":
        [{
            "reader": {...},
            "writer":
            {
                "parameter":
                {
                    "column":
                    [
                        // 目标表字段列表
                        "bigint_arr",
                        "double_arr",
                        "text_arr",
                        "jsonb_obj",
                        "json_obj"
                    ],
                    "pgType":
                    {
                        // 特殊的类型设置，key为目标表的字段名，value为字段类型。
                        "bigint_arr": "bigint[]",
                        "double_arr": "double[]",
                        "text_arr": "text[]",
                        "jsonb_obj": "jsonb",
                        "json_obj": "json"
                    }

                }
            }
        }]
    }
}

附录二：PostgreSQL数据源增加SSL认证