Getting Started

The following articles demonstrate installation, usage, and a basic understanding of C++ Paimon. These articles will get you set up quickly with C++ Paimon and give you a taste of what the library is capable of.

Start here to gain a basic understanding of Paimon, and move on to the User Guide to explore more specific topics and underlying concepts, or the API Reference to explore Paimon’s API.

• Building Paimon C++
  • System setup
  • Building
    • Manual configuration
      • Faster builds with Ninja
      • Optional Components
      • Optional Targets
      • Optional Checks
      • CMake version requirements
      • LLVM and Clang Tools
• Integrating Paimon C++
  • CMake
    • Quick Start
    • Available variables and targets
    • Optional plugins (built-in file formats, file systems, and index)
• Basic Concepts
  • File Layouts
  • Snapshot
  • Manifest Files
  • Data Files
  • Partition
  • Consistency Guarantees
• Building the Documentation
  • Prerequisites
  • Building