| |
| <!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>File Format — 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 = 'api/file_format';</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="File System" href="file_system.html" /> |
| <link rel="prev" title="Predicate" href="predicate.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 "> |
| <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 current active"> |
| <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 "> |
| <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 current active"> |
| <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="current nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="catalog.html">Catalog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="write.html">Write</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="commit.html">Commit</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="scan.html">Scan</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="read.html">Read</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="predicate.html">Predicate</a></li> |
| |
| <li class="toctree-l1 current active"><a class="current reference internal" href="#">File Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="file_system.html">File System</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="io.html">IO</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="data_types.html">Data Types</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="file_index.html">File Index</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="global_index.html">Global Index</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="clean.html">Orphan Files Clean</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="defs.html">Options</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="executor.html">Executor</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="memory.html">Memory</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"><a href="../api.html" class="nav-link">API Reference</a></li> |
| |
| <li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">File Format</span></li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="file-format"> |
| <h1>File Format<a class="headerlink" href="#file-format" title="Link to this heading">#</a></h1> |
| <section id="interface"> |
| <span id="cpp-api-file-format"></span><h2>Interface<a class="headerlink" href="#interface" title="Link to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon10FileFormatE"> |
| <span id="_CPPv3N6paimon10FileFormatE"></span><span id="_CPPv2N6paimon10FileFormatE"></span><span id="paimon::FileFormat"></span><span class="target" id="classpaimon_1_1_file_format"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FileFormat</span></span></span><a class="headerlink" href="#_CPPv4N6paimon10FileFormatE" title="Link to this definition">#</a><br /></dt> |
| <dd><p><code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_format"><span class="std std-ref"><span class="pre">FileFormat</span></span></a></code> is used to create <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_reader_builder"><span class="std std-ref"><span class="pre">ReaderBuilder</span></span></a></code> and <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_writer_builder"><span class="std std-ref"><span class="pre">WriterBuilder</span></span></a></code>. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon10FileFormatD0Ev"> |
| <span id="_CPPv3N6paimon10FileFormatD0Ev"></span><span id="_CPPv2N6paimon10FileFormatD0Ev"></span><span id="paimon::FileFormat::~FileFormat"></span><span class="target" id="classpaimon_1_1_file_format_1a15252abcf86e644c9cc38eb1344ac55a"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~FileFormat</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N6paimon10FileFormatD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon10FileFormat10IdentifierEv"> |
| <span id="_CPPv3NK6paimon10FileFormat10IdentifierEv"></span><span id="_CPPv2NK6paimon10FileFormat10IdentifierEv"></span><span id="paimon::FileFormat::IdentifierC"></span><span class="target" id="classpaimon_1_1_file_format_1acfea05a4c90d05a136f3ec508347e93d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">Identifier</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon10FileFormat10IdentifierEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The corresponding identifier of file format, e.g., orc. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon10FileFormat19CreateReaderBuilderE7int32_t"> |
| <span id="_CPPv3NK6paimon10FileFormat19CreateReaderBuilderE7int32_t"></span><span id="_CPPv2NK6paimon10FileFormat19CreateReaderBuilderE7int32_t"></span><span id="paimon::FileFormat::CreateReaderBuilder__int32_tC"></span><span class="target" id="classpaimon_1_1_file_format_1ad0921d76ee8531144b016b6bb38760cc"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon13ReaderBuilderE" title="paimon::ReaderBuilder"><span class="n"><span class="pre">ReaderBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreateReaderBuilder</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">batch_size</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon10FileFormat19CreateReaderBuilderE7int32_t" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A reader builder which will create reader with specific batch size. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon10FileFormat19CreateWriterBuilderEP11ArrowSchema7int32_t"> |
| <span id="_CPPv3NK6paimon10FileFormat19CreateWriterBuilderEP11ArrowSchema7int32_t"></span><span id="_CPPv2NK6paimon10FileFormat19CreateWriterBuilderEP11ArrowSchema7int32_t"></span><span id="paimon::FileFormat::CreateWriterBuilder__ArrowSchemaP.int32_tC"></span><span class="target" id="classpaimon_1_1_file_format_1abb275a73c000c0b240118d0fbc4cc5eb"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon13WriterBuilderE" title="paimon::WriterBuilder"><span class="n"><span class="pre">WriterBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreateWriterBuilder</span></span></span><span class="sig-paren">(</span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowSchema</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">schema</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">batch_size</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon10FileFormat19CreateWriterBuilderEP11ArrowSchema7int32_t" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_writer_builder"><span class="std std-ref"><span class="pre">WriterBuilder</span></span></a></code> of the corresponding schema, or error status when schema is invalid. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon10FileFormat20CreateStatsExtractorEP11ArrowSchema"> |
| <span id="_CPPv3NK6paimon10FileFormat20CreateStatsExtractorEP11ArrowSchema"></span><span id="_CPPv2NK6paimon10FileFormat20CreateStatsExtractorEP11ArrowSchema"></span><span id="paimon::FileFormat::CreateStatsExtractor__ArrowSchemaPC"></span><span class="target" id="classpaimon_1_1_file_format_1a62e4644cc68c7b981e6edf84d280fb24"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon20FormatStatsExtractorE" title="paimon::FormatStatsExtractor"><span class="n"><span class="pre">FormatStatsExtractor</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreateStatsExtractor</span></span></span><span class="sig-paren">(</span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowSchema</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">schema</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon10FileFormat20CreateStatsExtractorEP11ArrowSchema" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_format_stats_extractor"><span class="std std-ref"><span class="pre">FormatStatsExtractor</span></span></a></code> of current file format. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon12FormatWriterE"> |
| <span id="_CPPv3N6paimon12FormatWriterE"></span><span id="_CPPv2N6paimon12FormatWriterE"></span><span id="paimon::FormatWriter"></span><span class="target" id="classpaimon_1_1_format_writer"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FormatWriter</span></span></span><a class="headerlink" href="#_CPPv4N6paimon12FormatWriterE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>File format writer, each writer corresponds to a data file. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon12FormatWriterD0Ev"> |
| <span id="_CPPv3N6paimon12FormatWriterD0Ev"></span><span id="_CPPv2N6paimon12FormatWriterD0Ev"></span><span id="paimon::FormatWriter::~FormatWriter"></span><span class="target" id="classpaimon_1_1_format_writer_1ad93f4f889e5f6a84e443a56032c23e33"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~FormatWriter</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N6paimon12FormatWriterD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon12FormatWriter8AddBatchEP10ArrowArray"> |
| <span id="_CPPv3N6paimon12FormatWriter8AddBatchEP10ArrowArray"></span><span id="_CPPv2N6paimon12FormatWriter8AddBatchEP10ArrowArray"></span><span id="paimon::FormatWriter::AddBatch__ArrowArrayP"></span><span class="target" id="classpaimon_1_1_format_writer_1a2e7a64e6f91b3cfb5abddd4f3c15c05e"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Status</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AddBatch</span></span></span><span class="sig-paren">(</span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowArray</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">batch</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon12FormatWriter8AddBatchEP10ArrowArray" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Add a batch of records to the format writer. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>The batch must conform to the schema expected by the writer. </p> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This method can be called multiple times to write data incrementally. </p> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>After calling <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_format_writer_1a5baab67a1a5a3b42a6477dc0bf8eadc7"><span class="std std-ref"><span class="pre">Finish()</span></span></a></code>, this method should not be called again. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>batch</strong> – Pointer to an ArrowArray containing the batch data to write. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Status indicating success (OK) or failure with error information. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon12FormatWriter5FlushEv"> |
| <span id="_CPPv3N6paimon12FormatWriter5FlushEv"></span><span id="_CPPv2N6paimon12FormatWriter5FlushEv"></span><span id="paimon::FormatWriter::Flush"></span><span class="target" id="classpaimon_1_1_format_writer_1ad542d387b7ff77e9a38c782c66a7b743"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Status</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Flush</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon12FormatWriter5FlushEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Flushes all intermediate buffered data to the format writer. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Error status returned if the encoder cannot be flushed, or if the output stream return an error. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon12FormatWriter6FinishEv"> |
| <span id="_CPPv3N6paimon12FormatWriter6FinishEv"></span><span id="_CPPv2N6paimon12FormatWriter6FinishEv"></span><span id="paimon::FormatWriter::Finish"></span><span class="target" id="classpaimon_1_1_format_writer_1a5baab67a1a5a3b42a6477dc0bf8eadc7"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Status</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Finish</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon12FormatWriter6FinishEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Finishes the writing. </p> |
| <p>This must flush all internal buffer, finish encoding, and write footers.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>The writer is not expected to handle any more records via <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_format_writer_1a2e7a64e6f91b3cfb5abddd4f3c15c05e"><span class="std std-ref"><span class="pre">AddBatch()</span></span></a></code> after this method is called.</p> |
| </div> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p>This method <strong>MUST NOT</strong> close the stream that the writer writes to. Closing the stream is expected to happen through the invoker of this method afterwards.</p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Error status returned if the finalization fails. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon12FormatWriter15ReachTargetSizeEb7int64_t"> |
| <span id="_CPPv3NK6paimon12FormatWriter15ReachTargetSizeEb7int64_t"></span><span id="_CPPv2NK6paimon12FormatWriter15ReachTargetSizeEb7int64_t"></span><span id="paimon::FormatWriter::ReachTargetSize__b.int64_tC"></span><span class="target" id="classpaimon_1_1_format_writer_1a3a2e1e327fe9bf5e8f4a3aa8bdb76a43"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReachTargetSize</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">suggested_check</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">target_size</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon12FormatWriter15ReachTargetSizeEb7int64_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Check if the writer has reached the <code class="docutils literal notranslate"><span class="pre">target_size</span></code>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>suggested_check</strong> – Whether it needs to be checked, but subclasses can also decide whether to check it themselves. </p></li> |
| <li><p><strong>target_size</strong> – The size of the target. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>True if the target size was reached, otherwise false. </p> |
| </dd> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Error status returned if calculating the length fails. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon12FormatWriter16GetWriterMetricsEv"> |
| <span id="_CPPv3NK6paimon12FormatWriter16GetWriterMetricsEv"></span><span id="_CPPv2NK6paimon12FormatWriter16GetWriterMetricsEv"></span><span id="paimon::FormatWriter::GetWriterMetricsC"></span><span class="target" id="classpaimon_1_1_format_writer_1a87e5ca9131746f86812b1c7a45ec7536"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Metrics</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetWriterMetrics</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon12FormatWriter16GetWriterMetricsEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get metrics of the writer. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The accumulated writer metrics to current state. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13WriterBuilderE"> |
| <span id="_CPPv3N6paimon13WriterBuilderE"></span><span id="_CPPv2N6paimon13WriterBuilderE"></span><span id="paimon::WriterBuilder"></span><span class="target" id="classpaimon_1_1_writer_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">WriterBuilder</span></span></span><a class="headerlink" href="#_CPPv4N6paimon13WriterBuilderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Create a file format writer based on the file output stream. Allows you to specify memory pool. </p> |
| <p>Subclassed by paimon::DirectWriterBuilder, paimon::SpecificFSWriterBuilder</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13WriterBuilderD0Ev"> |
| <span id="_CPPv3N6paimon13WriterBuilderD0Ev"></span><span id="_CPPv2N6paimon13WriterBuilderD0Ev"></span><span id="paimon::WriterBuilder::~WriterBuilder"></span><span class="target" id="classpaimon_1_1_writer_builder_1a1bfb13d013967ed6e07459992bfa826c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~WriterBuilder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N6paimon13WriterBuilderD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13WriterBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon13WriterBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon13WriterBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::WriterBuilder::WithMemoryPool__std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_writer_builder_1aebeb244a2785f602ff9b500af9adef1c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon13WriterBuilderE" title="paimon::WriterBuilder"><span class="n"><span class="pre">WriterBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">WithMemoryPool</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon13WriterBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set memory pool to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13WriterBuilder5BuildERKNSt10shared_ptrI12OutputStreamEERKNSt6stringE"> |
| <span id="_CPPv3N6paimon13WriterBuilder5BuildERKNSt10shared_ptrI12OutputStreamEERKNSt6stringE"></span><span id="_CPPv2N6paimon13WriterBuilder5BuildERKNSt10shared_ptrI12OutputStreamEERKNSt6stringE"></span><span id="paimon::WriterBuilder::Build__std::shared_ptr:OutputStream:CR.ssCR"></span><span class="target" id="classpaimon_1_1_writer_builder_1a0dcede79a22f46a4bc35c2f3646116a4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon12FormatWriterE" title="paimon::FormatWriter"><span class="n"><span class="pre">FormatWriter</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Build</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="file_system.html#_CPPv4N6paimon12OutputStreamE" title="paimon::OutputStream"><span class="n"><span class="pre">OutputStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">out</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">compression</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon13WriterBuilder5BuildERKNSt10shared_ptrI12OutputStreamEERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Build a file format writer based on the file output stream and file compression. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon15FileBatchReaderE"> |
| <span id="_CPPv3N6paimon15FileBatchReaderE"></span><span id="_CPPv2N6paimon15FileBatchReaderE"></span><span id="paimon::FileBatchReader"></span><span class="target" id="classpaimon_1_1_file_batch_reader"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FileBatchReader</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="read.html#_CPPv4N6paimon11BatchReaderE" title="paimon::BatchReader"><span class="n"><span class="pre">BatchReader</span></span></a><a class="headerlink" href="#_CPPv4N6paimon15FileBatchReaderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>The batch reader for a single file supports returning the line number of the last batch read for deletion vector judgment. </p> |
| <p>Subclassed by paimon::PrefetchFileBatchReader</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15FileBatchReader13GetFileSchemaEv"> |
| <span id="_CPPv3NK6paimon15FileBatchReader13GetFileSchemaEv"></span><span id="_CPPv2NK6paimon15FileBatchReader13GetFileSchemaEv"></span><span id="paimon::FileBatchReader::GetFileSchemaC"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1ac7266064352ed90581738242cf69500f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowSchema</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFileSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15FileBatchReader13GetFileSchemaEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The schema of the file. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon15FileBatchReader13SetReadSchemaEP11ArrowSchemaRKNSt10shared_ptrI9PredicateEERKNSt8optionalI15RoaringBitmap32EE"> |
| <span id="_CPPv3N6paimon15FileBatchReader13SetReadSchemaEP11ArrowSchemaRKNSt10shared_ptrI9PredicateEERKNSt8optionalI15RoaringBitmap32EE"></span><span id="_CPPv2N6paimon15FileBatchReader13SetReadSchemaEP11ArrowSchemaRKNSt10shared_ptrI9PredicateEERKNSt8optionalI15RoaringBitmap32EE"></span><span id="paimon::FileBatchReader::SetReadSchema__ArrowSchemaP.std::shared_ptr:Predicate:CR.std::optional:RoaringBitmap32:CR"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1af1b28c896a926c6496d03b9a5b55afb2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Status</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetReadSchema</span></span></span><span class="sig-paren">(</span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowSchema</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">read_schema</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="predicate.html#_CPPv4N6paimon9PredicateE" title="paimon::Predicate"><span class="n"><span class="pre">Predicate</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">predicate</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">RoaringBitmap32</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">selection_bitmap</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon15FileBatchReader13SetReadSchemaEP11ArrowSchemaRKNSt10shared_ptrI9PredicateEERKNSt8optionalI15RoaringBitmap32EE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Resets the read schema and predicate. </p> |
| <p>If <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_batch_reader_1af1b28c896a926c6496d03b9a5b55afb2"><span class="std std-ref"><span class="pre">SetReadSchema()</span></span></a></code> is not called, <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_batch_reader_1a01358cb810bb14fcb26663d510c08fce"><span class="std std-ref"><span class="pre">NextBatch()</span></span></a></code> will return data with the file schema. After resetting the read schema, <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_batch_reader_1a01358cb810bb14fcb26663d510c08fce"><span class="std std-ref"><span class="pre">NextBatch()</span></span></a></code> will read data starting from the first row.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>read_schema</strong> – The schema to set for reading. </p></li> |
| <li><p><strong>predicate</strong> – The predicate to apply for filtering data. </p></li> |
| <li><p><strong>selection_bitmap</strong> – The bitmap to apply for filtering data. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>The status of the operation. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15FileBatchReader30GetPreviousBatchFirstRowNumberEv"> |
| <span id="_CPPv3NK6paimon15FileBatchReader30GetPreviousBatchFirstRowNumberEv"></span><span id="_CPPv2NK6paimon15FileBatchReader30GetPreviousBatchFirstRowNumberEv"></span><span id="paimon::FileBatchReader::GetPreviousBatchFirstRowNumberC"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1a25b072ce59e14b7a18dda4ce9b71b843"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">uint64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPreviousBatchFirstRowNumber</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15FileBatchReader30GetPreviousBatchFirstRowNumberEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get the row number of the first row in the previously read batch. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15FileBatchReader15GetNumberOfRowsEv"> |
| <span id="_CPPv3NK6paimon15FileBatchReader15GetNumberOfRowsEv"></span><span id="_CPPv2NK6paimon15FileBatchReader15GetNumberOfRowsEv"></span><span id="paimon::FileBatchReader::GetNumberOfRowsC"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1a8ebc841f9c493d3ec18786626a876073"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">uint64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetNumberOfRows</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15FileBatchReader15GetNumberOfRowsEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get the number of rows in the file. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15FileBatchReader29SupportPreciseBitmapSelectionEv"> |
| <span id="_CPPv3NK6paimon15FileBatchReader29SupportPreciseBitmapSelectionEv"></span><span id="_CPPv2NK6paimon15FileBatchReader29SupportPreciseBitmapSelectionEv"></span><span id="paimon::FileBatchReader::SupportPreciseBitmapSelectionC"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1ac5afd12bba8e497dfc95cba25a343ba3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SupportPreciseBitmapSelection</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15FileBatchReader29SupportPreciseBitmapSelectionEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get whether or not support read precisely while bitmap pushed down. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon15FileBatchReader9NextBatchEv"> |
| <span id="_CPPv3N6paimon15FileBatchReader9NextBatchEv"></span><span id="_CPPv2N6paimon15FileBatchReader9NextBatchEv"></span><span id="paimon::FileBatchReader::NextBatch"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1a01358cb810bb14fcb26663d510c08fce"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ReadBatch</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NextBatch</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon15FileBatchReader9NextBatchEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the next batch of data. </p> |
| <p>If EOF is reached, returns an OK status with a nullptr array. Returns an error status only for critical failures (e.g., IO errors). Once an error is returned, this method must not be retried, as it will repeatedly return the same error code.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A result containing a <code class="docutils literal notranslate"><a class="reference internal" href="read.html#classpaimon_1_1_batch_reader_1a52a5b04ada9bf1da22f5d7e1784927b2"><span class="std std-ref"><span class="pre">ReadBatch</span></span></a></code>, which consists of a unique pointer to <code class="docutils literal notranslate"><span class="pre">ArrowArray</span></code> and a unique pointer to <code class="docutils literal notranslate"><span class="pre">ArrowSchema</span></code>. Returned array contains a <code class="docutils literal notranslate"><span class="pre">_VALUE_KIND</span></code> field (the first field) to indicate the row kind of each row. Deleted or index-filtered rows are removed. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon15FileBatchReader19NextBatchWithBitmapEv"> |
| <span id="_CPPv3N6paimon15FileBatchReader19NextBatchWithBitmapEv"></span><span id="_CPPv2N6paimon15FileBatchReader19NextBatchWithBitmapEv"></span><span id="paimon::FileBatchReader::NextBatchWithBitmap"></span><span class="target" id="classpaimon_1_1_file_batch_reader_1ae4b5062701224aeae83472380d02f434"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ReadBatchWithBitmap</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NextBatchWithBitmap</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon15FileBatchReader19NextBatchWithBitmapEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the next batch of data. </p> |
| <p>If EOF is reached, returns an OK status with a nullptr array. Returns an error status only for critical failures (e.g., IO errors). Once an error is returned, this method must not be retried, as it will repeatedly return the same error code.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A result containing a <code class="docutils literal notranslate"><a class="reference internal" href="read.html#classpaimon_1_1_batch_reader_1a52a5b04ada9bf1da22f5d7e1784927b2"><span class="std std-ref"><span class="pre">ReadBatch</span></span></a></code> and a valid bitmap. <code class="docutils literal notranslate"><a class="reference internal" href="read.html#classpaimon_1_1_batch_reader_1a52a5b04ada9bf1da22f5d7e1784927b2"><span class="std std-ref"><span class="pre">ReadBatch</span></span></a></code> consists of a unique pointer to <code class="docutils literal notranslate"><span class="pre">ArrowArray</span></code> and a unique pointer to <code class="docutils literal notranslate"><span class="pre">ArrowSchema</span></code>. Returned array contains a _VALUE_KIND field (the first field) to indicate the row kind of each row. Deleted or index-filtered records maybe maintained in <code class="docutils literal notranslate"><a class="reference internal" href="read.html#classpaimon_1_1_batch_reader_1a52a5b04ada9bf1da22f5d7e1784927b2"><span class="std std-ref"><span class="pre">ReadBatch</span></span></a></code>, while bitmap indicates valid row id. If deletion vector or index are enabled, this function is more efficient than <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_batch_reader_1a01358cb810bb14fcb26663d510c08fce"><span class="std std-ref"><span class="pre">NextBatch()</span></span></a></code>. The default implementation calls <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_batch_reader_1a01358cb810bb14fcb26663d510c08fce"><span class="std std-ref"><span class="pre">NextBatch()</span></span></a></code> and adds all rows to valid bitmap. Noted that the returned bitmap has at least one valid row id. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13ReaderBuilderE"> |
| <span id="_CPPv3N6paimon13ReaderBuilderE"></span><span id="_CPPv2N6paimon13ReaderBuilderE"></span><span id="paimon::ReaderBuilder"></span><span class="target" id="classpaimon_1_1_reader_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReaderBuilder</span></span></span><a class="headerlink" href="#_CPPv4N6paimon13ReaderBuilderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Create a file batch reader based on the file path. Allows you to specify memory pool. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13ReaderBuilderD0Ev"> |
| <span id="_CPPv3N6paimon13ReaderBuilderD0Ev"></span><span id="_CPPv2N6paimon13ReaderBuilderD0Ev"></span><span id="paimon::ReaderBuilder::~ReaderBuilder"></span><span class="target" id="classpaimon_1_1_reader_builder_1aa4f6427f3e7265ac1ec43047027b2e91"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~ReaderBuilder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N6paimon13ReaderBuilderD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13ReaderBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon13ReaderBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon13ReaderBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::ReaderBuilder::WithMemoryPool__std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_reader_builder_1a3256a0e67c0174668a605a5a6513409d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon13ReaderBuilderE" title="paimon::ReaderBuilder"><span class="n"><span class="pre">ReaderBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">WithMemoryPool</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon13ReaderBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set memory pool to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon13ReaderBuilder5BuildERKNSt10shared_ptrI11InputStreamEE"> |
| <span id="_CPPv3NK6paimon13ReaderBuilder5BuildERKNSt10shared_ptrI11InputStreamEE"></span><span id="_CPPv2NK6paimon13ReaderBuilder5BuildERKNSt10shared_ptrI11InputStreamEE"></span><span id="paimon::ReaderBuilder::Build__std::shared_ptr:InputStream:CRC"></span><span class="target" id="classpaimon_1_1_reader_builder_1a0a025fdbb6bd1fbb5254a5ab8e01ed17"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon15FileBatchReaderE" title="paimon::FileBatchReader"><span class="n"><span class="pre">FileBatchReader</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Build</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="file_system.html#_CPPv4N6paimon11InputStreamE" title="paimon::InputStream"><span class="n"><span class="pre">InputStream</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon13ReaderBuilder5BuildERKNSt10shared_ptrI11InputStreamEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Build a file batch reader based on the created <code class="docutils literal notranslate"><a class="reference internal" href="file_system.html#classpaimon_1_1_input_stream"><span class="std std-ref"><span class="pre">InputStream</span></span></a></code>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17FileFormatFactoryE"> |
| <span id="_CPPv3N6paimon17FileFormatFactoryE"></span><span id="_CPPv2N6paimon17FileFormatFactoryE"></span><span id="paimon::FileFormatFactory"></span><span class="target" id="classpaimon_1_1_file_format_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FileFormatFactory</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Factory</span></span><a class="headerlink" href="#_CPPv4N6paimon17FileFormatFactoryE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>A factory for creating <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_format"><span class="std std-ref"><span class="pre">FileFormat</span></span></a></code> instances. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17FileFormatFactoryD0Ev"> |
| <span id="_CPPv3N6paimon17FileFormatFactoryD0Ev"></span><span id="_CPPv2N6paimon17FileFormatFactoryD0Ev"></span><span id="paimon::FileFormatFactory::~FileFormatFactory"></span><span class="target" id="classpaimon_1_1_file_format_factory_1a8985f35b3ad8d1b0400d3cb0f9b7c3fa"></span><span class="sig-name descname"><span class="n"><span class="pre">~FileFormatFactory</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon17FileFormatFactoryD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17FileFormatFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3NK6paimon17FileFormatFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2NK6paimon17FileFormatFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="paimon::FileFormatFactory::Create__std::map:ss.ss:CRC"></span><span class="target" id="classpaimon_1_1_file_format_factory_1a4d5699589bb9bf6998be41af9cfe0eb2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon10FileFormatE" title="paimon::FileFormat"><span class="n"><span class="pre">FileFormat</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Create</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon17FileFormatFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Create a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_format"><span class="std std-ref"><span class="pre">FileFormat</span></span></a></code> with the corresponding options. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17FileFormatFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3N6paimon17FileFormatFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N6paimon17FileFormatFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="paimon::FileFormatFactory::Get__ssCR.std::map:ss.ss:CR"></span><span class="target" id="classpaimon_1_1_file_format_factory_1a28fb855da5c5fa43575a3ede52caf911"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon10FileFormatE" title="paimon::FileFormat"><span class="n"><span class="pre">FileFormat</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Get</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">identifier</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon17FileFormatFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_file_format"><span class="std std-ref"><span class="pre">FileFormat</span></span></a></code> corresponding to identifier. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Pre<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Factory is already registered. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20FormatStatsExtractorE"> |
| <span id="_CPPv3N6paimon20FormatStatsExtractorE"></span><span id="_CPPv2N6paimon20FormatStatsExtractorE"></span><span id="paimon::FormatStatsExtractor"></span><span class="target" id="classpaimon_1_1_format_stats_extractor"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FormatStatsExtractor</span></span></span><a class="headerlink" href="#_CPPv4N6paimon20FormatStatsExtractorE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Extracts statistics directly from file. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20FormatStatsExtractorD0Ev"> |
| <span id="_CPPv3N6paimon20FormatStatsExtractorD0Ev"></span><span id="_CPPv2N6paimon20FormatStatsExtractorD0Ev"></span><span id="paimon::FormatStatsExtractor::~FormatStatsExtractor"></span><span class="target" id="classpaimon_1_1_format_stats_extractor_1a4732fe1bbe7bb127e63d8c926d8bbc5a"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~FormatStatsExtractor</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N6paimon20FormatStatsExtractorD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20FormatStatsExtractor7ExtractERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon20FormatStatsExtractor7ExtractERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon20FormatStatsExtractor7ExtractERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::FormatStatsExtractor::Extract__std::shared_ptr:FileSystem:CR.ssCR.std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_format_stats_extractor_1a286589bfa52690e64d144d95d0c8bc76"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ColumnStatsVector</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Extract</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="file_system.html#_CPPv4N6paimon10FileSystemE" title="paimon::FileSystem"><span class="n"><span class="pre">FileSystem</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">file_system</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">path</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon20FormatStatsExtractor7ExtractERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Extracts statistics for each column of a data file based on the file path and file system. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20FormatStatsExtractor19ExtractWithFileInfoERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon20FormatStatsExtractor19ExtractWithFileInfoERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon20FormatStatsExtractor19ExtractWithFileInfoERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::FormatStatsExtractor::ExtractWithFileInfo__std::shared_ptr:FileSystem:CR.ssCR.std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_format_stats_extractor_1a3752abc455e667aee823f31f60eb2a2f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">pair</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ColumnStatsVector</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon20FormatStatsExtractor8FileInfoE" title="paimon::FormatStatsExtractor::FileInfo"><span class="n"><span class="pre">FileInfo</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExtractWithFileInfo</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="file_system.html#_CPPv4N6paimon10FileSystemE" title="paimon::FileSystem"><span class="n"><span class="pre">FileSystem</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">file_system</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">path</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N6paimon20FormatStatsExtractor19ExtractWithFileInfoERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Extracts statistics for each column and <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_format_stats_extractor_1_1_file_info"><span class="std std-ref"><span class="pre">FileInfo</span></span></a></code> of a data file based on the file path and file system. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20FormatStatsExtractor8FileInfoE"> |
| <span id="_CPPv3N6paimon20FormatStatsExtractor8FileInfoE"></span><span id="_CPPv2N6paimon20FormatStatsExtractor8FileInfoE"></span><span id="paimon::FormatStatsExtractor::FileInfo"></span><span class="target" id="classpaimon_1_1_format_stats_extractor_1_1_file_info"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FileInfo</span></span></span><a class="headerlink" href="#_CPPv4N6paimon20FormatStatsExtractor8FileInfoE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>File info fetched from physical file, currently only include row count. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20FormatStatsExtractor8FileInfo8FileInfoE7int64_t"> |
| <span id="_CPPv3N6paimon20FormatStatsExtractor8FileInfo8FileInfoE7int64_t"></span><span id="_CPPv2N6paimon20FormatStatsExtractor8FileInfo8FileInfoE7int64_t"></span><span id="paimon::FormatStatsExtractor::FileInfo::FileInfo__int64_t"></span><span class="target" id="classpaimon_1_1_format_stats_extractor_1_1_file_info_1adb8bb2c2bc3469c47ff28ae1353fa317"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FileInfo</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">row_count</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon20FormatStatsExtractor8FileInfo8FileInfoE7int64_t" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon20FormatStatsExtractor8FileInfo11GetRowCountEv"> |
| <span id="_CPPv3NK6paimon20FormatStatsExtractor8FileInfo11GetRowCountEv"></span><span id="_CPPv2NK6paimon20FormatStatsExtractor8FileInfo11GetRowCountEv"></span><span id="paimon::FormatStatsExtractor::FileInfo::GetRowCountC"></span><span class="target" id="classpaimon_1_1_format_stats_extractor_1_1_file_info_1a235809074c255456264beb0296ba2326"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetRowCount</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK6paimon20FormatStatsExtractor8FileInfo11GetRowCountEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer d-print-none"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="predicate.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">Predicate</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="file_system.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">File System</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 |
| id="pst-page-navigation-heading-2" |
| class="page-toc tocsection onthispage"> |
| <i class="fa-solid fa-list"></i> On this page |
| </div> |
| <nav id="pst-page-toc-nav" class="page-toc" aria-labelledby="pst-page-navigation-heading-2"> |
| <ul class="pst-show_toc_level nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#interface">Interface</a><ul class="pst-show_toc_level nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10FileFormatE"><code class="docutils literal notranslate"><span class="pre">paimon::FileFormat</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10FileFormatD0Ev"><code class="docutils literal notranslate"><span class="pre">~FileFormat()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10FileFormat10IdentifierEv"><code class="docutils literal notranslate"><span class="pre">Identifier()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10FileFormat19CreateReaderBuilderE7int32_t"><code class="docutils literal notranslate"><span class="pre">CreateReaderBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10FileFormat19CreateWriterBuilderEP11ArrowSchema7int32_t"><code class="docutils literal notranslate"><span class="pre">CreateWriterBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10FileFormat20CreateStatsExtractorEP11ArrowSchema"><code class="docutils literal notranslate"><span class="pre">CreateStatsExtractor()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon12FormatWriterE"><code class="docutils literal notranslate"><span class="pre">paimon::FormatWriter</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon12FormatWriterD0Ev"><code class="docutils literal notranslate"><span class="pre">~FormatWriter()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon12FormatWriter8AddBatchEP10ArrowArray"><code class="docutils literal notranslate"><span class="pre">AddBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon12FormatWriter5FlushEv"><code class="docutils literal notranslate"><span class="pre">Flush()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon12FormatWriter6FinishEv"><code class="docutils literal notranslate"><span class="pre">Finish()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon12FormatWriter15ReachTargetSizeEb7int64_t"><code class="docutils literal notranslate"><span class="pre">ReachTargetSize()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon12FormatWriter16GetWriterMetricsEv"><code class="docutils literal notranslate"><span class="pre">GetWriterMetrics()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13WriterBuilderE"><code class="docutils literal notranslate"><span class="pre">paimon::WriterBuilder</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13WriterBuilderD0Ev"><code class="docutils literal notranslate"><span class="pre">~WriterBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13WriterBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">WithMemoryPool()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13WriterBuilder5BuildERKNSt10shared_ptrI12OutputStreamEERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">Build()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15FileBatchReaderE"><code class="docutils literal notranslate"><span class="pre">paimon::FileBatchReader</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon15FileBatchReader13GetFileSchemaEv"><code class="docutils literal notranslate"><span class="pre">GetFileSchema()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15FileBatchReader13SetReadSchemaEP11ArrowSchemaRKNSt10shared_ptrI9PredicateEERKNSt8optionalI15RoaringBitmap32EE"><code class="docutils literal notranslate"><span class="pre">SetReadSchema()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon15FileBatchReader30GetPreviousBatchFirstRowNumberEv"><code class="docutils literal notranslate"><span class="pre">GetPreviousBatchFirstRowNumber()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon15FileBatchReader15GetNumberOfRowsEv"><code class="docutils literal notranslate"><span class="pre">GetNumberOfRows()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon15FileBatchReader29SupportPreciseBitmapSelectionEv"><code class="docutils literal notranslate"><span class="pre">SupportPreciseBitmapSelection()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15FileBatchReader9NextBatchEv"><code class="docutils literal notranslate"><span class="pre">NextBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15FileBatchReader19NextBatchWithBitmapEv"><code class="docutils literal notranslate"><span class="pre">NextBatchWithBitmap()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13ReaderBuilderE"><code class="docutils literal notranslate"><span class="pre">paimon::ReaderBuilder</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13ReaderBuilderD0Ev"><code class="docutils literal notranslate"><span class="pre">~ReaderBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13ReaderBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">WithMemoryPool()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon13ReaderBuilder5BuildERKNSt10shared_ptrI11InputStreamEE"><code class="docutils literal notranslate"><span class="pre">Build()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17FileFormatFactoryE"><code class="docutils literal notranslate"><span class="pre">paimon::FileFormatFactory</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17FileFormatFactoryD0Ev"><code class="docutils literal notranslate"><span class="pre">~FileFormatFactory()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17FileFormatFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"><code class="docutils literal notranslate"><span class="pre">Create()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17FileFormatFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"><code class="docutils literal notranslate"><span class="pre">Get()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20FormatStatsExtractorE"><code class="docutils literal notranslate"><span class="pre">paimon::FormatStatsExtractor</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20FormatStatsExtractorD0Ev"><code class="docutils literal notranslate"><span class="pre">~FormatStatsExtractor()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20FormatStatsExtractor7ExtractERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">Extract()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20FormatStatsExtractor19ExtractWithFileInfoERKNSt10shared_ptrI10FileSystemEERKNSt6stringERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">ExtractWithFileInfo()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20FormatStatsExtractor8FileInfoE"><code class="docutils literal notranslate"><span class="pre">paimon::FormatStatsExtractor::FileInfo</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20FormatStatsExtractor8FileInfo8FileInfoE7int64_t"><code class="docutils literal notranslate"><span class="pre">FileInfo()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon20FormatStatsExtractor8FileInfo11GetRowCountEv"><code class="docutils literal notranslate"><span class="pre">GetRowCount()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav></div> |
| |
| <div class="sidebar-secondary-item"> |
| |
| |
| <div class="tocsection editthispage"> |
| <a href="https://github.com/apache/paimon-cpp/edit/main/docs/source/api/file_format.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> |
