数据复制服务 DRS数据复制服务 DRS

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
IoT行业生态工作台
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
可信分布式身份服务
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
商标注册
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
认证测试中心 CTC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
混合云灾备
华为工业云平台 IMC
Haydn解决方案工厂
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021-12-20 GMT+08:00
分享

SDK接口介绍

SDK中定义了多种类对象,本小节简单介绍SDK的这些类的接口定义。

  • SubscribeContext接口定义
    表1 SubscribeContext接口定义

    函数名称

    说明

    setDomainName(String domainName)

    设置用户名。

    参数为创建所需数据订阅任务的IAM主帐号。

    setPassword(String password)

    设置用户密码。

    参数为创建所需数据订阅任务的IAM主帐号密码。

    setIp(String ip)

    设置订阅通道的IP。

    在数据订阅页面,选择指定订阅任务,单击任务名称,在基本信息页签下,获取订阅实例信息的内部IP即可。

    setUserId(String userId)

    用户ID。

    登录控制台之后,单击右上角“账户名>我的凭证>用户ID”,复制用户ID即可。

  • ClusterClient接口定义
    表2 ClusterClient接口定义

    函数名称

    说明

    void addClusterListener(ClusterListener var1)

    添加下游监听者。监听者加入到一个ClusterClient中,才可以订阅订阅通道中的增量数据。

    参数ClusterListener arg0 为类ClusterListener的对象。

    void start()

    启动SDK客户端,开始订阅增量数据。

    void stop()

    停止订阅增量数据。

  • ClusterListener接口定义
    表3 ClusterListener接口定义

    函数名称

    说明

    void notify(List<ClusterMessage> var1)

    该函数主要用于定义增量数据的消费。当SDK接收到数据时,会通过notify通知ClusterListner消费数据。例如SDK使用模版的消费方式,就是将订阅数据打印到屏幕上。

    该函数输入参数类型为:List <ClusterMessage>, 其中ClusterMessage为订阅数据存储的结构对象,具体定义详见表4

  • ClusterMessage接口定义

    每个ClusterMessage保存RDS中的一个事务的数据记录,事务中的每条记录通过Record保存。

    表4 ClusterMessage接口定义

    函数名称

    说明

    Record getRecord()

    该接口从ClusterMessage中获取一条变更记录。这个变更记录表示RDS的binlog文件中的每一条记录,例如begin,commit,update,insert等。

  • Record接口定义

    Record代表订阅的RDS的binlog文件中的每条记录,例如begin,commit,update等。

    表5 Record接口定义

    函数名称

    说明

    String getAttribute(final String key)

    该函数可以获取Record中主要的一些属性值。传入参数为属性名,返回这个属性的值。

    可以调用这个函数获取的属性名及对应的属性值如表6所示。

    Type getOpt()

    获取这条记录的变更类型,包括: insert、delete、update、replace、ddl、begin、commit、heartbeat。

    String getCheckpoint()

    获取这条变更记录在binlog中的位点,返回的位点格式为:binlog_offset@binlog_fid。

    其中binlog_offset为变更记录在binlog文件中的偏移量,binlog_fid为binlog文件的数字后缀,例如binlog文件名为mysql-bin.00092,那么binlog_fid为92。

    int getFieldCount()

    获取这条变更记录的字段Field的个数。

    List <Field> getFieldList()

    该函数返回结果的数据类型为List <Field>。

    List <Field> 包含了这条变更记录对应表的所有字段的定义及变更前后的镜像值,Field对象的定义详见表7

    表6 属性信息

    key

    说明

    record_id

    这条Record的ID,这个ID在订阅过程中不保证递增。

    instance

    这条Record对应的数据库实例的连接地址,格式为:ip:port。

    source_type

    这条Record对应数据库实例的引擎类型,目前只支持MySQL。

    source_category

    这条Record的类型,目前只支持full_recorded。

    timestamp

    这条Record写入binlog的时间,这个时间同时也是这条SQL在RDS中执行的时间。

    checkpoint

    这条Record对应的binlog文件的位点,格式为:file_offset@file_name,file_name为binlog文件的数字后缀。

    record_type

    这条Record对应的操作类型,主要取值包括:insert/update/delete/replace/ddl/begin/commit/heartbeat。

    db

    这条Record更新对应的数据库名。

    table_name

    这条Record更新表的表名。

    record_recording

    这条Record对应的编码。

  • Field接口定义

    Field类定义了每个字段的编码、类型、字段名、字段值以及是否为主键等属性,Field类的各个接口定义如表7所示。

    表7 Field接口定义

    函数名称

    说明

    String getEncoding()

    获取该字段值的编码格式。

    String getFieldname()

    获取该字段的名称。

    Type getType()

    获取该字段的数据类型,Type的定义具体参见字段类型定义。

    ByteString getValue()

    获取该字段的值,返回类型为ByteString,当值为空时,返回NULL。

    Boolean isPrimary()

    判断该字段是否是表的主键列,如果是返回True,否则返回False。

分享:

    相关文档

    相关产品

关闭导读