The OceanBase Developer Handbook mainly guides developers on how to participate in OceanBase development, clearing obstacles you may encounter while preparing to contribute. This section covers the following articles, with more to be added in the future. For now, the OceanBase source code references the Open-Source Database OceanBase Source Code Walkthrough series on the OceanBase open-source official site:
How to compile the OceanBase source code
How to set up an IDE development environment
How to become an OceanBase Contributor
How to edit the OceanBase documentation
How to debug OceanBase
How to run tests
How to fix bugs
Steps
OS compatibility list
OS
Ver.
Arch
Compilable
Package Deployable
Compiled Binary Deployable
Mysqltest Passed
Alibaba Cloud Linux
2.1903
x86_64
✅
✅
✅
✅
CentOS
7.2, 8.3
x86_64
✅
✅
✅
✅
Debian
9.8, 10.9
x86_64
✅
✅
✅
✅
Fedora
33
x86_64
✅
✅
✅
✅
MacOS
any
x86_64
❌
❌
❌
❌
openSUSE
15.2
x86_64
✅
✅
✅
✅
OpenAnolis
8.2
x86_64
✅
✅
✅
✅
SUSE
15.2
x86_64
✅
✅
✅
✅
Ubuntu
16.04, 18.04, 20.04
x86_64
✅
✅
✅
✅
UOS
20
x86_64
✅
✅
✅
✅
How to build
This document shows you how to build OceanBase.
Preparation
Before building, you need to make sure the required dependencies are installed on your system.