| |
| <!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>User Guide — 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 = 'user_guide';</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="Catalog" href="user_guide/catalog.html" /> |
| <link rel="prev" title="Building the Documentation" href="documentations.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="index.html"> |
| |
| |
| |
| |
| |
| |
| <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 current active"> |
| <a class="nav-link nav-internal" href="#"> |
| 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"> |
| |
| |
| |
| <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 current active"> |
| <a class="nav-link nav-internal" href="#"> |
| 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__start sidebar-primary__section"> |
| <div class="sidebar-primary-item pst-sidebar-collapse"><button id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar"> |
| <svg class="pst-icon" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> |
| <path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/> |
| </svg> |
| <span class="pst-collapse-sidebar-label">Collapse Sidebar</span> |
| <span class="pst-expand-sidebar-label">Expand Sidebar</span> |
| </button></div> |
| <div class="sidebar-primary-item"> |
| |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/catalog.html">Catalog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/schema.html">Schema</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/snapshot.html">Snapshot</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/manifest.html">Manifest</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/data_types.html">Data Types</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/primary_key_table.html">Primary Key Table</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/append_only_table.html">Append Only Table</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/write.html">Write</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/commit.html">Commit</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/compaction.html">Compaction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/read.html">Read</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/clean.html">Data Cleanup</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/prefetch.html">Prefetch</a></li> |
| |
| |
| |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/arrow.html">Memory Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/global_index.html">Global Index</a></li> |
| </ul> |
| </div> |
| </nav></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 class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| <nav aria-label="Breadcrumb" class="d-print-none"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">User Guide</span></li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="user-guide"> |
| <h1>User Guide<a class="headerlink" href="#user-guide" title="Link to this heading">#</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/catalog.html">Catalog</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/catalog.html#filesystem-catalog">Filesystem Catalog</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/schema.html">Schema</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/schema.html#example">Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/schema.html#compatibility">Compatibility</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/schema.html#datafield">DataField</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/schema.html#limitations">Limitations</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/schema.html#map-key-must-be-not-null">MAP Key Must Be NOT NULL</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/schema.html#update-schema">Update Schema</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/snapshot.html">Snapshot</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/snapshot.html#directory-layout">Directory Layout</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/snapshot.html#snapshot-file">Snapshot File</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/manifest.html">Manifest</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/manifest.html#manifest-list">Manifest List</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/manifest.html#id1">Manifest</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/manifest.html#data-manifest">Data Manifest</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/manifest.html#index-manifest">Index Manifest</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/manifest.html#appendix">Appendix</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/manifest.html#simplestats">SimpleStats</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/manifest.html#binaryrow">BinaryRow</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/data_types.html">Data Types</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/primary_key_table.html">Primary Key Table</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/primary_key_table.html#bucket">Bucket</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/primary_key_table.html#lsm-trees">LSM Trees</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/primary_key_table.html#sorted-runs">Sorted Runs</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/append_only_table.html">Append Only Table</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/write.html">Write</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/write.html#bucketing-modes">Bucketing Modes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/write.html#recordbatch-construction">RecordBatch Construction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/write.html#prepare-commit">Prepare Commit</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/write.html#compatibility-goals">Compatibility Goals</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/write.html#interface-design-in-paimon-c">Interface Design in Paimon C++</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/write.html#commitmessage-contract">CommitMessage Contract</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/write.html#serialization-and-deserialization">Serialization and Deserialization</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/write.html#operational-flow">Operational Flow</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/commit.html">Commit</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/commit.html#commit-process-overview">Commit Process Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/commit.html#detailed-process">Detailed Process</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/commit.html#collect-file-changes">Collect File Changes</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/commit.html#compact-merge-manifest-files">Compact (Merge) Manifest Files</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="user_guide/commit.html#full-compaction">Full Compaction</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="user_guide/commit.html#minor-compaction">Minor Compaction</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="user_guide/commit.html#compaction-rules">Compaction Rules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/commit.html#generate-the-base-manifest-list">Generate the Base Manifest List</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/commit.html#generate-new-manifest-files-and-the-delta-manifest-list">Generate New Manifest Files and the Delta Manifest List</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/commit.html#generate-the-snapshot-and-hint-file">Generate the Snapshot and HINT File</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/compaction.html">Compaction</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/compaction.html#append-only-table-compaction">Append-Only Table Compaction</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/compaction.html#auto-compaction">Auto Compaction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/compaction.html#full-compaction">Full Compaction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/compaction.html#append-only-table-compaction-options">Append-Only Table Compaction Options</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/compaction.html#primary-key-table-compaction">Primary Key Table Compaction</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/compaction.html#id1">Full Compaction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/compaction.html#lookup-compaction">Lookup Compaction</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/compaction.html#primary-key-table-compaction-options">Primary Key Table Compaction Options</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="user_guide/compaction.html#number-of-sorted-runs-to-pause-writing">Number of Sorted Runs to Pause Writing</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="user_guide/compaction.html#number-of-sorted-runs-to-trigger-compaction">Number of Sorted Runs to Trigger Compaction</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/read.html">Read</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/read.html#schema-evolution">Schema Evolution</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/read.html#scope-and-compatibility">Scope and Compatibility</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/read.html#per-file-schema-via-field-ids">Per-File Schema via Field IDs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/read.html#overflow-behavior-disclaimer">Overflow Behavior Disclaimer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/read.html#type-change-support-matrix">Type Change Support Matrix</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/read.html#implementation-guidance">Implementation Guidance</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/clean.html">Data Cleanup</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/clean.html#orphan-file-cleanup">Orphan File Cleanup</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#description">Description</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#detailed-steps">Detailed Steps</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#performance-considerations">Performance Considerations</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/clean.html#expiring-partitions">Expiring Partitions</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#id3">Description</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#id4">Detailed Steps</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/clean.html#expiring-snapshots">Expiring Snapshots</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#id6">Description</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#id7">Detailed Steps</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/clean.html#id8">Performance Considerations</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/prefetch.html">Prefetch</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/prefetch.html#read-range-splitting-strategy">Read Range Splitting Strategy</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/prefetch.html#parquet">Parquet</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/prefetch.html#orc">ORC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/arrow.html">Memory Format</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/arrow.html#why-apache-arrow">Why Apache Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/arrow.html#versioning-and-dependency-concerns">Versioning and Dependency Concerns</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/arrow.html#adopting-the-arrow-c-data-interface">Adopting the Arrow C Data Interface</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/arrow.html#design-principles">Design Principles</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/arrow.html#implementation-outline">Implementation Outline</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/arrow.html#schema-and-buffers">Schema and buffers</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/arrow.html#memory-management">Memory management</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/arrow.html#nullability-and-validity">Nullability and validity</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="user_guide/arrow.html#conversion-boundaries">Conversion boundaries</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/global_index.html">Global Index</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/global_index.html#bitmap-index">Bitmap Index</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/global_index.html#btree-index">BTree Index</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/global_index.html#range-bitmap-index">Range Bitmap Index</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/global_index.html#lucene-index">Lucene Index</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="user_guide/global_index.html#vector-index-lumina">Vector Index (Lumina)</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer d-print-none"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="documentations.html" |
| title="previous page"> |
| <i class="fa-solid fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">Building the Documentation</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="user_guide/catalog.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Catalog</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/user_guide.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> |
