Skip to content

Latest commit

 

History

History
101 lines (62 loc) · 2.8 KB

postgresqlreader.md

File metadata and controls

101 lines (62 loc) · 2.8 KB

PostgreSQL读取插件（postgresqlreader）

1. 配置样例

{
	"job":{
		"content":[{
			"reader":{
				"parameter":{
					"username": "postgres",
					"password": "postgres",
					"connection": [{
						"jdbcUrl": ["jdbc:postgresql://localhost:5432/postgres"],
						"table": ["tableTest"]
					}],
					"splitPk": "id",
					"column": ["id", "tenant_id"],
					"where": "id > 0"
				},
				"name":"postgresqlreader"
			},
			"writer":{}
		}]
	}
}

2. 参数说明

  • name

    • 描述：插件名，此处只能填postgresqlreader，否则Flinkx将无法正常加载该插件包。

    • 必选：是

    • 默认值：无

  • jdbcUrl

    • 描述：针对PostgreSQL数据库的jdbc连接字符串

      jdbcUrl按照PostgreSQL官方规范，并可以填写连接附件控制信息。具体请参看PostgreSQL官方文档。

    • 必选：是

    • 默认值：无

  • username

    • 描述：数据源的用户名

    • 必选：是

    • 默认值：无

  • password

    • 描述：数据源指定用户名的密码

    • 必选：是

    • 默认值：无

  • where

    • 描述：筛选条件，PostgreSQLReader根据指定的column、table、where条件拼接SQL，并根据这个SQL进行数据抽取。在实际业务场景中，往往会选择当天的数据进行同步，可以将where条件指定为gmt_create > $bizdate 。注意：不可以将where条件指定为limit 10，limit不是SQL的合法where子句。

      where条件可以有效地进行业务增量同步。如果不填写where语句，包括不提供where的key或者value，FlinkX均视作同步全量数据。

    • 必选：否

    • 默认值：无

  • splitPk

    • 描述：PostgreSQLReader进行数据抽取时，如果指定splitPk，表示用户希望使用splitPk代表的字段进行数据分片，FlinkX因此会启动并发任务进行数据同步，这样可以大大提供数据同步的效能。

      推荐splitPk用户使用表主键，因为表主键通常情况下比较均匀，因此切分出来的分片也不容易出现数据热点。

     目前splitPk仅支持整形数据切分，不支持浮点、字符串、日期等其他类型。如果用户指定其他非支持类型，PostgreSQLReader将报错！

     如果splitPk不填写，包括不提供splitPk或者splitPk值为空，FlinkX视作使用单通道同步该表数据。

    • 必选：否

    • 默认值：空

  • column

    • 描述：所配置的表中需要同步的列名集合。

      支持列裁剪，即列可以挑选部分列进行导出。

      支持列换序，即列可以不按照表schema信息进行导出。

      暂不支持常量列。

    • 必选：是

    • 默认值：无