PostgreSQL同步

February 26, 2024About 5 min

PostgreSQL同步

SDK类名:/active/Postgres

同步规则 - 列表

SDK方法名:listPgsqlRule

URL

/pgsql/rule

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
pageNumber1
limitNumber10
search_fieldString
search_valueString
group_uuidString
where_argsObject
  rule_uuidString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  totalNumber5
  info_listArray2
    rule_uuidArray[
"6FBC9EB9-A10A-E226-9F2B-A77B3CF1D337",
"3BF809AF-4A2E-DD28-072E-530D33BAC189"
]
+1
    rule_nameArray["Ronald Lopez","Melissa Brown"]+1
    src_db_uuidString
    tgt_db_uuidString
    tgt_typeStringkafka
    user_uuidString1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
    tgt_db_nameStringbei
    map_typeStringdatabase
    configObject
      start_rule_nowNumber1
      table_mapString
      full_syncNumber1
      incre_syncNumber1
      full_sync_modeString
      db_user_mapObject
      dbmap_topicString
      row_map_modeString
      kafka_time_outString
      part_load_balanceString
      kafka_message_encodingString
    src_db_nameString1111
    is_biz_adminNumber
    can_delNumber
    can_opNumber
    can_upNumber
  messageString
  codeNumber0

同步规则 - 新建

SDK方法名:createPgsqlRule

URL

/pgsql/rule

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
rule_nameStringtest
src_db_uuidString7B1BE386-4CB1-86AA-D39D-B644C2EADD57
tgt_db_uuidStringCD52E44B-D25A-4CE3-126F-6F5A460731E4
tgt_typeStringsqlserver
map_typeStringdb:整库映射
inst:整实例映射
user:用户映射
table:表映射
table
configObject
  table_mapArray
    src_userString1
    src_tableString2
    dst_userString1
    dst_tableString2
    columnArray
  start_rule_nowNumber1
  db_user_mapString
  dbmap_topicString
  full_syncNumber1
  incre_syncNumber1
  full_sync_modeStringlogic
  row_map_modeStringrowid
  kafka_time_outString120000
  part_load_balanceStringby_table
  kafka_message_encodingStringUTF-8
  dst_connect_userString
  src_connect_userString
  jointingObject字段拼接
    tableString
    opString操作
op类型定义
前辍 prefix 后辍 append 常量 const 拼接 join 加 add 减 sub 乘 multiply 除 divide
    contentString目标列+其他两行
  save_json_textBoolean【目标类型为Kafka】保存为文件false
  full_sync_custom_cfgArray全局自定义配置
    keyString
    valueString
  full_sync_settingsObject全量设置
    full_sync_custom_cfgArray全局自定义配置
      keyString
      valueString
    dump_thdString全量导出线程数
    load_thdString全量装载线程数
    start_lsnString起始lsn
    existing_tableString表覆盖策略
    end_db_mapArray
      src_dbString
      tar_dbString
    end_tab_mapArray
      dst_dbString
      dst_tableString
      src_dbString
      src_tableString
      columnArray
        src_columnString
        dst_columnString
    end_target_typeString最终目标库类型
    end_target_dbString最终目标库
    table_msg_uuidString表元信息库
    inc_sync_ddl_filterObject增量DDL过滤设置
      inc_sync_ddl_dataArray
  database_mapArray整库映射信息
    src_databaseString源端库
    tgt_databaseString备端库
    src_schemaString源端模式
    tgt_schemaString备端模式

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

同步规则 - 修改

SDK方法名:modifyPgsqlRule

URL

/pgsql/rule

Method

PUT

Request

名称类型必选简介Mock初始值Mock规则
rule_nameString
src_db_uuidString
tgt_db_uuidString
tgt_typeStringsqlserver
map_typeStringdb
configObject
  start_rule_nowNumber1
  table_mapString
  full_syncNumber0
  incre_syncNumber
  full_sync_modeString1
rule_uuidString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

同步规则 - 删除

SDK方法名:deletePgsqlRule

URL

/pgsql/rule

Method

DELETE

Request

名称类型必选简介Mock初始值Mock规则
uuidsArray
forceStringtrue

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber1
  messageString[0] success
  success_listArray
    codeNumber0
    messageString[0] success
    rule_uuidString16CB63E1-13FA-FB32-EB49-D790682C9648
    rule_nameStringtask1
  fail_listArray
    codeNumber-1
    messageString[-1] 找不到节点
    rule_uuidString16CB63E1-13FA-FB32-EB49-D790682C9647
    rule_nameStringtask2

同步规则 - 操作

SDK方法名: 继续:resumePgsqlRule; 停止:stopPgsqlRule; 重启:restartPgsqlRule;复制:duplicatePgsqlRule

URL

/pgsql/rule/operate

Method

POST

Request

名称类型必选简介Mock初始值Mock规则
operateStringresume | stoprestart
stop_schedule 停止调度
start_schedule 启动调度
start_analysis 启动解析
stop_analysis 停止解析
reset_analysis 重置解析
duplicate 复制
uuidsString
scnString起始scn
allNumber只有在重置装载时才有此值

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  codeNumber0
  messageStringsuccess

同步规则 - 获取单个

SDK方法名:describePgsqlRules

URL

/pgsql/rule/:uuid([A-F0-9-]+)

Method

GET

Request

名称类型必选简介Mock初始值Mock规则
rule_uuidString

Response

名称类型必选简介Mock初始值Mock规则
retNumber200
msgString
dataObject
  messageString
  codeNumber0
  postgres_ruleObject
    rule_nameStringpostgres->kafka
    src_db_uuidString1111
    tgt_db_uuidString2222
    tgt_typeStringkafka
    map_typeStringdatabase
    configObject
      start_rule_nowNumber1
      table_mapString[{"src_user":"111","src_table":"222","dst_user":"333","dst_table":"444","column":[]}]
      full_syncNumber1
      incre_syncNumber1
      full_sync_modeStringlogic
      db_user_mapString{"111":"1112"}
      dbmap_topicString111
      row_map_modeStringrowid
      kafka_time_outString1200000
      part_load_balanceStringby_table
      kafka_message_encodingStringUTF-8
    rule_uuidString@uuid
Last update: 2/26/2024, 5:49:44 PM
Contributors: ganl