---
title: "oblogmsg 安装部署 - OceanBase 数据库 V4.2.0 | OceanBase 文档中心"
description: oblogmsg 安装部署 本文主要介绍什么是 oblogmsg 以及如何安装部署 oblogmsg。 oblogmsg oblogmsg 是一种数据库增量数据的输出格式，OceanBase 的增量采集模块 obcdc 正是使用的这种消息格式来输出增量数据，oblogmsg 支持 OceanBase 中不同数据类型的…
---
切换语言

- 中文站 - 简体中文
- International - English
- 日本站 - 日本語

文档反馈![](https://mdn.alipayobjects.com/huamei_22khvb/afts/img/A*P8CuR4UJ_FkAAAAAAAAAAAAADiGDAQ/original) OceanBase 数据库分布式版 - V 4.2.0

# oblogmsg 安装部署

更新时间：2024-04-19 09:30:55

[编辑](https://github.com/oceanbase/oceanbase-doc/edit/V4.2.0/zh-CN/700.reference/1500.components-and-tools/300.data-integrate/400.cdc/400.oblogmsg/100.install-and-deploy-oblogmsg.md)  

本文主要介绍什么是 oblogmsg 以及如何安装部署 oblogmsg。

## oblogmsg

oblogmsg 是一种数据库增量数据的输出格式，OceanBase 的增量采集模块 obcdc 正是使用的这种消息格式来输出增量数据，oblogmsg 支持 OceanBase 中不同数据类型的增量数据的写入，具有序列化和反序列化的能力。

## 使用

### 前置条件

- CMake：版本为 3.20.0 及以上
 - g++：支持 C++11 标准

### 以源码方式依赖（推荐方式）

- 使用 `git submodule` 的方式将 oblogmsg 作为主项目的子模块。
 - 在主项目的 `CMakeLists.txt` 文件中使用 `add_subdirectory(submodule_path_to_oblogmsg)` 来依赖 oblogmsg，该命令执行后将提供 `oceanbase::oblogmsg_shared` 和 `oceanbase::oblogmsg_static` 两个 targets。
 - 在主项目相关 `CMakeLists.txt` 文件中，对于要依赖 oblogmsg 的 target t1，使用 `target_link_libraries(t1 PRIVATE oceanbase::oblogmsg_shared)` 或者 `target_link_libraries(t1 PRIVATE oceanbase::oblogmsg_static)` 即可。

### 通过编译后的 oblogmsg 库依赖

- 编译、安装 oblogmsg

  ```unknow
  # 编译 oblogmsg
  git clone https://github.com/oceanbase/oblogmsg.git
  mkdir oblogmsg-build
  cd oblogmsg-build
  cmake -S ../oblogmsg -B .
  cmake --build .

  # 本地安装
  cmake --install . --prefix=${OBLOGMSG_INSTALL_PATH}

  ```
 - 主项目中依赖编译、安装后的 oblogmsg

     - 在主项目 `CMakeLists.txt` 文件中使用 `set(CMAKE_PREFIX_PATH $ENV{OBLOGMSG_INSTALL_PATH} ${CMAKE_PREFIX_PATH})` 设置 oblogmsg 库搜索路径。
     - 使用 `find_package(oblogmsg REQUIRED)` 加载 oblogmsg，该命令执行成功后将提供 `oceanbase::oblogmsg_shared` 和 `oceanbase::oblogmsg_static` 两个 targets。
     - 在主项目相关 `CMakeLists.txt` 文件中，对于要依赖 oblogmsg 的 target t1，使用 `target_link_libraries(t1 PRIVATE oceanbase::oblogmsg_shared)` 或者 `target_link_libraries(t1 PRIVATE oceanbase::oblogmsg_static)` 即可。

 上一篇 下一篇 ![有帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*y6ocSqN8cqsAAAAAAAAAAAAAARQnAQ)![无帮助](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*BG9IQJyLHF8AAAAAAAAAAAAAARQnAQ)![反馈](https://gw.alipayobjects.com/mdn/ob_asset/afts/img/A*eTWdQKCRKHwAAAAAAAAAAAAAARQnAQ)[AI](https://www.oceanbase.com/obi) 咨询热线