You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by gi...@apache.org on 2025/09/11 15:05:03 UTC
(iceberg-python) 01/01: Publish Python docs
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/iceberg-python.git
commit d662cdd363fa130f68f1f1adbfa4d5e53f93ff97
Author: GitHub Actions <ac...@github.com>
AuthorDate: Thu Sep 11 15:04:56 2025 +0000
Publish Python docs
---
404.html | 2971 ++++
CNAME | 1 +
SUMMARY/index.html | 3042 ++++
api/index.html | 5131 +++++++
assets/_mkdocstrings.css | 181 +
assets/images/favicon.png | Bin 0 -> 1870 bytes
assets/images/gen-release-notes.jpg | Bin 0 -> 73250 bytes
assets/images/iceberg-logo-icon.png | Bin 0 -> 17608 bytes
assets/javascripts/bundle.92b07e13.min.js | 16 +
assets/javascripts/bundle.92b07e13.min.js.map | 7 +
assets/javascripts/lunr/min/lunr.ar.min.js | 1 +
assets/javascripts/lunr/min/lunr.da.min.js | 18 +
assets/javascripts/lunr/min/lunr.de.min.js | 18 +
assets/javascripts/lunr/min/lunr.du.min.js | 18 +
assets/javascripts/lunr/min/lunr.el.min.js | 1 +
assets/javascripts/lunr/min/lunr.es.min.js | 18 +
assets/javascripts/lunr/min/lunr.fi.min.js | 18 +
assets/javascripts/lunr/min/lunr.fr.min.js | 18 +
assets/javascripts/lunr/min/lunr.he.min.js | 1 +
assets/javascripts/lunr/min/lunr.hi.min.js | 1 +
assets/javascripts/lunr/min/lunr.hu.min.js | 18 +
assets/javascripts/lunr/min/lunr.hy.min.js | 1 +
assets/javascripts/lunr/min/lunr.it.min.js | 18 +
assets/javascripts/lunr/min/lunr.ja.min.js | 1 +
assets/javascripts/lunr/min/lunr.jp.min.js | 1 +
assets/javascripts/lunr/min/lunr.kn.min.js | 1 +
assets/javascripts/lunr/min/lunr.ko.min.js | 1 +
assets/javascripts/lunr/min/lunr.multi.min.js | 1 +
assets/javascripts/lunr/min/lunr.nl.min.js | 18 +
assets/javascripts/lunr/min/lunr.no.min.js | 18 +
assets/javascripts/lunr/min/lunr.pt.min.js | 18 +
assets/javascripts/lunr/min/lunr.ro.min.js | 18 +
assets/javascripts/lunr/min/lunr.ru.min.js | 18 +
assets/javascripts/lunr/min/lunr.sa.min.js | 1 +
.../lunr/min/lunr.stemmer.support.min.js | 1 +
assets/javascripts/lunr/min/lunr.sv.min.js | 18 +
assets/javascripts/lunr/min/lunr.ta.min.js | 1 +
assets/javascripts/lunr/min/lunr.te.min.js | 1 +
assets/javascripts/lunr/min/lunr.th.min.js | 1 +
assets/javascripts/lunr/min/lunr.tr.min.js | 18 +
assets/javascripts/lunr/min/lunr.vi.min.js | 1 +
assets/javascripts/lunr/min/lunr.zh.min.js | 1 +
assets/javascripts/lunr/tinyseg.js | 206 +
assets/javascripts/lunr/wordcut.js | 6708 ++++++++
assets/javascripts/workers/search.973d3a69.min.js | 42 +
.../javascripts/workers/search.973d3a69.min.js.map | 7 +
assets/stylesheets/main.7e37652d.min.css | 1 +
assets/stylesheets/main.7e37652d.min.css.map | 1 +
assets/stylesheets/palette.06af60db.min.css | 1 +
assets/stylesheets/palette.06af60db.min.css.map | 1 +
.../decoder_fast.cpython-310-x86_64-linux-gnu.so | Bin 0 -> 532960 bytes
.../pyiceberg/avro/decoder_fast.o | Bin 0 -> 992056 bytes
cli/index.html | 3240 ++++
community/index.html | 3211 ++++
configuration/index.html | 5304 +++++++
contributing/index.html | 3436 +++++
expression-dsl/index.html | 3587 +++++
how-to-release/index.html | 4106 +++++
index.html | 3369 +++++
nightly-build/index.html | 3050 ++++
objects.inv | Bin 0 -> 14063 bytes
pyiceberg/__pycache__/__init__.cpython-310.pyc | Bin 0 -> 184 bytes
.../avro/__pycache__/__init__.cpython-310.pyc | Bin 0 -> 342 bytes
pyiceberg/avro/decoder_fast.c | 15131 +++++++++++++++++++
.../decoder_fast.cpython-310-x86_64-linux-gnu.so | Bin 0 -> 532960 bytes
pyiceberg/avro/decoder_fast.html | 2564 ++++
reference/SUMMARY/index.html | 3089 ++++
reference/pyiceberg/avro/codecs/bzip2/index.html | 3111 ++++
reference/pyiceberg/avro/codecs/codec/index.html | 3197 ++++
reference/pyiceberg/avro/codecs/deflate/index.html | 3111 ++++
reference/pyiceberg/avro/codecs/index.html | 3070 ++++
.../pyiceberg/avro/codecs/snappy_codec/index.html | 3111 ++++
.../avro/codecs/zstandard_codec/index.html | 3111 ++++
reference/pyiceberg/avro/decoder/index.html | 4306 ++++++
reference/pyiceberg/avro/encoder/index.html | 3718 +++++
reference/pyiceberg/avro/file/index.html | 4515 ++++++
reference/pyiceberg/avro/index.html | 3062 ++++
reference/pyiceberg/avro/reader/index.html | 5165 +++++++
reference/pyiceberg/avro/resolver/index.html | 3982 +++++
reference/pyiceberg/avro/writer/index.html | 4047 +++++
.../catalog/bigquery_metastore/index.html | 4913 ++++++
reference/pyiceberg/catalog/dynamodb/index.html | 6815 +++++++++
reference/pyiceberg/catalog/glue/index.html | 6766 +++++++++
reference/pyiceberg/catalog/hive/index.html | 6572 ++++++++
reference/pyiceberg/catalog/index.html | 9117 +++++++++++
reference/pyiceberg/catalog/memory/index.html | 3200 ++++
reference/pyiceberg/catalog/noop/index.html | 3521 +++++
reference/pyiceberg/catalog/rest/auth/index.html | 4968 ++++++
reference/pyiceberg/catalog/rest/index.html | 5454 +++++++
.../pyiceberg/catalog/rest/response/index.html | 3111 ++++
reference/pyiceberg/catalog/sql/index.html | 7185 +++++++++
reference/pyiceberg/cli/console/index.html | 4331 ++++++
reference/pyiceberg/cli/index.html | 3062 ++++
reference/pyiceberg/cli/output/index.html | 3723 +++++
reference/pyiceberg/conversions/index.html | 3829 +++++
reference/pyiceberg/exceptions/index.html | 4403 ++++++
reference/pyiceberg/expressions/index.html | 10577 +++++++++++++
.../pyiceberg/expressions/literals/index.html | 4988 ++++++
reference/pyiceberg/expressions/parser/index.html | 3154 ++++
.../pyiceberg/expressions/visitors/index.html | 6547 ++++++++
reference/pyiceberg/index.html | 3060 ++++
reference/pyiceberg/io/fsspec/index.html | 4754 ++++++
reference/pyiceberg/io/index.html | 4970 ++++++
reference/pyiceberg/io/pyarrow/index.html | 7749 ++++++++++
reference/pyiceberg/manifest/index.html | 5670 +++++++
reference/pyiceberg/partitioning/index.html | 4835 ++++++
reference/pyiceberg/schema/index.html | 11860 +++++++++++++++
reference/pyiceberg/serializers/index.html | 4173 +++++
reference/pyiceberg/table/index.html | 13584 +++++++++++++++++
reference/pyiceberg/table/inspect/index.html | 3109 ++++
reference/pyiceberg/table/locations/index.html | 3938 +++++
reference/pyiceberg/table/maintenance/index.html | 3297 ++++
reference/pyiceberg/table/metadata/index.html | 6991 +++++++++
reference/pyiceberg/table/name_mapping/index.html | 3959 +++++
reference/pyiceberg/table/puffin/index.html | 3109 ++++
reference/pyiceberg/table/refs/index.html | 3297 ++++
reference/pyiceberg/table/snapshots/index.html | 4055 +++++
reference/pyiceberg/table/sorting/index.html | 4140 +++++
reference/pyiceberg/table/statistics/index.html | 3187 ++++
reference/pyiceberg/table/update/index.html | 4325 ++++++
reference/pyiceberg/table/update/schema/index.html | 6171 ++++++++
.../pyiceberg/table/update/snapshot/index.html | 4597 ++++++
reference/pyiceberg/table/update/spec/index.html | 3111 ++++
.../pyiceberg/table/update/statistics/index.html | 3271 ++++
.../pyiceberg/table/update/validate/index.html | 3111 ++++
reference/pyiceberg/table/upsert_util/index.html | 3329 ++++
reference/pyiceberg/transforms/index.html | 6328 ++++++++
reference/pyiceberg/typedef/index.html | 4382 ++++++
reference/pyiceberg/types/index.html | 8287 ++++++++++
reference/pyiceberg/utils/bin_packing/index.html | 3433 +++++
reference/pyiceberg/utils/concurrent/index.html | 3327 ++++
reference/pyiceberg/utils/config/index.html | 3586 +++++
reference/pyiceberg/utils/datetime/index.html | 4669 ++++++
reference/pyiceberg/utils/decimal/index.html | 3960 +++++
reference/pyiceberg/utils/deprecated/index.html | 3286 ++++
reference/pyiceberg/utils/index.html | 3062 ++++
reference/pyiceberg/utils/lazydict/index.html | 3453 +++++
reference/pyiceberg/utils/parsing/index.html | 3203 ++++
reference/pyiceberg/utils/properties/index.html | 3109 ++++
.../pyiceberg/utils/schema_conversion/index.html | 4723 ++++++
reference/pyiceberg/utils/singleton/index.html | 3303 ++++
reference/pyiceberg/utils/truncate/index.html | 3107 ++++
row-filter-syntax/index.html | 3463 +++++
search/search_index.json | 1 +
sitemap.xml | 355 +
sitemap.xml.gz | Bin 0 -> 808 bytes
verify-release/index.html | 3260 ++++
147 files changed, 422381 insertions(+)
diff --git a/404.html b/404.html
new file mode 100644
index 00000000..76e4e7c4
--- /dev/null
+++ b/404.html
@@ -0,0 +1,2971 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+
+
+
+ <link rel="icon" href="/assets/images/iceberg-logo-icon.png">
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
+
+
+
+ <title>PyIceberg</title>
+
+
+
+ <link rel="stylesheet" href="/assets/stylesheets/main.7e37652d.min.css">
+
+
+ <link rel="stylesheet" href="/assets/stylesheets/palette.06af60db.min.css">
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Lato";--md-code-font:"Roboto Mono"}</style>
+
+
+
+ <link rel="stylesheet" href="/assets/_mkdocstrings.css">
+
+ <script>__md_scope=new URL("/",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
+
+
+
+
+ </head>
+
+
+
+
+
+
+
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+
+
+<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href="/." title="PyIceberg" class="md-header__button md-logo" aria-label="PyIceberg" data-md-component="logo">
+
+ <img src="/assets/images/iceberg-logo-icon.png" alt="logo">
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ PyIceberg
+ </span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+ <form class="md-header__option" data-md-component="palette">
+
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
+ </label>
+
+
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
+ </label>
+
+
+</form>
+
+
+
+ <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.get [...]
+
+
+
+
+
+ <label class="md-header__button md-icon" for="__search">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+ </label>
+ <div class="md-search" data-md-component="search" role="dialog">
+ <label class="md-search__overlay" for="__search"></label>
+ <div class="md-search__inner" role="search">
+ <form class="md-search__form" name="search">
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+ <label class="md-search__icon md-icon" for="__search">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
+ </label>
+ <nav class="md-search__options" aria-label="Search">
+
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
+ </button>
+ </nav>
+
+ </form>
+ <div class="md-search__output">
+ <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
+ <div class="md-search-result" data-md-component="search-result">
+ <div class="md-search-result__meta">
+ Initializing search
+ </div>
+ <ol class="md-search-result__list" role="presentation"></ol>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+
+ <div class="md-header__source">
+ <a href="https://github.com/apache/iceberg-python" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v [...]
+ </div>
+ <div class="md-source__repository">
+ apache/iceberg-python
+ </div>
+</a>
+ </div>
+
+ </nav>
+
+
+
+<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
+ <div class="md-grid">
+ <ul class="md-tabs__list">
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/." class="md-tabs__link">
+
+
+
+
+
+ Getting started
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/configuration/" class="md-tabs__link">
+
+
+
+
+
+ Configuration
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/cli/" class="md-tabs__link">
+
+
+
+
+
+ CLI
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/api/" class="md-tabs__link">
+
+
+
+
+
+ API
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/contributing/" class="md-tabs__link">
+
+
+
+
+
+ Contributing
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/community/" class="md-tabs__link">
+
+
+
+
+
+ Community
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/verify-release/" class="md-tabs__link">
+
+
+
+ Releases
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="/reference/pyiceberg/" class="md-tabs__link">
+
+
+
+ Code Reference
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </div>
+</nav>
+
+
+</header>
+
+ <div class="md-container" data-md-component="container">
+
+
+
+
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
+
+
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+
+
+
+
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="/." title="PyIceberg" class="md-nav__button md-logo" aria-label="PyIceberg" data-md-component="logo">
+
+ <img src="/assets/images/iceberg-logo-icon.png" alt="logo">
+
+ </a>
+ PyIceberg
+ </label>
+
+ <div class="md-nav__source">
+ <a href="https://github.com/apache/iceberg-python" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v [...]
+ </div>
+ <div class="md-source__repository">
+ apache/iceberg-python
+ </div>
+</a>
+ </div>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/." class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Getting started
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/configuration/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Configuration
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/cli/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ CLI
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/api/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ API
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/row-filter-syntax/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Row Filter Syntax
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/expression-dsl/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Expression DSL
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/contributing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Contributing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/community/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Community
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+
+
+ <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
+
+
+
+ <span class="md-ellipsis">
+ Releases
+
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_7">
+ <span class="md-nav__icon md-icon"></span>
+ Releases
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/verify-release/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Verify a release
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/how-to-release/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ How to release
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="https://github.com/apache/iceberg-python/releases" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Release Notes
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/nightly-build/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Nightly Build
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
+
+
+ <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
+
+
+
+ <span class="md-ellipsis">
+ Code Reference
+
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8">
+ <span class="md-nav__icon md-icon"></span>
+ Code Reference
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ pyiceberg
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1" id="__nav_8_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1">
+ <span class="md-nav__icon md-icon"></span>
+ pyiceberg
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/avro/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ avro
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_1" id="__nav_8_1_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_1">
+ <span class="md-nav__icon md-icon"></span>
+ avro
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_1_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/avro/codecs/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ codecs
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_1_1" id="__nav_8_1_1_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_1_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_1_1">
+ <span class="md-nav__icon md-icon"></span>
+ codecs
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/codecs/bzip2/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bzip2
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/codecs/codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/codecs/deflate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ deflate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/codecs/snappy_codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snappy_codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/codecs/zstandard_codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ zstandard_codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/decoder/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ decoder
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/encoder/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ encoder
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/file/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ file
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/reader/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ reader
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/resolver/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ resolver
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/avro/writer/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ writer
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_2" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/catalog/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ catalog
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_2" id="__nav_8_1_2_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_2_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_2">
+ <span class="md-nav__icon md-icon"></span>
+ catalog
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/bigquery_metastore/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bigquery_metastore
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/dynamodb/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ dynamodb
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/glue/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ glue
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/hive/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ hive
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/memory/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ memory
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/noop/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ noop
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_2_7" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/catalog/rest/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ rest
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_2_7" id="__nav_8_1_2_7_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_2_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_2_7">
+ <span class="md-nav__icon md-icon"></span>
+ rest
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/rest/auth/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ auth
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/rest/response/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ response
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/catalog/sql/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ sql
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_3" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/cli/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ cli
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_3" id="__nav_8_1_3_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_3_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_3">
+ <span class="md-nav__icon md-icon"></span>
+ cli
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/cli/console/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ console
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/cli/output/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ output
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/conversions/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ conversions
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/exceptions/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ exceptions
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_6" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/expressions/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ expressions
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_6" id="__nav_8_1_6_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_6">
+ <span class="md-nav__icon md-icon"></span>
+ expressions
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/expressions/literals/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ literals
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/expressions/parser/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ parser
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/expressions/visitors/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ visitors
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_7" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/io/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ io
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_7" id="__nav_8_1_7_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_7">
+ <span class="md-nav__icon md-icon"></span>
+ io
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/io/fsspec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ fsspec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/io/pyarrow/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ pyarrow
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/manifest/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ manifest
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/partitioning/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ partitioning
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/schema/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/serializers/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ serializers
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_12" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/table/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ table
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_12" id="__nav_8_1_12_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_12_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_12">
+ <span class="md-nav__icon md-icon"></span>
+ table
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/inspect/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ inspect
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/locations/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ locations
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/maintenance/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ maintenance
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/metadata/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ metadata
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/name_mapping/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ name_mapping
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/puffin/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ puffin
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/refs/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ refs
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/snapshots/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snapshots
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/sorting/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ sorting
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/statistics/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ statistics
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_12_11" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/table/update/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ update
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_12_11" id="__nav_8_1_12_11_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_12_11_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_12_11">
+ <span class="md-nav__icon md-icon"></span>
+ update
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/update/schema/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/update/snapshot/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snapshot
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/update/spec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ spec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/update/statistics/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ statistics
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/update/validate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ validate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/table/upsert_util/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ upsert_util
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/transforms/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ transforms
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/typedef/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ typedef
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/types/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ types
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_16" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="/reference/pyiceberg/utils/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ utils
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_16" id="__nav_8_1_16_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_16_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_16">
+ <span class="md-nav__icon md-icon"></span>
+ utils
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/bin_packing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bin_packing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/concurrent/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ concurrent
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/config/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ config
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/datetime/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ datetime
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/decimal/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ decimal
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/deprecated/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ deprecated
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/lazydict/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ lazydict
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/parsing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ parsing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/properties/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ properties
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/schema_conversion/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema_conversion
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/singleton/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ singleton
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/reference/pyiceberg/utils/truncate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ truncate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+ </ul>
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+ <h1>404 - Not found</h1>
+
+ </article>
+ </div>
+
+
+<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
+ </div>
+
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
+ Back to top
+</button>
+
+ </main>
+
+ <footer class="md-footer">
+
+ <div class="md-footer-meta md-typeset">
+ <div class="md-footer-meta__inner md-grid">
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
+
+ </div>
+ </div>
+</footer>
+
+ </div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
+
+
+
+
+ <script id="__config" type="application/json">{"base": "/", "features": ["navigation.top", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy"], "search": "/assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No ma [...]
+
+
+ <script src="/assets/javascripts/bundle.92b07e13.min.js"></script>
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/CNAME b/CNAME
new file mode 100644
index 00000000..0b63f25f
--- /dev/null
+++ b/CNAME
@@ -0,0 +1 @@
+py.iceberg.apache.org
diff --git a/SUMMARY/index.html b/SUMMARY/index.html
new file mode 100644
index 00000000..f98af832
--- /dev/null
+++ b/SUMMARY/index.html
@@ -0,0 +1,3042 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+ <link rel="canonical" href="https://py.iceberg.apache.org/SUMMARY/">
+
+
+
+
+ <link rel="icon" href="../assets/images/iceberg-logo-icon.png">
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
+
+
+
+ <title>SUMMARY - PyIceberg</title>
+
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Lato";--md-code-font:"Roboto Mono"}</style>
+
+
+
+ <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+
+ <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
+
+
+
+
+ </head>
+
+
+
+
+
+
+
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#summary" class="md-skip">
+ Skip to content
+ </a>
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+
+
+<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href=".." title="PyIceberg" class="md-header__button md-logo" aria-label="PyIceberg" data-md-component="logo">
+
+ <img src="../assets/images/iceberg-logo-icon.png" alt="logo">
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ PyIceberg
+ </span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ SUMMARY
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+ <form class="md-header__option" data-md-component="palette">
+
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
+ </label>
+
+
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
+ </label>
+
+
+</form>
+
+
+
+ <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.get [...]
+
+
+
+
+
+ <label class="md-header__button md-icon" for="__search">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+ </label>
+ <div class="md-search" data-md-component="search" role="dialog">
+ <label class="md-search__overlay" for="__search"></label>
+ <div class="md-search__inner" role="search">
+ <form class="md-search__form" name="search">
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+ <label class="md-search__icon md-icon" for="__search">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
+ </label>
+ <nav class="md-search__options" aria-label="Search">
+
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
+ </button>
+ </nav>
+
+ </form>
+ <div class="md-search__output">
+ <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
+ <div class="md-search-result" data-md-component="search-result">
+ <div class="md-search-result__meta">
+ Initializing search
+ </div>
+ <ol class="md-search-result__list" role="presentation"></ol>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+
+ <div class="md-header__source">
+ <a href="https://github.com/apache/iceberg-python" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v [...]
+ </div>
+ <div class="md-source__repository">
+ apache/iceberg-python
+ </div>
+</a>
+ </div>
+
+ </nav>
+
+
+
+<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
+ <div class="md-grid">
+ <ul class="md-tabs__list">
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href=".." class="md-tabs__link">
+
+
+
+
+
+ Getting started
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../configuration/" class="md-tabs__link">
+
+
+
+
+
+ Configuration
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../cli/" class="md-tabs__link">
+
+
+
+
+
+ CLI
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../api/" class="md-tabs__link">
+
+
+
+
+
+ API
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../contributing/" class="md-tabs__link">
+
+
+
+
+
+ Contributing
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../community/" class="md-tabs__link">
+
+
+
+
+
+ Community
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../verify-release/" class="md-tabs__link">
+
+
+
+ Releases
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../reference/pyiceberg/" class="md-tabs__link">
+
+
+
+ Code Reference
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </div>
+</nav>
+
+
+</header>
+
+ <div class="md-container" data-md-component="container">
+
+
+
+
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
+
+
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+
+
+
+
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href=".." title="PyIceberg" class="md-nav__button md-logo" aria-label="PyIceberg" data-md-component="logo">
+
+ <img src="../assets/images/iceberg-logo-icon.png" alt="logo">
+
+ </a>
+ PyIceberg
+ </label>
+
+ <div class="md-nav__source">
+ <a href="https://github.com/apache/iceberg-python" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v [...]
+ </div>
+ <div class="md-source__repository">
+ apache/iceberg-python
+ </div>
+</a>
+ </div>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href=".." class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Getting started
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../configuration/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Configuration
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../cli/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ CLI
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../api/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ API
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../row-filter-syntax/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Row Filter Syntax
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../expression-dsl/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Expression DSL
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../contributing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Contributing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../community/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Community
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+
+
+ <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
+
+
+
+ <span class="md-ellipsis">
+ Releases
+
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_7">
+ <span class="md-nav__icon md-icon"></span>
+ Releases
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../verify-release/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Verify a release
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../how-to-release/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ How to release
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="https://github.com/apache/iceberg-python/releases" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Release Notes
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../nightly-build/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Nightly Build
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
+
+
+ <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
+
+
+
+ <span class="md-ellipsis">
+ Code Reference
+
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8">
+ <span class="md-nav__icon md-icon"></span>
+ Code Reference
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ pyiceberg
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1" id="__nav_8_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1">
+ <span class="md-nav__icon md-icon"></span>
+ pyiceberg
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/avro/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ avro
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_1" id="__nav_8_1_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_1">
+ <span class="md-nav__icon md-icon"></span>
+ avro
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_1_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/avro/codecs/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ codecs
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_1_1" id="__nav_8_1_1_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_1_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_1_1">
+ <span class="md-nav__icon md-icon"></span>
+ codecs
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/bzip2/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bzip2
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/deflate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ deflate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/snappy_codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snappy_codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/zstandard_codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ zstandard_codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/decoder/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ decoder
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/encoder/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ encoder
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/file/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ file
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/reader/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ reader
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/resolver/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ resolver
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/writer/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ writer
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_2" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/catalog/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ catalog
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_2" id="__nav_8_1_2_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_2_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_2">
+ <span class="md-nav__icon md-icon"></span>
+ catalog
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/bigquery_metastore/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bigquery_metastore
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/dynamodb/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ dynamodb
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/glue/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ glue
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/hive/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ hive
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/memory/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ memory
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/noop/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ noop
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_2_7" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/catalog/rest/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ rest
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_2_7" id="__nav_8_1_2_7_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_2_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_2_7">
+ <span class="md-nav__icon md-icon"></span>
+ rest
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/rest/auth/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ auth
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/rest/response/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ response
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/sql/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ sql
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_3" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/cli/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ cli
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_3" id="__nav_8_1_3_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_3_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_3">
+ <span class="md-nav__icon md-icon"></span>
+ cli
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/cli/console/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ console
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/cli/output/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ output
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/conversions/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ conversions
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/exceptions/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ exceptions
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_6" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/expressions/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ expressions
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_6" id="__nav_8_1_6_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_6">
+ <span class="md-nav__icon md-icon"></span>
+ expressions
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/expressions/literals/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ literals
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/expressions/parser/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ parser
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/expressions/visitors/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ visitors
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_7" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/io/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ io
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_7" id="__nav_8_1_7_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_7">
+ <span class="md-nav__icon md-icon"></span>
+ io
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/io/fsspec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ fsspec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/io/pyarrow/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ pyarrow
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/manifest/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ manifest
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/partitioning/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ partitioning
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/schema/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/serializers/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ serializers
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_12" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/table/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ table
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_12" id="__nav_8_1_12_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_12_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_12">
+ <span class="md-nav__icon md-icon"></span>
+ table
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/inspect/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ inspect
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/locations/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ locations
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/maintenance/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ maintenance
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/metadata/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ metadata
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/name_mapping/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ name_mapping
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/puffin/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ puffin
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/refs/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ refs
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/snapshots/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snapshots
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/sorting/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ sorting
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/statistics/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ statistics
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_12_11" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/table/update/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ update
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_12_11" id="__nav_8_1_12_11_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_12_11_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_12_11">
+ <span class="md-nav__icon md-icon"></span>
+ update
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/schema/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/snapshot/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snapshot
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/spec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ spec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/statistics/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ statistics
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/validate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ validate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/upsert_util/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ upsert_util
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/transforms/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ transforms
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/typedef/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ typedef
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/types/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ types
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_16" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/utils/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ utils
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_16" id="__nav_8_1_16_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_16_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_16">
+ <span class="md-nav__icon md-icon"></span>
+ utils
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/bin_packing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bin_packing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/concurrent/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ concurrent
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/config/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ config
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/datetime/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ datetime
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/decimal/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ decimal
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/deprecated/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ deprecated
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/lazydict/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ lazydict
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/parsing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ parsing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/properties/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ properties
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/schema_conversion/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema_conversion
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/singleton/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ singleton
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/truncate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ truncate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+ </ul>
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+
+
+
+
+
+
+
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+<!-- prettier-ignore-start -->
+
+<!-- markdown-link-check-disable -->
+<h1 id="summary">Summary<a class="headerlink" href="#summary" title="Permanent link">¶</a></h1>
+<ul>
+<li><a href="../">Getting started</a></li>
+<li><a href="../configuration/">Configuration</a></li>
+<li><a href="../cli/">CLI</a></li>
+<li><a href="../api/">API</a><ul>
+<li><a href="../row-filter-syntax/">Row Filter Syntax</a></li>
+<li><a href="../expression-dsl/">Expression DSL</a></li>
+</ul>
+</li>
+<li><a href="../contributing/">Contributing</a></li>
+<li><a href="../community/">Community</a></li>
+<li>Releases<ul>
+<li><a href="../verify-release/">Verify a release</a></li>
+<li><a href="../how-to-release/">How to release</a></li>
+<li><a href="https://github.com/apache/iceberg-python/releases">Release Notes</a></li>
+<li><a href="../nightly-build/">Nightly Build</a></li>
+</ul>
+</li>
+<li><a href="reference/">Code Reference</a></li>
+</ul>
+<!-- markdown-link-check-enable-->
+
+<!-- prettier-ignore-end -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </article>
+ </div>
+
+
+<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
+ </div>
+
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
+ Back to top
+</button>
+
+ </main>
+
+ <footer class="md-footer">
+
+ <div class="md-footer-meta md-typeset">
+ <div class="md-footer-meta__inner md-grid">
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
+
+ </div>
+ </div>
+</footer>
+
+ </div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
+
+
+
+
+ <script id="__config" type="application/json">{"base": "..", "features": ["navigation.top", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No [...]
+
+
+ <script src="../assets/javascripts/bundle.92b07e13.min.js"></script>
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/api/index.html b/api/index.html
new file mode 100644
index 00000000..0b73585a
--- /dev/null
+++ b/api/index.html
@@ -0,0 +1,5131 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+ <link rel="canonical" href="https://py.iceberg.apache.org/api/">
+
+
+ <link rel="prev" href="../cli/">
+
+
+ <link rel="next" href="../row-filter-syntax/">
+
+
+ <link rel="icon" href="../assets/images/iceberg-logo-icon.png">
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.18">
+
+
+
+ <title>API - PyIceberg</title>
+
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/main.7e37652d.min.css">
+
+
+ <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Lato";--md-code-font:"Roboto Mono"}</style>
+
+
+
+ <link rel="stylesheet" href="../assets/_mkdocstrings.css">
+
+ <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+
+
+
+
+
+
+ </head>
+
+
+
+
+
+
+
+
+
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
+
+
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+ <label class="md-overlay" for="__drawer"></label>
+ <div data-md-component="skip">
+
+
+ <a href="#python-api" class="md-skip">
+ Skip to content
+ </a>
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+
+
+<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href=".." title="PyIceberg" class="md-header__button md-logo" aria-label="PyIceberg" data-md-component="logo">
+
+ <img src="../assets/images/iceberg-logo-icon.png" alt="logo">
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis">
+ PyIceberg
+ </span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ API
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+ <form class="md-header__option" data-md-component="palette">
+
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
+
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
+ </label>
+
+
+
+
+
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
+
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
+ </label>
+
+
+</form>
+
+
+
+ <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.get [...]
+
+
+
+
+
+ <label class="md-header__button md-icon" for="__search">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+ </label>
+ <div class="md-search" data-md-component="search" role="dialog">
+ <label class="md-search__overlay" for="__search"></label>
+ <div class="md-search__inner" role="search">
+ <form class="md-search__form" name="search">
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
+ <label class="md-search__icon md-icon" for="__search">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
+ </label>
+ <nav class="md-search__options" aria-label="Search">
+
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
+ </button>
+ </nav>
+
+ </form>
+ <div class="md-search__output">
+ <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
+ <div class="md-search-result" data-md-component="search-result">
+ <div class="md-search-result__meta">
+ Initializing search
+ </div>
+ <ol class="md-search-result__list" role="presentation"></ol>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+
+ <div class="md-header__source">
+ <a href="https://github.com/apache/iceberg-python" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v [...]
+ </div>
+ <div class="md-source__repository">
+ apache/iceberg-python
+ </div>
+</a>
+ </div>
+
+ </nav>
+
+
+
+<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
+ <div class="md-grid">
+ <ul class="md-tabs__list">
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href=".." class="md-tabs__link">
+
+
+
+
+
+ Getting started
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../configuration/" class="md-tabs__link">
+
+
+
+
+
+ Configuration
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../cli/" class="md-tabs__link">
+
+
+
+
+
+ CLI
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item md-tabs__item--active">
+ <a href="./" class="md-tabs__link">
+
+
+
+
+
+ API
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../contributing/" class="md-tabs__link">
+
+
+
+
+
+ Contributing
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../community/" class="md-tabs__link">
+
+
+
+
+
+ Community
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../verify-release/" class="md-tabs__link">
+
+
+
+ Releases
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-tabs__item">
+ <a href="../reference/pyiceberg/" class="md-tabs__link">
+
+
+
+ Code Reference
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </div>
+</nav>
+
+
+</header>
+
+ <div class="md-container" data-md-component="container">
+
+
+
+
+ <main class="md-main" data-md-component="main">
+ <div class="md-main__inner md-grid">
+
+
+
+
+
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" hidden>
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+
+
+
+
+<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href=".." title="PyIceberg" class="md-nav__button md-logo" aria-label="PyIceberg" data-md-component="logo">
+
+ <img src="../assets/images/iceberg-logo-icon.png" alt="logo">
+
+ </a>
+ PyIceberg
+ </label>
+
+ <div class="md-nav__source">
+ <a href="https://github.com/apache/iceberg-python" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v [...]
+ </div>
+ <div class="md-source__repository">
+ apache/iceberg-python
+ </div>
+</a>
+ </div>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href=".." class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Getting started
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../configuration/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Configuration
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../cli/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ CLI
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="./" class="md-nav__link md-nav__link--active">
+
+
+
+ <span class="md-ellipsis">
+ API
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link md-nav__link--active" for="__nav_4" id="__nav_4_label" tabindex="">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+ <label class="md-nav__title" for="__nav_4">
+ <span class="md-nav__icon md-icon"></span>
+ API
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../row-filter-syntax/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Row Filter Syntax
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../expression-dsl/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Expression DSL
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../contributing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Contributing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../community/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Community
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+
+
+ <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
+
+
+
+ <span class="md-ellipsis">
+ Releases
+
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_7">
+ <span class="md-nav__icon md-icon"></span>
+ Releases
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../verify-release/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Verify a release
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../how-to-release/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ How to release
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="https://github.com/apache/iceberg-python/releases" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Release Notes
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../nightly-build/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ Nightly Build
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
+
+
+ <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
+
+
+
+ <span class="md-ellipsis">
+ Code Reference
+
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8">
+ <span class="md-nav__icon md-icon"></span>
+ Code Reference
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ pyiceberg
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1" id="__nav_8_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_8_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1">
+ <span class="md-nav__icon md-icon"></span>
+ pyiceberg
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/avro/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ avro
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_1" id="__nav_8_1_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_1">
+ <span class="md-nav__icon md-icon"></span>
+ avro
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_1_1" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/avro/codecs/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ codecs
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_1_1" id="__nav_8_1_1_1_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_1_1_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_1_1">
+ <span class="md-nav__icon md-icon"></span>
+ codecs
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/bzip2/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bzip2
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/deflate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ deflate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/snappy_codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snappy_codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/codecs/zstandard_codec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ zstandard_codec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/decoder/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ decoder
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/encoder/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ encoder
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/file/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ file
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/reader/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ reader
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/resolver/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ resolver
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/avro/writer/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ writer
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_2" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/catalog/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ catalog
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_2" id="__nav_8_1_2_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_2_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_2">
+ <span class="md-nav__icon md-icon"></span>
+ catalog
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/bigquery_metastore/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bigquery_metastore
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/dynamodb/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ dynamodb
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/glue/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ glue
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/hive/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ hive
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/memory/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ memory
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/noop/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ noop
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_2_7" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/catalog/rest/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ rest
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_2_7" id="__nav_8_1_2_7_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_2_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_2_7">
+ <span class="md-nav__icon md-icon"></span>
+ rest
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/rest/auth/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ auth
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/rest/response/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ response
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/catalog/sql/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ sql
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_3" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/cli/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ cli
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_3" id="__nav_8_1_3_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_3_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_3">
+ <span class="md-nav__icon md-icon"></span>
+ cli
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/cli/console/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ console
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/cli/output/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ output
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/conversions/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ conversions
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/exceptions/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ exceptions
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_6" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/expressions/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ expressions
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_6" id="__nav_8_1_6_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_6">
+ <span class="md-nav__icon md-icon"></span>
+ expressions
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/expressions/literals/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ literals
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/expressions/parser/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ parser
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/expressions/visitors/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ visitors
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_7" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/io/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ io
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_7" id="__nav_8_1_7_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_7">
+ <span class="md-nav__icon md-icon"></span>
+ io
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/io/fsspec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ fsspec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/io/pyarrow/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ pyarrow
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/manifest/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ manifest
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/partitioning/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ partitioning
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/schema/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/serializers/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ serializers
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_12" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/table/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ table
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_12" id="__nav_8_1_12_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_12_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_12">
+ <span class="md-nav__icon md-icon"></span>
+ table
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/inspect/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ inspect
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/locations/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ locations
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/maintenance/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ maintenance
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/metadata/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ metadata
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/name_mapping/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ name_mapping
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/puffin/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ puffin
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/refs/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ refs
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/snapshots/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snapshots
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/sorting/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ sorting
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/statistics/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ statistics
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_12_11" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/table/update/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ update
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_12_11" id="__nav_8_1_12_11_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_8_1_12_11_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_12_11">
+ <span class="md-nav__icon md-icon"></span>
+ update
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/schema/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/snapshot/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ snapshot
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/spec/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ spec
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/statistics/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ statistics
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/update/validate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ validate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/table/upsert_util/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ upsert_util
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/transforms/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ transforms
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/typedef/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ typedef
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/types/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ types
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_16" >
+
+
+ <div class="md-nav__link md-nav__container">
+ <a href="../reference/pyiceberg/utils/" class="md-nav__link ">
+
+
+
+ <span class="md-ellipsis">
+ utils
+
+ </span>
+
+
+ </a>
+
+
+ <label class="md-nav__link " for="__nav_8_1_16" id="__nav_8_1_16_label" tabindex="0">
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ </div>
+
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_16_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_8_1_16">
+ <span class="md-nav__icon md-icon"></span>
+ utils
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/bin_packing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ bin_packing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/concurrent/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ concurrent
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/config/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ config
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/datetime/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ datetime
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/decimal/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ decimal
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/deprecated/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ deprecated
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/lazydict/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ lazydict
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/parsing/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ parsing
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/properties/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ properties
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/schema_conversion/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ schema_conversion
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/singleton/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ singleton
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../reference/pyiceberg/utils/truncate/" class="md-nav__link">
+
+
+
+ <span class="md-ellipsis">
+ truncate
+
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+ </ul>
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#create-a-table" class="md-nav__link">
+ <span class="md-ellipsis">
+ Create a table
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#load-a-table" class="md-nav__link">
+ <span class="md-ellipsis">
+ Load a table
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Load a table">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#catalog-table" class="md-nav__link">
+ <span class="md-ellipsis">
+ Catalog table
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#static-table" class="md-nav__link">
+ <span class="md-ellipsis">
+ Static table
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#check-if-a-table-exists" class="md-nav__link">
+ <span class="md-ellipsis">
+ Check if a table exists
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#write-to-a-table" class="md-nav__link">
+ <span class="md-ellipsis">
+ Write to a table
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Write to a table">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#partial-overwrites" class="md-nav__link">
+ <span class="md-ellipsis">
+ Partial overwrites
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#upsert" class="md-nav__link">
+ <span class="md-ellipsis">
+ Upsert
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#inspecting-tables" class="md-nav__link">
+ <span class="md-ellipsis">
+ Inspecting tables
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Inspecting tables">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#snapshots" class="md-nav__link">
+ <span class="md-ellipsis">
+ Snapshots
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#partitions" class="md-nav__link">
+ <span class="md-ellipsis">
+ Partitions
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#entries" class="md-nav__link">
+ <span class="md-ellipsis">
+ Entries
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#references" class="md-nav__link">
+ <span class="md-ellipsis">
+ References
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#manifests" class="md-nav__link">
+ <span class="md-ellipsis">
+ Manifests
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#metadata-log-entries" class="md-nav__link">
+ <span class="md-ellipsis">
+ Metadata Log Entries
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#history" class="md-nav__link">
+ <span class="md-ellipsis">
+ History
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#files" class="md-nav__link">
+ <span class="md-ellipsis">
+ Files
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#add-files" class="md-nav__link">
+ <span class="md-ellipsis">
+ Add Files
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Add Files">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#usage" class="md-nav__link">
+ <span class="md-ellipsis">
+ Usage
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#example" class="md-nav__link">
+ <span class="md-ellipsis">
+ Example
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#schema-evolution" class="md-nav__link">
+ <span class="md-ellipsis">
+ Schema evolution
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Schema evolution">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#union-by-name" class="md-nav__link">
+ <span class="md-ellipsis">
+ Union by Name
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#add-column" class="md-nav__link">
+ <span class="md-ellipsis">
+ Add column
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#rename-column" class="md-nav__link">
+ <span class="md-ellipsis">
+ Rename column
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#move-column" class="md-nav__link">
+ <span class="md-ellipsis">
+ Move column
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#update-column" class="md-nav__link">
+ <span class="md-ellipsis">
+ Update column
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#delete-column" class="md-nav__link">
+ <span class="md-ellipsis">
+ Delete column
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#partition-evolution" class="md-nav__link">
+ <span class="md-ellipsis">
+ Partition evolution
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Partition evolution">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#add-fields" class="md-nav__link">
+ <span class="md-ellipsis">
+ Add fields
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#remove-fields" class="md-nav__link">
+ <span class="md-ellipsis">
+ Remove fields
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#rename-fields" class="md-nav__link">
+ <span class="md-ellipsis">
+ Rename fields
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#table-properties" class="md-nav__link">
+ <span class="md-ellipsis">
+ Table properties
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#snapshot-properties" class="md-nav__link">
+ <span class="md-ellipsis">
+ Snapshot properties
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#snapshot-management" class="md-nav__link">
+ <span class="md-ellipsis">
+ Snapshot Management
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#table-maintenance" class="md-nav__link">
+ <span class="md-ellipsis">
+ Table Maintenance
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Table Maintenance">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#snapshot-expiration" class="md-nav__link">
+ <span class="md-ellipsis">
+ Snapshot Expiration
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Snapshot Expiration">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#real-world-example" class="md-nav__link">
+ <span class="md-ellipsis">
+ Real-world Example
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#views" class="md-nav__link">
+ <span class="md-ellipsis">
+ Views
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Views">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#check-if-a-view-exists" class="md-nav__link">
+ <span class="md-ellipsis">
+ Check if a view exists
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#table-statistics-management" class="md-nav__link">
+ <span class="md-ellipsis">
+ Table Statistics Management
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#query-the-data" class="md-nav__link">
+ <span class="md-ellipsis">
+ Query the data
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Query the data">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#apache-arrow" class="md-nav__link">
+ <span class="md-ellipsis">
+ Apache Arrow
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#pandas" class="md-nav__link">
+ <span class="md-ellipsis">
+ Pandas
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#duckdb" class="md-nav__link">
+ <span class="md-ellipsis">
+ DuckDB
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#ray" class="md-nav__link">
+ <span class="md-ellipsis">
+ Ray
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#bodo" class="md-nav__link">
+ <span class="md-ellipsis">
+ Bodo
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#daft" class="md-nav__link">
+ <span class="md-ellipsis">
+ Daft
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#polars" class="md-nav__link">
+ <span class="md-ellipsis">
+ Polars
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="Polars">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#working-with-polars-dataframe" class="md-nav__link">
+ <span class="md-ellipsis">
+ Working with Polars DataFrame
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#working-with-polars-lazyframe" class="md-nav__link">
+ <span class="md-ellipsis">
+ Working with Polars LazyFrame
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#apache-datafusion" class="md-nav__link">
+ <span class="md-ellipsis">
+ Apache DataFusion
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+
+
+
+
+
+
+
+
+
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one
+ - or more contributor license agreements. See the NOTICE file
+ - distributed with this work for additional information
+ - regarding copyright ownership. The ASF licenses this file
+ - to you under the Apache License, Version 2.0 (the
+ - "License"); you may not use this file except in compliance
+ - with the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing,
+ - software distributed under the License is distributed on an
+ - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ - KIND, either express or implied. See the License for the
+ - specific language governing permissions and limitations
+ - under the License.
+ -->
+
+<h1 id="python-api">Python API<a class="headerlink" href="#python-api" title="Permanent link">¶</a></h1>
+<p>(Py)Iceberg is <a href="https://iceberg.apache.org/terms/#catalog">catalog</a> centric. Meaning that reading/writing data goes via a catalog. First step is to instantiate a catalog to load a table. Let's use the following configuration in <code>.pyiceberg.yaml</code> to define a REST catalog called <code>prod</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">catalog</span><span class="p">:</span>
+<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">prod</span><span class="p">:</span>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">uri</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://rest-catalog/ws/</span>
+<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">credential</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">t-1234:secret</span>
+</code></pre></div>
+<p>Note that multiple catalogs can be defined in the same <code>.pyiceberg.yaml</code>, for example, in the case of a Hive and REST catalog:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">catalog</span><span class="p">:</span>
+<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt">hive</span><span class="p">:</span>
+<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">uri</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">thrift://127.0.0.1:9083</span>
+<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">s3.endpoint</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://127.0.0.1:9000</span>
+<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">s3.access-key-id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">admin</span>
+<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">s3.secret-access-key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">password</span>
+<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">rest</span><span class="p">:</span>
+<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nt">uri</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://rest-server:8181/</span>
+<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="nt">warehouse</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-warehouse</span>
+</code></pre></div>
+<p>The different catalogs can be loaded in PyIceberg by their name: <code>load_catalog(name="hive")</code> and <code>load_catalog(name="rest")</code>. An overview of the configuration options can be found on the <a href="https://py.iceberg.apache.org/configuration/">configuration page</a>.</p>
+<p>This information must be placed inside a file called <code>.pyiceberg.yaml</code> located either in the <code>$HOME</code> or <code>%USERPROFILE%</code> directory (depending on whether the operating system is Unix-based or Windows-based, respectively), in the current working directory, or in the <code>$PYICEBERG_HOME</code> directory (if the corresponding environment variable is set).</p>
+<p>It is also possible to load a catalog without using a <code>.pyiceberg.yaml</code> by passing in the properties directly:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.catalog</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_catalog</span>
+<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>
+<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="n">catalog</span> <span class="o">=</span> <span class="n">load_catalog</span><span class="p">(</span>
+<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a> <span class="s2">"docs"</span><span class="p">,</span>
+<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a> <span class="o">**</span><span class="p">{</span>
+<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a> <span class="s2">"uri"</span><span class="p">:</span> <span class="s2">"http://127.0.0.1:8181"</span><span class="p">,</span>
+<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a> <span class="s2">"s3.endpoint"</span><span class="p">:</span> <span class="s2">"http://127.0.0.1:9000"</span><span class="p">,</span>
+<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a> <span class="s2">"py-io-impl"</span><span class="p">:</span> <span class="s2">"pyiceberg.io.pyarrow.PyArrowFileIO"</span><span class="p">,</span>
+<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a> <span class="s2">"s3.access-key-id"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
+<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a> <span class="s2">"s3.secret-access-key"</span><span class="p">:</span> <span class="s2">"password"</span><span class="p">,</span>
+<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a> <span class="p">}</span>
+<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="p">)</span>
+</code></pre></div>
+<p>Next, create a namespace:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">catalog</span><span class="o">.</span><span class="n">create_namespace</span><span class="p">(</span><span class="s2">"docs_example"</span><span class="p">)</span>
+</code></pre></div>
+<p>Or, list existing namespaces:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">ns</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="n">list_namespaces</span><span class="p">()</span>
+<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>
+<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="k">assert</span> <span class="n">ns</span> <span class="o">==</span> <span class="p">[(</span><span class="s2">"docs_example"</span><span class="p">,)]</span>
+</code></pre></div>
+<h2 id="create-a-table">Create a table<a class="headerlink" href="#create-a-table" title="Permanent link">¶</a></h2>
+<p>To create a table from a catalog:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.schema</span><span class="w"> </span><span class="kn">import</span> <span class="n">Schema</span>
+<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.types</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
+<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a> <span class="n">TimestampType</span><span class="p">,</span>
+<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a> <span class="n">FloatType</span><span class="p">,</span>
+<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a> <span class="n">DoubleType</span><span class="p">,</span>
+<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a> <span class="n">StringType</span><span class="p">,</span>
+<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a> <span class="n">NestedField</span><span class="p">,</span>
+<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a> <span class="n">StructType</span><span class="p">,</span>
+<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a><span class="p">)</span>
+<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a>
+<a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a><span class="n">schema</span> <span class="o">=</span> <span class="n">Schema</span><span class="p">(</span>
+<a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a> <span class="n">NestedField</span><span class="p">(</span><span class="n">field_id</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"datetime"</span><span class="p">,</span> <span class="n">field_type</span><span class="o">=</span><span class="n">TimestampType</span><span class="p">(),</span> <spa [...]
+<a id="__codelineno-5-13" name="__codelineno-5-13" href="#__codelineno-5-13"></a> <span class="n">NestedField</span><span class="p">(</span><span class="n">field_id</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"symbol"</span><span class="p">,</span> <span class="n">field_type</span><span class="o">=</span><span class="n">StringType</span><span class="p">(),</span> <span cla [...]
+<a id="__codelineno-5-14" name="__codelineno-5-14" href="#__codelineno-5-14"></a> <span class="n">NestedField</span><span class="p">(</span><span class="n">field_id</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"bid"</span><span class="p">,</span> <span class="n">field_type</span><span class="o">=</span><span class="n">FloatType</span><span class="p">(),</span> <span class=" [...]
+<a id="__codelineno-5-15" name="__codelineno-5-15" href="#__codelineno-5-15"></a> <span class="n">NestedField</span><span class="p">(</span><span class="n">field_id</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"ask"</span><span class="p">,</span> <span class="n">field_type</span><span class="o">=</span><span class="n">DoubleType</span><span class="p">(),</span> <span class= [...]
+<a id="__codelineno-5-16" name="__codelineno-5-16" href="#__codelineno-5-16"></a> <span class="n">NestedField</span><span class="p">(</span>
+<a id="__codelineno-5-17" name="__codelineno-5-17" href="#__codelineno-5-17"></a> <span class="n">field_id</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span>
+<a id="__codelineno-5-18" name="__codelineno-5-18" href="#__codelineno-5-18"></a> <span class="n">name</span><span class="o">=</span><span class="s2">"details"</span><span class="p">,</span>
+<a id="__codelineno-5-19" name="__codelineno-5-19" href="#__codelineno-5-19"></a> <span class="n">field_type</span><span class="o">=</span><span class="n">StructType</span><span class="p">(</span>
+<a id="__codelineno-5-20" name="__codelineno-5-20" href="#__codelineno-5-20"></a> <span class="n">NestedField</span><span class="p">(</span>
+<a id="__codelineno-5-21" name="__codelineno-5-21" href="#__codelineno-5-21"></a> <span class="n">field_id</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">"created_by"</span><span class="p">,</span> <span class="n">field_type</span><span class="o">=</span><span class="n">StringType</span><span class="p">(),</span> <span class="n">required</span><span class="o">=</s [...]
+<a id="__codelineno-5-22" name="__codelineno-5-22" href="#__codelineno-5-22"></a> <span class="p">),</span>
+<a id="__codelineno-5-23" name="__codelineno-5-23" href="#__codelineno-5-23"></a> <span class="p">),</span>
+<a id="__codelineno-5-24" name="__codelineno-5-24" href="#__codelineno-5-24"></a> <span class="n">required</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+<a id="__codelineno-5-25" name="__codelineno-5-25" href="#__codelineno-5-25"></a> <span class="p">),</span>
+<a id="__codelineno-5-26" name="__codelineno-5-26" href="#__codelineno-5-26"></a><span class="p">)</span>
+<a id="__codelineno-5-27" name="__codelineno-5-27" href="#__codelineno-5-27"></a>
+<a id="__codelineno-5-28" name="__codelineno-5-28" href="#__codelineno-5-28"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.partitioning</span><span class="w"> </span><span class="kn">import</span> <span class="n">PartitionSpec</span><span class="p">,</span> <span class="n">PartitionField</span>
+<a id="__codelineno-5-29" name="__codelineno-5-29" href="#__codelineno-5-29"></a>
+<a id="__codelineno-5-30" name="__codelineno-5-30" href="#__codelineno-5-30"></a><span class="n">partition_spec</span> <span class="o">=</span> <span class="n">PartitionSpec</span><span class="p">(</span>
+<a id="__codelineno-5-31" name="__codelineno-5-31" href="#__codelineno-5-31"></a> <span class="n">PartitionField</span><span class="p">(</span>
+<a id="__codelineno-5-32" name="__codelineno-5-32" href="#__codelineno-5-32"></a> <span class="n">source_id</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">field_id</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="s2">"day"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">& [...]
+<a id="__codelineno-5-33" name="__codelineno-5-33" href="#__codelineno-5-33"></a> <span class="p">)</span>
+<a id="__codelineno-5-34" name="__codelineno-5-34" href="#__codelineno-5-34"></a><span class="p">)</span>
+<a id="__codelineno-5-35" name="__codelineno-5-35" href="#__codelineno-5-35"></a>
+<a id="__codelineno-5-36" name="__codelineno-5-36" href="#__codelineno-5-36"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.table.sorting</span><span class="w"> </span><span class="kn">import</span> <span class="n">SortOrder</span><span class="p">,</span> <span class="n">SortField</span>
+<a id="__codelineno-5-37" name="__codelineno-5-37" href="#__codelineno-5-37"></a>
+<a id="__codelineno-5-38" name="__codelineno-5-38" href="#__codelineno-5-38"></a><span class="c1"># Sort on the symbol</span>
+<a id="__codelineno-5-39" name="__codelineno-5-39" href="#__codelineno-5-39"></a><span class="n">sort_order</span> <span class="o">=</span> <span class="n">SortOrder</span><span class="p">(</span><span class="n">SortField</span><span class="p">(</span><span class="n">source_id</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">transform</span><span class="o">=</span><span class="s1">'identity'</span><span class="p">))</span>
+<a id="__codelineno-5-40" name="__codelineno-5-40" href="#__codelineno-5-40"></a>
+<a id="__codelineno-5-41" name="__codelineno-5-41" href="#__codelineno-5-41"></a><span class="n">catalog</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span>
+<a id="__codelineno-5-42" name="__codelineno-5-42" href="#__codelineno-5-42"></a> <span class="n">identifier</span><span class="o">=</span><span class="s2">"docs_example.bids"</span><span class="p">,</span>
+<a id="__codelineno-5-43" name="__codelineno-5-43" href="#__codelineno-5-43"></a> <span class="n">schema</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span>
+<a id="__codelineno-5-44" name="__codelineno-5-44" href="#__codelineno-5-44"></a> <span class="n">partition_spec</span><span class="o">=</span><span class="n">partition_spec</span><span class="p">,</span>
+<a id="__codelineno-5-45" name="__codelineno-5-45" href="#__codelineno-5-45"></a> <span class="n">sort_order</span><span class="o">=</span><span class="n">sort_order</span><span class="p">,</span>
+<a id="__codelineno-5-46" name="__codelineno-5-46" href="#__codelineno-5-46"></a><span class="p">)</span>
+</code></pre></div>
+<p>When the table is created, all IDs in the schema are re-assigned to ensure uniqueness.</p>
+<p>To create a table using a pyarrow schema:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span>
+<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>
+<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="n">schema</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">schema</span><span class="p">([</span>
+<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a> <span class="n">pa</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="s2">"foo"</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">string</span><span class="p">(),</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span>
+<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a> <span class="n">pa</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="s2">"bar"</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">int32</span><span class="p">(),</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
+<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a> <span class="n">pa</span><span class="o">.</span><span class="n">field</span><span class="p">(</span><span class="s2">"baz"</span><span class="p">,</span> <span class="n">pa</span><span class="o">.</span><span class="n">bool_</span><span class="p">(),</span> <span class="n">nullable</span><span class="o">=</span><span class="kc">True</span><span class="p">),</span>
+<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="p">])</span>
+<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a>
+<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="n">catalog</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span>
+<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a> <span class="n">identifier</span><span class="o">=</span><span class="s2">"docs_example.bids"</span><span class="p">,</span>
+<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a> <span class="n">schema</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span>
+<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a><span class="p">)</span>
+</code></pre></div>
+<p>Another API to create a table is using the <code>create_table_transaction</code>. This follows the same APIs when making updates to a table. This is a friendly API for both setting the partition specification and sort-order, because you don't have to deal with field-IDs.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="k">with</span> <span class="n">catalog</span><span class="o">.</span><span class="n">create_table_transaction</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">"docs_example.bids"</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="n">schema</sp [...]
+<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a> <span class="k">with</span> <span class="n">txn</span><span class="o">.</span><span class="n">update_schema</span><span class="p">()</span> <span class="k">as</span> <span class="n">update_schema</span><span class="p">:</span>
+<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a> <span class="n">update_schema</span><span class="o">.</span><span class="n">add_column</span><span class="p">(</span><span class="n">path</span><span class="o">=</span><span class="s2">"new_column"</span><span class="p">,</span> <span class="n">field_type</span><span class="o">=</span><span class="s1">'string'</span><span class="p">)</span>
+<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>
+<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a> <span class="k">with</span> <span class="n">txn</span><span class="o">.</span><span class="n">update_spec</span><span class="p">()</span> <span class="k">as</span> <span class="n">update_spec</span><span class="p">:</span>
+<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a> <span class="n">update_spec</span><span class="o">.</span><span class="n">add_identity</span><span class="p">(</span><span class="s2">"symbol"</span><span class="p">)</span>
+<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>
+<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a> <span class="n">txn</span><span class="o">.</span><span class="n">set_properties</span><span class="p">(</span><span class="n">test_a</span><span class="o">=</span><span class="s2">"test_aa"</span><span class="p">,</span> <span class="n">test_b</span><span class="o">=</span><span class="s2">"test_b"</span><span class="p">,</span> <span class="n">test_c</span><span class="o">=</span><span [...]
+</code></pre></div>
+<h2 id="load-a-table">Load a table<a class="headerlink" href="#load-a-table" title="Permanent link">¶</a></h2>
+<p>There are two ways of reading an Iceberg table; through a catalog, and by pointing at the Iceberg metadata directly. Reading through a catalog is preferred, and directly pointing at the metadata is read-only.</p>
+<h3 id="catalog-table">Catalog table<a class="headerlink" href="#catalog-table" title="Permanent link">¶</a></h3>
+<p>Loading the <code>bids</code> table:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="n">table</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="n">load_table</span><span class="p">(</span><span class="s2">"docs_example.bids"</span><span class="p">)</span>
+<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="c1"># Equivalent to:</span>
+<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="n">table</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="n">load_table</span><span class="p">((</span><span class="s2">"docs_example"</span><span class="p">,</span> <span class="s2">"bids"</span><span class="p">))</span>
+<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="c1"># The tuple syntax can be used if the namespace or table contains a dot.</span>
+</code></pre></div>
+<p>This returns a <code>Table</code> that represents an Iceberg table that can be queried and altered.</p>
+<h3 id="static-table">Static table<a class="headerlink" href="#static-table" title="Permanent link">¶</a></h3>
+<p>To load a table directly from a <code>metadata.json</code> file (i.e., <strong>without</strong> using a catalog), you can use a <code>StaticTable</code> as follows:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.table</span><span class="w"> </span><span class="kn">import</span> <span class="n">StaticTable</span>
+<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>
+<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="n">static_table</span> <span class="o">=</span> <span class="n">StaticTable</span><span class="o">.</span><span class="n">from_metadata</span><span class="p">(</span>
+<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a> <span class="s2">"s3://warehouse/wh/nyc.db/taxis/metadata/00002-6ea51ce3-62aa-4197-9cf8-43d07c3440ca.metadata.json"</span>
+<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="p">)</span>
+</code></pre></div>
+<p>The static-table does not allow for write operations. If your table metadata directory contains a <code>version-hint.text</code> file, you can just specify the table root path, and the latest <code>metadata.json</code> file will be resolved automatically:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.table</span><span class="w"> </span><span class="kn">import</span> <span class="n">StaticTable</span>
+<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>
+<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="n">static_table</span> <span class="o">=</span> <span class="n">StaticTable</span><span class="o">.</span><span class="n">from_metadata</span><span class="p">(</span>
+<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a> <span class="s2">"s3://warehouse/wh/nyc.db/taxis"</span>
+<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="p">)</span>
+</code></pre></div>
+<h2 id="check-if-a-table-exists">Check if a table exists<a class="headerlink" href="#check-if-a-table-exists" title="Permanent link">¶</a></h2>
+<p>To check whether the <code>bids</code> table exists:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="n">catalog</span><span class="o">.</span><span class="n">table_exists</span><span class="p">(</span><span class="s2">"docs_example.bids"</span><span class="p">)</span>
+</code></pre></div>
+<p>Returns <code>True</code> if the table already exists.</p>
+<h2 id="write-to-a-table">Write to a table<a class="headerlink" href="#write-to-a-table" title="Permanent link">¶</a></h2>
+<p>Reading and writing is being done using <a href="https://arrow.apache.org/">Apache Arrow</a>. Arrow is an in-memory columnar format for fast data interchange and in-memory analytics. Let's consider the following Arrow Table:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span>
+<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a>
+<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="n">df</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pylist</span><span class="p">(</span>
+<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a> <span class="p">[</span>
+<a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Amsterdam"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">52.371807</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">4.896029</span><span class="p">},</span>
+<a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">37.773972</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.431297</ [...]
+<a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Drachten"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">53.11254</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">6.0989</span><span class="p">},</span>
+<a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Paris"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">48.864716</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">2.349014</span><span class="p">},</span>
+<a id="__codelineno-12-9" name="__codelineno-12-9" href="#__codelineno-12-9"></a> <span class="p">],</span>
+<a id="__codelineno-12-10" name="__codelineno-12-10" href="#__codelineno-12-10"></a><span class="p">)</span>
+</code></pre></div>
+<p>Next, create a table using the Arrow schema:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.catalog</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_catalog</span>
+<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>
+<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="n">catalog</span> <span class="o">=</span> <span class="n">load_catalog</span><span class="p">(</span><span class="s2">"default"</span><span class="p">)</span>
+<a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a>
+<a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="n">tbl</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span><span class="s2">"default.cities"</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="n">df</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span>
+</code></pre></div>
+<p>Next, write the data to the table. Both <code>append</code> and <code>overwrite</code> produce the same result, since the table is empty on creation:</p>
+<!-- prettier-ignore-start -->
+
+<div class="admonition note inline end">
+<p class="admonition-title">Fast append</p>
+<p>PyIceberg defaults to the <a href="https://iceberg.apache.org/spec/#snapshots">fast append</a> to minimize the amount of data written. This enables fast commit operations, reducing the possibility of conflicts. The downside of the fast append is that it creates more metadata than a merge commit. <a href="https://github.com/apache/iceberg-python/issues/270">Compaction is planned</a> and will automatically rewrite all the metadata when a threshold is hit, to maintain performant reads.</p>
+</div>
+<!-- prettier-ignore-end -->
+
+<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="n">tbl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
+<a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>
+<a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a><span class="c1"># or</span>
+<a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a>
+<a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a><span class="n">tbl</span><span class="o">.</span><span class="n">overwrite</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
+</code></pre></div>
+<p>Now, the data is written to the table, and the table can be read using <code>tbl.scan().to_arrow()</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="n">pyarrow</span><span class="o">.</span><span class="n">Table</span>
+<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="n">city</span><span class="p">:</span> <span class="n">string</span>
+<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="n">lat</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="n">long</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="o">----</span>
+<a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="n">city</span><span class="p">:</span> <span class="p">[[</span><span class="s2">"Amsterdam"</span><span class="p">,</span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="s2">"Drachten"</span><span class="p">,</span><span class="s2">"Paris"</span><span class="p">]]</span>
+<a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a><span class="n">lat</span><span class="p">:</span> <span class="p">[[</span><span class="mf">52.371807</span><span class="p">,</span><span class="mf">37.773972</span><span class="p">,</span><span class="mf">53.11254</span><span class="p">,</span><span class="mf">48.864716</span><span class="p">]]</span>
+<a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a><span class="n">long</span><span class="p">:</span> <span class="p">[[</span><span class="mf">4.896029</span><span class="p">,</span><span class="o">-</span><span class="mf">122.431297</span><span class="p">,</span><span class="mf">6.0989</span><span class="p">,</span><span class="mf">2.349014</span><span class="p">]]</span>
+</code></pre></div>
+<p>If we want to add more data, we can use <code>.append()</code> again:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="n">tbl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pylist</span><span class="p">(</span>
+<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a> <span class="p">[{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Groningen"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">53.21917</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">6.56667</span><span class="p">}],</span>
+<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="p">))</span>
+</code></pre></div>
+<p>When reading the table <code>tbl.scan().to_arrow()</code> you can see that <code>Groningen</code> is now also part of the table:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="n">pyarrow</span><span class="o">.</span><span class="n">Table</span>
+<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="n">city</span><span class="p">:</span> <span class="n">string</span>
+<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a><span class="n">lat</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="n">long</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="o">----</span>
+<a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a><span class="n">city</span><span class="p">:</span> <span class="p">[[</span><span class="s2">"Amsterdam"</span><span class="p">,</span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="s2">"Drachten"</span><span class="p">,</span><span class="s2">"Paris"</span><span class="p">],[</span><span class="s2">"Groningen"</span><span class= [...]
+<a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a><span class="n">lat</span><span class="p">:</span> <span class="p">[[</span><span class="mf">52.371807</span><span class="p">,</span><span class="mf">37.773972</span><span class="p">,</span><span class="mf">53.11254</span><span class="p">,</span><span class="mf">48.864716</span><span class="p">],[</span><span class="mf">53.21917</span><span class="p">]]</span>
+<a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a><span class="n">long</span><span class="p">:</span> <span class="p">[[</span><span class="mf">4.896029</span><span class="p">,</span><span class="o">-</span><span class="mf">122.431297</span><span class="p">,</span><span class="mf">6.0989</span><span class="p">,</span><span class="mf">2.349014</span><span class="p">],[</span><span class="mf">6.56667</span><span class="p">]]</span>
+</code></pre></div>
+<p>The nested lists indicate the different Arrow buffers. Each of the writes produce a <a href="https://parquet.apache.org/">Parquet file</a> where each <a href="https://parquet.apache.org/docs/concepts/">row group</a> translates into an Arrow buffer. In the case where the table is large, PyIceberg also allows the option to stream the buffers using the Arrow <a href="https://arrow.apache.org/docs/python/generated/pyarrow.RecordBatchReader.html">RecordBatchReader</a>, avoiding pulling eve [...]
+<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="k">for</span> <span class="n">buf</span> <span class="ow">in</span> <span class="n">tbl</span><span class="o">.</span><span class="n">scan</span><span class="p">()</span><span class="o">.</span><span class="n">to_arrow_batch_reader</span><span class="p">():</span>
+<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Buffer contains </span><span class="si">{</span><span class="nb">len</span><span class="p">(</span><span class="n">buf</span><span class="p">)</span><span class="si">}</span><span class="s2"> rows"</span><span class="p">)</span>
+</code></pre></div>
+<p>To avoid any type inconsistencies during writing, you can convert the Iceberg table schema to Arrow:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="n">df</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pylist</span><span class="p">(</span>
+<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a> <span class="p">[{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Groningen"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">53.21917</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">6.56667</span><span class="p">}],</span> <sp [...]
+<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a><span class="p">)</span>
+<a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a>
+<a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="n">tbl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
+</code></pre></div>
+<p>You can delete some of the data from the table by calling <code>tbl.delete()</code> with a desired <code>delete_filter</code>. This will use the Iceberg metadata to only open up the Parquet files that contain relevant information.</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="n">tbl</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">delete_filter</span><span class="o">=</span><span class="s2">"city == 'Paris'"</span><span class="p">)</span>
+</code></pre></div>
+<p>In the above example, any records where the city field value equals to <code>Paris</code> will be deleted. Running <code>tbl.scan().to_arrow()</code> will now yield:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="n">pyarrow</span><span class="o">.</span><span class="n">Table</span>
+<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="n">city</span><span class="p">:</span> <span class="n">string</span>
+<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a><span class="n">lat</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="n">long</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="o">----</span>
+<a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a><span class="n">city</span><span class="p">:</span> <span class="p">[[</span><span class="s2">"Amsterdam"</span><span class="p">,</span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="s2">"Drachten"</span><span class="p">],[</span><span class="s2">"Groningen"</span><span class="p">]]</span>
+<a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="n">lat</span><span class="p">:</span> <span class="p">[[</span><span class="mf">52.371807</span><span class="p">,</span><span class="mf">37.773972</span><span class="p">,</span><span class="mf">53.11254</span><span class="p">],[</span><span class="mf">53.21917</span><span class="p">]]</span>
+<a id="__codelineno-21-8" name="__codelineno-21-8" href="#__codelineno-21-8"></a><span class="n">long</span><span class="p">:</span> <span class="p">[[</span><span class="mf">4.896029</span><span class="p">,</span><span class="o">-</span><span class="mf">122.431297</span><span class="p">,</span><span class="mf">6.0989</span><span class="p">],[</span><span class="mf">6.56667</span><span class="p">]]</span>
+</code></pre></div>
+<p>In the case of <code>tbl.delete(delete_filter="city == 'Groningen'")</code>, the whole Parquet file will be dropped without checking it contents, since from the Iceberg metadata PyIceberg can derive that all the content in the file matches the predicate.</p>
+<h3 id="partial-overwrites">Partial overwrites<a class="headerlink" href="#partial-overwrites" title="Permanent link">¶</a></h3>
+<p>When using the <code>overwrite</code> API, you can use an <code>overwrite_filter</code> to delete data that matches the filter before appending new data into the table. For example, consider the following Iceberg table:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span>
+<a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a><span class="n">df</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pylist</span><span class="p">(</span>
+<a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a> <span class="p">[</span>
+<a id="__codelineno-22-4" name="__codelineno-22-4" href="#__codelineno-22-4"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Amsterdam"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">52.371807</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">4.896029</span><span class="p">},</span>
+<a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">37.773972</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.431297</ [...]
+<a id="__codelineno-22-6" name="__codelineno-22-6" href="#__codelineno-22-6"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Drachten"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">53.11254</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">6.0989</span><span class="p">},</span>
+<a id="__codelineno-22-7" name="__codelineno-22-7" href="#__codelineno-22-7"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Paris"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">48.864716</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">2.349014</span><span class="p">},</span>
+<a id="__codelineno-22-8" name="__codelineno-22-8" href="#__codelineno-22-8"></a> <span class="p">],</span>
+<a id="__codelineno-22-9" name="__codelineno-22-9" href="#__codelineno-22-9"></a><span class="p">)</span>
+<a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a>
+<a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.catalog</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_catalog</span>
+<a id="__codelineno-22-12" name="__codelineno-22-12" href="#__codelineno-22-12"></a><span class="n">catalog</span> <span class="o">=</span> <span class="n">load_catalog</span><span class="p">(</span><span class="s2">"default"</span><span class="p">)</span>
+<a id="__codelineno-22-13" name="__codelineno-22-13" href="#__codelineno-22-13"></a>
+<a id="__codelineno-22-14" name="__codelineno-22-14" href="#__codelineno-22-14"></a><span class="n">tbl</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span><span class="s2">"default.cities"</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="n">df</span><span class="o">.</span><span class="n">schema</span><span class="p">)</span>
+<a id="__codelineno-22-15" name="__codelineno-22-15" href="#__codelineno-22-15"></a>
+<a id="__codelineno-22-16" name="__codelineno-22-16" href="#__codelineno-22-16"></a><span class="n">tbl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
+</code></pre></div>
+<p>You can overwrite the record of <code>Paris</code> with a record of <code>New York</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.expressions</span><span class="w"> </span><span class="kn">import</span> <span class="n">EqualTo</span>
+<a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a><span class="n">df</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pylist</span><span class="p">(</span>
+<a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a> <span class="p">[</span>
+<a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"New York"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">40.7128</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">74.0060</span><span class="p">},</span>
+<a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a> <span class="p">]</span>
+<a id="__codelineno-23-6" name="__codelineno-23-6" href="#__codelineno-23-6"></a><span class="p">)</span>
+<a id="__codelineno-23-7" name="__codelineno-23-7" href="#__codelineno-23-7"></a><span class="n">tbl</span><span class="o">.</span><span class="n">overwrite</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">overwrite_filter</span><span class="o">=</span><span class="n">EqualTo</span><span class="p">(</span><span class="s1">'city'</span><span class="p">,</span> <span class="s2">"Paris"</span><span class="p">))</span>
+</code></pre></div>
+<p>This produces the following result with <code>tbl.scan().to_arrow()</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="n">pyarrow</span><span class="o">.</span><span class="n">Table</span>
+<a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a><span class="n">city</span><span class="p">:</span> <span class="n">large_string</span>
+<a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a><span class="n">lat</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a><span class="n">long</span><span class="p">:</span> <span class="n">double</span>
+<a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a><span class="o">----</span>
+<a id="__codelineno-24-6" name="__codelineno-24-6" href="#__codelineno-24-6"></a><span class="n">city</span><span class="p">:</span> <span class="p">[[</span><span class="s2">"New York"</span><span class="p">],[</span><span class="s2">"Amsterdam"</span><span class="p">,</span><span class="s2">"San Francisco"</span><span class="p">,</span><span class="s2">"Drachten"</span><span class="p">]]</span>
+<a id="__codelineno-24-7" name="__codelineno-24-7" href="#__codelineno-24-7"></a><span class="n">lat</span><span class="p">:</span> <span class="p">[[</span><span class="mf">40.7128</span><span class="p">],[</span><span class="mf">52.371807</span><span class="p">,</span><span class="mf">37.773972</span><span class="p">,</span><span class="mf">53.11254</span><span class="p">]]</span>
+<a id="__codelineno-24-8" name="__codelineno-24-8" href="#__codelineno-24-8"></a><span class="n">long</span><span class="p">:</span> <span class="p">[[</span><span class="mf">74.006</span><span class="p">],[</span><span class="mf">4.896029</span><span class="p">,</span><span class="o">-</span><span class="mf">122.431297</span><span class="p">,</span><span class="mf">6.0989</span><span class="p">]]</span>
+</code></pre></div>
+<p>If the PyIceberg table is partitioned, you can use <code>tbl.dynamic_partition_overwrite(df)</code> to replace the existing partitions with new ones provided in the dataframe. The partitions to be replaced are detected automatically from the provided arrow table.
+For example, with an iceberg table with a partition specified on <code>"city"</code> field:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.schema</span><span class="w"> </span><span class="kn">import</span> <span class="n">Schema</span>
+<a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pyiceberg.types</span><span class="w"> </span><span class="kn">import</span> <span class="n">DoubleType</span><span class="p">,</span> <span class="n">NestedField</span><span class="p">,</span> <span class="n">StringType</span>
+<a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a>
+<a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a><span class="n">schema</span> <span class="o">=</span> <span class="n">Schema</span><span class="p">(</span>
+<a id="__codelineno-25-5" name="__codelineno-25-5" href="#__codelineno-25-5"></a> <span class="n">NestedField</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s2">"city"</span><span class="p">,</span> <span class="n">StringType</span><span class="p">(),</span> <span class="n">required</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
+<a id="__codelineno-25-6" name="__codelineno-25-6" href="#__codelineno-25-6"></a> <span class="n">NestedField</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">,</span> <span class="n">DoubleType</span><span class="p">(),</span> <span class="n">required</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
+<a id="__codelineno-25-7" name="__codelineno-25-7" href="#__codelineno-25-7"></a> <span class="n">NestedField</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">,</span> <span class="n">DoubleType</span><span class="p">(),</span> <span class="n">required</span><span class="o">=</span><span class="kc">False</span><span class="p">),</span>
+<a id="__codelineno-25-8" name="__codelineno-25-8" href="#__codelineno-25-8"></a><span class="p">)</span>
+<a id="__codelineno-25-9" name="__codelineno-25-9" href="#__codelineno-25-9"></a>
+<a id="__codelineno-25-10" name="__codelineno-25-10" href="#__codelineno-25-10"></a><span class="n">tbl</span> <span class="o">=</span> <span class="n">catalog</span><span class="o">.</span><span class="n">create_table</span><span class="p">(</span>
+<a id="__codelineno-25-11" name="__codelineno-25-11" href="#__codelineno-25-11"></a> <span class="s2">"default.cities"</span><span class="p">,</span>
+<a id="__codelineno-25-12" name="__codelineno-25-12" href="#__codelineno-25-12"></a> <span class="n">schema</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span>
+<a id="__codelineno-25-13" name="__codelineno-25-13" href="#__codelineno-25-13"></a> <span class="n">partition_spec</span><span class="o">=</span><span class="n">PartitionSpec</span><span class="p">(</span><span class="n">PartitionField</span><span class="p">(</span><span class="n">source_id</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">field_id</span><span class="o">=</span><span class="mi">1001</span><span class="p">,</span> <span cl [...]
+<a id="__codelineno-25-14" name="__codelineno-25-14" href="#__codelineno-25-14"></a><span class="p">)</span>
+</code></pre></div>
+<p>And we want to overwrite the data for the partition of <code>"Paris"</code>:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="kn">import</span><span class="w"> </span><span class="nn">pyarrow</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pa</span>
+<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a>
+<a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a><span class="n">df</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">from_pylist</span><span class="p">(</span>
+<a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a> <span class="p">[</span>
+<a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Amsterdam"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">52.371807</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">4.896029</span><span class="p">},</span>
+<a id="__codelineno-26-6" name="__codelineno-26-6" href="#__codelineno-26-6"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"San Francisco"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">37.773972</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="o">-</span><span class="mf">122.431297</ [...]
+<a id="__codelineno-26-7" name="__codelineno-26-7" href="#__codelineno-26-7"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Drachten"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="mf">53.11254</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="mf">6.0989</span><span class="p">},</span>
+<a id="__codelineno-26-8" name="__codelineno-26-8" href="#__codelineno-26-8"></a> <span class="p">{</span><span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Paris"</span><span class="p">,</span> <span class="s2">"lat"</span><span class="p">:</span> <span class="o">-</span><span class="mf">48.864716</span><span class="p">,</span> <span class="s2">"long"</span><span class="p">:</span> <span class="o">-</span><span class=" [...]
+<a id="__codelineno-26-9" name="__codelineno-26-9" href="#__codelineno-26-9"></a> <span class="p">],</span>
+<a id="__codelineno-26-10" name="__codelineno-26-10" href="#__codelineno-26-10"></a><span class="p">)</span>
+<a id="__codelineno-26-11" name="__codelineno-26-11" href="#__codelineno-26-11"></a><span class="n">tbl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
+</code></pre></div>
+<p>Then we can call <code>dynamic_partition_overwrite</code> with this arrow table:</p>
... 413527 lines suppressed ...