Install and deploy OBCDC

This topic describes how to install and deploy OBCDC. You can install and deploy OBCDC by using an RPM package or compiling your package.

Install OBCDC by using an RPM package

RPM packages of OBCDC will be published after OceanBase Database Community Edition is released, and are named in the format of oceanbase-ce-cdc-${package_version}. For details, see OceanBase Community Edition release notes.

Run the following command to decompress the package:

rpm2cpio oceanbase-ce-cdc-${package_version} | cpio -idv

In the directory to which the RPM package is decompressed, the home/admin/oceanbase directory exists and contains the following components that are essential for the running of OBCDC:

• Header files: libobcdc.h and ob_errno.h in the include/libobcdc/ directory.
• Configuration file for reference: libobcdc.conf in the etc/ directory.
• Library files: libobcdc.so in the lib64/ directory.
• Executable files: obcdc_tailf in the bin/ directory.
• Output messages: in the include/oblogmsg/ directory.

Build OBCDC by compiling the source code

Code description

The OBCDC code is in the src/logservice/libobcdc directory of the OceanBase Database open-source repository. The directory has two subdirectories:

• src directory: stores the OBCDC code.

• tests directory: stores obcdc_tailf, a simple application for you to experience the features of OBCDC. For more information, see obcdc_tailf. The tests directory contains the following files and directories:

  • Source files of obcdc_tailf. You can use them as a reference when you compile your incremental data consumption tools for OceanBase Database.

  • watch\*.sh: various monitoring scripts.

  • demo directory: contains libobcdc examples that describe the usage of libobcdc.

Compilation

You can run the following command to compile OBCDC together with OceanBase Database:

./build.sh release -DOB_BUILD_CDC=ON --init --make

The compilation output includes:

• libobcdc.so: in the ${PROJECT_BUILD_DIR}/src/logservice/libobcdc/src/ directory.
• obcdc_tailf: in the $${PROJECT_BUILD_DIR}/src/logservice/libobcdc/tests/ directory.

You can run the ./libobcdc.so -v command in the output directory to view the version, build time, and build method of OBCDC.