| |
| <!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>Read — 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/read';</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="Predicate" href="predicate.html" /> |
| <link rel="prev" title="Scan" href="scan.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 current active"><a class="current reference internal" href="#">Read</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="predicate.html">Predicate</a></li> |
| |
| <li class="toctree-l1"><a class="reference internal" href="file_format.html">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">Read</span></li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="read"> |
| <h1>Read<a class="headerlink" href="#read" title="Link to this heading">#</a></h1> |
| <section id="interface"> |
| <span id="cpp-api-read"></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="_CPPv4N6paimon9TableReadE"> |
| <span id="_CPPv3N6paimon9TableReadE"></span><span id="_CPPv2N6paimon9TableReadE"></span><span id="paimon::TableRead"></span><span class="target" id="classpaimon_1_1_table_read"></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">TableRead</span></span></span><a class="headerlink" href="#_CPPv4N6paimon9TableReadE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Given a <code class="docutils literal notranslate"><a class="reference internal" href="scan.html#classpaimon_1_1_split"><span class="std std-ref"><span class="pre">Split</span></span></a></code> or a list of <code class="docutils literal notranslate"><a class="reference internal" href="scan.html#classpaimon_1_1_split"><span class="std std-ref"><span class="pre">Split</span></span></a></code>, generate a reader for batch reading. </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="_CPPv4N6paimon9TableReadD0Ev"> |
| <span id="_CPPv3N6paimon9TableReadD0Ev"></span><span id="_CPPv2N6paimon9TableReadD0Ev"></span><span id="paimon::TableRead::~TableRead"></span><span class="target" id="classpaimon_1_1_table_read_1a489cf1b366949b163c0db353988c3503"></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">~TableRead</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="#_CPPv4N6paimon9TableReadD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon9TableRead12CreateReaderERKNSt6vectorINSt10shared_ptrI5SplitEEEE"> |
| <span id="_CPPv3N6paimon9TableRead12CreateReaderERKNSt6vectorINSt10shared_ptrI5SplitEEEE"></span><span id="_CPPv2N6paimon9TableRead12CreateReaderERKNSt6vectorINSt10shared_ptrI5SplitEEEE"></span><span id="paimon::TableRead::CreateReader__std::vector:std::shared_ptr:Split::CR"></span><span class="target" id="classpaimon_1_1_table_read_1a81796bc3daa8d21e21f8ba2e32b539ec"></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="#_CPPv4N6paimon11BatchReaderE" title="paimon::BatchReader"><span class="n"><span class="pre">BatchReader</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">CreateReader</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">vector</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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="scan.html#_CPPv4N6paimon5SplitE" title="paimon::Split"><span class="n"><span class="pre">Split</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="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">splits</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon9TableRead12CreateReaderERKNSt6vectorINSt10shared_ptrI5SplitEEEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref"><span class="pre">BatchReader</span></span></a></code> instance for reading data. </p> |
| <p>This method creates a <a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref">BatchReader</span></a> that will be responsible for reading data from the provided splits.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p><code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref"><span class="pre">BatchReader</span></span></a></code>s created by the same <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_table_read"><span class="std std-ref"><span class="pre">TableRead</span></span></a></code> are not thread-safe for concurrent reading. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>splits</strong> – A vector of shared pointers to <code class="docutils literal notranslate"><a class="reference internal" href="scan.html#classpaimon_1_1_split"><span class="std std-ref"><span class="pre">Split</span></span></a></code> instances representing the data to be read. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Result containing a unique pointer to the <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref"><span class="pre">BatchReader</span></span></a></code> instance. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon9TableRead12CreateReaderERKNSt10shared_ptrI5SplitEE"> |
| <span id="_CPPv3N6paimon9TableRead12CreateReaderERKNSt10shared_ptrI5SplitEE"></span><span id="_CPPv2N6paimon9TableRead12CreateReaderERKNSt10shared_ptrI5SplitEE"></span><span id="paimon::TableRead::CreateReader__std::shared_ptr:Split:CR"></span><span class="target" id="classpaimon_1_1_table_read_1a45d5949ae071cd273bf18d87908a9522"></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="#_CPPv4N6paimon11BatchReaderE" title="paimon::BatchReader"><span class="n"><span class="pre">BatchReader</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">CreateReader</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="scan.html#_CPPv4N6paimon5SplitE" title="paimon::Split"><span class="n"><span class="pre">Split</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">split</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="#_CPPv4N6paimon9TableRead12CreateReaderERKNSt10shared_ptrI5SplitEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref"><span class="pre">BatchReader</span></span></a></code> instance for a single split. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>split</strong> – A shared pointer to the <code class="docutils literal notranslate"><a class="reference internal" href="scan.html#classpaimon_1_1_split"><span class="std std-ref"><span class="pre">Split</span></span></a></code> instance that defines the data to be read. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Result containing a unique pointer to the <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref"><span class="pre">BatchReader</span></span></a></code> instance. </p> |
| </dd> |
| </dl> |
| </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="_CPPv4N6paimon9TableRead6CreateENSt10unique_ptrI11ReadContextEE"> |
| <span id="_CPPv3N6paimon9TableRead6CreateENSt10unique_ptrI11ReadContextEE"></span><span id="_CPPv2N6paimon9TableRead6CreateENSt10unique_ptrI11ReadContextEE"></span><span id="paimon::TableRead::Create__std::unique_ptr:ReadContext:"></span><span class="target" id="classpaimon_1_1_table_read_1a61ce8ddb69965e9166ba34c337ca8841"></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="#_CPPv4N6paimon9TableReadE" title="paimon::TableRead"><span class="n"><span class="pre">TableRead</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="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="#_CPPv4N6paimon11ReadContextE" title="paimon::ReadContext"><span class="n"><span class="pre">ReadContext</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon9TableRead6CreateENSt10unique_ptrI11ReadContextEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Create an instance of <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_table_read"><span class="std std-ref"><span class="pre">TableRead</span></span></a></code>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>context</strong> – A unique pointer to the <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context"><span class="std std-ref"><span class="pre">ReadContext</span></span></a></code> used for read operations. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Result containing a unique pointer to the <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_table_read"><span class="std std-ref"><span class="pre">TableRead</span></span></a></code> instance. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilderE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilderE"></span><span id="_CPPv2N6paimon18ReadContextBuilderE"></span><span id="paimon::ReadContextBuilder"></span><span class="target" id="classpaimon_1_1_read_context_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">ReadContextBuilder</span></span></span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p><code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder"><span class="std std-ref"><span class="pre">ReadContextBuilder</span></span></a></code> used to build a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context"><span class="std std-ref"><span class="pre">ReadContext</span></span></a></code>, has input validation. </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="_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERKNSt6stringE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder18ReadContextBuilderERKNSt6stringE"></span><span id="_CPPv2N6paimon18ReadContextBuilder18ReadContextBuilderERKNSt6stringE"></span><span id="paimon::ReadContextBuilder::ReadContextBuilder__ssCR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a4e36cce9a1da99af61afb2283804128f"></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">ReadContextBuilder</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">path</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Constructs a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder"><span class="std std-ref"><span class="pre">ReadContextBuilder</span></span></a></code> with required parameters. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>path</strong> – The root path of the table. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilderD0Ev"> |
| <span id="_CPPv3N6paimon18ReadContextBuilderD0Ev"></span><span id="_CPPv2N6paimon18ReadContextBuilderD0Ev"></span><span id="paimon::ReadContextBuilder::~ReadContextBuilder"></span><span class="target" id="classpaimon_1_1_read_context_builder_1ab2df9112180f6a2e2216ab9a2efc876e"></span><span class="sig-name descname"><span class="n"><span class="pre">~ReadContextBuilder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilderD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERR18ReadContextBuilder"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder18ReadContextBuilderERR18ReadContextBuilder"></span><span id="_CPPv2N6paimon18ReadContextBuilder18ReadContextBuilderERR18ReadContextBuilder"></span><span id="paimon::ReadContextBuilder::ReadContextBuilder__ReadContextBuilderRR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a06fd2e446a1ce516d7b13f52ab3e29a2"></span><span class="sig-name descname"><span class="n"><span class="pre">ReadContextBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERR18ReadContextBuilder" title="paimon::ReadContextBuilder::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</span></span></a><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERR18ReadContextBuilder" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilderaSERR18ReadContextBuilder"> |
| <span id="_CPPv3N6paimon18ReadContextBuilderaSERR18ReadContextBuilder"></span><span id="_CPPv2N6paimon18ReadContextBuilderaSERR18ReadContextBuilder"></span><span id="paimon::ReadContextBuilder::assign-operator__ReadContextBuilderRR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a2925ca4ec784ce7e78ad0ff3f08535d7"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">=</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</span></span></a><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilderaSERR18ReadContextBuilder" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder13SetReadSchemaERKNSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder13SetReadSchemaERKNSt6vectorINSt6stringEEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder13SetReadSchemaERKNSt6vectorINSt6stringEEE"></span><span id="paimon::ReadContextBuilder::SetReadSchema__std::vector:ss:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1ab9d0cde6e98dccd3b10439bae2b6865b"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetReadSchema</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">vector</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="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">read_field_names</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder13SetReadSchemaERKNSt6vectorINSt6stringEEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the schema fields to read from the table. </p> |
| <p>If not set, all fields from the table schema will be read. This is useful for projection pushdown to reduce I/O and improve performance by reading only the required columns.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Currently supports top-level field selection. Future versions may support nested field selection using ArrowSchema for more granular projection </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>read_field_names</strong> – Vector of field names to read from the table. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder15SetReadFieldIdsERKNSt6vectorI7int32_tEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder15SetReadFieldIdsERKNSt6vectorI7int32_tEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder15SetReadFieldIdsERKNSt6vectorI7int32_tEE"></span><span id="paimon::ReadContextBuilder::SetReadFieldIds__std::vector:int32_t:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a13e652d39f99bd80ffa2b10af2b29245"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetReadFieldIds</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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</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">read_field_ids</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder15SetReadFieldIdsERKNSt6vectorI7int32_tEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the schema fields to read from the table. </p> |
| <p>If not set, all fields from the table schema will be read. This is useful for projection pushdown to reduce I/O and improve performance by reading only the required columns.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Currently supports top-level field selection. Future versions may support nested field selection using ArrowSchema for more granular projection. </p> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p><a class="reference internal" href="#classpaimon_1_1_read_context_builder_1a13e652d39f99bd80ffa2b10af2b29245"><span class="std std-ref">SetReadFieldIds()</span></a> and <a class="reference internal" href="#classpaimon_1_1_read_context_builder_1ab9d0cde6e98dccd3b10439bae2b6865b"><span class="std std-ref">SetReadSchema()</span></a> are mutually exclusive. Calling both will ignore the read schema set by <a class="reference internal" href="#classpaimon_1_1_read_context_builder_1ab9d0cde6e98dccd3b10439bae2b6865b"><span class="std std-ref">SetReadSchema()</span></a>. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>read_field_ids</strong> – Vector of field ids to read from the table. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder10SetOptionsERKNSt3mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder10SetOptionsERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder10SetOptionsERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="paimon::ReadContextBuilder::SetOptions__std::map:ss.ss:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a19370226e886d90bfb4b2146e769cff6"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetOptions</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><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder10SetOptionsERKNSt3mapINSt6stringENSt6stringEEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set a configuration options map to set some option entries which are not defined in the table schema or whose values you want to overwrite. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>The options map will clear the options added by <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder_1a19a1a07f17d04342f0a3e31faedf4d04"><span class="std std-ref"><span class="pre">AddOption()</span></span></a></code> before. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>options</strong> – The configuration options map. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder9AddOptionERKNSt6stringERKNSt6stringE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder9AddOptionERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N6paimon18ReadContextBuilder9AddOptionERKNSt6stringERKNSt6stringE"></span><span id="paimon::ReadContextBuilder::AddOption__ssCR.ssCR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a19a1a07f17d04342f0a3e31faedf4d04"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">AddOption</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">key</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">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder9AddOptionERKNSt6stringERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Add a single configuration option which is not defined in the table schema or whose value you want to overwrite. </p> |
| <p>If you want to add multiple options, call <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder_1a19a1a07f17d04342f0a3e31faedf4d04"><span class="std std-ref"><span class="pre">AddOption()</span></span></a></code> multiple times or use <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder_1a19370226e886d90bfb4b2146e769cff6"><span class="std std-ref"><span class="pre">SetOptions()</span></span></a></code> instead. </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>key</strong> – The option key. </p></li> |
| <li><p><strong>value</strong> – The option value. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder12SetPredicateERKNSt10shared_ptrI9PredicateEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder12SetPredicateERKNSt10shared_ptrI9PredicateEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder12SetPredicateERKNSt10shared_ptrI9PredicateEE"></span><span id="paimon::ReadContextBuilder::SetPredicate__std::shared_ptr:Predicate:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a58b67acbb681a859634c7d017bfc2551"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetPredicate</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="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="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder12SetPredicateERKNSt10shared_ptrI9PredicateEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set a predicate for filtering data during reading. </p> |
| <p>The predicate is used for both partition pruning and data filtering. It can significantly improve performance by reducing the amount of data that needs to be read and processed.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>predicate</strong> – Shared pointer to the predicate for data filtering. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder21EnablePredicateFilterEb"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder21EnablePredicateFilterEb"></span><span id="_CPPv2N6paimon18ReadContextBuilder21EnablePredicateFilterEb"></span><span id="paimon::ReadContextBuilder::EnablePredicateFilter__b"></span><span class="target" id="classpaimon_1_1_read_context_builder_1af48c4f27fd8e263b51f13f9c2badf167"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">EnablePredicateFilter</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">enabled</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder21EnablePredicateFilterEb" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Whether to perform precise filtering according to predicates for data read from format reader. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>enabled</strong> – Whether to enable precise filtering (default: false) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder14EnablePrefetchEb"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder14EnablePrefetchEb"></span><span id="_CPPv2N6paimon18ReadContextBuilder14EnablePrefetchEb"></span><span id="paimon::ReadContextBuilder::EnablePrefetch__b"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a72ae2dddf806f6ac9b715e282e0dce8b"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">EnablePrefetch</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">enabled</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder14EnablePrefetchEb" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Enable or disable prefetching of data batches from individual files. </p> |
| <p>When enabled, the reader will prefetch multiple batches in parallel to improve throughput by overlapping I/O with computation. This is particularly beneficial for high-latency storage systems.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>enabled</strong> – Whether to enable prefetching (default: false) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder20SetPrefetchCacheModeE17PrefetchCacheMode"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder20SetPrefetchCacheModeE17PrefetchCacheMode"></span><span id="_CPPv2N6paimon18ReadContextBuilder20SetPrefetchCacheModeE17PrefetchCacheMode"></span><span id="paimon::ReadContextBuilder::SetPrefetchCacheMode__PrefetchCacheMode"></span><span class="target" id="classpaimon_1_1_read_context_builder_1aa475fea0a27ee724f55584a666062d7c"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetPrefetchCacheMode</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">PrefetchCacheMode</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">mode</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder20SetPrefetchCacheModeE17PrefetchCacheMode" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set prefetch cache mode for read operations. </p> |
| <p>A prefetch cache is used to prebuffer data ranges before they are needed, which can improve read performance by reducing redundant I/O operations. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>mode</strong> – (default: PrefetchCacheMode::ALWAYS) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder15WithCacheConfigERK11CacheConfig"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder15WithCacheConfigERK11CacheConfig"></span><span id="_CPPv2N6paimon18ReadContextBuilder15WithCacheConfigERK11CacheConfig"></span><span id="paimon::ReadContextBuilder::WithCacheConfig__CacheConfigCR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a60637f1be393cdb39ab43cfff979d53f"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">WithCacheConfig</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">CacheConfig</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder15WithCacheConfigERK11CacheConfig" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the cache configuration for prefetch read operations. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>config</strong> – The cache configuration to use. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder21SetPrefetchBatchCountE8uint32_t"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder21SetPrefetchBatchCountE8uint32_t"></span><span id="_CPPv2N6paimon18ReadContextBuilder21SetPrefetchBatchCountE8uint32_t"></span><span id="paimon::ReadContextBuilder::SetPrefetchBatchCount__uint32_t"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a83ced5a0fc3709b3dce8cda137825340"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetPrefetchBatchCount</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">batch_count</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder21SetPrefetchBatchCountE8uint32_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the total number of batches to prefetch across all files. </p> |
| <p>This controls the memory usage and parallelism of the prefetching mechanism. Higher values can improve throughput but consume more memory.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>batch_count</strong> – Total number of batches to prefetch (default: 600) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder25SetPrefetchMaxParallelNumE8uint32_t"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder25SetPrefetchMaxParallelNumE8uint32_t"></span><span id="_CPPv2N6paimon18ReadContextBuilder25SetPrefetchMaxParallelNumE8uint32_t"></span><span id="paimon::ReadContextBuilder::SetPrefetchMaxParallelNum__uint32_t"></span><span class="target" id="classpaimon_1_1_read_context_builder_1ac13b0e6cbeae7bea3c5f66b50331e57b"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetPrefetchMaxParallelNum</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">parallel_num</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder25SetPrefetchMaxParallelNumE8uint32_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the maximum number of parallel prefetch operations. </p> |
| <p>This limits the number of concurrent I/O operations to prevent overwhelming the storage system or consuming excessive system resources.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>parallel_num</strong> – Maximum parallel prefetch operations (default: 3) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder27EnableMultiThreadRowToBatchEb"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder27EnableMultiThreadRowToBatchEb"></span><span id="_CPPv2N6paimon18ReadContextBuilder27EnableMultiThreadRowToBatchEb"></span><span id="paimon::ReadContextBuilder::EnableMultiThreadRowToBatch__b"></span><span class="target" id="classpaimon_1_1_read_context_builder_1aa1d3965c3097b420ebb61eb8871a1029"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">EnableMultiThreadRowToBatch</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">enabled</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder27EnableMultiThreadRowToBatchEb" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Enable or disable multi-threaded row-to-batch conversion in merge-on-read scenarios. </p> |
| <p>When enabled, multiple threads are used to convert row data to batch format during merge operations, which can improve performance for CPU-intensive merge operations.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>enabled</strong> – Whether to enable multi-threaded conversion (default: false) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder25SetRowToBatchThreadNumberE8uint32_t"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder25SetRowToBatchThreadNumberE8uint32_t"></span><span id="_CPPv2N6paimon18ReadContextBuilder25SetRowToBatchThreadNumberE8uint32_t"></span><span id="paimon::ReadContextBuilder::SetRowToBatchThreadNumber__uint32_t"></span><span class="target" id="classpaimon_1_1_read_context_builder_1aa1babef236e8c932d8cfe3ebfb0d07c3"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetRowToBatchThreadNumber</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">thread_number</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder25SetRowToBatchThreadNumberE8uint32_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the number of threads for row-to-batch conversion in merge-on-read scenarios. </p> |
| <p>This controls the parallelism of row-to-batch conversion during merge operations. Higher values can improve performance but may affect result ordering.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If thread_number > 1, Arrow batches from the reader may not be in primary key order. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>thread_number</strong> – Number of conversion threads (default: 1) </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::ReadContextBuilder::WithMemoryPool__std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a23ca35125be67f60a8b74ea69bdeaa72"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">memory_pool</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder14WithMemoryPoolERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set custom memory pool for memory management. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If not set, the default system memory pool will be used. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>memory_pool</strong> – The memory pool to use. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder12WithExecutorERKNSt10shared_ptrI8ExecutorEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder12WithExecutorERKNSt10shared_ptrI8ExecutorEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder12WithExecutorERKNSt10shared_ptrI8ExecutorEE"></span><span id="paimon::ReadContextBuilder::WithExecutor__std::shared_ptr:Executor:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a2a4a37fe0d1985877ea97b6f653a7ded"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">WithExecutor</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="executor.html#_CPPv4N6paimon8ExecutorE" title="paimon::Executor"><span class="n"><span class="pre">Executor</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">executor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder12WithExecutorERKNSt10shared_ptrI8ExecutorEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set custom executor for task execution. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If not set, the default system executor will be used. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>executor</strong> – The executor to use. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder14SetTableSchemaERKNSt6stringE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder14SetTableSchemaERKNSt6stringE"></span><span id="_CPPv2N6paimon18ReadContextBuilder14SetTableSchemaERKNSt6stringE"></span><span id="paimon::ReadContextBuilder::SetTableSchema__ssCR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a2207f97601909364651cf498d8a7ca7b"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">SetTableSchema</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">table_schema</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder14SetTableSchemaERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the table schema as a string to avoid schema loading I/O operations. </p> |
| <p>This optimization allows the reader to use a pre-loaded schema instead of reading it from the table metadata, which can improve performance especially in scenarios with many small read operations.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>The user must ensure that the schema string is valid and matches the table. </p> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If not set, the schema will be loaded from the table path. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>table_schema</strong> – String representation of the table schema. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder10WithBranchERKNSt6stringE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder10WithBranchERKNSt6stringE"></span><span id="_CPPv2N6paimon18ReadContextBuilder10WithBranchERKNSt6stringE"></span><span id="paimon::ReadContextBuilder::WithBranch__ssCR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1ac9370c5ed4080773bdfd707f27d8a758"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">WithBranch</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">branch</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder10WithBranchERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Set the specific branch to read from in a versioned table. </p> |
| <p>Paimon supports branching for data versioning and time travel queries. This method allows reading from a specific branch instead of the main branch.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Default branch is “main” if not specified. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>branch</strong> – Name of the branch to read from. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder35WithFileSystemSchemeToIdentifierMapERKNSt3mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder35WithFileSystemSchemeToIdentifierMapERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder35WithFileSystemSchemeToIdentifierMapERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="paimon::ReadContextBuilder::WithFileSystemSchemeToIdentifierMap__std::map:ss.ss:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a251413e5eb4909c235f157bce73cf5b4"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">WithFileSystemSchemeToIdentifierMap</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">fs_scheme_to_identifier_map</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder35WithFileSystemSchemeToIdentifierMapERKNSt3mapINSt6stringENSt6stringEEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Sets a mapping from URI schemes (e.g., “file”, “oss”) to registered file system identifiers. </p> |
| <p>This allows selecting different pre-registered file system implementations based on the URI scheme at runtime.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p><ul class="simple"> |
| <li><p>This method is intended for environments where multiple file systems are pre-registered.</p></li> |
| <li><p>The specified identifiers must correspond to file systems that have been registered at compile time or initialization.</p></li> |
| <li><p>Cannot be used together with <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder_1a6ff02f27a5346cd2f4fd7026bee9a47b"><span class="std std-ref"><span class="pre">WithFileSystem()</span></span></a></code>.</p></li> |
| <li><p>If not set, use default file system (configured in <code class="docutils literal notranslate"><a class="reference internal" href="defs.html#structpaimon_1_1_options_1a91cdf2a3a8110ea53a0d9197d38cfae3"><span class="std std-ref"><span class="pre">Options::FILE_SYSTEM</span></span></a></code>). Example: builder.WithFileSystemSchemeToIdentifierMap({{“oss”, “jindo”}, {“file”, “local”}}); </p></li> |
| </ul> |
| </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>fs_scheme_to_identifier_map</strong> – Map from URI scheme (like “oss”) to the corresponding file system identifier. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder14WithFileSystemERKNSt10shared_ptrI10FileSystemEE"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder14WithFileSystemERKNSt10shared_ptrI10FileSystemEE"></span><span id="_CPPv2N6paimon18ReadContextBuilder14WithFileSystemERKNSt10shared_ptrI10FileSystemEE"></span><span id="paimon::ReadContextBuilder::WithFileSystem__std::shared_ptr:FileSystem:CR"></span><span class="target" id="classpaimon_1_1_read_context_builder_1a6ff02f27a5346cd2f4fd7026bee9a47b"></span><a class="reference internal" href="#_CPPv4N6paimon18ReadContextBuilderE" title="paimon::ReadContextBuilder"><span class="n"><span class="pre">ReadContextBuilder</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">WithFileSystem</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="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder14WithFileSystemERKNSt10shared_ptrI10FileSystemEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Sets a custom file system instance to be used for all file operations in this read context. </p> |
| <p>This bypasses the global file system registry and uses the provided implementation directly.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>If not set, use default file system (configured in <code class="docutils literal notranslate"><a class="reference internal" href="defs.html#structpaimon_1_1_options_1a91cdf2a3a8110ea53a0d9197d38cfae3"><span class="std std-ref"><span class="pre">Options::FILE_SYSTEM</span></span></a></code>) </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>file_system</strong> – The file system to use. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>Reference to this builder for method chaining. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon18ReadContextBuilder6FinishEv"> |
| <span id="_CPPv3N6paimon18ReadContextBuilder6FinishEv"></span><span id="_CPPv2N6paimon18ReadContextBuilder6FinishEv"></span><span id="paimon::ReadContextBuilder::Finish"></span><span class="target" id="classpaimon_1_1_read_context_builder_1ab2d9a3bf13203069492ddd73961555c1"></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="#_CPPv4N6paimon11ReadContextE" title="paimon::ReadContext"><span class="n"><span class="pre">ReadContext</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">Finish</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon18ReadContextBuilder6FinishEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Build and return a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context"><span class="std std-ref"><span class="pre">ReadContext</span></span></a></code> instance with input validation. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Result containing the constructed <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context"><span class="std std-ref"><span class="pre">ReadContext</span></span></a></code> or an error status. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11ReadContextE"> |
| <span id="_CPPv3N6paimon11ReadContextE"></span><span id="_CPPv2N6paimon11ReadContextE"></span><span id="paimon::ReadContext"></span><span class="target" id="classpaimon_1_1_read_context"></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">ReadContext</span></span></span><a class="headerlink" href="#_CPPv4N6paimon11ReadContextE" title="Link to this definition">#</a><br /></dt> |
| <dd><p><code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context"><span class="std std-ref"><span class="pre">ReadContext</span></span></a></code> is some configuration for read operations. </p> |
| <p>Please do not use this class directly, use <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context_builder"><span class="std std-ref"><span class="pre">ReadContextBuilder</span></span></a></code> to build a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_read_context"><span class="std std-ref"><span class="pre">ReadContext</span></span></a></code> which has input validation. <div class="admonition seealso"> |
| <p class="admonition-title">See also</p> |
| <p><a class="reference internal" href="#classpaimon_1_1_read_context_builder"><span class="std std-ref">ReadContextBuilder</span></a></p> |
| </div> |
| </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="_CPPv4N6paimon11ReadContext11ReadContextERKNSt6stringERKNSt6stringERKNSt6vectorINSt6stringEEERKNSt6vectorI7int32_tEERKNSt10shared_ptrI9PredicateEEbb8uint32_t8uint32_tb8uint32_tRKNSt8optionalINSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10FileSystemEERKNSt3mapINSt6stringENSt6stringEEERKNSt3mapINSt6stringENSt6stringEEE17PrefetchCacheModeRK11CacheConfig"> |
| <span id="_CPPv3N6paimon11ReadContext11ReadContextERKNSt6stringERKNSt6stringERKNSt6vectorINSt6stringEEERKNSt6vectorI7int32_tEERKNSt10shared_ptrI9PredicateEEbb8uint32_t8uint32_tb8uint32_tRKNSt8optionalINSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10FileSystemEERKNSt3mapINSt6stringENSt6stringEEERKNSt3mapINSt6stringENSt6stringEEE17PrefetchCacheModeRK11CacheConfig"></span><span id="_CPPv2N6paimon11ReadContext11ReadContextERKNSt6stringERKNSt6stringERKNSt6vectorINSt6stringEEERKNSt6vectorI7int32_tEERKNSt10shared_ptrI9PredicateEEbb8uint32_t8uint32_tb8uint32_tRKNSt8optionalINSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10FileSystemEERKNSt3mapINSt6stringENSt6stringEEERKNSt3mapINSt6stringENSt6stringEEE17PrefetchCacheModeRK11CacheConfig"></span><span id="paimon::ReadContext::ReadContext__ssCR.ssCR.std::vector:ss:CR.std::vector:int32_t:CR.std::shared_ptr:Predicate:CR.b.b.uint32_t.uint32_t.b.uint32_t.std::optional:ss:CR.std::shared_ptr:MemoryPool:CR.std::shared_ptr:Executor:CR.std::shared_ptr:FileSystem:CR.std::map:ss.ss:CR.std::map:ss.ss:CR.PrefetchCacheMode.CacheConfigCR"></span><span class="target" id="classpaimon_1_1_read_context_1aca4825d6a1b013f50ed9b5ad55800815"></span><span class="sig-name descname"><span class="n"><span class="pre">ReadContext</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">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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">branch</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">vector</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="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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</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">read_field_ids</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="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">enable_predicate_filter</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">enable_prefetch</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">prefetch_batch_count</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">prefetch_max_parallel_num</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">enable_multi_thread_row_to_batch</span></span>, <span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">row_to_batch_thread_number</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">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">table_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="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">memory_pool</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="executor.html#_CPPv4N6paimon8ExecutorE" title="paimon::Executor"><span class="n"><span class="pre">Executor</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">executor</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="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">specific_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">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">fs_scheme_to_identifier_map</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="n"><span class="pre">PrefetchCacheMode</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">prefetch_cache_mode</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">CacheConfig</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">cache_config</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon11ReadContext11ReadContextERKNSt6stringERKNSt6stringERKNSt6vectorINSt6stringEEERKNSt6vectorI7int32_tEERKNSt10shared_ptrI9PredicateEEbb8uint32_t8uint32_tb8uint32_tRKNSt8optionalINSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10FileSystemEERKNSt3mapINSt6stringENSt6stringEEERKNSt3mapINSt6stringENSt6stringEEE17PrefetchCacheModeRK11CacheConfig" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11ReadContextD0Ev"> |
| <span id="_CPPv3N6paimon11ReadContextD0Ev"></span><span id="_CPPv2N6paimon11ReadContextD0Ev"></span><span id="paimon::ReadContext::~ReadContext"></span><span class="target" id="classpaimon_1_1_read_context_1a3b4cb5b0681f570c739c83dd1a08306f"></span><span class="sig-name descname"><span class="n"><span class="pre">~ReadContext</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon11ReadContextD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext7GetPathEv"> |
| <span id="_CPPv3NK6paimon11ReadContext7GetPathEv"></span><span id="_CPPv2NK6paimon11ReadContext7GetPathEv"></span><span id="paimon::ReadContext::GetPathC"></span><span class="target" id="classpaimon_1_1_read_context_1a126994d77a895c402c93490a7cce310f"></span><span class="k"><span class="pre">inline</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">GetPath</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="#_CPPv4NK6paimon11ReadContext7GetPathEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext9GetBranchEv"> |
| <span id="_CPPv3NK6paimon11ReadContext9GetBranchEv"></span><span id="_CPPv2NK6paimon11ReadContext9GetBranchEv"></span><span id="paimon::ReadContext::GetBranchC"></span><span class="target" id="classpaimon_1_1_read_context_1ab1ccaf50daa127ed9cb086691ebba1be"></span><span class="k"><span class="pre">inline</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">GetBranch</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="#_CPPv4NK6paimon11ReadContext9GetBranchEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext34GetFileSystemSchemeToIdentifierMapEv"> |
| <span id="_CPPv3NK6paimon11ReadContext34GetFileSystemSchemeToIdentifierMapEv"></span><span id="_CPPv2NK6paimon11ReadContext34GetFileSystemSchemeToIdentifierMapEv"></span><span id="paimon::ReadContext::GetFileSystemSchemeToIdentifierMapC"></span><span class="target" id="classpaimon_1_1_read_context_1a542da2195d8ea92e921dc5c3d27dce5c"></span><span class="k"><span class="pre">inline</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">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="sig-name descname"><span class="n"><span class="pre">GetFileSystemSchemeToIdentifierMap</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="#_CPPv4NK6paimon11ReadContext34GetFileSystemSchemeToIdentifierMapEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext10GetOptionsEv"> |
| <span id="_CPPv3NK6paimon11ReadContext10GetOptionsEv"></span><span id="_CPPv2NK6paimon11ReadContext10GetOptionsEv"></span><span id="paimon::ReadContext::GetOptionsC"></span><span class="target" id="classpaimon_1_1_read_context_1afeb99ede7b094443737236b966b3d371"></span><span class="k"><span class="pre">inline</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">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="sig-name descname"><span class="n"><span class="pre">GetOptions</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="#_CPPv4NK6paimon11ReadContext10GetOptionsEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext13GetReadSchemaEv"> |
| <span id="_CPPv3NK6paimon11ReadContext13GetReadSchemaEv"></span><span id="_CPPv2NK6paimon11ReadContext13GetReadSchemaEv"></span><span id="paimon::ReadContext::GetReadSchemaC"></span><span class="target" id="classpaimon_1_1_read_context_1aff6208b05dffcf6b54533d6406d03982"></span><span class="k"><span class="pre">inline</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">vector</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="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetReadSchema</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="#_CPPv4NK6paimon11ReadContext13GetReadSchemaEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext15GetReadFieldIdsEv"> |
| <span id="_CPPv3NK6paimon11ReadContext15GetReadFieldIdsEv"></span><span id="_CPPv2NK6paimon11ReadContext15GetReadFieldIdsEv"></span><span id="paimon::ReadContext::GetReadFieldIdsC"></span><span class="target" id="classpaimon_1_1_read_context_1a4269c206dfe6321ca9cc5a805d82e36e"></span><span class="k"><span class="pre">inline</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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">></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">GetReadFieldIds</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="#_CPPv4NK6paimon11ReadContext15GetReadFieldIdsEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext12GetPredicateEv"> |
| <span id="_CPPv3NK6paimon11ReadContext12GetPredicateEv"></span><span id="_CPPv2NK6paimon11ReadContext12GetPredicateEv"></span><span id="paimon::ReadContext::GetPredicateC"></span><span class="target" id="classpaimon_1_1_read_context_1ad41c2bfffce5da9a3cd9c423b0fc8f9d"></span><span class="k"><span class="pre">inline</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">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="sig-name descname"><span class="n"><span class="pre">GetPredicate</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="#_CPPv4NK6paimon11ReadContext12GetPredicateEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext21EnablePredicateFilterEv"> |
| <span id="_CPPv3NK6paimon11ReadContext21EnablePredicateFilterEv"></span><span id="_CPPv2NK6paimon11ReadContext21EnablePredicateFilterEv"></span><span id="paimon::ReadContext::EnablePredicateFilterC"></span><span class="target" id="classpaimon_1_1_read_context_1a9f3ca13af9dd86a4d8ac5e732cf6c09b"></span><span class="k"><span class="pre">inline</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">EnablePredicateFilter</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="#_CPPv4NK6paimon11ReadContext21EnablePredicateFilterEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext14EnablePrefetchEv"> |
| <span id="_CPPv3NK6paimon11ReadContext14EnablePrefetchEv"></span><span id="_CPPv2NK6paimon11ReadContext14EnablePrefetchEv"></span><span id="paimon::ReadContext::EnablePrefetchC"></span><span class="target" id="classpaimon_1_1_read_context_1a38890f8c5c11c29c09c5be8232e1f74b"></span><span class="k"><span class="pre">inline</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">EnablePrefetch</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="#_CPPv4NK6paimon11ReadContext14EnablePrefetchEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext21GetPrefetchBatchCountEv"> |
| <span id="_CPPv3NK6paimon11ReadContext21GetPrefetchBatchCountEv"></span><span id="_CPPv2NK6paimon11ReadContext21GetPrefetchBatchCountEv"></span><span id="paimon::ReadContext::GetPrefetchBatchCountC"></span><span class="target" id="classpaimon_1_1_read_context_1a25903f37618345ac1d57d6dddb90981d"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPrefetchBatchCount</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="#_CPPv4NK6paimon11ReadContext21GetPrefetchBatchCountEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext25GetPrefetchMaxParallelNumEv"> |
| <span id="_CPPv3NK6paimon11ReadContext25GetPrefetchMaxParallelNumEv"></span><span id="_CPPv2NK6paimon11ReadContext25GetPrefetchMaxParallelNumEv"></span><span id="paimon::ReadContext::GetPrefetchMaxParallelNumC"></span><span class="target" id="classpaimon_1_1_read_context_1aabf26ec645f7fbdf4e35117a04591f8f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPrefetchMaxParallelNum</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="#_CPPv4NK6paimon11ReadContext25GetPrefetchMaxParallelNumEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext27EnableMultiThreadRowToBatchEv"> |
| <span id="_CPPv3NK6paimon11ReadContext27EnableMultiThreadRowToBatchEv"></span><span id="_CPPv2NK6paimon11ReadContext27EnableMultiThreadRowToBatchEv"></span><span id="paimon::ReadContext::EnableMultiThreadRowToBatchC"></span><span class="target" id="classpaimon_1_1_read_context_1a1b2651cb2f61643cb99440cb32d23df0"></span><span class="k"><span class="pre">inline</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">EnableMultiThreadRowToBatch</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="#_CPPv4NK6paimon11ReadContext27EnableMultiThreadRowToBatchEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext25GetRowToBatchThreadNumberEv"> |
| <span id="_CPPv3NK6paimon11ReadContext25GetRowToBatchThreadNumberEv"></span><span id="_CPPv2NK6paimon11ReadContext25GetRowToBatchThreadNumberEv"></span><span id="paimon::ReadContext::GetRowToBatchThreadNumberC"></span><span class="target" id="classpaimon_1_1_read_context_1a735de1639311f59837ce5a4c899814d2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetRowToBatchThreadNumber</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="#_CPPv4NK6paimon11ReadContext25GetRowToBatchThreadNumberEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11ReadContext22GetSpecificTableSchemaEv"> |
| <span id="_CPPv3N6paimon11ReadContext22GetSpecificTableSchemaEv"></span><span id="_CPPv2N6paimon11ReadContext22GetSpecificTableSchemaEv"></span><span id="paimon::ReadContext::GetSpecificTableSchema"></span><span class="target" id="classpaimon_1_1_read_context_1add40ef1a2dfcc7df53789de9c255a2a8"></span><span class="k"><span class="pre">inline</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">optional</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="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetSpecificTableSchema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon11ReadContext22GetSpecificTableSchemaEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext13GetMemoryPoolEv"> |
| <span id="_CPPv3NK6paimon11ReadContext13GetMemoryPoolEv"></span><span id="_CPPv2NK6paimon11ReadContext13GetMemoryPoolEv"></span><span id="paimon::ReadContext::GetMemoryPoolC"></span><span class="target" id="classpaimon_1_1_read_context_1a3367b9e6f643e99a18b837952798383a"></span><span class="k"><span class="pre">inline</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="sig-name descname"><span class="n"><span class="pre">GetMemoryPool</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="#_CPPv4NK6paimon11ReadContext13GetMemoryPoolEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext11GetExecutorEv"> |
| <span id="_CPPv3NK6paimon11ReadContext11GetExecutorEv"></span><span id="_CPPv2NK6paimon11ReadContext11GetExecutorEv"></span><span id="paimon::ReadContext::GetExecutorC"></span><span class="target" id="classpaimon_1_1_read_context_1aa6fbbb0c471bb6f3bc71684cef2d722d"></span><span class="k"><span class="pre">inline</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="executor.html#_CPPv4N6paimon8ExecutorE" title="paimon::Executor"><span class="n"><span class="pre">Executor</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetExecutor</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="#_CPPv4NK6paimon11ReadContext11GetExecutorEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext21GetSpecificFileSystemEv"> |
| <span id="_CPPv3NK6paimon11ReadContext21GetSpecificFileSystemEv"></span><span id="_CPPv2NK6paimon11ReadContext21GetSpecificFileSystemEv"></span><span id="paimon::ReadContext::GetSpecificFileSystemC"></span><span class="target" id="classpaimon_1_1_read_context_1a92d7eece4b5af981c2baf650a9a99bc1"></span><span class="k"><span class="pre">inline</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="sig-name descname"><span class="n"><span class="pre">GetSpecificFileSystem</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="#_CPPv4NK6paimon11ReadContext21GetSpecificFileSystemEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext20GetPrefetchCacheModeEv"> |
| <span id="_CPPv3NK6paimon11ReadContext20GetPrefetchCacheModeEv"></span><span id="_CPPv2NK6paimon11ReadContext20GetPrefetchCacheModeEv"></span><span id="paimon::ReadContext::GetPrefetchCacheModeC"></span><span class="target" id="classpaimon_1_1_read_context_1a350abe173fc0c5bca463b32563cd88f7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">PrefetchCacheMode</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetPrefetchCacheMode</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="#_CPPv4NK6paimon11ReadContext20GetPrefetchCacheModeEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11ReadContext14GetCacheConfigEv"> |
| <span id="_CPPv3NK6paimon11ReadContext14GetCacheConfigEv"></span><span id="_CPPv2NK6paimon11ReadContext14GetCacheConfigEv"></span><span id="paimon::ReadContext::GetCacheConfigC"></span><span class="target" id="classpaimon_1_1_read_context_1a238e7187ee6bfe9a7744e1c1738b2f49"></span><span class="k"><span class="pre">inline</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">CacheConfig</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">GetCacheConfig</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="#_CPPv4NK6paimon11ReadContext14GetCacheConfigEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReaderE"> |
| <span id="_CPPv3N6paimon11BatchReaderE"></span><span id="_CPPv2N6paimon11BatchReaderE"></span><span id="paimon::BatchReader"></span><span class="target" id="classpaimon_1_1_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">BatchReader</span></span></span><a class="headerlink" href="#_CPPv4N6paimon11BatchReaderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>A batch reader that supports reading batch data into an arrow array. </p> |
| <p>Subclassed by <a class="reference internal" href="file_format.html#classpaimon_1_1_file_batch_reader"><span class="std std-ref">paimon::FileBatchReader</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p> |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader9ReadBatchE"> |
| <span id="_CPPv3N6paimon11BatchReader9ReadBatchE"></span><span id="_CPPv2N6paimon11BatchReader9ReadBatchE"></span><span class="target" id="classpaimon_1_1_batch_reader_1a52a5b04ada9bf1da22f5d7e1784927b2"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReadBatch</span></span></span><span class="w"> </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">pair</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="n"><span class="pre">ArrowArray</span></span><span class="p"><span class="pre">></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">unique_ptr</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><a class="headerlink" href="#_CPPv4N6paimon11BatchReader9ReadBatchE" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader19ReadBatchWithBitmapE"> |
| <span id="_CPPv3N6paimon11BatchReader19ReadBatchWithBitmapE"></span><span id="_CPPv2N6paimon11BatchReader19ReadBatchWithBitmapE"></span><span class="target" id="classpaimon_1_1_batch_reader_1a4ee7cac856f2b254e171b12db7146246"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReadBatchWithBitmap</span></span></span><span class="w"> </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">pair</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon11BatchReader9ReadBatchE" title="paimon::BatchReader::ReadBatch"><span class="n"><span class="pre">ReadBatch</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">RoaringBitmap32</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N6paimon11BatchReader19ReadBatchWithBitmapE" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| <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="_CPPv4N6paimon11BatchReaderD0Ev"> |
| <span id="_CPPv3N6paimon11BatchReaderD0Ev"></span><span id="_CPPv2N6paimon11BatchReaderD0Ev"></span><span id="paimon::BatchReader::~BatchReader"></span><span class="target" id="classpaimon_1_1_batch_reader_1a9741d92af7160375a51e1a497afcfa1a"></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">~BatchReader</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="#_CPPv4N6paimon11BatchReaderD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader9NextBatchEv"> |
| <span id="_CPPv3N6paimon11BatchReader9NextBatchEv"></span><span id="_CPPv2N6paimon11BatchReader9NextBatchEv"></span><span id="paimon::BatchReader::NextBatch"></span><span class="target" id="classpaimon_1_1_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><a class="reference internal" href="#_CPPv4N6paimon11BatchReader9ReadBatchE" title="paimon::BatchReader::ReadBatch"><span class="n"><span class="pre">ReadBatch</span></span></a><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="#_CPPv4N6paimon11BatchReader9NextBatchEv" 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="#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="_CPPv4N6paimon11BatchReader19NextBatchWithBitmapEv"> |
| <span id="_CPPv3N6paimon11BatchReader19NextBatchWithBitmapEv"></span><span id="_CPPv2N6paimon11BatchReader19NextBatchWithBitmapEv"></span><span id="paimon::BatchReader::NextBatchWithBitmap"></span><span class="target" id="classpaimon_1_1_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><a class="reference internal" href="#_CPPv4N6paimon11BatchReader19ReadBatchWithBitmapE" title="paimon::BatchReader::ReadBatchWithBitmap"><span class="n"><span class="pre">ReadBatchWithBitmap</span></span></a><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="#_CPPv4N6paimon11BatchReader19NextBatchWithBitmapEv" 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="#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="#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="#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_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_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> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon11BatchReader16GetReaderMetricsEv"> |
| <span id="_CPPv3NK6paimon11BatchReader16GetReaderMetricsEv"></span><span id="_CPPv2NK6paimon11BatchReader16GetReaderMetricsEv"></span><span id="paimon::BatchReader::GetReaderMetricsC"></span><span class="target" id="classpaimon_1_1_batch_reader_1a8af3a8346bbfc3de3da09840c70ac0ff"></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">GetReaderMetrics</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="#_CPPv4NK6paimon11BatchReader16GetReaderMetricsEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the reader’s metrics. </p> |
| <p>Note that calling this method frequently may incur significant performance overhead. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A shared pointer to the <code class="docutils literal notranslate"><span class="pre">Metrics</span></code> object. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader5CloseEv"> |
| <span id="_CPPv3N6paimon11BatchReader5CloseEv"></span><span id="_CPPv2N6paimon11BatchReader5CloseEv"></span><span id="paimon::BatchReader::Close"></span><span class="target" id="classpaimon_1_1_batch_reader_1a167febf97b0e2ef4f48f034fe3af16b6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Close</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="#_CPPv4N6paimon11BatchReader5CloseEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Closes the <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader"><span class="std std-ref"><span class="pre">BatchReader</span></span></a></code>, releasing any associated resources. </p> |
| <p>After calling this method, further calls to <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader_1a01358cb810bb14fcb26663d510c08fce"><span class="std std-ref"><span class="pre">NextBatch()</span></span></a></code> is undefined and should be avoided. </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="_CPPv4N6paimon11BatchReader10IsEofBatchERK9ReadBatch"> |
| <span id="_CPPv3N6paimon11BatchReader10IsEofBatchERK9ReadBatch"></span><span id="_CPPv2N6paimon11BatchReader10IsEofBatchERK9ReadBatch"></span><span id="paimon::BatchReader::IsEofBatch__ReadBatchCR"></span><span class="target" id="classpaimon_1_1_batch_reader_1ac05becfb364d38b4a031f052bfc9cf14"></span><span class="k"><span class="pre">static</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">IsEofBatch</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon11BatchReader9ReadBatchE" title="paimon::BatchReader::ReadBatch"><span class="n"><span class="pre">ReadBatch</span></span></a><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><a class="headerlink" href="#_CPPv4N6paimon11BatchReader10IsEofBatchERK9ReadBatch" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Determine whether a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader_1a52a5b04ada9bf1da22f5d7e1784927b2"><span class="std std-ref"><span class="pre">ReadBatch</span></span></a></code> or <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_batch_reader_1a4ee7cac856f2b254e171b12db7146246"><span class="std std-ref"><span class="pre">ReadBatchWithBitmap</span></span></a></code> is eof batch, if return true, all the data has been returned. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader10IsEofBatchERK19ReadBatchWithBitmap"> |
| <span id="_CPPv3N6paimon11BatchReader10IsEofBatchERK19ReadBatchWithBitmap"></span><span id="_CPPv2N6paimon11BatchReader10IsEofBatchERK19ReadBatchWithBitmap"></span><span id="paimon::BatchReader::IsEofBatch__ReadBatchWithBitmapCR"></span><span class="target" id="classpaimon_1_1_batch_reader_1a4d21246481d9779eff506eaf8f1410fd"></span><span class="k"><span class="pre">static</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">IsEofBatch</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon11BatchReader19ReadBatchWithBitmapE" title="paimon::BatchReader::ReadBatchWithBitmap"><span class="n"><span class="pre">ReadBatchWithBitmap</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">batch_with_bitmap</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon11BatchReader10IsEofBatchERK19ReadBatchWithBitmap" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader12MakeEofBatchEv"> |
| <span id="_CPPv3N6paimon11BatchReader12MakeEofBatchEv"></span><span id="_CPPv2N6paimon11BatchReader12MakeEofBatchEv"></span><span id="paimon::BatchReader::MakeEofBatch"></span><span class="target" id="classpaimon_1_1_batch_reader_1a00dea15698a3203dd058daf2a184a74e"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon11BatchReader9ReadBatchE" title="paimon::BatchReader::ReadBatch"><span class="n"><span class="pre">ReadBatch</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MakeEofBatch</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon11BatchReader12MakeEofBatchEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Make an eof batch or batch with bitmap. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon11BatchReader22MakeEofBatchWithBitmapEv"> |
| <span id="_CPPv3N6paimon11BatchReader22MakeEofBatchWithBitmapEv"></span><span id="_CPPv2N6paimon11BatchReader22MakeEofBatchWithBitmapEv"></span><span id="paimon::BatchReader::MakeEofBatchWithBitmap"></span><span class="target" id="classpaimon_1_1_batch_reader_1a81dd9677ebaf7b97ef898a51179e42c6"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon11BatchReader19ReadBatchWithBitmapE" title="paimon::BatchReader::ReadBatchWithBitmap"><span class="n"><span class="pre">ReadBatchWithBitmap</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MakeEofBatchWithBitmap</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon11BatchReader22MakeEofBatchWithBitmapEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer d-print-none"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="scan.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">Scan</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="predicate.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Predicate</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="#_CPPv4N6paimon9TableReadE"><code class="docutils literal notranslate"><span class="pre">paimon::TableRead</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="#_CPPv4N6paimon9TableReadD0Ev"><code class="docutils literal notranslate"><span class="pre">~TableRead()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon9TableRead12CreateReaderERKNSt6vectorINSt10shared_ptrI5SplitEEEE"><code class="docutils literal notranslate"><span class="pre">CreateReader()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon9TableRead12CreateReaderERKNSt10shared_ptrI5SplitEE"><code class="docutils literal notranslate"><span class="pre">CreateReader()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon9TableRead6CreateENSt10unique_ptrI11ReadContextEE"><code class="docutils literal notranslate"><span class="pre">Create()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilderE"><code class="docutils literal notranslate"><span class="pre">paimon::ReadContextBuilder</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="#_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">ReadContextBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilderD0Ev"><code class="docutils literal notranslate"><span class="pre">~ReadContextBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder18ReadContextBuilderERR18ReadContextBuilder"><code class="docutils literal notranslate"><span class="pre">ReadContextBuilder()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilderaSERR18ReadContextBuilder"><code class="docutils literal notranslate"><span class="pre">operator=()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder13SetReadSchemaERKNSt6vectorINSt6stringEEE"><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="#_CPPv4N6paimon18ReadContextBuilder15SetReadFieldIdsERKNSt6vectorI7int32_tEE"><code class="docutils literal notranslate"><span class="pre">SetReadFieldIds()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder10SetOptionsERKNSt3mapINSt6stringENSt6stringEEE"><code class="docutils literal notranslate"><span class="pre">SetOptions()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder9AddOptionERKNSt6stringERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">AddOption()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder12SetPredicateERKNSt10shared_ptrI9PredicateEE"><code class="docutils literal notranslate"><span class="pre">SetPredicate()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder21EnablePredicateFilterEb"><code class="docutils literal notranslate"><span class="pre">EnablePredicateFilter()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder14EnablePrefetchEb"><code class="docutils literal notranslate"><span class="pre">EnablePrefetch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder20SetPrefetchCacheModeE17PrefetchCacheMode"><code class="docutils literal notranslate"><span class="pre">SetPrefetchCacheMode()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder15WithCacheConfigERK11CacheConfig"><code class="docutils literal notranslate"><span class="pre">WithCacheConfig()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder21SetPrefetchBatchCountE8uint32_t"><code class="docutils literal notranslate"><span class="pre">SetPrefetchBatchCount()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder25SetPrefetchMaxParallelNumE8uint32_t"><code class="docutils literal notranslate"><span class="pre">SetPrefetchMaxParallelNum()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder27EnableMultiThreadRowToBatchEb"><code class="docutils literal notranslate"><span class="pre">EnableMultiThreadRowToBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder25SetRowToBatchThreadNumberE8uint32_t"><code class="docutils literal notranslate"><span class="pre">SetRowToBatchThreadNumber()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder14WithMemoryPoolERKNSt10shared_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="#_CPPv4N6paimon18ReadContextBuilder12WithExecutorERKNSt10shared_ptrI8ExecutorEE"><code class="docutils literal notranslate"><span class="pre">WithExecutor()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder14SetTableSchemaERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">SetTableSchema()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder10WithBranchERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">WithBranch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder35WithFileSystemSchemeToIdentifierMapERKNSt3mapINSt6stringENSt6stringEEE"><code class="docutils literal notranslate"><span class="pre">WithFileSystemSchemeToIdentifierMap()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder14WithFileSystemERKNSt10shared_ptrI10FileSystemEE"><code class="docutils literal notranslate"><span class="pre">WithFileSystem()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon18ReadContextBuilder6FinishEv"><code class="docutils literal notranslate"><span class="pre">Finish()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11ReadContextE"><code class="docutils literal notranslate"><span class="pre">paimon::ReadContext</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="#_CPPv4N6paimon11ReadContext11ReadContextERKNSt6stringERKNSt6stringERKNSt6vectorINSt6stringEEERKNSt6vectorI7int32_tEERKNSt10shared_ptrI9PredicateEEbb8uint32_t8uint32_tb8uint32_tRKNSt8optionalINSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10FileSystemEERKNSt3mapINSt6stringENSt6stringEEERKNSt3mapINSt6stringENSt6stringEEE17PrefetchCacheModeRK11CacheConfig"><code class="docutils literal notranslate"><span class="pre">ReadContext()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11ReadContextD0Ev"><code class="docutils literal notranslate"><span class="pre">~ReadContext()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext7GetPathEv"><code class="docutils literal notranslate"><span class="pre">GetPath()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext9GetBranchEv"><code class="docutils literal notranslate"><span class="pre">GetBranch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext34GetFileSystemSchemeToIdentifierMapEv"><code class="docutils literal notranslate"><span class="pre">GetFileSystemSchemeToIdentifierMap()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext10GetOptionsEv"><code class="docutils literal notranslate"><span class="pre">GetOptions()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext13GetReadSchemaEv"><code class="docutils literal notranslate"><span class="pre">GetReadSchema()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext15GetReadFieldIdsEv"><code class="docutils literal notranslate"><span class="pre">GetReadFieldIds()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext12GetPredicateEv"><code class="docutils literal notranslate"><span class="pre">GetPredicate()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext21EnablePredicateFilterEv"><code class="docutils literal notranslate"><span class="pre">EnablePredicateFilter()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext14EnablePrefetchEv"><code class="docutils literal notranslate"><span class="pre">EnablePrefetch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext21GetPrefetchBatchCountEv"><code class="docutils literal notranslate"><span class="pre">GetPrefetchBatchCount()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext25GetPrefetchMaxParallelNumEv"><code class="docutils literal notranslate"><span class="pre">GetPrefetchMaxParallelNum()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext27EnableMultiThreadRowToBatchEv"><code class="docutils literal notranslate"><span class="pre">EnableMultiThreadRowToBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext25GetRowToBatchThreadNumberEv"><code class="docutils literal notranslate"><span class="pre">GetRowToBatchThreadNumber()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11ReadContext22GetSpecificTableSchemaEv"><code class="docutils literal notranslate"><span class="pre">GetSpecificTableSchema()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext13GetMemoryPoolEv"><code class="docutils literal notranslate"><span class="pre">GetMemoryPool()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext11GetExecutorEv"><code class="docutils literal notranslate"><span class="pre">GetExecutor()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext21GetSpecificFileSystemEv"><code class="docutils literal notranslate"><span class="pre">GetSpecificFileSystem()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext20GetPrefetchCacheModeEv"><code class="docutils literal notranslate"><span class="pre">GetPrefetchCacheMode()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11ReadContext14GetCacheConfigEv"><code class="docutils literal notranslate"><span class="pre">GetCacheConfig()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReaderE"><code class="docutils literal notranslate"><span class="pre">paimon::BatchReader</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="#_CPPv4N6paimon11BatchReader9ReadBatchE"><code class="docutils literal notranslate"><span class="pre">ReadBatch</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader19ReadBatchWithBitmapE"><code class="docutils literal notranslate"><span class="pre">ReadBatchWithBitmap</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReaderD0Ev"><code class="docutils literal notranslate"><span class="pre">~BatchReader()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader9NextBatchEv"><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="#_CPPv4N6paimon11BatchReader19NextBatchWithBitmapEv"><code class="docutils literal notranslate"><span class="pre">NextBatchWithBitmap()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon11BatchReader16GetReaderMetricsEv"><code class="docutils literal notranslate"><span class="pre">GetReaderMetrics()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader5CloseEv"><code class="docutils literal notranslate"><span class="pre">Close()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader10IsEofBatchERK9ReadBatch"><code class="docutils literal notranslate"><span class="pre">IsEofBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader10IsEofBatchERK19ReadBatchWithBitmap"><code class="docutils literal notranslate"><span class="pre">IsEofBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader12MakeEofBatchEv"><code class="docutils literal notranslate"><span class="pre">MakeEofBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon11BatchReader22MakeEofBatchWithBitmapEv"><code class="docutils literal notranslate"><span class="pre">MakeEofBatchWithBitmap()</span></code></a></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/read.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> |
