docs/_build/html/index.html - paimon-cpp - Git at Google


 <!DOCTYPE html>


 <html lang="en" data-content_root="./" >

   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

     <title>C++ Paimon Documentation &#8212; C++ Paimon</title>


   <script data-cfasync="false">
     document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
     document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
   </script>
   <!--
     this give us a css class that will be invisible only if js is disabled
   -->
   <noscript>
     <style>
       .pst-js-only { display: none !important; }

     </style>
   </noscript>

   <!-- Loaded before other Sphinx assets -->
   <link href="_static/styles/theme.css?digest=90905a2f556bf617f1a9" rel="stylesheet" />
 <link href="_static/styles/pydata-sphinx-theme.css?digest=90905a2f556bf617f1a9" rel="stylesheet" />

     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
     <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
     <link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=d7227091" />

   <!-- So that users can add custom icons -->
   <script defer src="_static/scripts/fontawesome.js?digest=90905a2f556bf617f1a9"></script>
   <!-- Pre-loaded scripts that we'll load fully later -->
   <link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=90905a2f556bf617f1a9" />
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=90905a2f556bf617f1a9" />

     <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <script src="_static/doctools.js?v=fd6eb6e6"></script>
     <script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="_static/copybutton.js?v=3bb21c8c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
     <script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Getting Started" href="getting_started.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   <meta name="docsearch:version" content="0.2.3" />


     <script src="_static/searchtools.js"></script>
     <script src="_static/language_data.js"></script>
     <script src="searchindex.js"></script>

   </head>
   <body data-default-mode="">


   <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>


   <div id="pst-scroll-pixel-helper"></div>

   <button type="button" class="btn rounded-pill" id="pst-back-to-top">
     <i class="fa-solid fa-arrow-up"></i>Back to top</button>


   <dialog id="pst-search-dialog">

 <form class="bd-search d-flex align-items-center"
       action="search.html"
       method="get">
   <i class="fa-solid fa-magnifying-glass"></i>
   <input type="search"
          class="form-control"
          name="q"
          placeholder="Search the docs ..."
          aria-label="Search the docs ..."
          autocomplete="off"
          autocorrect="off"
          autocapitalize="off"
          spellcheck="false"/>
   <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 </form>
   </dialog>

   <div class="pst-async-banner-revealer d-none">
   <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
 </div>


     <header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
 <div class="bd-header__inner bd-page-width">
   <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
     <span class="fa-solid fa-bars"></span>
   </button>


   <div class=" navbar-header-items__start">

       <div class="navbar-item">


 <a class="navbar-brand logo" href="#">


     <p class="title logo__title">Paimon C++</p>

 </a></div>

   </div>

   <div class=" navbar-header-items">

     <div class="me-auto navbar-header-items__center">

         <div class="navbar-item">
 <nav>
   <ul class="bd-navbar-elements navbar-nav">

 <li class="nav-item ">
   <a class="nav-link nav-internal" href="getting_started.html">
     Getting Started
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="user_guide.html">
     User Guide
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="examples/index.html">
     Examples
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="api.html">
     API Reference
   </a>
 </li>

   </ul>
 </nav></div>

     </div>


     <div class="navbar-header-items__end">

         <div class="navbar-item navbar-persistent--container">


 <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="fa-solid fa-magnifying-glass"></i>
  <span class="search-button__default-text">Search</span>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 </button>
         </div>


         <div class="navbar-item">

 <div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
   <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
     <i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
     <i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
     <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
   </button>
   <ul class="dropdown-menu dropdown-menu-end">
     <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
     <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
     <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
   </ul>
 </div></div>

         <div class="navbar-item"><ul class="navbar-icon-links"
     aria-label="Icon Links">
         <li class="nav-item">


           <a href="https://github.com/apache/paimon-cpp" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i><span class="visually-hidden">GitHub</span></a>
         </li>
 </ul></div>

     </div>

   </div>


     <div class="navbar-persistent--mobile">

 <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <i class="fa-solid fa-magnifying-glass"></i>
  <span class="search-button__default-text">Search</span>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
 </button>
     </div>


     <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
       <span class="fa-solid fa-outdent"></span>
     </button>

 </div>

     </header>


   <div class="bd-container">
     <div class="bd-container__inner bd-page-width">


       <dialog id="pst-primary-sidebar-modal"></dialog>
       <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">


   <div class="sidebar-header-items sidebar-primary__section">


       <div class="sidebar-header-items__center">


             <div class="navbar-item">
 <nav>
   <ul class="bd-navbar-elements navbar-nav">

 <li class="nav-item ">
   <a class="nav-link nav-internal" href="getting_started.html">
     Getting Started
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="user_guide.html">
     User Guide
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="examples/index.html">
     Examples
   </a>
 </li>


 <li class="nav-item ">
   <a class="nav-link nav-internal" href="api.html">
     API Reference
   </a>
 </li>

   </ul>
 </nav></div>


       </div>


       <div class="sidebar-header-items__end">

           <div class="navbar-item">

 <div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
   <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
     <i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
     <i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
     <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
   </button>
   <ul class="dropdown-menu dropdown-menu-end">
     <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
     <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
     <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
   </ul>
 </div></div>

           <div class="navbar-item"><ul class="navbar-icon-links"
     aria-label="Icon Links">
         <li class="nav-item">


           <a href="https://github.com/apache/paimon-cpp" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i><span class="visually-hidden">GitHub</span></a>
         </li>
 </ul></div>

       </div>

   </div>


   <div class="sidebar-primary-items__end sidebar-primary__section">
       <div class="sidebar-primary-item">
 <div id="ethical-ad-placement"
       class="flat"
       data-ea-publisher="readthedocs"
       data-ea-type="readthedocs-sidebar"
       data-ea-manual="true">
 </div></div>
   </div>


       </div>

       <main id="main-content" class="bd-main" role="main">


           <div class="bd-content">
             <div class="bd-article-container">

               <div class="bd-header-article d-print-none"></div>


 <div id="searchbox"></div>
                 <article class="bd-article">

   <section id="c-paimon-documentation">
 <span id="implementations"></span><h1>C++ Paimon Documentation<a class="headerlink" href="#c-paimon-documentation" title="Link to this heading">#</a></h1>
 <p>Paimon C++ is a high-performance C++ implementation of Apache Paimon. We aim to
 provide a native, high-performance and extensible implementation that allows
 native engines to access the Paimon datalake format with maximum efficiency.</p>
 <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-pt-2 sd-pb-2 sd-pl-0 sd-pr-0 sd-text-center docutils">
 <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
 <div class="sd-col sd-d-flex-row docutils">
 <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
 <div class="sd-card-body docutils">
 <div class="sd-card-title sd-font-weight-bold docutils">
 Getting started</div>
 <p class="sd-card-text">Start here to gain a basic understanding of Paimon with
 an installation and linking guide, basic concepts etc.</p>
 </div>
 <div class="sd-card-footer docutils">
 <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="getting_started.html"><span>To Getting started</span></a></span></p>
 </div>
 </div>
 </div>
 <div class="sd-col sd-d-flex-row docutils">
 <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
 <div class="sd-card-body docutils">
 <div class="sd-card-title sd-font-weight-bold docutils">
 User Guide</div>
 <p class="sd-card-text">Explore more specific topics and underlying concepts
 of Paimon C++</p>
 </div>
 <div class="sd-card-footer docutils">
 <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="user_guide.html"><span>To the User Guide</span></a></span></p>
 </div>
 </div>
 </div>
 </div>
 </div>
 <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-pt-2 sd-pb-2 sd-pl-0 sd-pr-0 sd-text-center docutils">
 <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
 <div class="sd-col sd-d-flex-row docutils">
 <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
 <div class="sd-card-body docutils">
 <div class="sd-card-title sd-font-weight-bold docutils">
 Examples</div>
 <p class="sd-card-text">Find the description and location of the examples
 using Paimon C++ library</p>
 </div>
 <div class="sd-card-footer docutils">
 <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="examples/index.html"><span>To the Examples</span></a></span></p>
 </div>
 </div>
 </div>
 <div class="sd-col sd-d-flex-row docutils">
 <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
 <div class="sd-card-body docutils">
 <div class="sd-card-title sd-font-weight-bold docutils">
 API Reference</div>
 <p class="sd-card-text">Explore Paimon’s API reference documentation</p>
 </div>
 <div class="sd-card-footer docutils">
 <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="api.html"><span>To the API Reference</span></a></span></p>
 </div>
 </div>
 </div>
 </div>
 </div>
 <div class="toctree-wrapper compound">
 </div>
 </section>


                 </article>


                 <footer class="prev-next-footer d-print-none">

 <div class="prev-next-area">
     <a class="right-next"
        href="getting_started.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">Getting Started</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>
 </div>
                 </footer>

             </div>


                 <dialog id="pst-secondary-sidebar-modal"></dialog>
                 <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


   <div class="sidebar-secondary-item">


   <div class="tocsection editthispage">
     <a href="https://github.com/apache/paimon-cpp/edit/main/docs/source/index.rst">
       <i class="fa-solid fa-pencil"></i>


           Edit on GitHub


     </a>
   </div>
 </div>

 </div></div>


           </div>
           <footer class="bd-footer-content">

           </footer>

       </main>
     </div>
   </div>

   <!-- Scripts loaded after <body> so the DOM is not blocked -->
   <script defer src="_static/scripts/bootstrap.js?digest=90905a2f556bf617f1a9"></script>
 <script defer src="_static/scripts/pydata-sphinx-theme.js?digest=90905a2f556bf617f1a9"></script>

   <footer class="bd-footer">
 <div class="bd-footer__inner bd-page-width">

     <div class="footer-items__start">

         <div class="footer-item">

   <p class="copyright">

       © Copyright 2024-2026 Apache Software Foundation.
       <br/>

   </p>
 </div>

         <div class="footer-item">

   <p class="sphinx-version">
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
     <br/>
   </p>
 </div>

     </div>


     <div class="footer-items__end">

         <div class="footer-item">
 <p class="theme-version">
   <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
   Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.20.0.
 </p></div>

     </div>

 </div>

   </footer>
   </body>
 </html>

	<!DOCTYPE html>


	<html lang="en" data-content_root="./" >

	<head>
	<meta charset="utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

	<title>C++ Paimon Documentation — C++ Paimon</title>



	<script data-cfasync="false">
	document.documentElement.dataset.mode = localStorage.getItem("mode") \|\| "";
	document.documentElement.dataset.theme = localStorage.getItem("theme") \|\| "";
	</script>
	<!--
	this give us a css class that will be invisible only if js is disabled
	-->
	<noscript>
	<style>
	.pst-js-only { display: none !important; }

	</style>
	</noscript>

	<!-- Loaded before other Sphinx assets -->
	<link href="_static/styles/theme.css?digest=90905a2f556bf617f1a9" rel="stylesheet" />
	<link href="_static/styles/pydata-sphinx-theme.css?digest=90905a2f556bf617f1a9" rel="stylesheet" />

	<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
	<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
	<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
	<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=d7227091" />

	<!-- So that users can add custom icons -->
	<script defer src="_static/scripts/fontawesome.js?digest=90905a2f556bf617f1a9"></script>
	<!-- Pre-loaded scripts that we'll load fully later -->
	<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=90905a2f556bf617f1a9" />
	<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=90905a2f556bf617f1a9" />

	<script src="_static/documentation_options.js?v=5929fcd5"></script>
	<script src="_static/doctools.js?v=fd6eb6e6"></script>
	<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
	<script src="_static/clipboard.min.js?v=a7894cd8"></script>
	<script src="_static/copybutton.js?v=3bb21c8c"></script>
	<script src="_static/design-tabs.js?v=f930bc37"></script>
	<script>DOCUMENTATION_OPTIONS.pagename = 'index';</script>
	<script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script>
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="Getting Started" href="getting_started.html" />
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<meta name="docsearch:language" content="en"/>
	<meta name="docsearch:version" content="0.2.3" />


	<script src="_static/searchtools.js"></script>
	<script src="_static/language_data.js"></script>
	<script src="searchindex.js"></script>

	</head>
	<body data-default-mode="">


	<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>


	<div id="pst-scroll-pixel-helper"></div>

	<button type="button" class="btn rounded-pill" id="pst-back-to-top">
	<i class="fa-solid fa-arrow-up"></i>Back to top</button>




	<dialog id="pst-search-dialog">

	<form class="bd-search d-flex align-items-center"
	action="search.html"
	method="get">
	<i class="fa-solid fa-magnifying-glass"></i>
	<input type="search"
	class="form-control"
	name="q"
	placeholder="Search the docs ..."
	aria-label="Search the docs ..."
	autocomplete="off"
	autocorrect="off"
	autocapitalize="off"
	spellcheck="false"/>
	<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
	</form>
	</dialog>

	<div class="pst-async-banner-revealer d-none">
	<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
	</div>


	<header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
	<div class="bd-header__inner bd-page-width">
	<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
	<span class="fa-solid fa-bars"></span>
	</button>


	<div class=" navbar-header-items__start">

	<div class="navbar-item">





	<a class="navbar-brand logo" href="#">






	<p class="title logo__title">Paimon C++</p>

	</a></div>

	</div>

	<div class=" navbar-header-items">

	<div class="me-auto navbar-header-items__center">

	<div class="navbar-item">
	<nav>
	<ul class="bd-navbar-elements navbar-nav">

	<li class="nav-item ">
	<a class="nav-link nav-internal" href="getting_started.html">
	Getting Started
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="user_guide.html">
	User Guide
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="examples/index.html">
	Examples
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="api.html">
	API Reference
	</a>
	</li>

	</ul>
	</nav></div>

	</div>


	<div class="navbar-header-items__end">

	<div class="navbar-item navbar-persistent--container">


	<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="fa-solid fa-magnifying-glass"></i>
	<span class="search-button__default-text">Search</span>
	<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
	</button>
	</div>


	<div class="navbar-item">

	<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
	<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
	<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
	<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
	<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
	</button>
	<ul class="dropdown-menu dropdown-menu-end">
	<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
	<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
	<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
	</ul>
	</div></div>

	<div class="navbar-item"><ul class="navbar-icon-links"
	aria-label="Icon Links">
	<li class="nav-item">








	<a href="https://github.com/apache/paimon-cpp" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i><span class="visually-hidden">GitHub</span></a>
	</li>
	</ul></div>

	</div>

	</div>


	<div class="navbar-persistent--mobile">

	<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
	<i class="fa-solid fa-magnifying-glass"></i>
	<span class="search-button__default-text">Search</span>
	<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
	</button>
	</div>



	<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
	<span class="fa-solid fa-outdent"></span>
	</button>

	</div>

	</header>


	<div class="bd-container">
	<div class="bd-container__inner bd-page-width">





	<dialog id="pst-primary-sidebar-modal"></dialog>
	<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">



	<div class="sidebar-header-items sidebar-primary__section">


	<div class="sidebar-header-items__center">



	<div class="navbar-item">
	<nav>
	<ul class="bd-navbar-elements navbar-nav">

	<li class="nav-item ">
	<a class="nav-link nav-internal" href="getting_started.html">
	Getting Started
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="user_guide.html">
	User Guide
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="examples/index.html">
	Examples
	</a>
	</li>


	<li class="nav-item ">
	<a class="nav-link nav-internal" href="api.html">
	API Reference
	</a>
	</li>

	</ul>
	</nav></div>


	</div>



	<div class="sidebar-header-items__end">

	<div class="navbar-item">

	<div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode">
	<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown">
	<i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i>
	<i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i>
	<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i>
	</button>
	<ul class="dropdown-menu dropdown-menu-end">
	<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li>
	<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li>
	<li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li>
	</ul>
	</div></div>

	<div class="navbar-item"><ul class="navbar-icon-links"
	aria-label="Icon Links">
	<li class="nav-item">








	<a href="https://github.com/apache/paimon-cpp" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i><span class="visually-hidden">GitHub</span></a>
	</li>
	</ul></div>

	</div>

	</div>


	<div class="sidebar-primary-items__end sidebar-primary__section">
	<div class="sidebar-primary-item">
	<div id="ethical-ad-placement"
	class="flat"
	data-ea-publisher="readthedocs"
	data-ea-type="readthedocs-sidebar"
	data-ea-manual="true">
	</div></div>
	</div>


	</div>

	<main id="main-content" class="bd-main" role="main">


	<div class="bd-content">
	<div class="bd-article-container">

	<div class="bd-header-article d-print-none"></div>




	<div id="searchbox"></div>
	<article class="bd-article">

	<section id="c-paimon-documentation">
	<span id="implementations"></span><h1>C++ Paimon Documentation<a class="headerlink" href="#c-paimon-documentation" title="Link to this heading">#</a></h1>
	<p>Paimon C++ is a high-performance C++ implementation of Apache Paimon. We aim to
	provide a native, high-performance and extensible implementation that allows
	native engines to access the Paimon datalake format with maximum efficiency.</p>
	<div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-pt-2 sd-pb-2 sd-pl-0 sd-pr-0 sd-text-center docutils">
	<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
	<div class="sd-col sd-d-flex-row docutils">
	<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
	<div class="sd-card-body docutils">
	<div class="sd-card-title sd-font-weight-bold docutils">
	Getting started</div>
	<p class="sd-card-text">Start here to gain a basic understanding of Paimon with
	an installation and linking guide, basic concepts etc.</p>
	</div>
	<div class="sd-card-footer docutils">
	<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="getting_started.html"><span>To Getting started</span></a></span></p>
	</div>
	</div>
	</div>
	<div class="sd-col sd-d-flex-row docutils">
	<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
	<div class="sd-card-body docutils">
	<div class="sd-card-title sd-font-weight-bold docutils">
	User Guide</div>
	<p class="sd-card-text">Explore more specific topics and underlying concepts
	of Paimon C++</p>
	</div>
	<div class="sd-card-footer docutils">
	<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="user_guide.html"><span>To the User Guide</span></a></span></p>
	</div>
	</div>
	</div>
	</div>
	</div>
	<div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-pt-2 sd-pb-2 sd-pl-0 sd-pr-0 sd-text-center docutils">
	<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-4 sd-g-xs-4 sd-g-sm-4 sd-g-md-4 sd-g-lg-4 docutils">
	<div class="sd-col sd-d-flex-row docutils">
	<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
	<div class="sd-card-body docutils">
	<div class="sd-card-title sd-font-weight-bold docutils">
	Examples</div>
	<p class="sd-card-text">Find the description and location of the examples
	using Paimon C++ library</p>
	</div>
	<div class="sd-card-footer docutils">
	<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="examples/index.html"><span>To the Examples</span></a></span></p>
	</div>
	</div>
	</div>
	<div class="sd-col sd-d-flex-row docutils">
	<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-none contrib-card docutils">
	<div class="sd-card-body docutils">
	<div class="sd-card-title sd-font-weight-bold docutils">
	API Reference</div>
	<p class="sd-card-text">Explore Paimon’s API reference documentation</p>
	</div>
	<div class="sd-card-footer docutils">
	<p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-stretched-link reference external" href="api.html"><span>To the API Reference</span></a></span></p>
	</div>
	</div>
	</div>
	</div>
	</div>
	<div class="toctree-wrapper compound">
	</div>
	</section>


	</article>





	<footer class="prev-next-footer d-print-none">

	<div class="prev-next-area">
	<a class="right-next"
	href="getting_started.html"
	title="next page">
	<div class="prev-next-info">
	<p class="prev-next-subtitle">next</p>
	<p class="prev-next-title">Getting Started</p>
	</div>
	<i class="fa-solid fa-angle-right"></i>
	</a>
	</div>
	</footer>

	</div>



	<dialog id="pst-secondary-sidebar-modal"></dialog>
	<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


	<div class="sidebar-secondary-item">


	<div class="tocsection editthispage">
	<a href="https://github.com/apache/paimon-cpp/edit/main/docs/source/index.rst">
	<i class="fa-solid fa-pencil"></i>



	Edit on GitHub


	</a>
	</div>
	</div>

	</div></div>


	</div>
	<footer class="bd-footer-content">

	</footer>

	</main>
	</div>
	</div>

	<!-- Scripts loaded after <body> so the DOM is not blocked -->
	<script defer src="_static/scripts/bootstrap.js?digest=90905a2f556bf617f1a9"></script>
	<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=90905a2f556bf617f1a9"></script>

	<footer class="bd-footer">
	<div class="bd-footer__inner bd-page-width">

	<div class="footer-items__start">

	<div class="footer-item">

	<p class="copyright">

	© Copyright 2024-2026 Apache Software Foundation.
	<br/>

	</p>
	</div>

	<div class="footer-item">

	<p class="sphinx-version">
	Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
	<br/>
	</p>
	</div>

	</div>



	<div class="footer-items__end">

	<div class="footer-item">
	<p class="theme-version">
	<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
	Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.20.0.
	</p></div>

	</div>

	</div>

	</footer>
	</body>
	</html>