| |
| <!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>Global Index — 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/global_index';</script> |
| <script>DOCUMENTATION_OPTIONS.search_as_you_type = false;</script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Orphan Files Clean" href="clean.html" /> |
| <link rel="prev" title="File Index" href="file_index.html" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| <meta name="docsearch:version" content="0.2.3" /> |
| |
| |
| <script src="../_static/searchtools.js"></script> |
| <script src="../_static/language_data.js"></script> |
| <script src="../searchindex.js"></script> |
| |
| </head> |
| <body data-default-mode=""> |
| |
| |
| <div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div> |
| |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i>Back to top</button> |
| |
| |
| |
| |
| <dialog id="pst-search-dialog"> |
| |
| <form class="bd-search d-flex align-items-center" |
| action="../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form> |
| </dialog> |
| |
| <div class="pst-async-banner-revealer d-none"> |
| <aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside> |
| </div> |
| |
| |
| <header id="pst-header" class="bd-header navbar navbar-expand-lg bd-navbar d-print-none"> |
| <div class="bd-header__inner bd-page-width"> |
| <button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation"> |
| <span class="fa-solid fa-bars"></span> |
| </button> |
| |
| |
| <div class=" navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| |
| |
| <a class="navbar-brand logo" href="../index.html"> |
| |
| |
| |
| |
| |
| |
| <p class="title logo__title">Paimon C++</p> |
| |
| </a></div> |
| |
| </div> |
| |
| <div class=" navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item "> |
| <a class="nav-link nav-internal" href="../getting_started.html"> |
| Getting Started |
| </a> |
| </li> |
| |
| |
| <li class="nav-item "> |
| <a class="nav-link nav-internal" href="../user_guide.html"> |
| User Guide |
| </a> |
| </li> |
| |
| |
| <li class="nav-item "> |
| <a class="nav-link nav-internal" href="../examples/index.html"> |
| Examples |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link nav-internal" href="../api.html"> |
| API Reference |
| </a> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| |
| <div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode"> |
| <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown"> |
| <i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i> |
| <i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i> |
| <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i> |
| </button> |
| <ul class="dropdown-menu dropdown-menu-end"> |
| <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li> |
| <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li> |
| <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li> |
| </ul> |
| </div></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/paimon-cpp" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i><span class="visually-hidden">GitHub</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| </div> |
| |
| |
| |
| <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page"> |
| <span class="fa-solid fa-outdent"></span> |
| </button> |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <dialog id="pst-primary-sidebar-modal"></dialog> |
| <div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| |
| |
| <div class="navbar-item"> |
| <nav> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item "> |
| <a class="nav-link nav-internal" href="../getting_started.html"> |
| Getting Started |
| </a> |
| </li> |
| |
| |
| <li class="nav-item "> |
| <a class="nav-link nav-internal" href="../user_guide.html"> |
| User Guide |
| </a> |
| </li> |
| |
| |
| <li class="nav-item "> |
| <a class="nav-link nav-internal" href="../examples/index.html"> |
| Examples |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link nav-internal" href="../api.html"> |
| API Reference |
| </a> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| |
| <div class="theme-switch-container dropdown pst-js-only" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Color mode"> |
| <button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button dropdown-toggle" aria-label="Color mode" data-bs-toggle="dropdown"> |
| <i class="theme-switch fa-solid fa-sun fa-lg fa-fw" data-mode="light" title="Light"></i> |
| <i class="theme-switch fa-solid fa-moon fa-lg fa-fw" data-mode="dark" title="Dark"></i> |
| <i class="theme-switch fa-solid fa-circle-half-stroke fa-lg fa-fw" data-mode="auto" title="System Settings"></i> |
| </button> |
| <ul class="dropdown-menu dropdown-menu-end"> |
| <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg fa-fw me-1"></i>System Settings</button></li> |
| <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="light"><i class="fa-solid fa-sun fa-lg fa-fw me-1"></i>Light</button></li> |
| <li><button class="dropdown-item d-flex align-items-center theme-change-button" data-mode="dark"><i class="fa-solid fa-moon fa-lg fa-fw me-1"></i>Dark</button></li> |
| </ul> |
| </div></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/paimon-cpp" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i><span class="visually-hidden">GitHub</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item pst-sidebar-collapse"><button id="pst-collapse-sidebar-button" aria-expanded="true" aria-controls="pst-primary-sidebar"> |
| <svg class="pst-icon" role="img" aria-hidden="true" focusable="false" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"> |
| <path fill="currentColor" d="M3 15.5C2.36232 15.5 1.74874 15.2564 1.28478 14.8189C0.820828 14.3815 0.541576 13.7832 0.504167 13.1467L0.5 13L0.5 3C0.499965 2.36232 0.743605 1.74874 1.18107 1.28478C1.61854 0.820828 2.21676 0.541576 2.85333 0.504167L3 0.5L13 0.5C13.6377 0.499965 14.2513 0.743605 14.7152 1.18107C15.1792 1.61854 15.4584 2.21676 15.4958 2.85333L15.5 3L15.5 13C15.5 13.6377 15.2564 14.2513 14.8189 14.7152C14.3815 15.1792 13.7832 15.4584 13.1467 15.4958L13 15.5L3 15.5ZM3 13.8333L10.5 13.8333L10.5 2.16667L3 2.16667C2.79589 2.16669 2.59889 2.24163 2.44636 2.37726C2.29383 2.5129 2.19638 2.69979 2.1725 2.9025L2.16667 3L2.16667 13C2.16669 13.2041 2.24163 13.4011 2.37726 13.5536C2.5129 13.7062 2.69979 13.8036 2.9025 13.8275L3 13.8333ZM6.65583 10.325L6.5775 10.2558L4.91083 8.58917C4.76735 8.44567 4.68116 8.25476 4.66843 8.05223C4.65569 7.84971 4.71729 7.6495 4.84167 7.48917L4.91083 7.41083L6.5775 5.74417C6.72747 5.59471 6.9287 5.50794 7.14032 5.50148C7.35194 5.49502 7.55809 5.56935 7.7169 5.70937C7.8757 5.8494 7.97525 6.04463 7.99533 6.25539C8.01541 6.46616 7.95451 6.67667 7.825 6.84417L7.75583 6.9225L6.67917 8L7.75583 9.0775C7.89931 9.22099 7.98551 9.41191 7.99824 9.61443C8.01097 9.81695 7.94938 10.0172 7.825 10.1775L7.75583 10.2558C7.61234 10.3993 7.42142 10.4855 7.2189 10.4982C7.01638 10.511 6.81617 10.4494 6.65583 10.325Z"/> |
| </svg> |
| <span class="pst-collapse-sidebar-label">Collapse Sidebar</span> |
| <span class="pst-expand-sidebar-label">Expand Sidebar</span> |
| </button></div> |
| <div class="sidebar-primary-item"> |
| |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="catalog.html">Catalog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="write.html">Write</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="commit.html">Commit</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="scan.html">Scan</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="read.html">Read</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="predicate.html">Predicate</a></li> |
| |
| <li class="toctree-l1"><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 current active"><a class="current reference internal" href="#">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">Global Index</span></li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="global-index"> |
| <h1>Global Index<a class="headerlink" href="#global-index" title="Link to this heading">#</a></h1> |
| <section id="interface"> |
| <span id="cpp-api-global-index"></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="_CPPv4N6paimon20GlobalIndexerFactoryE"> |
| <span id="_CPPv3N6paimon20GlobalIndexerFactoryE"></span><span id="_CPPv2N6paimon20GlobalIndexerFactoryE"></span><span id="paimon::GlobalIndexerFactory"></span><span class="target" id="classpaimon_1_1_global_indexer_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GlobalIndexerFactory</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Factory</span></span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexerFactoryE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Factory for creating <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_indexer"><span class="std std-ref"><span class="pre">GlobalIndexer</span></span></a></code> instances based on index type identifiers. </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="_CPPv4N6paimon20GlobalIndexerFactoryD0Ev"> |
| <span id="_CPPv3N6paimon20GlobalIndexerFactoryD0Ev"></span><span id="_CPPv2N6paimon20GlobalIndexerFactoryD0Ev"></span><span id="paimon::GlobalIndexerFactory::~GlobalIndexerFactory"></span><span class="target" id="classpaimon_1_1_global_indexer_factory_1a5fb7c39dd060a18e8bf89fff5c46abbb"></span><span class="sig-name descname"><span class="n"><span class="pre">~GlobalIndexerFactory</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><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="#_CPPv4N6paimon20GlobalIndexerFactoryD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon20GlobalIndexerFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3NK6paimon20GlobalIndexerFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2NK6paimon20GlobalIndexerFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="paimon::GlobalIndexerFactory::Create__std::map:ss.ss:CRC"></span><span class="target" id="classpaimon_1_1_global_indexer_factory_1a05b24b744dd0388a0ae4188cdb51acca"></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="#_CPPv4N6paimon13GlobalIndexerE" title="paimon::GlobalIndexer"><span class="n"><span class="pre">GlobalIndexer</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Create</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon20GlobalIndexerFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE" 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_global_indexer"><span class="std std-ref"><span class="pre">GlobalIndexer</span></span></a></code> using the current factory’s implementation and the given options. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20GlobalIndexerFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"> |
| <span id="_CPPv3N6paimon20GlobalIndexerFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="_CPPv2N6paimon20GlobalIndexerFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"></span><span id="paimon::GlobalIndexerFactory::Get__ssCR.std::map:ss.ss:CR"></span><span class="target" id="classpaimon_1_1_global_indexer_factory_1a09abf2b41638d845477bf2147c8929ac"></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="#_CPPv4N6paimon13GlobalIndexerE" title="paimon::GlobalIndexer"><span class="n"><span class="pre">GlobalIndexer</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Get</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">identifier</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">map</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexerFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE" 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_global_indexer"><span class="std std-ref"><span class="pre">GlobalIndexer</span></span></a></code> instance by looking up a registered factory using an identifier. </p> |
| <p>The provided <code class="docutils literal notranslate"><span class="pre">identifier</span></code> is automatically appended with <code class="docutils literal notranslate"><span class="pre">GLOBAL_INDEX_IDENTIFIER_SUFFIX</span></code> (e.g., “-global”) to form the full key used for factory lookup. This ensures namespace separation between file and global index types.</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>identifier</strong> – The base name of the index type (e.g., “bitmap”). </p></li> |
| <li><p><strong>options</strong> – Configuration parameters for the indexer. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> containing a unique pointer to the created <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_indexer"><span class="std std-ref"><span class="pre">GlobalIndexer</span></span></a></code>, or an error if creation fails. </p> |
| </dd> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>nullptr if no matching factory. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-attributes">Public Static Attributes</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20GlobalIndexerFactory30GLOBAL_INDEX_IDENTIFIER_SUFFIXE"> |
| <span id="_CPPv3N6paimon20GlobalIndexerFactory30GLOBAL_INDEX_IDENTIFIER_SUFFIXE"></span><span id="_CPPv2N6paimon20GlobalIndexerFactory30GLOBAL_INDEX_IDENTIFIER_SUFFIXE"></span><span id="paimon::GlobalIndexerFactory::GLOBAL_INDEX_IDENTIFIER_SUFFIX__cCA"></span><span class="target" id="classpaimon_1_1_global_indexer_factory_1a53bcb91e611b57be14cf983313ca7131"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GLOBAL_INDEX_IDENTIFIER_SUFFIX</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexerFactory30GLOBAL_INDEX_IDENTIFIER_SUFFIXE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Suffix used to distinguish global index identifiers (e.g., “bitmap-global”). </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon13GlobalIndexerE"> |
| <span id="_CPPv3N6paimon13GlobalIndexerE"></span><span id="_CPPv2N6paimon13GlobalIndexerE"></span><span id="paimon::GlobalIndexer"></span><span class="target" id="classpaimon_1_1_global_indexer"></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">GlobalIndexer</span></span></span><a class="headerlink" href="#_CPPv4N6paimon13GlobalIndexerE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Interface for creating global index readers and writers. </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="_CPPv4N6paimon13GlobalIndexerD0Ev"> |
| <span id="_CPPv3N6paimon13GlobalIndexerD0Ev"></span><span id="_CPPv2N6paimon13GlobalIndexerD0Ev"></span><span id="paimon::GlobalIndexer::~GlobalIndexer"></span><span class="target" id="classpaimon_1_1_global_indexer_1a8350b04541d75e0ffb3a451b2067c90e"></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">~GlobalIndexer</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="#_CPPv4N6paimon13GlobalIndexerD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon13GlobalIndexer12CreateWriterERKNSt6stringEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileWriterEERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3NK6paimon13GlobalIndexer12CreateWriterERKNSt6stringEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileWriterEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2NK6paimon13GlobalIndexer12CreateWriterERKNSt6stringEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileWriterEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::GlobalIndexer::CreateWriter__ssCR.ArrowSchemaP.std::shared_ptr:GlobalIndexFileWriter:CR.std::shared_ptr:MemoryPool:CRC"></span><span class="target" id="classpaimon_1_1_global_indexer_1a48c350f4c101dace9fe5d79ff629f622"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexWriterE" title="paimon::GlobalIndexWriter"><span class="n"><span class="pre">GlobalIndexWriter</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">CreateWriter</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">field_name</span></span>, <span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowSchema</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">arrow_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="#_CPPv4N6paimon21GlobalIndexFileWriterE" title="paimon::GlobalIndexFileWriter"><span class="n"><span class="pre">GlobalIndexFileWriter</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_writer</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="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="#_CPPv4NK6paimon13GlobalIndexer12CreateWriterERKNSt6stringEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileWriterEERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a writer for building a global index on a specific field. </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>field_name</strong> – Name of the field to be indexed. </p></li> |
| <li><p><strong>arrow_schema</strong> – Schema of the input Arrow struct array. It must contain the field specified by field_name and may include additional associated fields used during index construction. </p></li> |
| <li><p><strong>file_writer</strong> – I/O handler for persisting index data to storage. </p></li> |
| <li><p><strong>pool</strong> – Memory pool for temporary allocations; if nullptr, uses default. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> containing a shared pointer to the created <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_index_writer"><span class="std std-ref"><span class="pre">GlobalIndexWriter</span></span></a></code>, or an error if the field is not found, unsupported, or initialization fails, etc. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon13GlobalIndexer12CreateReaderEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileReaderEERKNSt6vectorI17GlobalIndexIOMetaEERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3NK6paimon13GlobalIndexer12CreateReaderEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileReaderEERKNSt6vectorI17GlobalIndexIOMetaEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2NK6paimon13GlobalIndexer12CreateReaderEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileReaderEERKNSt6vectorI17GlobalIndexIOMetaEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::GlobalIndexer::CreateReader__ArrowSchemaP.std::shared_ptr:GlobalIndexFileReader:CR.std::vector:GlobalIndexIOMeta:CR.std::shared_ptr:MemoryPool:CRC"></span><span class="target" id="classpaimon_1_1_global_indexer_1aef056d9a8177dfcfa86bc60cf5ac86ef"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexReaderE" title="paimon::GlobalIndexReader"><span class="n"><span class="pre">GlobalIndexReader</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="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowSchema</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">arrow_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="#_CPPv4N6paimon21GlobalIndexFileReaderE" title="paimon::GlobalIndexFileReader"><span class="n"><span class="pre">GlobalIndexFileReader</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_reader</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><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexIOMetaE" title="paimon::GlobalIndexIOMeta"><span class="n"><span class="pre">GlobalIndexIOMeta</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">files</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="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="#_CPPv4NK6paimon13GlobalIndexer12CreateReaderEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileReaderEERKNSt6vectorI17GlobalIndexIOMetaEERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a reader for querying a pre-built global index. </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>arrow_schema</strong> – Schema of the indexed data; used to interpret predicate literals. </p></li> |
| <li><p><strong>file_reader</strong> – I/O handler for reading index artifacts from storage. </p></li> |
| <li><p><strong>files</strong> – List of index file metadata entries produced during writing. </p></li> |
| <li><p><strong>pool</strong> – Memory pool for temporary allocations; if nullptr, uses default. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> containing a shared pointer to the created <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_index_reader"><span class="std std-ref"><span class="pre">GlobalIndexReader</span></span></a></code>, or an error if the index cannot be loaded or is incompatible, etc. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexReaderE"> |
| <span id="_CPPv3N6paimon17GlobalIndexReaderE"></span><span id="_CPPv2N6paimon17GlobalIndexReaderE"></span><span id="paimon::GlobalIndexReader"></span><span class="target" id="classpaimon_1_1_global_index_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">GlobalIndexReader</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="predicate.html#_CPPv4I0EN6paimon15FunctionVisitorE" title="paimon::FunctionVisitor"><span class="n"><span class="pre">FunctionVisitor</span></span></a><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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexReaderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Reads and evaluates filter predicates against a global file index. </p> |
| <p>Derived classes are expected to implement the visitor methods (e.g., <code class="docutils literal notranslate"><span class="pre">VisitEqual</span></code>, <code class="docutils literal notranslate"><span class="pre">VisitIsNull</span></code>, etc.) to return index-based results that indicate which rows satisfy the given predicate. </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="_CPPv4N6paimon17GlobalIndexReader17VisitVectorSearchERKNSt10shared_ptrI12VectorSearchEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexReader17VisitVectorSearchERKNSt10shared_ptrI12VectorSearchEE"></span><span id="_CPPv2N6paimon17GlobalIndexReader17VisitVectorSearchERKNSt10shared_ptrI12VectorSearchEE"></span><span id="paimon::GlobalIndexReader::VisitVectorSearch__std::shared_ptr:VectorSearch:CR"></span><span class="target" id="classpaimon_1_1_global_index_reader_1a16fa9dbc84a8db7ec433895e111a8ad9"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ScoredGlobalIndexResult</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">VisitVectorSearch</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><span class="n"><span class="pre">VectorSearch</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">vector_search</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="#_CPPv4N6paimon17GlobalIndexReader17VisitVectorSearchERKNSt10shared_ptrI12VectorSearchEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>VisitVectorSearch performs approximate vector similarity search. </p> |
| <div class="admonition warning"> |
| <p class="admonition-title">Warning</p> |
| <p><code class="docutils literal notranslate"><span class="pre">VisitVectorSearch</span></code> may return error status when it is incorrectly invoked (e.g., BitmapGlobalIndexReader call <code class="docutils literal notranslate"><span class="pre">VisitVectorSearch</span></code>). </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexReader19VisitFullTextSearchERKNSt10shared_ptrI14FullTextSearchEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexReader19VisitFullTextSearchERKNSt10shared_ptrI14FullTextSearchEE"></span><span id="_CPPv2N6paimon17GlobalIndexReader19VisitFullTextSearchERKNSt10shared_ptrI14FullTextSearchEE"></span><span id="paimon::GlobalIndexReader::VisitFullTextSearch__std::shared_ptr:FullTextSearch:CR"></span><span class="target" id="classpaimon_1_1_global_index_reader_1a47e75572d834bf832fe83cd9f04928b3"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">VisitFullTextSearch</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><span class="n"><span class="pre">FullTextSearch</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">full_text_search</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="#_CPPv4N6paimon17GlobalIndexReader19VisitFullTextSearchERKNSt10shared_ptrI14FullTextSearchEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>VisitFullTextSearch performs full text search. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexReader12IsThreadSafeEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexReader12IsThreadSafeEv"></span><span id="_CPPv2NK6paimon17GlobalIndexReader12IsThreadSafeEv"></span><span id="paimon::GlobalIndexReader::IsThreadSafeC"></span><span class="target" id="classpaimon_1_1_global_index_reader_1a372637284f1f11769618184f9bb8615f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsThreadSafe</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="#_CPPv4NK6paimon17GlobalIndexReader12IsThreadSafeEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>true if the reader is thread-safe; false otherwise. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexReader12GetIndexTypeEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexReader12GetIndexTypeEv"></span><span id="_CPPv2NK6paimon17GlobalIndexReader12GetIndexTypeEv"></span><span id="paimon::GlobalIndexReader::GetIndexTypeC"></span><span class="target" id="classpaimon_1_1_global_index_reader_1a1470a15c09ec8ed15124704e12ddd1fc"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetIndexType</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="#_CPPv4NK6paimon17GlobalIndexReader12GetIndexTypeEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>An identifier representing the index type. (e.g., “bitmap”, “lumina”). </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon21GlobalIndexFileReaderE"> |
| <span id="_CPPv3N6paimon21GlobalIndexFileReaderE"></span><span id="_CPPv2N6paimon21GlobalIndexFileReaderE"></span><span id="paimon::GlobalIndexFileReader"></span><span class="target" id="classpaimon_1_1_global_index_file_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">GlobalIndexFileReader</span></span></span><a class="headerlink" href="#_CPPv4N6paimon21GlobalIndexFileReaderE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Abstract interface for reading global index files from storage. </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="_CPPv4N6paimon21GlobalIndexFileReaderD0Ev"> |
| <span id="_CPPv3N6paimon21GlobalIndexFileReaderD0Ev"></span><span id="_CPPv2N6paimon21GlobalIndexFileReaderD0Ev"></span><span id="paimon::GlobalIndexFileReader::~GlobalIndexFileReader"></span><span class="target" id="classpaimon_1_1_global_index_file_reader_1a5827c0f10c75e2ad85f428df056e3133"></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">~GlobalIndexFileReader</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="#_CPPv4N6paimon21GlobalIndexFileReaderD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon21GlobalIndexFileReader14GetInputStreamERKNSt6stringE"> |
| <span id="_CPPv3NK6paimon21GlobalIndexFileReader14GetInputStreamERKNSt6stringE"></span><span id="_CPPv2NK6paimon21GlobalIndexFileReader14GetInputStreamERKNSt6stringE"></span><span id="paimon::GlobalIndexFileReader::GetInputStream__ssCRC"></span><span class="target" id="classpaimon_1_1_global_index_file_reader_1a2820933f0a131dcc39402e2954a8e10c"></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="file_system.html#_CPPv4N6paimon11InputStreamE" title="paimon::InputStream"><span class="n"><span class="pre">InputStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetInputStream</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">file_path</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon21GlobalIndexFileReader14GetInputStreamERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Opens an input stream for reading the specified global index file. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexIOMetaE"> |
| <span id="_CPPv3N6paimon17GlobalIndexIOMetaE"></span><span id="_CPPv2N6paimon17GlobalIndexIOMetaE"></span><span id="paimon::GlobalIndexIOMeta"></span><span class="target" id="structpaimon_1_1_global_index_i_o_meta"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GlobalIndexIOMeta</span></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexIOMetaE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Metadata describing a single file entry in a global index. </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="_CPPv4N6paimon17GlobalIndexIOMeta17GlobalIndexIOMetaERKNSt6stringE7int64_tRKNSt10shared_ptrI5BytesEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexIOMeta17GlobalIndexIOMetaERKNSt6stringE7int64_tRKNSt10shared_ptrI5BytesEE"></span><span id="_CPPv2N6paimon17GlobalIndexIOMeta17GlobalIndexIOMetaERKNSt6stringE7int64_tRKNSt10shared_ptrI5BytesEE"></span><span id="paimon::GlobalIndexIOMeta::GlobalIndexIOMeta__ssCR.int64_t.std::shared_ptr:Bytes:CR"></span><span class="target" id="structpaimon_1_1_global_index_i_o_meta_1ae4ad7d589548064b23034cc4c7b07199"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GlobalIndexIOMeta</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">_file_path</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">_file_size</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#_CPPv4N6paimon5BytesE" title="paimon::Bytes"><span class="n"><span class="pre">Bytes</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">_metadata</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexIOMeta17GlobalIndexIOMetaERKNSt6stringE7int64_tRKNSt10shared_ptrI5BytesEE" 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-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexIOMeta9file_pathE"> |
| <span id="_CPPv3N6paimon17GlobalIndexIOMeta9file_pathE"></span><span id="_CPPv2N6paimon17GlobalIndexIOMeta9file_pathE"></span><span id="paimon::GlobalIndexIOMeta::file_path__ss"></span><span class="target" id="structpaimon_1_1_global_index_i_o_meta_1adba7db339b5ead4acee6b04f64e5ab3c"></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="sig-name descname"><span class="n"><span class="pre">file_path</span></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexIOMeta9file_pathE" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexIOMeta9file_sizeE"> |
| <span id="_CPPv3N6paimon17GlobalIndexIOMeta9file_sizeE"></span><span id="_CPPv2N6paimon17GlobalIndexIOMeta9file_sizeE"></span><span id="paimon::GlobalIndexIOMeta::file_size__int64_t"></span><span class="target" id="structpaimon_1_1_global_index_i_o_meta_1af7a811477df217c2e74f6c30efaa0dd4"></span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">file_size</span></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexIOMeta9file_sizeE" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexIOMeta8metadataE"> |
| <span id="_CPPv3N6paimon17GlobalIndexIOMeta8metadataE"></span><span id="_CPPv2N6paimon17GlobalIndexIOMeta8metadataE"></span><span id="paimon::GlobalIndexIOMeta::metadata__std::shared_ptr:Bytes:"></span><span class="target" id="structpaimon_1_1_global_index_i_o_meta_1af0433a4a657ce0c0b0a2f27cf7f66197"></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#_CPPv4N6paimon5BytesE" title="paimon::Bytes"><span class="n"><span class="pre">Bytes</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">metadata</span></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexIOMeta8metadataE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Optional binary metadata associated with the file, such as serialized secondary index structures or inline index bytes. </p> |
| <p>May be null if no additional metadata is available. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResultE"> |
| <span id="_CPPv3N6paimon17GlobalIndexResultE"></span><span id="_CPPv2N6paimon17GlobalIndexResultE"></span><span id="paimon::GlobalIndexResult"></span><span class="target" id="classpaimon_1_1_global_index_result"></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">GlobalIndexResult</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">enable_shared_from_this</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexResultE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Global index result that holds the row ids. </p> |
| <p>Subclassed by <a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result"><span class="std std-ref">paimon::BitmapGlobalIndexResult</span></a>, paimon::ScoredGlobalIndexResult</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="_CPPv4N6paimon17GlobalIndexResultD0Ev"> |
| <span id="_CPPv3N6paimon17GlobalIndexResultD0Ev"></span><span id="_CPPv2N6paimon17GlobalIndexResultD0Ev"></span><span id="paimon::GlobalIndexResult::~GlobalIndexResult"></span><span class="target" id="classpaimon_1_1_global_index_result_1a08518aaa907fab25595a3fac121e446a"></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">~GlobalIndexResult</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="#_CPPv4N6paimon17GlobalIndexResultD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexResult7IsEmptyEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexResult7IsEmptyEv"></span><span id="_CPPv2NK6paimon17GlobalIndexResult7IsEmptyEv"></span><span id="paimon::GlobalIndexResult::IsEmptyC"></span><span class="target" id="classpaimon_1_1_global_index_result_1a05a3bf2cf4de40d4111f5b5ea087c42c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsEmpty</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="#_CPPv4NK6paimon17GlobalIndexResult7IsEmptyEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Checks whether the global index result contains no matching row ids. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span><span class="pre"><bool></span></code> where:<ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">true</span></code> indicates the result is empty (no matching rows),</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">false</span></code> indicates at least one matching row exists,</p></li> |
| <li><p>An error is returned only if internal state is corrupted or I/O fails (e.g., during lazy loading of index data). </p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexResult14CreateIteratorEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexResult14CreateIteratorEv"></span><span id="_CPPv2NK6paimon17GlobalIndexResult14CreateIteratorEv"></span><span id="paimon::GlobalIndexResult::CreateIteratorC"></span><span class="target" id="classpaimon_1_1_global_index_result_1ace69c312887a2e4d2166cbeaab2dcdf9"></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="#_CPPv4N6paimon17GlobalIndexResult8IteratorE" title="paimon::GlobalIndexResult::Iterator"><span class="n"><span class="pre">Iterator</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">CreateIterator</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="#_CPPv4NK6paimon17GlobalIndexResult14CreateIteratorEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a new iterator over the selected row ids. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexResult8ToRangesEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexResult8ToRangesEv"></span><span id="_CPPv2NK6paimon17GlobalIndexResult8ToRangesEv"></span><span id="paimon::GlobalIndexResult::ToRangesC"></span><span class="target" id="classpaimon_1_1_global_index_result_1a9f44de9b4fd9cf03ab8ecb933daa0f76"></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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Range</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToRanges</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="#_CPPv4NK6paimon17GlobalIndexResult8ToRangesEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Returns non-overlapping, sorted ranges covering all row ids in <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_index_result"><span class="std std-ref"><span class="pre">GlobalIndexResult</span></span></a></code>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="_CPPv2N6paimon17GlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="paimon::GlobalIndexResult::And__std::shared_ptr:GlobalIndexResult:CR"></span><span class="target" id="classpaimon_1_1_global_index_result_1a607f1de75fd37e32b1d45a920ef03869"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">And</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">other</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Computes the logical AND (intersection) between current result and another. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="_CPPv2N6paimon17GlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="paimon::GlobalIndexResult::Or__std::shared_ptr:GlobalIndexResult:CR"></span><span class="target" id="classpaimon_1_1_global_index_result_1ae671eeb65cc8602695328a62e5d13283"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">Or</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">other</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Computes the logical OR (union) between this result and another. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult9AddOffsetE7int64_t"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult9AddOffsetE7int64_t"></span><span id="_CPPv2N6paimon17GlobalIndexResult9AddOffsetE7int64_t"></span><span id="paimon::GlobalIndexResult::AddOffset__int64_t"></span><span class="target" id="classpaimon_1_1_global_index_result_1afd16e7179e2bcfd49f5355a23c44cecd"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">AddOffset</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</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="#_CPPv4N6paimon17GlobalIndexResult9AddOffsetE7int64_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Adds the given offset to each row id in current result and returns the new global index result. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexResult8ToStringEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexResult8ToStringEv"></span><span id="_CPPv2NK6paimon17GlobalIndexResult8ToStringEv"></span><span id="paimon::GlobalIndexResult::ToStringC"></span><span class="target" id="classpaimon_1_1_global_index_result_1a6c022a8685d9e5994ffe37a9efb630f2"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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="#_CPPv4NK6paimon17GlobalIndexResult8ToStringEv" 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-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult9SerializeERKNSt10shared_ptrI17GlobalIndexResultEERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult9SerializeERKNSt10shared_ptrI17GlobalIndexResultEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon17GlobalIndexResult9SerializeERKNSt10shared_ptrI17GlobalIndexResultEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::GlobalIndexResult::Serialize__std::shared_ptr:GlobalIndexResult:CR.std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_global_index_result_1a9e672c533c723ee18391cca40e72da2e"></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">PAIMON_UNIQUE_PTR</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon5BytesE" title="paimon::Bytes"><span class="n"><span class="pre">Bytes</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">Serialize</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">global_index_result</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexResult9SerializeERKNSt10shared_ptrI17GlobalIndexResultEERKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Serializes a <a class="reference internal" href="#classpaimon_1_1_global_index_result"><span class="std std-ref">GlobalIndexResult</span></a> object into a byte array. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This method only supports the following concrete implementations:<ul class="simple"> |
| <li><p><a class="reference internal" href="#classpaimon_1_1_bitmap_scored_global_index_result"><span class="std std-ref">BitmapScoredGlobalIndexResult</span></a></p></li> |
| <li><p><a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result"><span class="std std-ref">BitmapGlobalIndexResult</span></a></p></li> |
| </ul> |
| </p> |
| </div> |
| <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>global_index_result</strong> – The <a class="reference internal" href="#classpaimon_1_1_global_index_result"><span class="std std-ref">GlobalIndexResult</span></a> instance to serialize (must not be null). </p></li> |
| <li><p><strong>pool</strong> – Memory pool used to allocate the output byte buffer. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Result containing a unique pointer to the serialized <a class="reference internal" href="memory.html#classpaimon_1_1_bytes"><span class="std std-ref">Bytes</span></a> on success, or an error status on failure. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult11DeserializeEPKc6size_tRKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult11DeserializeEPKc6size_tRKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon17GlobalIndexResult11DeserializeEPKc6size_tRKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::GlobalIndexResult::Deserialize__cCP.s.std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_global_index_result_1a1ab7dbefdca130a6e8a500f46801be91"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">Deserialize</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexResult11DeserializeEPKc6size_tRKNSt10shared_ptrI10MemoryPoolEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Deserializes a <a class="reference internal" href="#classpaimon_1_1_global_index_result"><span class="std std-ref">GlobalIndexResult</span></a> object from a raw byte buffer. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>The concrete type of the deserialized object is determined by metadata embedded in the buffer. Currently, only the following types are supported:<ul class="simple"> |
| <li><p><a class="reference internal" href="#classpaimon_1_1_bitmap_scored_global_index_result"><span class="std std-ref">BitmapScoredGlobalIndexResult</span></a></p></li> |
| <li><p><a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result"><span class="std std-ref">BitmapGlobalIndexResult</span></a></p></li> |
| </ul> |
| </p> |
| </div> |
| <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>buffer</strong> – Pointer to the serialized byte data (must not be null). </p></li> |
| <li><p><strong>length</strong> – Size of the buffer in bytes. </p></li> |
| <li><p><strong>pool</strong> – Memory pool used to allocate internal objects during deserialization. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A Result containing a shared pointer to the reconstructed <a class="reference internal" href="#classpaimon_1_1_global_index_result"><span class="std std-ref">GlobalIndexResult</span></a> on success, or an error status on failure. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult8IteratorE"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult8IteratorE"></span><span id="_CPPv2N6paimon17GlobalIndexResult8IteratorE"></span><span id="paimon::GlobalIndexResult::Iterator"></span><span class="target" id="classpaimon_1_1_global_index_result_1_1_iterator"></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">Iterator</span></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexResult8IteratorE" title="Link to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="#classpaimon_1_1_global_index_result_1_1_iterator"><span class="std std-ref">Iterator</span></a> interface for traversing selected row ids. </p> |
| <p>Subclassed by <a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result_1_1_iterator"><span class="std std-ref">paimon::BitmapGlobalIndexResult::Iterator</span></a></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="_CPPv4N6paimon17GlobalIndexResult8IteratorD0Ev"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult8IteratorD0Ev"></span><span id="_CPPv2N6paimon17GlobalIndexResult8IteratorD0Ev"></span><span id="paimon::GlobalIndexResult::Iterator::~Iterator"></span><span class="target" id="classpaimon_1_1_global_index_result_1_1_iterator_1aac4fb487be27001bafee04694a02d036"></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">~Iterator</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="#_CPPv4N6paimon17GlobalIndexResult8IteratorD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon17GlobalIndexResult8Iterator7HasNextEv"> |
| <span id="_CPPv3NK6paimon17GlobalIndexResult8Iterator7HasNextEv"></span><span id="_CPPv2NK6paimon17GlobalIndexResult8Iterator7HasNextEv"></span><span id="paimon::GlobalIndexResult::Iterator::HasNextC"></span><span class="target" id="classpaimon_1_1_global_index_result_1_1_iterator_1a20a59325817772e958f9433b56e11ab9"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasNext</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="#_CPPv4NK6paimon17GlobalIndexResult8Iterator7HasNextEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Checks whether more row ids are available. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexResult8Iterator4NextEv"> |
| <span id="_CPPv3N6paimon17GlobalIndexResult8Iterator4NextEv"></span><span id="_CPPv2N6paimon17GlobalIndexResult8Iterator4NextEv"></span><span id="paimon::GlobalIndexResult::Iterator::Next"></span><span class="target" id="classpaimon_1_1_global_index_result_1_1_iterator_1aec3a22bc75ba73c1e043b5b1db52ce07"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</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="#_CPPv4N6paimon17GlobalIndexResult8Iterator4NextEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The next row id and advances the iterator. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon23BitmapGlobalIndexResultE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResultE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResultE"></span><span id="paimon::BitmapGlobalIndexResult"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result"></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">BitmapGlobalIndexResult</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</span></span></a><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResultE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Represents a global index query result that <strong>lazily materializes</strong> its matching row ids as a Roaring bitmap. </p> |
| <p>The underlying 64-bit Roaring bitmap is <strong>not constructed during object creation</strong>; instead, it is built on-demand the first time <a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result_1a46943e0387c15fa969d3191be225c432"><span class="std std-ref">GetBitmap()</span></a> is called. This design avoids unnecessary computation and memory allocation when the bitmap is not needed (e.g., during early stopping). </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="_CPPv4N6paimon23BitmapGlobalIndexResult14BitmapSupplierE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult14BitmapSupplierE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult14BitmapSupplierE"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1a7e28c39acb886b92fd1323a40601a79f"></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">BitmapSupplier</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">function</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">RoaringBitmap64</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult14BitmapSupplierE" 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="_CPPv4N6paimon23BitmapGlobalIndexResult23BitmapGlobalIndexResultE14BitmapSupplier"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult23BitmapGlobalIndexResultE14BitmapSupplier"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult23BitmapGlobalIndexResultE14BitmapSupplier"></span><span id="paimon::BitmapGlobalIndexResult::BitmapGlobalIndexResult__BitmapSupplier"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1accacdab3aa8b80967e25ac0437fedb7c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BitmapGlobalIndexResult</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N6paimon23BitmapGlobalIndexResult14BitmapSupplierE" title="paimon::BitmapGlobalIndexResult::BitmapSupplier"><span class="n"><span class="pre">BitmapSupplier</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">bitmap_supplier</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult23BitmapGlobalIndexResultE14BitmapSupplier" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon23BitmapGlobalIndexResult14CreateIteratorEv"> |
| <span id="_CPPv3NK6paimon23BitmapGlobalIndexResult14CreateIteratorEv"></span><span id="_CPPv2NK6paimon23BitmapGlobalIndexResult14CreateIteratorEv"></span><span id="paimon::BitmapGlobalIndexResult::CreateIteratorC"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1ad3b8473b722436071b4940f6ec6b3f8a"></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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResult8IteratorE" title="paimon::GlobalIndexResult::Iterator"><span class="n"><span class="pre">Iterator</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">CreateIterator</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult14CreateIteratorEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a new iterator over the selected row ids. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon23BitmapGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="paimon::BitmapGlobalIndexResult::And__std::shared_ptr:GlobalIndexResult:CR"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1abe5b158b0b72b11193671df7ff8faa84"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">And</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Computes the logical AND (intersection) between current result and another. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon23BitmapGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="paimon::BitmapGlobalIndexResult::Or__std::shared_ptr:GlobalIndexResult:CR"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1a8c154d866ae1147734c8b1f1f3ba8367"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">Or</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Computes the logical OR (union) between this result and another. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon23BitmapGlobalIndexResult7IsEmptyEv"> |
| <span id="_CPPv3NK6paimon23BitmapGlobalIndexResult7IsEmptyEv"></span><span id="_CPPv2NK6paimon23BitmapGlobalIndexResult7IsEmptyEv"></span><span id="paimon::BitmapGlobalIndexResult::IsEmptyC"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1ae4ec122ed6a0e13f2aa42cf28e39fc29"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsEmpty</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult7IsEmptyEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Checks whether the global index result contains no matching row ids. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span><span class="pre"><bool></span></code> where:<ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">true</span></code> indicates the result is empty (no matching rows),</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">false</span></code> indicates at least one matching row exists,</p></li> |
| <li><p>An error is returned only if internal state is corrupted or I/O fails (e.g., during lazy loading of index data). </p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon23BitmapGlobalIndexResult9AddOffsetE7int64_t"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult9AddOffsetE7int64_t"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult9AddOffsetE7int64_t"></span><span id="paimon::BitmapGlobalIndexResult::AddOffset__int64_t"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1a409d2f875a261fddfa84936c2e9e1390"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">AddOffset</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult9AddOffsetE7int64_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Adds the given offset to each row id in current result and returns the new global index result. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon23BitmapGlobalIndexResult8ToStringEv"> |
| <span id="_CPPv3NK6paimon23BitmapGlobalIndexResult8ToStringEv"></span><span id="_CPPv2NK6paimon23BitmapGlobalIndexResult8ToStringEv"></span><span id="paimon::BitmapGlobalIndexResult::ToStringC"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1a0ca5deec02bf047112fdb947d8f680d3"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult8ToStringEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon23BitmapGlobalIndexResult9GetBitmapEv"> |
| <span id="_CPPv3NK6paimon23BitmapGlobalIndexResult9GetBitmapEv"></span><span id="_CPPv2NK6paimon23BitmapGlobalIndexResult9GetBitmapEv"></span><span id="paimon::BitmapGlobalIndexResult::GetBitmapC"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1a46943e0387c15fa969d3191be225c432"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">RoaringBitmap64</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetBitmap</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="#_CPPv4NK6paimon23BitmapGlobalIndexResult9GetBitmapEv" title="Link to this definition">#</a><br /></dt> |
| <dd><div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p><strong>Lazy initialization</strong>: The bitmap is constructed only on the first call to this method. Subsequent calls return the cached instance. Construction may involve non-trivial CPU/IO cost (e.g., read indexes or merging bitmap), so avoid calling this if the bitmap is not actually required. <strong>Not thread-safe</strong>. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A non-owning, const pointer to the bitmap. The returned pointer is valid as long as this <a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result"><span class="std std-ref">BitmapGlobalIndexResult</span></a> object is alive. The caller must not modify the bitmap. </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="_CPPv4N6paimon23BitmapGlobalIndexResult10FromRangesERKNSt6vectorI5RangeEE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult10FromRangesERKNSt6vectorI5RangeEE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult10FromRangesERKNSt6vectorI5RangeEE"></span><span id="paimon::BitmapGlobalIndexResult::FromRanges__std::vector:Range:CR"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1ad8da62f2613c50200141a8c932a12dbb"></span><span class="k"><span class="pre">static</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="#_CPPv4N6paimon23BitmapGlobalIndexResultE" title="paimon::BitmapGlobalIndexResult"><span class="n"><span class="pre">BitmapGlobalIndexResult</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">FromRanges</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">Range</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">ranges</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult10FromRangesERKNSt6vectorI5RangeEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_bitmap_global_index_result"><span class="std std-ref"><span class="pre">BitmapGlobalIndexResult</span></span></a></code> for all row ids in the given ranges. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Overlapping or unsorted ranges are accepted. </p> |
| </div> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon23BitmapGlobalIndexResult8IteratorE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult8IteratorE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult8IteratorE"></span><span id="paimon::BitmapGlobalIndexResult::Iterator"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1_1_iterator"></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">Iterator</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResult8IteratorE" title="paimon::GlobalIndexResult::Iterator"><span class="n"><span class="pre">Iterator</span></span></a><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult8IteratorE" title="Link to this definition">#</a><br /></dt> |
| <dd><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="_CPPv4N6paimon23BitmapGlobalIndexResult8Iterator8IteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorE"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult8Iterator8IteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorE"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult8Iterator8IteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorE"></span><span id="paimon::BitmapGlobalIndexResult::Iterator::Iterator__RoaringBitmap64CP.RoaringBitmap64::IteratorRR"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1_1_iterator_1ac59f6d035818a81f17dc8edf2f173296"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Iterator</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">RoaringBitmap64</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">bitmap</span></span>, <span class="n"><span class="pre">RoaringBitmap64</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Iterator</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">iter</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult8Iterator8IteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorE" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon23BitmapGlobalIndexResult8Iterator7HasNextEv"> |
| <span id="_CPPv3NK6paimon23BitmapGlobalIndexResult8Iterator7HasNextEv"></span><span id="_CPPv2NK6paimon23BitmapGlobalIndexResult8Iterator7HasNextEv"></span><span id="paimon::BitmapGlobalIndexResult::Iterator::HasNextC"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1_1_iterator_1ab2955ec4b6bcbb7ae0df16d10e18e893"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasNext</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult8Iterator7HasNextEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Checks whether more row ids are available. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon23BitmapGlobalIndexResult8Iterator4NextEv"> |
| <span id="_CPPv3N6paimon23BitmapGlobalIndexResult8Iterator4NextEv"></span><span id="_CPPv2N6paimon23BitmapGlobalIndexResult8Iterator4NextEv"></span><span id="paimon::BitmapGlobalIndexResult::Iterator::Next"></span><span class="target" id="classpaimon_1_1_bitmap_global_index_result_1_1_iterator_1a30fc7c3c5e779784b9ff8398668f7623"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Next</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon23BitmapGlobalIndexResult8Iterator4NextEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The next row id and advances the iterator. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon29BitmapScoredGlobalIndexResultE"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResultE"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResultE"></span><span id="paimon::BitmapScoredGlobalIndexResult"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result"></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">BitmapScoredGlobalIndexResult</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ScoredGlobalIndexResult</span></span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResultE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Represents a scored global index result that combines a Roaring bitmap of candidate row ids with an array of associated relevance scores. </p> |
| <p><strong>Important Ordering Note</strong>: Inheriting from ScoredGlobalIndexResult, the results are <strong>NOT sorted by score</strong>. Instead, both the bitmap and the score vector are ordered by <strong>ascending row id</strong>. This design enables efficient merging and set operations while preserving row id-to-score mapping. </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="_CPPv4N6paimon29BitmapScoredGlobalIndexResult29BitmapScoredGlobalIndexResultERR15RoaringBitmap64RRNSt6vectorIfEE"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult29BitmapScoredGlobalIndexResultERR15RoaringBitmap64RRNSt6vectorIfEE"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult29BitmapScoredGlobalIndexResultERR15RoaringBitmap64RRNSt6vectorIfEE"></span><span id="paimon::BitmapScoredGlobalIndexResult::BitmapScoredGlobalIndexResult__RoaringBitmap64RR.std::vector:float:RR"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a874e2b480a96b1545ff55554de4fe8b4"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BitmapScoredGlobalIndexResult</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">RoaringBitmap64</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">bitmap</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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">float</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">scores</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult29BitmapScoredGlobalIndexResultERR15RoaringBitmap64RRNSt6vectorIfEE" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult14CreateIteratorEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult14CreateIteratorEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult14CreateIteratorEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::CreateIteratorC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1ae7faeabe6cbbb4b329a4080d321e9102"></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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResult8IteratorE" title="paimon::GlobalIndexResult::Iterator"><span class="n"><span class="pre">Iterator</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">CreateIterator</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult14CreateIteratorEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a new iterator over the selected row ids. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult20CreateScoredIteratorEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult20CreateScoredIteratorEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult20CreateScoredIteratorEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::CreateScoredIteratorC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a0aa82119ac1ba8029d104567f0e21f6a"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">ScoredGlobalIndexResult</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ScoredIterator</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreateScoredIterator</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult20CreateScoredIteratorEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates a new iterator for traversing the scored results. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon29BitmapScoredGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="paimon::BitmapScoredGlobalIndexResult::And__std::shared_ptr:GlobalIndexResult:CR"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a4d72acfda8309befc95f2feef2f06226"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">And</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Computes the logical AND (intersection) between current result and another. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon29BitmapScoredGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"></span><span id="paimon::BitmapScoredGlobalIndexResult::Or__std::shared_ptr:GlobalIndexResult:CR"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1ac16fbd0b55b871064a49a890be7e7aa7"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">Or</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="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Computes the logical OR (union) between this result and another. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon29BitmapScoredGlobalIndexResult9AddOffsetE7int64_t"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult9AddOffsetE7int64_t"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult9AddOffsetE7int64_t"></span><span id="paimon::BitmapScoredGlobalIndexResult::AddOffset__int64_t"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a3d3657beeb503f2478ed03bc34213877"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexResultE" title="paimon::GlobalIndexResult"><span class="n"><span class="pre">GlobalIndexResult</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">AddOffset</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult9AddOffsetE7int64_t" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Adds the given offset to each row id in current result and returns the new global index result. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult7IsEmptyEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult7IsEmptyEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult7IsEmptyEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::IsEmptyC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a629b132f7de75e9ffc2e807b807332d0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsEmpty</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult7IsEmptyEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Checks whether the global index result contains no matching row ids. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span><span class="pre"><bool></span></code> where:<ul class="simple"> |
| <li><p><code class="docutils literal notranslate"><span class="pre">true</span></code> indicates the result is empty (no matching rows),</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">false</span></code> indicates at least one matching row exists,</p></li> |
| <li><p>An error is returned only if internal state is corrupted or I/O fails (e.g., during lazy loading of index data). </p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult8ToStringEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult8ToStringEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult8ToStringEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::ToStringC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a193cf75c20e7a319984d1697d8cbe3cf"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult8ToStringEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult9GetBitmapEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult9GetBitmapEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult9GetBitmapEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::GetBitmapC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1aec333b5bc720d7e89ccf4bd81a661794"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">RoaringBitmap64</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetBitmap</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="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult9GetBitmapEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A non-owning, const pointer to the bitmap. The row ids in the bitmap are stored in ascending order (as guaranteed by Roaring64 iteration). </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult9GetScoresEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult9GetScoresEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult9GetScoresEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::GetScoresC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1a5defb073590a0d6864b7fe3385cf412a"></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="kt"><span class="pre">float</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">GetScores</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="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult9GetScoresEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A const reference to a vector of float scores, where the i-th element corresponds to the i-th row id when iterating the bitmap in <strong>ascending row id order</strong>. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIteratorE"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult14ScoredIteratorE"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult14ScoredIteratorE"></span><span id="paimon::BitmapScoredGlobalIndexResult::ScoredIterator"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1_1_scored_iterator"></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">ScoredIterator</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ScoredGlobalIndexResult</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ScoredIterator</span></span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIteratorE" title="Link to this definition">#</a><br /></dt> |
| <dd><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="_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator14ScoredIteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorEPKf"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator14ScoredIteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorEPKf"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator14ScoredIteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorEPKf"></span><span id="paimon::BitmapScoredGlobalIndexResult::ScoredIterator::ScoredIterator__RoaringBitmap64CP.RoaringBitmap64::IteratorRR.floatCP"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1_1_scored_iterator_1a86ff02cadc99d390a8e52d466aed769d"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ScoredIterator</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">RoaringBitmap64</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">bitmap</span></span>, <span class="n"><span class="pre">RoaringBitmap64</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Iterator</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">iter</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">scores</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator14ScoredIteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorEPKf" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon29BitmapScoredGlobalIndexResult14ScoredIterator7HasNextEv"> |
| <span id="_CPPv3NK6paimon29BitmapScoredGlobalIndexResult14ScoredIterator7HasNextEv"></span><span id="_CPPv2NK6paimon29BitmapScoredGlobalIndexResult14ScoredIterator7HasNextEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::ScoredIterator::HasNextC"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1_1_scored_iterator_1a9b40575f42f290923ef56256afc4e54a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasNext</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="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult14ScoredIterator7HasNextEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Checks whether more row ids are available. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator13NextWithScoreEv"> |
| <span id="_CPPv3N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator13NextWithScoreEv"></span><span id="_CPPv2N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator13NextWithScoreEv"></span><span id="paimon::BitmapScoredGlobalIndexResult::ScoredIterator::NextWithScore"></span><span class="target" id="classpaimon_1_1_bitmap_scored_global_index_result_1_1_scored_iterator_1aaf33f5b1eb6a294e05d467ed28cee836"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </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">pair</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</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">NextWithScore</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator13NextWithScoreEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Retrieves the next (row_id, score) pair and advances the iterator. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>The sequence is ordered by <strong>row_id</strong>, not by score. </p> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A pair where:<ul class="simple"> |
| <li><p>first: the row id (returned in ascending order).</p></li> |
| <li><p>second: the associated score computed by the index.</p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon15GlobalIndexScanE"> |
| <span id="_CPPv3N6paimon15GlobalIndexScanE"></span><span id="_CPPv2N6paimon15GlobalIndexScanE"></span><span id="paimon::GlobalIndexScan"></span><span class="target" id="classpaimon_1_1_global_index_scan"></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">GlobalIndexScan</span></span></span><a class="headerlink" href="#_CPPv4N6paimon15GlobalIndexScanE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Represents a logical scan over a global index for a table. </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="_CPPv4N6paimon15GlobalIndexScanD0Ev"> |
| <span id="_CPPv3N6paimon15GlobalIndexScanD0Ev"></span><span id="_CPPv2N6paimon15GlobalIndexScanD0Ev"></span><span id="paimon::GlobalIndexScan::~GlobalIndexScan"></span><span class="target" id="classpaimon_1_1_global_index_scan_1a1051cd7569a99f0686645e701f88b2b3"></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">~GlobalIndexScan</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="#_CPPv4N6paimon15GlobalIndexScanD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15GlobalIndexScan13CreateReadersERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"> |
| <span id="_CPPv3NK6paimon15GlobalIndexScan13CreateReadersERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"></span><span id="_CPPv2NK6paimon15GlobalIndexScan13CreateReadersERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"></span><span id="paimon::GlobalIndexScan::CreateReaders__ssCR.std::optional:RowRangeIndex:CRC"></span><span class="target" id="classpaimon_1_1_global_index_scan_1a43d7c958b304e92560a41daafafc3098"></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">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="#_CPPv4N6paimon17GlobalIndexReaderE" title="paimon::GlobalIndexReader"><span class="n"><span class="pre">GlobalIndexReader</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreateReaders</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">field_name</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">RowRangeIndex</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">row_range_index</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15GlobalIndexScan13CreateReadersERKNSt6stringERKNSt8optionalI13RowRangeIndexEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates several <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_index_reader"><span class="std std-ref"><span class="pre">GlobalIndexReader</span></span></a></code>s for a specific field. </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>field_name</strong> – Name of the indexed column. </p></li> |
| <li><p><strong>row_range_index</strong> – Optional row range that limits the scan to a sub-range of row ids. If not provided, the entire row range is considered. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> that is:<ul class="simple"> |
| <li><p>Successful with several readers(with global row id) if the indexes exist and load correctly;</p></li> |
| <li><p>Successful with an empty vector if no index was built for the given field;</p></li> |
| <li><p>Error returns when loading fails (e.g., file corruption, I/O error, unsupported format). </p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15GlobalIndexScan12CreateReaderERKNSt6stringERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"> |
| <span id="_CPPv3NK6paimon15GlobalIndexScan12CreateReaderERKNSt6stringERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"></span><span id="_CPPv2NK6paimon15GlobalIndexScan12CreateReaderERKNSt6stringERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"></span><span id="paimon::GlobalIndexScan::CreateReader__ssCR.ssCR.std::optional:RowRangeIndex:CRC"></span><span class="target" id="classpaimon_1_1_global_index_scan_1a7b842f1c37b1be50dd0f1bdacc645e0e"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexReaderE" title="paimon::GlobalIndexReader"><span class="n"><span class="pre">GlobalIndexReader</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">field_name</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">index_type</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">RowRangeIndex</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">row_range_index</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15GlobalIndexScan12CreateReaderERKNSt6stringERKNSt6stringERKNSt8optionalI13RowRangeIndexEE" 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_global_index_reader"><span class="std std-ref"><span class="pre">GlobalIndexReader</span></span></a></code> for a specific field with a specific index type. </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>field_name</strong> – Name of the indexed column. </p></li> |
| <li><p><strong>index_type</strong> – Name of index type. </p></li> |
| <li><p><strong>row_range_index</strong> – Optional row range that limits the scan to a sub-range of row ids. If not provided, the entire row range is considered. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> that is:<ul class="simple"> |
| <li><p>Successful with a reader(with global row id) if the index exists and loads correctly;</p></li> |
| <li><p>Successful with nullptr if no index was built for the given field with the given index type;</p></li> |
| <li><p>Error returns when loading fails (e.g., file corruption, I/O error, unsupported format). </p></li> |
| </ul> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon15GlobalIndexScan13CreateReadersE7int32_tRKNSt8optionalI13RowRangeIndexEE"> |
| <span id="_CPPv3NK6paimon15GlobalIndexScan13CreateReadersE7int32_tRKNSt8optionalI13RowRangeIndexEE"></span><span id="_CPPv2NK6paimon15GlobalIndexScan13CreateReadersE7int32_tRKNSt8optionalI13RowRangeIndexEE"></span><span id="paimon::GlobalIndexScan::CreateReaders__int32_t.std::optional:RowRangeIndex:CRC"></span><span class="target" id="classpaimon_1_1_global_index_scan_1a6e85bd78a0b4cabff050601370f6b7ab"></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">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="#_CPPv4N6paimon17GlobalIndexReaderE" title="paimon::GlobalIndexReader"><span class="n"><span class="pre">GlobalIndexReader</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CreateReaders</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">field_id</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">RowRangeIndex</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">row_range_index</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon15GlobalIndexScan13CreateReadersE7int32_tRKNSt8optionalI13RowRangeIndexEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Creates several <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_global_index_reader"><span class="std std-ref"><span class="pre">GlobalIndexReader</span></span></a></code>s for a specific field (looked up by id),. </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>field_id</strong> – Field id of the indexed column. </p></li> |
| <li><p><strong>row_range_index</strong> – Optional row range that limits the scan to a sub-range of row ids. If not provided, the entire row range is considered. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> that is:<ul class="simple"> |
| <li><p>Successful with several readers(with global row id) if the indexes exist and load correctly;</p></li> |
| <li><p>Successful with an empty vector if no index was built for the given field;</p></li> |
| <li><p>Error returns when loading fails (e.g., file corruption, I/O error, unsupported format). </p></li> |
| </ul> |
| </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="_CPPv4N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt8optionalINSt6vectorINSt3mapINSt6stringENSt6stringEEEEEEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt8optionalINSt6vectorINSt3mapINSt6stringENSt6stringEEEEEEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt8optionalINSt6vectorINSt3mapINSt6stringENSt6stringEEEEEEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::GlobalIndexScan::Create__ssCR.std::optional:int64_t:CR.std::optional:std::vector:std::map:ss.ss:::CR.std::map:ss.ss:CR.std::shared_ptr:FileSystem:CR.std::shared_ptr:Executor:CR.std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_global_index_scan_1a1f8aace0a549c16e138c9f680db78040"></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="#_CPPv4N6paimon15GlobalIndexScanE" title="paimon::GlobalIndexScan"><span class="n"><span class="pre">GlobalIndexScan</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Create</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table_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">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_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">snapshot_id</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">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">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="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">partitions</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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="file_system.html#_CPPv4N6paimon10FileSystemE" title="paimon::FileSystem"><span class="n"><span class="pre">FileSystem</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">file_system</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">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="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt8optionalINSt6vectorINSt3mapINSt6stringENSt6stringEEEEEEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE" 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_global_index_scan"><span class="std std-ref"><span class="pre">GlobalIndexScan</span></span></a></code> instance for the specified table and context. </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>table_path</strong> – Root directory of the table. </p></li> |
| <li><p><strong>snapshot_id</strong> – Optional snapshot id to read from; if not provided, uses the latest. </p></li> |
| <li><p><strong>partitions</strong> – Optional list of specific partitions to restrict the scan scope. Each map represents one partition (e.g., {“dt”: “2024-06-01”}). If omitted (<code class="docutils literal notranslate"><span class="pre">std::nullopt</span></code>), scans all partitions of the table. </p></li> |
| <li><p><strong>options</strong> – User defined configuration. </p></li> |
| <li><p><strong>file_system</strong> – File system for accessing index files. If not provided (nullptr), it is inferred from the <code class="docutils literal notranslate"><span class="pre">FILE_SYSTEM</span></code> key in the <code class="docutils literal notranslate"><span class="pre">options</span></code> parameter. </p></li> |
| <li><p><strong>executor</strong> – The executor to be used for asynchronous operations during global index scan. </p></li> |
| <li><p><strong>pool</strong> – Memory pool for temporary allocations; if nullptr, uses default. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> containing a unique pointer to the created scanner, or an error if initialization fails (e.g., I/O error, invalid snapshot id, unknown partition). </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt10shared_ptrI9PredicateEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"> |
| <span id="_CPPv3N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt10shared_ptrI9PredicateEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="_CPPv2N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt10shared_ptrI9PredicateEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"></span><span id="paimon::GlobalIndexScan::Create__ssCR.std::optional:int64_t:CR.std::shared_ptr:Predicate:CR.std::map:ss.ss:CR.std::shared_ptr:FileSystem:CR.std::shared_ptr:Executor:CR.std::shared_ptr:MemoryPool:CR"></span><span class="target" id="classpaimon_1_1_global_index_scan_1a5492873a52ecd09e4ce363a35da9ce30"></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="#_CPPv4N6paimon15GlobalIndexScanE" title="paimon::GlobalIndexScan"><span class="n"><span class="pre">GlobalIndexScan</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Create</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">root_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">optional</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_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">snapshot_id</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">partition_filters</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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="file_system.html#_CPPv4N6paimon10FileSystemE" title="paimon::FileSystem"><span class="n"><span class="pre">FileSystem</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">file_system</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">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="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt10shared_ptrI9PredicateEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE" 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_global_index_scan"><span class="std std-ref"><span class="pre">GlobalIndexScan</span></span></a></code> instance for the specified table and context, with a predicate-based partition filter. </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>root_path</strong> – Root directory of the table. </p></li> |
| <li><p><strong>snapshot_id</strong> – Optional snapshot id to read from; if not provided, uses the latest snapshot. </p></li> |
| <li><p><strong>partition_filters</strong> – Optional partition-level predicate used for partition pruning. If nullptr, all partitions are scanned. </p></li> |
| <li><p><strong>options</strong> – User defined configuration. </p></li> |
| <li><p><strong>file_system</strong> – File system for accessing index files. If nullptr, it is inferred from the <code class="docutils literal notranslate"><span class="pre">FILE_SYSTEM</span></code> key in <code class="docutils literal notranslate"><span class="pre">options</span></code>. </p></li> |
| <li><p><strong>executor</strong> – The executor to be used for asynchronous operations during global index scan. </p></li> |
| <li><p><strong>pool</strong> – Memory pool for temporary allocations; if nullptr, uses default. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> containing a unique pointer to the created scanner, or an error if initialization fails. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon12IndexedSplitE"> |
| <span id="_CPPv3N6paimon12IndexedSplitE"></span><span id="_CPPv2N6paimon12IndexedSplitE"></span><span id="paimon::IndexedSplit"></span><span class="target" id="classpaimon_1_1_indexed_split"></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">IndexedSplit</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">paimon</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="scan.html#_CPPv4N6paimon5SplitE" title="paimon::Split"><span class="n"><span class="pre">Split</span></span></a><a class="headerlink" href="#_CPPv4N6paimon12IndexedSplitE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Indexed split for global index reading operation. </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="_CPPv4NK6paimon12IndexedSplit12GetDataSplitEv"> |
| <span id="_CPPv3NK6paimon12IndexedSplit12GetDataSplitEv"></span><span id="_CPPv2NK6paimon12IndexedSplit12GetDataSplitEv"></span><span id="paimon::IndexedSplit::GetDataSplitC"></span><span class="target" id="classpaimon_1_1_indexed_split_1a300f60cf027e4f074528b8fee6b95174"></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><a class="reference internal" href="scan.html#_CPPv4N6paimon9DataSplitE" title="paimon::DataSplit"><span class="n"><span class="pre">DataSplit</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">GetDataSplit</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="#_CPPv4NK6paimon12IndexedSplit12GetDataSplitEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The underlying physical data split containing actual data file details. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon12IndexedSplit9RowRangesEv"> |
| <span id="_CPPv3NK6paimon12IndexedSplit9RowRangesEv"></span><span id="_CPPv2NK6paimon12IndexedSplit9RowRangesEv"></span><span id="paimon::IndexedSplit::RowRangesC"></span><span class="target" id="classpaimon_1_1_indexed_split_1a3cbb838885cd2b1e8f3724c0c15b3cb6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Range</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">RowRanges</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="#_CPPv4NK6paimon12IndexedSplit9RowRangesEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A list of row intervals [start, end] indicating which rows are relevant (e.g., passed predicate pushdown). </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon12IndexedSplit6ScoresEv"> |
| <span id="_CPPv3NK6paimon12IndexedSplit6ScoresEv"></span><span id="_CPPv2NK6paimon12IndexedSplit6ScoresEv"></span><span id="paimon::IndexedSplit::ScoresC"></span><span class="target" id="classpaimon_1_1_indexed_split_1a83da73ba29107339b818100ddbecae6c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">float</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">Scores</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="#_CPPv4NK6paimon12IndexedSplit6ScoresEv" title="Link to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>A score for <strong>each individual row</strong> included in <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_indexed_split_1a3cbb838885cd2b1e8f3724c0c15b3cb6"><span class="std std-ref"><span class="pre">RowRanges()</span></span></a></code>, in the order they appear when traversing the ranges. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20GlobalIndexWriteTaskE"> |
| <span id="_CPPv3N6paimon20GlobalIndexWriteTaskE"></span><span id="_CPPv2N6paimon20GlobalIndexWriteTaskE"></span><span id="paimon::GlobalIndexWriteTask"></span><span class="target" id="classpaimon_1_1_global_index_write_task"></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">GlobalIndexWriteTask</span></span></span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexWriteTaskE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Writes a range-level global index for a specific data split and field. </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="_CPPv4N6paimon20GlobalIndexWriteTask20GlobalIndexWriteTaskEv"> |
| <span id="_CPPv3N6paimon20GlobalIndexWriteTask20GlobalIndexWriteTaskEv"></span><span id="_CPPv2N6paimon20GlobalIndexWriteTask20GlobalIndexWriteTaskEv"></span><span id="paimon::GlobalIndexWriteTask::GlobalIndexWriteTask"></span><span class="target" id="classpaimon_1_1_global_index_write_task_1ae32df03747bc4284565e678047fda25f"></span><span class="sig-name descname"><span class="n"><span class="pre">GlobalIndexWriteTask</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">delete</span></span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexWriteTask20GlobalIndexWriteTaskEv" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20GlobalIndexWriteTaskD0Ev"> |
| <span id="_CPPv3N6paimon20GlobalIndexWriteTaskD0Ev"></span><span id="_CPPv2N6paimon20GlobalIndexWriteTaskD0Ev"></span><span id="paimon::GlobalIndexWriteTask::~GlobalIndexWriteTask"></span><span class="target" id="classpaimon_1_1_global_index_write_task_1a21f86e346af2dbdbdeec789f4fbed2a2"></span><span class="sig-name descname"><span class="n"><span class="pre">~GlobalIndexWriteTask</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">delete</span></span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexWriteTaskD0Ev" 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-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon20GlobalIndexWriteTask10WriteIndexERKNSt6stringERKNSt6stringERKNSt6stringERKNSt10shared_ptrI12IndexedSplitEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI10FileSystemEE"> |
| <span id="_CPPv3N6paimon20GlobalIndexWriteTask10WriteIndexERKNSt6stringERKNSt6stringERKNSt6stringERKNSt10shared_ptrI12IndexedSplitEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI10FileSystemEE"></span><span id="_CPPv2N6paimon20GlobalIndexWriteTask10WriteIndexERKNSt6stringERKNSt6stringERKNSt6stringERKNSt10shared_ptrI12IndexedSplitEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI10FileSystemEE"></span><span id="paimon::GlobalIndexWriteTask::WriteIndex__ssCR.ssCR.ssCR.std::shared_ptr:IndexedSplit:CR.std::map:ss.ss:CR.std::shared_ptr:MemoryPool:CR.std::shared_ptr:FileSystem:CR"></span><span class="target" id="classpaimon_1_1_global_index_write_task_1a1d447bf8f4dbce5910533b4137a37929"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="commit.html#_CPPv4N6paimon13CommitMessageE" title="paimon::CommitMessage"><span class="n"><span class="pre">CommitMessage</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">WriteIndex</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_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">field_name</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">index_type</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="#_CPPv4N6paimon12IndexedSplitE" title="paimon::IndexedSplit"><span class="n"><span class="pre">IndexedSplit</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">indexed_split</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="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="memory.html#_CPPv4N6paimon10MemoryPoolE" title="paimon::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="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="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">nullptr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon20GlobalIndexWriteTask10WriteIndexERKNSt6stringERKNSt6stringERKNSt6stringERKNSt10shared_ptrI12IndexedSplitEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI10FileSystemEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Builds and writes a global index for the specified data range. </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>table_path</strong> – Path to the table root directory where index files are stored. </p></li> |
| <li><p><strong>field_name</strong> – Name of the indexed column (must be present in the table schema). </p></li> |
| <li><p><strong>index_type</strong> – Type of global index to build (e.g., “bitmap”, “lumina”). </p></li> |
| <li><p><strong>indexed_split</strong> – The indexed split containing the actual data (e.g., Parquet file) and row id range [from, to] for data to build index. The range must be fully contained within the data covered by the given <code class="docutils literal notranslate"><span class="pre">indexed_split</span></code>. </p></li> |
| <li><p><strong>options</strong> – Index-specific configuration (e.g., false positive rate for bloom filters). </p></li> |
| <li><p><strong>pool</strong> – Memory pool for temporary allocations during index construction. If <code class="docutils literal notranslate"><span class="pre">nullptr</span></code>, the system’s default memory pool will be used. </p></li> |
| <li><p><strong>file_system</strong> – Specifies the file system for file operations. If <code class="docutils literal notranslate"><span class="pre">nullptr</span></code>, use default file system. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A <code class="docutils literal notranslate"><span class="pre">Result</span></code> containing a shared pointer to the <code class="docutils literal notranslate"><a class="reference internal" href="commit.html#classpaimon_1_1_commit_message"><span class="std std-ref"><span class="pre">CommitMessage</span></span></a></code> with index metadata, or an error if indexing fails (e.g., unsupported type, I/O error). </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexWriterE"> |
| <span id="_CPPv3N6paimon17GlobalIndexWriterE"></span><span id="_CPPv2N6paimon17GlobalIndexWriterE"></span><span id="paimon::GlobalIndexWriter"></span><span class="target" id="classpaimon_1_1_global_index_writer"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GlobalIndexWriter</span></span></span><a class="headerlink" href="#_CPPv4N6paimon17GlobalIndexWriterE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Abstract interface for building a global index from Arrow data batches. </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="_CPPv4N6paimon17GlobalIndexWriterD0Ev"> |
| <span id="_CPPv3N6paimon17GlobalIndexWriterD0Ev"></span><span id="_CPPv2N6paimon17GlobalIndexWriterD0Ev"></span><span id="paimon::GlobalIndexWriter::~GlobalIndexWriter"></span><span class="target" id="classpaimon_1_1_global_index_writer_1a78f234455ecc8a3c5af6eb369829bb8b"></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">~GlobalIndexWriter</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="#_CPPv4N6paimon17GlobalIndexWriterD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexWriter8AddBatchEP10ArrowArrayRRNSt6vectorI7int64_tEE"> |
| <span id="_CPPv3N6paimon17GlobalIndexWriter8AddBatchEP10ArrowArrayRRNSt6vectorI7int64_tEE"></span><span id="_CPPv2N6paimon17GlobalIndexWriter8AddBatchEP10ArrowArrayRRNSt6vectorI7int64_tEE"></span><span id="paimon::GlobalIndexWriter::AddBatch__ArrowArrayP.std::vector:int64_t:RR"></span><span class="target" id="classpaimon_1_1_global_index_writer_1aad726f8c89cb1d7e912e0806df6c2761"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">Status</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AddBatch</span></span></span><span class="sig-paren">(</span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrowArray</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">arrow_array</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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">int64_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="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">relative_row_ids</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="#_CPPv4N6paimon17GlobalIndexWriter8AddBatchEP10ArrowArrayRRNSt6vectorI7int64_tEE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Builds index structures from a batch of columnar data. </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>arrow_array</strong> – A valid C ArrowArray pointer representing a struct array. Must not be nullptr, and must conform to the expected schema. </p></li> |
| <li><p><strong>relative_row_ids</strong> – local row id calculated by <code class="docutils literal notranslate"><span class="pre">row_id</span> <span class="pre">-</span> <span class="pre">range.from</span></code>. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><code class="docutils literal notranslate"><span class="pre">Status::OK()</span></code> on success; otherwise, an error indicating malformed input, I/O failure, or unsupported type, etc. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon17GlobalIndexWriter6FinishEv"> |
| <span id="_CPPv3N6paimon17GlobalIndexWriter6FinishEv"></span><span id="_CPPv2N6paimon17GlobalIndexWriter6FinishEv"></span><span id="paimon::GlobalIndexWriter::Finish"></span><span class="target" id="classpaimon_1_1_global_index_writer_1a1e1b50ac25ccdf20c897b63f4d058916"></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">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N6paimon17GlobalIndexIOMetaE" title="paimon::GlobalIndexIOMeta"><span class="n"><span class="pre">GlobalIndexIOMeta</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><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="#_CPPv4N6paimon17GlobalIndexWriter6FinishEv" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Finalizes the index build process and returns metadata for persisted index. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N6paimon21GlobalIndexFileWriterE"> |
| <span id="_CPPv3N6paimon21GlobalIndexFileWriterE"></span><span id="_CPPv2N6paimon21GlobalIndexFileWriterE"></span><span id="paimon::GlobalIndexFileWriter"></span><span class="target" id="classpaimon_1_1_global_index_file_writer"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GlobalIndexFileWriter</span></span></span><a class="headerlink" href="#_CPPv4N6paimon21GlobalIndexFileWriterE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Abstract interface for writing global index files to storage. </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="_CPPv4N6paimon21GlobalIndexFileWriterD0Ev"> |
| <span id="_CPPv3N6paimon21GlobalIndexFileWriterD0Ev"></span><span id="_CPPv2N6paimon21GlobalIndexFileWriterD0Ev"></span><span id="paimon::GlobalIndexFileWriter::~GlobalIndexFileWriter"></span><span class="target" id="classpaimon_1_1_global_index_file_writer_1ac565b06a2f56e34afaf59149002e45b1"></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">~GlobalIndexFileWriter</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="#_CPPv4N6paimon21GlobalIndexFileWriterD0Ev" title="Link to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon21GlobalIndexFileWriter11NewFileNameERKNSt6stringE"> |
| <span id="_CPPv3NK6paimon21GlobalIndexFileWriter11NewFileNameERKNSt6stringE"></span><span id="_CPPv2NK6paimon21GlobalIndexFileWriter11NewFileNameERKNSt6stringE"></span><span id="paimon::GlobalIndexFileWriter::NewFileName__ssCRC"></span><span class="target" id="classpaimon_1_1_global_index_file_writer_1a31d48a7c456af3324c547df8281d48df"></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">string</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">NewFileName</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">prefix</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon21GlobalIndexFileWriter11NewFileNameERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Generates a unique file name for a new index file using the given prefix. </p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>This function may be called multiple times if the index consists of multiple files. </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon21GlobalIndexFileWriter15NewOutputStreamERKNSt6stringE"> |
| <span id="_CPPv3NK6paimon21GlobalIndexFileWriter15NewOutputStreamERKNSt6stringE"></span><span id="_CPPv2NK6paimon21GlobalIndexFileWriter15NewOutputStreamERKNSt6stringE"></span><span id="paimon::GlobalIndexFileWriter::NewOutputStream__ssCRC"></span><span class="target" id="classpaimon_1_1_global_index_file_writer_1a60e6c169024b5f3b656c65c1dee77889"></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="file_system.html#_CPPv4N6paimon12OutputStreamE" title="paimon::OutputStream"><span class="n"><span class="pre">OutputStream</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NewOutputStream</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">file_name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon21GlobalIndexFileWriter15NewOutputStreamERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Opens a new output stream for writing index data to the specified file. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon21GlobalIndexFileWriter11GetFileSizeERKNSt6stringE"> |
| <span id="_CPPv3NK6paimon21GlobalIndexFileWriter11GetFileSizeERKNSt6stringE"></span><span id="_CPPv2NK6paimon21GlobalIndexFileWriter11GetFileSizeERKNSt6stringE"></span><span id="paimon::GlobalIndexFileWriter::GetFileSize__ssCRC"></span><span class="target" id="classpaimon_1_1_global_index_file_writer_1a0b10c104b8a533060647ce8f288974eb"></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">int64_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFileSize</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">file_name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon21GlobalIndexFileWriter11GetFileSizeERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get the file size of input file name. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK6paimon21GlobalIndexFileWriter6ToPathERKNSt6stringE"> |
| <span id="_CPPv3NK6paimon21GlobalIndexFileWriter6ToPathERKNSt6stringE"></span><span id="_CPPv2NK6paimon21GlobalIndexFileWriter6ToPathERKNSt6stringE"></span><span id="paimon::GlobalIndexFileWriter::ToPath__ssCRC"></span><span class="target" id="classpaimon_1_1_global_index_file_writer_1a6621ba805862243ad372e10d95afde94"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToPath</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">file_name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK6paimon21GlobalIndexFileWriter6ToPathERKNSt6stringE" title="Link to this definition">#</a><br /></dt> |
| <dd><p>Get the index file path of input file name. </p> |
| </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="file_index.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">File Index</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="clean.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Orphan Files Clean</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="#_CPPv4N6paimon20GlobalIndexerFactoryE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexerFactory</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="#_CPPv4N6paimon20GlobalIndexerFactoryD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexerFactory()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon20GlobalIndexerFactory6CreateERKNSt3mapINSt6stringENSt6stringEEE"><code class="docutils literal notranslate"><span class="pre">Create()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20GlobalIndexerFactory3GetERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEE"><code class="docutils literal notranslate"><span class="pre">Get()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20GlobalIndexerFactory30GLOBAL_INDEX_IDENTIFIER_SUFFIXE"><code class="docutils literal notranslate"><span class="pre">GLOBAL_INDEX_IDENTIFIER_SUFFIX</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon13GlobalIndexerE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexer</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="#_CPPv4N6paimon13GlobalIndexerD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexer()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon13GlobalIndexer12CreateWriterERKNSt6stringEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileWriterEERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">CreateWriter()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon13GlobalIndexer12CreateReaderEP11ArrowSchemaRKNSt10shared_ptrI21GlobalIndexFileReaderEERKNSt6vectorI17GlobalIndexIOMetaEERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">CreateReader()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexReaderE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexReader</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="#_CPPv4N6paimon17GlobalIndexReader17VisitVectorSearchERKNSt10shared_ptrI12VectorSearchEE"><code class="docutils literal notranslate"><span class="pre">VisitVectorSearch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexReader19VisitFullTextSearchERKNSt10shared_ptrI14FullTextSearchEE"><code class="docutils literal notranslate"><span class="pre">VisitFullTextSearch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexReader12IsThreadSafeEv"><code class="docutils literal notranslate"><span class="pre">IsThreadSafe()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexReader12GetIndexTypeEv"><code class="docutils literal notranslate"><span class="pre">GetIndexType()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon21GlobalIndexFileReaderE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexFileReader</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="#_CPPv4N6paimon21GlobalIndexFileReaderD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexFileReader()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon21GlobalIndexFileReader14GetInputStreamERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">GetInputStream()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexIOMetaE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexIOMeta</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="#_CPPv4N6paimon17GlobalIndexIOMeta17GlobalIndexIOMetaERKNSt6stringE7int64_tRKNSt10shared_ptrI5BytesEE"><code class="docutils literal notranslate"><span class="pre">GlobalIndexIOMeta()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexIOMeta9file_pathE"><code class="docutils literal notranslate"><span class="pre">file_path</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexIOMeta9file_sizeE"><code class="docutils literal notranslate"><span class="pre">file_size</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexIOMeta8metadataE"><code class="docutils literal notranslate"><span class="pre">metadata</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResultE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexResult</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="#_CPPv4N6paimon17GlobalIndexResultD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexResult()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexResult7IsEmptyEv"><code class="docutils literal notranslate"><span class="pre">IsEmpty()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexResult14CreateIteratorEv"><code class="docutils literal notranslate"><span class="pre">CreateIterator()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexResult8ToRangesEv"><code class="docutils literal notranslate"><span class="pre">ToRanges()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"><code class="docutils literal notranslate"><span class="pre">And()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"><code class="docutils literal notranslate"><span class="pre">Or()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult9AddOffsetE7int64_t"><code class="docutils literal notranslate"><span class="pre">AddOffset()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexResult8ToStringEv"><code class="docutils literal notranslate"><span class="pre">ToString()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult9SerializeERKNSt10shared_ptrI17GlobalIndexResultEERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">Serialize()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult11DeserializeEPKc6size_tRKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">Deserialize()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult8IteratorE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexResult::Iterator</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult8IteratorD0Ev"><code class="docutils literal notranslate"><span class="pre">~Iterator()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon17GlobalIndexResult8Iterator7HasNextEv"><code class="docutils literal notranslate"><span class="pre">HasNext()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexResult8Iterator4NextEv"><code class="docutils literal notranslate"><span class="pre">Next()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResultE"><code class="docutils literal notranslate"><span class="pre">paimon::BitmapGlobalIndexResult</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="#_CPPv4N6paimon23BitmapGlobalIndexResult14BitmapSupplierE"><code class="docutils literal notranslate"><span class="pre">BitmapSupplier</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult23BitmapGlobalIndexResultE14BitmapSupplier"><code class="docutils literal notranslate"><span class="pre">BitmapGlobalIndexResult()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult14CreateIteratorEv"><code class="docutils literal notranslate"><span class="pre">CreateIterator()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"><code class="docutils literal notranslate"><span class="pre">And()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"><code class="docutils literal notranslate"><span class="pre">Or()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult7IsEmptyEv"><code class="docutils literal notranslate"><span class="pre">IsEmpty()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult9AddOffsetE7int64_t"><code class="docutils literal notranslate"><span class="pre">AddOffset()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult8ToStringEv"><code class="docutils literal notranslate"><span class="pre">ToString()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult9GetBitmapEv"><code class="docutils literal notranslate"><span class="pre">GetBitmap()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult10FromRangesERKNSt6vectorI5RangeEE"><code class="docutils literal notranslate"><span class="pre">FromRanges()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult8IteratorE"><code class="docutils literal notranslate"><span class="pre">paimon::BitmapGlobalIndexResult::Iterator</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult8Iterator8IteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorE"><code class="docutils literal notranslate"><span class="pre">Iterator()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon23BitmapGlobalIndexResult8Iterator7HasNextEv"><code class="docutils literal notranslate"><span class="pre">HasNext()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon23BitmapGlobalIndexResult8Iterator4NextEv"><code class="docutils literal notranslate"><span class="pre">Next()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResultE"><code class="docutils literal notranslate"><span class="pre">paimon::BitmapScoredGlobalIndexResult</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="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult29BitmapScoredGlobalIndexResultERR15RoaringBitmap64RRNSt6vectorIfEE"><code class="docutils literal notranslate"><span class="pre">BitmapScoredGlobalIndexResult()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult14CreateIteratorEv"><code class="docutils literal notranslate"><span class="pre">CreateIterator()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult20CreateScoredIteratorEv"><code class="docutils literal notranslate"><span class="pre">CreateScoredIterator()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult3AndERKNSt10shared_ptrI17GlobalIndexResultEE"><code class="docutils literal notranslate"><span class="pre">And()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult2OrERKNSt10shared_ptrI17GlobalIndexResultEE"><code class="docutils literal notranslate"><span class="pre">Or()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult9AddOffsetE7int64_t"><code class="docutils literal notranslate"><span class="pre">AddOffset()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult7IsEmptyEv"><code class="docutils literal notranslate"><span class="pre">IsEmpty()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult8ToStringEv"><code class="docutils literal notranslate"><span class="pre">ToString()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult9GetBitmapEv"><code class="docutils literal notranslate"><span class="pre">GetBitmap()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult9GetScoresEv"><code class="docutils literal notranslate"><span class="pre">GetScores()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIteratorE"><code class="docutils literal notranslate"><span class="pre">paimon::BitmapScoredGlobalIndexResult::ScoredIterator</span></code></a><ul class="nav section-nav flex-column"> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator14ScoredIteratorEPK15RoaringBitmap64RRN15RoaringBitmap648IteratorEPKf"><code class="docutils literal notranslate"><span class="pre">ScoredIterator()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon29BitmapScoredGlobalIndexResult14ScoredIterator7HasNextEv"><code class="docutils literal notranslate"><span class="pre">HasNext()</span></code></a></li> |
| <li class="toc-h5 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon29BitmapScoredGlobalIndexResult14ScoredIterator13NextWithScoreEv"><code class="docutils literal notranslate"><span class="pre">NextWithScore()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15GlobalIndexScanE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexScan</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="#_CPPv4N6paimon15GlobalIndexScanD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexScan()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon15GlobalIndexScan13CreateReadersERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"><code class="docutils literal notranslate"><span class="pre">CreateReaders()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon15GlobalIndexScan12CreateReaderERKNSt6stringERKNSt6stringERKNSt8optionalI13RowRangeIndexEE"><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="#_CPPv4NK6paimon15GlobalIndexScan13CreateReadersE7int32_tRKNSt8optionalI13RowRangeIndexEE"><code class="docutils literal notranslate"><span class="pre">CreateReaders()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt8optionalINSt6vectorINSt3mapINSt6stringENSt6stringEEEEEEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"><code class="docutils literal notranslate"><span class="pre">Create()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon15GlobalIndexScan6CreateERKNSt6stringERKNSt8optionalI7int64_tEERKNSt10shared_ptrI9PredicateEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEERKNSt10shared_ptrI8ExecutorEERKNSt10shared_ptrI10MemoryPoolEE"><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="#_CPPv4N6paimon12IndexedSplitE"><code class="docutils literal notranslate"><span class="pre">paimon::IndexedSplit</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="#_CPPv4NK6paimon12IndexedSplit12GetDataSplitEv"><code class="docutils literal notranslate"><span class="pre">GetDataSplit()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon12IndexedSplit9RowRangesEv"><code class="docutils literal notranslate"><span class="pre">RowRanges()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon12IndexedSplit6ScoresEv"><code class="docutils literal notranslate"><span class="pre">Scores()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20GlobalIndexWriteTaskE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexWriteTask</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="#_CPPv4N6paimon20GlobalIndexWriteTask20GlobalIndexWriteTaskEv"><code class="docutils literal notranslate"><span class="pre">GlobalIndexWriteTask()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20GlobalIndexWriteTaskD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexWriteTask()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon20GlobalIndexWriteTask10WriteIndexERKNSt6stringERKNSt6stringERKNSt6stringERKNSt10shared_ptrI12IndexedSplitEERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10MemoryPoolEERKNSt10shared_ptrI10FileSystemEE"><code class="docutils literal notranslate"><span class="pre">WriteIndex()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexWriterE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexWriter</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="#_CPPv4N6paimon17GlobalIndexWriterD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexWriter()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexWriter8AddBatchEP10ArrowArrayRRNSt6vectorI7int64_tEE"><code class="docutils literal notranslate"><span class="pre">AddBatch()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon17GlobalIndexWriter6FinishEv"><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="#_CPPv4N6paimon21GlobalIndexFileWriterE"><code class="docutils literal notranslate"><span class="pre">paimon::GlobalIndexFileWriter</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="#_CPPv4N6paimon21GlobalIndexFileWriterD0Ev"><code class="docutils literal notranslate"><span class="pre">~GlobalIndexFileWriter()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon21GlobalIndexFileWriter11NewFileNameERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">NewFileName()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon21GlobalIndexFileWriter15NewOutputStreamERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">NewOutputStream()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon21GlobalIndexFileWriter11GetFileSizeERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">GetFileSize()</span></code></a></li> |
| <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon21GlobalIndexFileWriter6ToPathERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">ToPath()</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/global_index.rst"> |
| <i class="fa-solid fa-pencil"></i> |
| |
| |
| |
| Edit on GitHub |
| |
| |
| </a> |
| </div> |
| </div> |
| |
| </div></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| </footer> |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script defer src="../_static/scripts/bootstrap.js?digest=90905a2f556bf617f1a9"></script> |
| <script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=90905a2f556bf617f1a9"></script> |
| |
| <footer class="bd-footer"> |
| <div class="bd-footer__inner bd-page-width"> |
| |
| <div class="footer-items__start"> |
| |
| <div class="footer-item"> |
| |
| <p class="copyright"> |
| |
| © Copyright 2024-2026 Apache Software Foundation. |
| <br/> |
| |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| |
| <p class="sphinx-version"> |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0. |
| <br/> |
| </p> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="footer-items__end"> |
| |
| <div class="footer-item"> |
| <p class="theme-version"> |
| <!-- # L10n: Setting the PST URL as an argument as this does not need to be localized --> |
| Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.20.0. |
| </p></div> |
| |
| </div> |
| |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
