Google Git
Sign in
apache/paimon-cpp/refs/heads/gh-pages/./docs/_build/html/api/catalog.html
blob: b38f0e1f5428133d0bbbf177cc97d30b47e08b42 [file]
<!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>Catalog &#8212; C++ Paimon</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=90905a2f556bf617f1a9" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=90905a2f556bf617f1a9" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../_static/theme_overrides.css?v=d7227091" />
<!-- So that users can add custom icons -->
<script defer src="../_static/scripts/fontawesome.js?digest=90905a2f556bf617f1a9"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=90905a2f556bf617f1a9" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=90905a2f556bf617f1a9" />
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=3bb21c8c"></script>
<script src="../_static/design-tabs.js?v=f930bc37"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'api/catalog';</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="Write" href="write.html" />
<link rel="prev" title="API Reference" href="../api.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 current active"><a class="current reference internal" href="#">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"><a class="reference internal" href="global_index.html">Global Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="clean.html">Orphan Files Clean</a></li>
<li class="toctree-l1"><a class="reference internal" href="defs.html">Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="executor.html">Executor</a></li>
<li class="toctree-l1"><a class="reference internal" href="memory.html">Memory</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="../api.html" class="nav-link">API Reference</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Catalog</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="catalog">
<h1>Catalog<a class="headerlink" href="#catalog" title="Link to this heading">#</a></h1>
<section id="interface">
<span id="cpp-api-catalog"></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="_CPPv4N6paimon7CatalogE">
<span id="_CPPv3N6paimon7CatalogE"></span><span id="_CPPv2N6paimon7CatalogE"></span><span id="paimon::Catalog"></span><span class="target" id="classpaimon_1_1_catalog"></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">Catalog</span></span></span><a class="headerlink" href="#_CPPv4N6paimon7CatalogE" title="Link to this definition">#</a><br /></dt>
<dd><p>This interface is responsible for reading and writing metadata such as database/table from a paimon catalog. </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="_CPPv4N6paimon7Catalog14CreateDatabaseERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEEb">
<span id="_CPPv3N6paimon7Catalog14CreateDatabaseERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEEb"></span><span id="_CPPv2N6paimon7Catalog14CreateDatabaseERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEEb"></span><span id="paimon::Catalog::CreateDatabase__ssCR.std::map:ss.ss:CR.b"></span><span class="target" id="classpaimon_1_1_catalog_1a84df9597c6b425ff192f01b66f060cb5"></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">CreateDatabase</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">&amp;</span></span><span class="n sig-param"><span class="pre">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">map</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ignore_if_exists</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="#_CPPv4N6paimon7Catalog14CreateDatabaseERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEEb" title="Link to this definition">#</a><br /></dt>
<dd><p>Creates a database with the specified properties. </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>name</strong> – Name of the database to be created. </p></li>
<li><p><strong>options</strong> – Additional properties associated with the database. </p></li>
<li><p><strong>ignore_if_exists</strong> – If true, no action is taken if the database already exists. If false, an error status is returned if the database exists. </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A status indicating success or failure. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon7Catalog11CreateTableERK10IdentifierP11ArrowSchemaRKNSt6vectorINSt6stringEEERKNSt6vectorINSt6stringEEERKNSt3mapINSt6stringENSt6stringEEEb">
<span id="_CPPv3N6paimon7Catalog11CreateTableERK10IdentifierP11ArrowSchemaRKNSt6vectorINSt6stringEEERKNSt6vectorINSt6stringEEERKNSt3mapINSt6stringENSt6stringEEEb"></span><span id="_CPPv2N6paimon7Catalog11CreateTableERK10IdentifierP11ArrowSchemaRKNSt6vectorINSt6stringEEERKNSt6vectorINSt6stringEEERKNSt3mapINSt6stringENSt6stringEEEb"></span><span id="paimon::Catalog::CreateTable__IdentifierCR.ArrowSchemaP.std::vector:ss:CR.std::vector:ss:CR.std::map:ss.ss:CR.b"></span><span class="target" id="classpaimon_1_1_catalog_1a3897ab46944bc30efb90182dbb68359e"></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">CreateTable</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identifier</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">c_schema</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">partition_keys</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">&lt;</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">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">primary_keys</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">&lt;</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">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">options</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ignore_if_exists</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="#_CPPv4N6paimon7Catalog11CreateTableERK10IdentifierP11ArrowSchemaRKNSt6vectorINSt6stringEEERKNSt6vectorINSt6stringEEERKNSt3mapINSt6stringENSt6stringEEEb" title="Link to this definition">#</a><br /></dt>
<dd><p>Creates a new table in the catalog. </p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>System tables cannot be created using this method.</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>identifier</strong> – <a class="reference internal" href="#classpaimon_1_1_identifier"><span class="std std-ref">Identifier</span></a> of the table to be created. </p></li>
<li><p><strong>c_schema</strong> – The schema of the table to be created. </p></li>
<li><p><strong>partition_keys</strong> – List of columns that should be used as partition keys for the table. </p></li>
<li><p><strong>primary_keys</strong> – List of columns that should be used as primary keys for the table. </p></li>
<li><p><strong>options</strong> – Additional table-specific options. </p></li>
<li><p><strong>ignore_if_exists</strong> – If true, no action is taken if the table already exists. If false, an error status is returned if the table exists. </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A status indicating success or failure. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog13ListDatabasesEv">
<span id="_CPPv3NK6paimon7Catalog13ListDatabasesEv"></span><span id="_CPPv2NK6paimon7Catalog13ListDatabasesEv"></span><span id="paimon::Catalog::ListDatabasesC"></span><span class="target" id="classpaimon_1_1_catalog_1ad105a410f62dbbe891272d3c647b7976"></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">&lt;</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">&lt;</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">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListDatabases</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="#_CPPv4NK6paimon7Catalog13ListDatabasesEv" title="Link to this definition">#</a><br /></dt>
<dd><p>Lists all the databases available in the catalog. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A result containing a vector of database names, or an error status. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog10ListTablesERKNSt6stringE">
<span id="_CPPv3NK6paimon7Catalog10ListTablesERKNSt6stringE"></span><span id="_CPPv2NK6paimon7Catalog10ListTablesERKNSt6stringE"></span><span id="paimon::Catalog::ListTables__ssCRC"></span><span class="target" id="classpaimon_1_1_catalog_1ad0bb25fe3c39013b1f981079208e4c4c"></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">&lt;</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">&lt;</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">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListTables</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">&amp;</span></span><span class="n sig-param"><span class="pre">db_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="#_CPPv4NK6paimon7Catalog10ListTablesERKNSt6stringE" title="Link to this definition">#</a><br /></dt>
<dd><p>Lists all the tables within a specified database. </p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>System tables will not be listed.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>db_name</strong> – The name of the database to list tables from. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A result containing a vector of table names in the specified database, or an error status. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon7Catalog12DropDatabaseERKNSt6stringEbb">
<span id="_CPPv3N6paimon7Catalog12DropDatabaseERKNSt6stringEbb"></span><span id="_CPPv2N6paimon7Catalog12DropDatabaseERKNSt6stringEbb"></span><span id="paimon::Catalog::DropDatabase__ssCR.b.b"></span><span class="target" id="classpaimon_1_1_catalog_1a64d2540b73141b56cf3c0983d91ac4bc"></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">DropDatabase</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">&amp;</span></span><span class="n sig-param"><span class="pre">name</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ignore_if_not_exists</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">cascade</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="#_CPPv4N6paimon7Catalog12DropDatabaseERKNSt6stringEbb" title="Link to this definition">#</a><br /></dt>
<dd><p>Drops a database. </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>name</strong> – Name of the database to be dropped. </p></li>
<li><p><strong>ignore_if_not_exists</strong> – If true, no action is taken if the database does not exist. </p></li>
<li><p><strong>cascade</strong> – If true, drops all tables and functions in the database before dropping the database. </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A status indicating success or failure. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon7Catalog9DropTableERK10Identifierb">
<span id="_CPPv3N6paimon7Catalog9DropTableERK10Identifierb"></span><span id="_CPPv2N6paimon7Catalog9DropTableERK10Identifierb"></span><span id="paimon::Catalog::DropTable__IdentifierCR.b"></span><span class="target" id="classpaimon_1_1_catalog_1aefa990be4e6085cd974d10058708ec69"></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">DropTable</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identifier</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ignore_if_not_exists</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="#_CPPv4N6paimon7Catalog9DropTableERK10Identifierb" title="Link to this definition">#</a><br /></dt>
<dd><p>Drops a table. </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> – <a class="reference internal" href="#classpaimon_1_1_identifier"><span class="std std-ref">Identifier</span></a> of the table to drop. </p></li>
<li><p><strong>ignore_if_not_exists</strong> – If true, no action is taken if the table does not exist. </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A status indicating success or failure. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon7Catalog11RenameTableERK10IdentifierRK10Identifierb">
<span id="_CPPv3N6paimon7Catalog11RenameTableERK10IdentifierRK10Identifierb"></span><span id="_CPPv2N6paimon7Catalog11RenameTableERK10IdentifierRK10Identifierb"></span><span id="paimon::Catalog::RenameTable__IdentifierCR.IdentifierCR.b"></span><span class="target" id="classpaimon_1_1_catalog_1a40a3e8efa5b2f93f869ad96057ba259c"></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">RenameTable</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">from_table</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">to_table</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ignore_if_not_exists</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="#_CPPv4N6paimon7Catalog11RenameTableERK10IdentifierRK10Identifierb" title="Link to this definition">#</a><br /></dt>
<dd><p>Renames a table. </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>from_table</strong> – Current identifier of the table. </p></li>
<li><p><strong>to_table</strong> – New identifier for the table. </p></li>
<li><p><strong>ignore_if_not_exists</strong> – If true, no action is taken if the table does not exist. </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A status indicating success or failure. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog8GetTableERK10Identifier">
<span id="_CPPv3NK6paimon7Catalog8GetTableERK10Identifier"></span><span id="_CPPv2NK6paimon7Catalog8GetTableERK10Identifier"></span><span id="paimon::Catalog::GetTable__IdentifierCRC"></span><span class="target" id="classpaimon_1_1_catalog_1a9f7eca6e83e7dec670067c5ce6e40282"></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">&lt;</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">&lt;</span></span><span class="n"><span class="pre">Table</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetTable</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identifier</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="#_CPPv4NK6paimon7Catalog8GetTableERK10Identifier" title="Link to this definition">#</a><br /></dt>
<dd><p>Gets a table. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>identifier</strong> – <a class="reference internal" href="#classpaimon_1_1_identifier"><span class="std std-ref">Identifier</span></a> of the table to get. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A result containing the table, or an error status. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog14DatabaseExistsERKNSt6stringE">
<span id="_CPPv3NK6paimon7Catalog14DatabaseExistsERKNSt6stringE"></span><span id="_CPPv2NK6paimon7Catalog14DatabaseExistsERKNSt6stringE"></span><span id="paimon::Catalog::DatabaseExists__ssCRC"></span><span class="target" id="classpaimon_1_1_catalog_1aaf2810f83b1d246cf43912bde9897778"></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">&lt;</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DatabaseExists</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">&amp;</span></span><span class="n sig-param"><span class="pre">db_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="#_CPPv4NK6paimon7Catalog14DatabaseExistsERKNSt6stringE" title="Link to this definition">#</a><br /></dt>
<dd><p>Checks whether a database with the specified name exists in the catalog. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>db_name</strong> – The name of the database to check for existence. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A result containing true if the database exists, false otherwise, or an error status. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog11TableExistsERK10Identifier">
<span id="_CPPv3NK6paimon7Catalog11TableExistsERK10Identifier"></span><span id="_CPPv2NK6paimon7Catalog11TableExistsERK10Identifier"></span><span id="paimon::Catalog::TableExists__IdentifierCRC"></span><span class="target" id="classpaimon_1_1_catalog_1a932d3d0f433c56ffd60792d391894cfc"></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">&lt;</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TableExists</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identifier</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="#_CPPv4NK6paimon7Catalog11TableExistsERK10Identifier" title="Link to this definition">#</a><br /></dt>
<dd><p>Checks whether a table with the specified identifier exists in the catalog. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>identifier</strong> – The identifier of the table to check for existence. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A result containing true if the table exists, false otherwise, or an error status. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog19GetDatabaseLocationERKNSt6stringE">
<span id="_CPPv3NK6paimon7Catalog19GetDatabaseLocationERKNSt6stringE"></span><span id="_CPPv2NK6paimon7Catalog19GetDatabaseLocationERKNSt6stringE"></span><span id="paimon::Catalog::GetDatabaseLocation__ssCRC"></span><span class="target" id="classpaimon_1_1_catalog_1ad116620f15a45bb7a538b58b68e65c97"></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">GetDatabaseLocation</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">&amp;</span></span><span class="n sig-param"><span class="pre">db_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="#_CPPv4NK6paimon7Catalog19GetDatabaseLocationERKNSt6stringE" title="Link to this definition">#</a><br /></dt>
<dd><p>Returns the expected location of a specified database. </p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This does not check whether the database actually exists.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>db_name</strong> – The name of the database to get the location for. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A string representing the expected location of the database. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog16GetTableLocationERK10Identifier">
<span id="_CPPv3NK6paimon7Catalog16GetTableLocationERK10Identifier"></span><span id="_CPPv2NK6paimon7Catalog16GetTableLocationERK10Identifier"></span><span id="paimon::Catalog::GetTableLocation__IdentifierCRC"></span><span class="target" id="classpaimon_1_1_catalog_1a33a427b16f6ae55cbfbd1e99efe89f2e"></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">GetTableLocation</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identifier</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="#_CPPv4NK6paimon7Catalog16GetTableLocationERK10Identifier" title="Link to this definition">#</a><br /></dt>
<dd><p>Returns the expected location of a specified table. </p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This does not check whether the table actually exists.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>identifier</strong> – The table identifier containing database and table name. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A string representing the expected location of the table. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog11GetRootPathEv">
<span id="_CPPv3NK6paimon7Catalog11GetRootPathEv"></span><span id="_CPPv2NK6paimon7Catalog11GetRootPathEv"></span><span id="paimon::Catalog::GetRootPathC"></span><span class="target" id="classpaimon_1_1_catalog_1abe34a5b283e9f1d7c1dd90e148df3378"></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">GetRootPath</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="#_CPPv4NK6paimon7Catalog11GetRootPathEv" title="Link to this definition">#</a><br /></dt>
<dd><p>Returns the root path of the catalog. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A string representing the root path of the catalog. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog13GetFileSystemEv">
<span id="_CPPv3NK6paimon7Catalog13GetFileSystemEv"></span><span id="_CPPv2NK6paimon7Catalog13GetFileSystemEv"></span><span id="paimon::Catalog::GetFileSystemC"></span><span class="target" id="classpaimon_1_1_catalog_1a2e95dfc17f25b19a541f8453745161d0"></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">&lt;</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">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetFileSystem</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="#_CPPv4NK6paimon7Catalog13GetFileSystemEv" title="Link to this definition">#</a><br /></dt>
<dd><p>Returns the file system used by the catalog. </p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A shared pointer to the file system instance. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog15LoadTableSchemaERK10Identifier">
<span id="_CPPv3NK6paimon7Catalog15LoadTableSchemaERK10Identifier"></span><span id="_CPPv2NK6paimon7Catalog15LoadTableSchemaERK10Identifier"></span><span id="paimon::Catalog::LoadTableSchema__IdentifierCRC"></span><span class="target" id="classpaimon_1_1_catalog_1a76e4d168264fe571fee9e39d356457e8"></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">&lt;</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">&lt;</span></span><span class="n"><span class="pre">Schema</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LoadTableSchema</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">identifier</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="#_CPPv4NK6paimon7Catalog15LoadTableSchemaERK10Identifier" title="Link to this definition">#</a><br /></dt>
<dd><p>Loads the latest schema of a specified table. </p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>System tables will not be supported.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>identifier</strong> – The identifier (database and table name) of the table to load. </p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A result containing table schema if the table exists, or an error status on failure. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon7Catalog13ListSnapshotsERK10IdentifierRKNSt6stringE">
<span id="_CPPv3NK6paimon7Catalog13ListSnapshotsERK10IdentifierRKNSt6stringE"></span><span id="_CPPv2NK6paimon7Catalog13ListSnapshotsERK10IdentifierRKNSt6stringE"></span><span id="paimon::Catalog::ListSnapshots__IdentifierCR.ssCRC"></span><span class="target" id="classpaimon_1_1_catalog_1a44ba13c2315f71f5ca6f42648209150e"></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">&lt;</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">&lt;</span></span><span class="n"><span class="pre">SnapshotInfo</span></span><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListSnapshots</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">branch</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">&quot;&quot;</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="#_CPPv4NK6paimon7Catalog13ListSnapshotsERK10IdentifierRKNSt6stringE" title="Link to this definition">#</a><br /></dt>
<dd><p>Lists all snapshots of the specified table, ordered by snapshot 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>identifier</strong> – The identifier (database and table name) of the table. </p></li>
<li><p><strong>branch</strong> – Branch name; empty string means the main branch. </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A result containing a vector of SnapshotInfo ordered by snapshot id ascending, or an error status. </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="_CPPv4N6paimon7Catalog6CreateERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEE">
<span id="_CPPv3N6paimon7Catalog6CreateERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEE"></span><span id="_CPPv2N6paimon7Catalog6CreateERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEE"></span><span id="paimon::Catalog::Create__ssCR.std::map:ss.ss:CR.std::shared_ptr:FileSystem:CR"></span><span class="target" id="classpaimon_1_1_catalog_1a40ca2ab99f62612d7cf5a252c3b07328"></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">&lt;</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">&lt;</span></span><a class="reference internal" href="#_CPPv4N6paimon7CatalogE" title="paimon::Catalog"><span class="n"><span class="pre">Catalog</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="p"><span class="pre">&gt;</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">&amp;</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">map</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</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">&lt;</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">&gt;</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</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="#_CPPv4N6paimon7Catalog6CreateERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEE" title="Link to this definition">#</a><br /></dt>
<dd><p>Factory method for creating a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_catalog"><span class="std std-ref"><span class="pre">Catalog</span></span></a></code> instance. </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> – Path to the root directory where the catalog is located. </p></li>
<li><p><strong>options</strong> – Configuration options for catalog initialization. </p></li>
<li><p><strong>file_system</strong> – Specifies the file system for file operations. If not set, use default file system (configured in <code class="docutils literal notranslate"><a class="reference internal" href="defs.html#structpaimon_1_1_options_1a91cdf2a3a8110ea53a0d9197d38cfae3"><span class="std std-ref"><span class="pre">Options::FILE_SYSTEM</span></span></a></code>) </p></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 a <code class="docutils literal notranslate"><a class="reference internal" href="#classpaimon_1_1_catalog"><span class="std std-ref"><span class="pre">Catalog</span></span></a></code> instance, or an error status. </p>
</dd>
</dl>
</dd></dl>
</div>
</dd></dl>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10IdentifierE">
<span id="_CPPv3N6paimon10IdentifierE"></span><span id="_CPPv2N6paimon10IdentifierE"></span><span id="paimon::Identifier"></span><span class="target" id="classpaimon_1_1_identifier"></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">Identifier</span></span></span><a class="headerlink" href="#_CPPv4N6paimon10IdentifierE" title="Link to this definition">#</a><br /></dt>
<dd><p>An identifier for a table containing database and table name. </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="_CPPv4N6paimon10Identifier10IdentifierERKNSt6stringE">
<span id="_CPPv3N6paimon10Identifier10IdentifierERKNSt6stringE"></span><span id="_CPPv2N6paimon10Identifier10IdentifierERKNSt6stringE"></span><span id="paimon::Identifier::Identifier__ssCR"></span><span class="target" id="classpaimon_1_1_identifier_1addb1767479a4e29c2ccb245f576c3524"></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">Identifier</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">&amp;</span></span><span class="n sig-param"><span class="pre">table</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon10Identifier10IdentifierERKNSt6stringE" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10Identifier10IdentifierERKNSt6stringERKNSt6stringE">
<span id="_CPPv3N6paimon10Identifier10IdentifierERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N6paimon10Identifier10IdentifierERKNSt6stringERKNSt6stringE"></span><span id="paimon::Identifier::Identifier__ssCR.ssCR"></span><span class="target" id="classpaimon_1_1_identifier_1a55a561dfb9b064e17dbb481b17985622"></span><span class="sig-name descname"><span class="n"><span class="pre">Identifier</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">&amp;</span></span><span class="n sig-param"><span class="pre">database</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">&amp;</span></span><span class="n sig-param"><span class="pre">table</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon10Identifier10IdentifierERKNSt6stringERKNSt6stringE" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10IdentifiereqERK10Identifier">
<span id="_CPPv3N6paimon10IdentifiereqERK10Identifier"></span><span id="_CPPv2N6paimon10IdentifiereqERK10Identifier"></span><span id="paimon::Identifier::eq-operator__IdentifierCR"></span><span class="target" id="classpaimon_1_1_identifier_1a0a1df189995dd93123dc479fcd9f694a"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">==</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N6paimon10IdentifierE" title="paimon::Identifier"><span class="n"><span class="pre">Identifier</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6paimon10IdentifiereqERK10Identifier" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier15GetDatabaseNameEv">
<span id="_CPPv3NK6paimon10Identifier15GetDatabaseNameEv"></span><span id="_CPPv2NK6paimon10Identifier15GetDatabaseNameEv"></span><span id="paimon::Identifier::GetDatabaseNameC"></span><span class="target" id="classpaimon_1_1_identifier_1a3542e82502dbdf018d5a0532b19fbe4e"></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">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetDatabaseName</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="#_CPPv4NK6paimon10Identifier15GetDatabaseNameEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier12GetTableNameEv">
<span id="_CPPv3NK6paimon10Identifier12GetTableNameEv"></span><span id="_CPPv2NK6paimon10Identifier12GetTableNameEv"></span><span id="paimon::Identifier::GetTableNameC"></span><span class="target" id="classpaimon_1_1_identifier_1adb64851f69ca7cd10d1e0653afa2f48c"></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">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetTableName</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="#_CPPv4NK6paimon10Identifier12GetTableNameEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier16GetDataTableNameEv">
<span id="_CPPv3NK6paimon10Identifier16GetDataTableNameEv"></span><span id="_CPPv2NK6paimon10Identifier16GetDataTableNameEv"></span><span id="paimon::Identifier::GetDataTableNameC"></span><span class="target" id="classpaimon_1_1_identifier_1acdc79d4ba081420f25feff151c640547"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetDataTableName</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="#_CPPv4NK6paimon10Identifier16GetDataTableNameEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier13GetBranchNameEv">
<span id="_CPPv3NK6paimon10Identifier13GetBranchNameEv"></span><span id="_CPPv2NK6paimon10Identifier13GetBranchNameEv"></span><span id="paimon::Identifier::GetBranchNameC"></span><span class="target" id="classpaimon_1_1_identifier_1ad1d628f7cd8ab0115960ca39775f3959"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre">&lt;</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">optional</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetBranchName</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="#_CPPv4NK6paimon10Identifier13GetBranchNameEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier22GetBranchNameOrDefaultEv">
<span id="_CPPv3NK6paimon10Identifier22GetBranchNameOrDefaultEv"></span><span id="_CPPv2NK6paimon10Identifier22GetBranchNameOrDefaultEv"></span><span id="paimon::Identifier::GetBranchNameOrDefaultC"></span><span class="target" id="classpaimon_1_1_identifier_1a3f58db38fc327274e80e9045cf38ab03"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetBranchNameOrDefault</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="#_CPPv4NK6paimon10Identifier22GetBranchNameOrDefaultEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier18GetSystemTableNameEv">
<span id="_CPPv3NK6paimon10Identifier18GetSystemTableNameEv"></span><span id="_CPPv2NK6paimon10Identifier18GetSystemTableNameEv"></span><span id="paimon::Identifier::GetSystemTableNameC"></span><span class="target" id="classpaimon_1_1_identifier_1a8bc4db846a227e52a6190a465416e485"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre">&lt;</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">optional</span></span><span class="p"><span class="pre">&lt;</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">&gt;</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetSystemTableName</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="#_CPPv4NK6paimon10Identifier18GetSystemTableNameEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier13IsSystemTableEv">
<span id="_CPPv3NK6paimon10Identifier13IsSystemTableEv"></span><span id="_CPPv2NK6paimon10Identifier13IsSystemTableEv"></span><span id="paimon::Identifier::IsSystemTableC"></span><span class="target" id="classpaimon_1_1_identifier_1a9b4eabdd08ac5fbca7ba132dcc51d79b"></span><span class="n"><span class="pre">Result</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsSystemTable</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="#_CPPv4NK6paimon10Identifier13IsSystemTableEv" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK6paimon10Identifier8ToStringEv">
<span id="_CPPv3NK6paimon10Identifier8ToStringEv"></span><span id="_CPPv2NK6paimon10Identifier8ToStringEv"></span><span id="paimon::Identifier::ToStringC"></span><span class="target" id="classpaimon_1_1_identifier_1a524957e38fa739fc158fda51f2e6747c"></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><a class="headerlink" href="#_CPPv4NK6paimon10Identifier8ToStringEv" 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-attributes">Public Static Attributes</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10Identifier16kUnknownDatabaseE">
<span id="_CPPv3N6paimon10Identifier16kUnknownDatabaseE"></span><span id="_CPPv2N6paimon10Identifier16kUnknownDatabaseE"></span><span id="paimon::Identifier::kUnknownDatabase__cCA"></span><span class="target" id="classpaimon_1_1_identifier_1abd41e49d3fd6d4bc02e3e4ff0adfaaf0"></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">kUnknownDatabase</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N6paimon10Identifier16kUnknownDatabaseE" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10Identifier20kSystemTableSplitterE">
<span id="_CPPv3N6paimon10Identifier20kSystemTableSplitterE"></span><span id="_CPPv2N6paimon10Identifier20kSystemTableSplitterE"></span><span id="paimon::Identifier::kSystemTableSplitter__cCA"></span><span class="target" id="classpaimon_1_1_identifier_1a5a8418f8ea5acb8e740aeafa12cbad46"></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">kSystemTableSplitter</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N6paimon10Identifier20kSystemTableSplitterE" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10Identifier19kSystemBranchPrefixE">
<span id="_CPPv3N6paimon10Identifier19kSystemBranchPrefixE"></span><span id="_CPPv2N6paimon10Identifier19kSystemBranchPrefixE"></span><span id="paimon::Identifier::kSystemBranchPrefix__cCA"></span><span class="target" id="classpaimon_1_1_identifier_1a376ad2b89ec8f8fe97b4e400dd695b47"></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">kSystemBranchPrefix</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N6paimon10Identifier19kSystemBranchPrefixE" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N6paimon10Identifier18kDefaultMainBranchE">
<span id="_CPPv3N6paimon10Identifier18kDefaultMainBranchE"></span><span id="_CPPv2N6paimon10Identifier18kDefaultMainBranchE"></span><span id="paimon::Identifier::kDefaultMainBranch__cCA"></span><span class="target" id="classpaimon_1_1_identifier_1a85d979577567b42785cee921941c61f4"></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">kDefaultMainBranch</span></span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#_CPPv4N6paimon10Identifier18kDefaultMainBranchE" title="Link to this definition">#</a><br /></dt>
<dd></dd></dl>
</div>
</dd></dl>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="../api.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">API Reference</p>
</div>
</a>
<a class="right-next"
href="write.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Write</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="#_CPPv4N6paimon7CatalogE"><code class="docutils literal notranslate"><span class="pre">paimon::Catalog</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="#_CPPv4N6paimon7Catalog14CreateDatabaseERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEEb"><code class="docutils literal notranslate"><span class="pre">CreateDatabase()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon7Catalog11CreateTableERK10IdentifierP11ArrowSchemaRKNSt6vectorINSt6stringEEERKNSt6vectorINSt6stringEEERKNSt3mapINSt6stringENSt6stringEEEb"><code class="docutils literal notranslate"><span class="pre">CreateTable()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog13ListDatabasesEv"><code class="docutils literal notranslate"><span class="pre">ListDatabases()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog10ListTablesERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">ListTables()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon7Catalog12DropDatabaseERKNSt6stringEbb"><code class="docutils literal notranslate"><span class="pre">DropDatabase()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon7Catalog9DropTableERK10Identifierb"><code class="docutils literal notranslate"><span class="pre">DropTable()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon7Catalog11RenameTableERK10IdentifierRK10Identifierb"><code class="docutils literal notranslate"><span class="pre">RenameTable()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog8GetTableERK10Identifier"><code class="docutils literal notranslate"><span class="pre">GetTable()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog14DatabaseExistsERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">DatabaseExists()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog11TableExistsERK10Identifier"><code class="docutils literal notranslate"><span class="pre">TableExists()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog19GetDatabaseLocationERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">GetDatabaseLocation()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog16GetTableLocationERK10Identifier"><code class="docutils literal notranslate"><span class="pre">GetTableLocation()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog11GetRootPathEv"><code class="docutils literal notranslate"><span class="pre">GetRootPath()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog13GetFileSystemEv"><code class="docutils literal notranslate"><span class="pre">GetFileSystem()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog15LoadTableSchemaERK10Identifier"><code class="docutils literal notranslate"><span class="pre">LoadTableSchema()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon7Catalog13ListSnapshotsERK10IdentifierRKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">ListSnapshots()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon7Catalog6CreateERKNSt6stringERKNSt3mapINSt6stringENSt6stringEEERKNSt10shared_ptrI10FileSystemEE"><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="#_CPPv4N6paimon10IdentifierE"><code class="docutils literal notranslate"><span class="pre">paimon::Identifier</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="#_CPPv4N6paimon10Identifier10IdentifierERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">Identifier()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10Identifier10IdentifierERKNSt6stringERKNSt6stringE"><code class="docutils literal notranslate"><span class="pre">Identifier()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10IdentifiereqERK10Identifier"><code class="docutils literal notranslate"><span class="pre">operator==()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier15GetDatabaseNameEv"><code class="docutils literal notranslate"><span class="pre">GetDatabaseName()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier12GetTableNameEv"><code class="docutils literal notranslate"><span class="pre">GetTableName()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier16GetDataTableNameEv"><code class="docutils literal notranslate"><span class="pre">GetDataTableName()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier13GetBranchNameEv"><code class="docutils literal notranslate"><span class="pre">GetBranchName()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier22GetBranchNameOrDefaultEv"><code class="docutils literal notranslate"><span class="pre">GetBranchNameOrDefault()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier18GetSystemTableNameEv"><code class="docutils literal notranslate"><span class="pre">GetSystemTableName()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier13IsSystemTableEv"><code class="docutils literal notranslate"><span class="pre">IsSystemTable()</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4NK6paimon10Identifier8ToStringEv"><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="#_CPPv4N6paimon10Identifier16kUnknownDatabaseE"><code class="docutils literal notranslate"><span class="pre">kUnknownDatabase</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10Identifier20kSystemTableSplitterE"><code class="docutils literal notranslate"><span class="pre">kSystemTableSplitter</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10Identifier19kSystemBranchPrefixE"><code class="docutils literal notranslate"><span class="pre">kSystemBranchPrefix</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#_CPPv4N6paimon10Identifier18kDefaultMainBranchE"><code class="docutils literal notranslate"><span class="pre">kDefaultMainBranch</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/catalog.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>