| |
| <!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/reference/pyiceberg/io/"> |
| |
| |
| <link rel="prev" href="../expressions/visitors/"> |
| |
| |
| <link rel="next" href="fsspec/"> |
| |
| |
| |
| |
| |
| <link rel="icon" href="../../../assets/images/iceberg-logo-icon.png"> |
| <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.0"> |
| |
| |
| |
| <title>io - PyIceberg</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../../assets/stylesheets/main.618322db.min.css"> |
| |
| |
| <link rel="stylesheet" href="../../../assets/stylesheets/palette.ab4e12ef.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> |
| |
| |
| |
| |
| |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '82']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo --> |
| |
| </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="#pyiceberg.io" 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"> |
| |
| io |
| |
| </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.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> |
| |
| |
| |
| |
| |
| <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.1.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 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 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg> |
| </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 md-tabs__item--active"> |
| <a href="../" 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.1.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 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 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg> |
| </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--active md-nav__item--section md-nav__item--nested"> |
| |
| |
| |
| <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked> |
| |
| |
| <label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex=""> |
| |
| |
| |
| <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="true"> |
| <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--active md-nav__item--nested"> |
| |
| |
| |
| <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1" checked> |
| |
| |
| <div class="md-nav__link md-nav__container"> |
| <a href="../" 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="true"> |
| <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="../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="../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="../avro/codecs/bzip2/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| bzip2 |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/codecs/codec/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| codec |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/codecs/deflate/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| deflate |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/codecs/snappy_codec/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| snappy_codec |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../avro/decoder/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| decoder |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/encoder/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| encoder |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/file/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| file |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/reader/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| reader |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../avro/resolver/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| resolver |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../catalog/bigquery_metastore/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| bigquery_metastore |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../catalog/dynamodb/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| dynamodb |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../catalog/glue/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| glue |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../catalog/hive/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| hive |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../catalog/memory/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| memory |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../catalog/rest/auth/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| auth |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../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="../cli/console/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| console |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../cli/output/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| output |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../conversions/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| conversions |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../expressions/literals/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| literals |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../expressions/parser/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| parser |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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--active md-nav__item--nested"> |
| |
| |
| |
| <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_7" checked> |
| |
| |
| <div class="md-nav__link md-nav__container"> |
| <a href="./" class="md-nav__link md-nav__link--active"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| io |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| |
| |
| <label class="md-nav__link md-nav__link--active" 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="true"> |
| <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="fsspec/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| fsspec |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="pyarrow/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| pyarrow |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../manifest/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| manifest |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../partitioning/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| partitioning |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../schema/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| schema |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../table/inspect/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| inspect |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/locations/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| locations |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/maintenance/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| maintenance |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/metadata/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| metadata |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/name_mapping/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| name_mapping |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/puffin/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| puffin |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/refs/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| refs |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/snapshots/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| snapshots |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/sorting/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| sorting |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../table/update/schema/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| schema |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/update/snapshot/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| snapshot |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/update/sorting/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| sorting |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/update/spec/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| spec |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../table/update/statistics/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| statistics |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../transforms/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| transforms |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../typedef/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| typedef |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="../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="../utils/bin_packing/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| bin_packing |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/concurrent/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| concurrent |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/config/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| config |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/datetime/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| datetime |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/decimal/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| decimal |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/deprecated/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| deprecated |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/lazydict/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| lazydict |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/parsing/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| parsing |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/properties/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| properties |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/schema_conversion/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| schema_conversion |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../utils/singleton/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| singleton |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../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="#pyiceberg.io" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| io |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.FileIO" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| FileIO |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="FileIO"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.FileIO.delete" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| delete |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.FileIO.new_input" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| new_input |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.FileIO.new_output" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| new_output |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputFile" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| InputFile |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="InputFile"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputFile.location" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| location |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputFile.__len__" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| __len__ |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputFile.exists" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| exists |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputFile.open" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| open |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputStream" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| InputStream |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="InputStream"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputStream.__enter__" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| __enter__ |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.InputStream.__exit__" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| __exit__ |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputFile" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| OutputFile |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="OutputFile"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputFile.location" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| location |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputFile.__len__" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| __len__ |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputFile.create" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| create |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputFile.exists" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| exists |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputFile.to_input_file" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| to_input_file |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputStream" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| OutputStream |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="OutputStream"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputStream.__enter__" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| __enter__ |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.io.OutputStream.__exit__" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| __exit__ |
| |
| </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"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h1>io</h1> |
| |
| <div class="doc doc-object doc-module"> |
| |
| |
| |
| <a id="pyiceberg.io"></a> |
| <div class="doc doc-contents first"> |
| |
| <p>Base FileIO classes for implementing reading and writing table files.</p> |
| <p>The FileIO abstraction includes a subset of full filesystem implementations. Specifically, |
| Iceberg needs to read or write a file at a given location (as a seekable stream), as well |
| as check if a file exists. An implementation of the FileIO abstract base class is responsible |
| for returning an InputFile instance, an OutputFile instance, and deleting a file given |
| its location.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.io.FileIO" class="doc doc-heading"> |
| <code>FileIO</code> |
| |
| |
| <a href="#pyiceberg.io.FileIO" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| <p class="doc doc-class-bases"> |
| Bases: <code><span title="abc.ABC">ABC</span></code></p> |
| |
| |
| |
| <p>A base class for FileIO implementations.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-252">252</a></span> |
| <span class="normal"><a href="#__codelineno-0-253">253</a></span> |
| <span class="normal"><a href="#__codelineno-0-254">254</a></span> |
| <span class="normal"><a href="#__codelineno-0-255">255</a></span> |
| <span class="normal"><a href="#__codelineno-0-256">256</a></span> |
| <span class="normal"><a href="#__codelineno-0-257">257</a></span> |
| <span class="normal"><a href="#__codelineno-0-258">258</a></span> |
| <span class="normal"><a href="#__codelineno-0-259">259</a></span> |
| <span class="normal"><a href="#__codelineno-0-260">260</a></span> |
| <span class="normal"><a href="#__codelineno-0-261">261</a></span> |
| <span class="normal"><a href="#__codelineno-0-262">262</a></span> |
| <span class="normal"><a href="#__codelineno-0-263">263</a></span> |
| <span class="normal"><a href="#__codelineno-0-264">264</a></span> |
| <span class="normal"><a href="#__codelineno-0-265">265</a></span> |
| <span class="normal"><a href="#__codelineno-0-266">266</a></span> |
| <span class="normal"><a href="#__codelineno-0-267">267</a></span> |
| <span class="normal"><a href="#__codelineno-0-268">268</a></span> |
| <span class="normal"><a href="#__codelineno-0-269">269</a></span> |
| <span class="normal"><a href="#__codelineno-0-270">270</a></span> |
| <span class="normal"><a href="#__codelineno-0-271">271</a></span> |
| <span class="normal"><a href="#__codelineno-0-272">272</a></span> |
| <span class="normal"><a href="#__codelineno-0-273">273</a></span> |
| <span class="normal"><a href="#__codelineno-0-274">274</a></span> |
| <span class="normal"><a href="#__codelineno-0-275">275</a></span> |
| <span class="normal"><a href="#__codelineno-0-276">276</a></span> |
| <span class="normal"><a href="#__codelineno-0-277">277</a></span> |
| <span class="normal"><a href="#__codelineno-0-278">278</a></span> |
| <span class="normal"><a href="#__codelineno-0-279">279</a></span> |
| <span class="normal"><a href="#__codelineno-0-280">280</a></span> |
| <span class="normal"><a href="#__codelineno-0-281">281</a></span> |
| <span class="normal"><a href="#__codelineno-0-282">282</a></span> |
| <span class="normal"><a href="#__codelineno-0-283">283</a></span> |
| <span class="normal"><a href="#__codelineno-0-284">284</a></span> |
| <span class="normal"><a href="#__codelineno-0-285">285</a></span> |
| <span class="normal"><a href="#__codelineno-0-286">286</a></span> |
| <span class="normal"><a href="#__codelineno-0-287">287</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-252" name="__codelineno-0-252"></a><span class="k">class</span><span class="w"> </span><span class="nc">FileIO</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span> |
| <a id="__codelineno-0-253" name="__codelineno-0-253"></a><span class="w"> </span><span class="sd">"""A base class for FileIO implementations."""</span> |
| <a id="__codelineno-0-254" name="__codelineno-0-254"></a> |
| <a id="__codelineno-0-255" name="__codelineno-0-255"></a> <span class="n">properties</span><span class="p">:</span> <span class="n">Properties</span> |
| <a id="__codelineno-0-256" name="__codelineno-0-256"></a> |
| <a id="__codelineno-0-257" name="__codelineno-0-257"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">properties</span><span class="p">:</span> <span class="n">Properties</span> <span class="o">=</span> <span class="n">EMPTY_DICT</span><span class="p">):</span> |
| <a id="__codelineno-0-258" name="__codelineno-0-258"></a> <span class="bp">self</span><span class="o">.</span><span class="n">properties</span> <span class="o">=</span> <span class="n">properties</span> |
| <a id="__codelineno-0-259" name="__codelineno-0-259"></a> |
| <a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-261" name="__codelineno-0-261"></a> <span class="k">def</span><span class="w"> </span><span class="nf">new_input</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-262" name="__codelineno-0-262"></a><span class="w"> </span><span class="sd">"""Get an InputFile instance to read bytes from the file at the given location.</span> |
| <a id="__codelineno-0-263" name="__codelineno-0-263"></a> |
| <a id="__codelineno-0-264" name="__codelineno-0-264"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-265" name="__codelineno-0-265"></a><span class="sd"> location (str): A URI or a path to a local file.</span> |
| <a id="__codelineno-0-266" name="__codelineno-0-266"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-267" name="__codelineno-0-267"></a> |
| <a id="__codelineno-0-268" name="__codelineno-0-268"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-269" name="__codelineno-0-269"></a> <span class="k">def</span><span class="w"> </span><span class="nf">new_output</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">OutputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="w"> </span><span class="sd">"""Get an OutputFile instance to write bytes to the file at the given location.</span> |
| <a id="__codelineno-0-271" name="__codelineno-0-271"></a> |
| <a id="__codelineno-0-272" name="__codelineno-0-272"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-273" name="__codelineno-0-273"></a><span class="sd"> location (str): A URI or a path to a local file.</span> |
| <a id="__codelineno-0-274" name="__codelineno-0-274"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-275" name="__codelineno-0-275"></a> |
| <a id="__codelineno-0-276" name="__codelineno-0-276"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-277" name="__codelineno-0-277"></a> <span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">InputFile</span> <span class="o">|</span> <span class="n">OutputFile</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="w"> </span><span class="sd">"""Delete the file at the given path.</span> |
| <a id="__codelineno-0-279" name="__codelineno-0-279"></a> |
| <a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-281" name="__codelineno-0-281"></a><span class="sd"> location (Union[str, InputFile, OutputFile]): A URI or a path to a local file--if an InputFile instance or</span> |
| <a id="__codelineno-0-282" name="__codelineno-0-282"></a><span class="sd"> an OutputFile instance is provided, the location attribute for that instance is used as the URI to delete.</span> |
| <a id="__codelineno-0-283" name="__codelineno-0-283"></a> |
| <a id="__codelineno-0-284" name="__codelineno-0-284"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-285" name="__codelineno-0-285"></a><span class="sd"> PermissionError: If the file at location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-286" name="__codelineno-0-286"></a><span class="sd"> FileNotFoundError: When the file at the provided location does not exist.</span> |
| <a id="__codelineno-0-287" name="__codelineno-0-287"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.FileIO.delete" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">delete</span><span class="p">(</span><span class="n">location</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.FileIO.delete" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Delete the file at the given path.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>location</code> |
| </td> |
| <td> |
| <code><span title="Union">Union</span>[<span title="str">str</span>, <a class="autorefs autorefs-internal" title="InputFile (pyiceberg.io.InputFile)" href="#pyiceberg.io.InputFile">InputFile</a>, <a class="autorefs autorefs-internal" title="OutputFile (pyiceberg.io.OutputFile)" href="#pyiceberg.io.OutputFile">OutputFile</a>]</code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A URI or a path to a local file--if an InputFile instance or |
| an OutputFile instance is provided, the location attribute for that instance is used as the URI to delete.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Raises:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="PermissionError">PermissionError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at location cannot be accessed due to a permission error.</p> |
| </div> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="FileNotFoundError">FileNotFoundError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>When the file at the provided location does not exist.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-276">276</a></span> |
| <span class="normal"><a href="#__codelineno-0-277">277</a></span> |
| <span class="normal"><a href="#__codelineno-0-278">278</a></span> |
| <span class="normal"><a href="#__codelineno-0-279">279</a></span> |
| <span class="normal"><a href="#__codelineno-0-280">280</a></span> |
| <span class="normal"><a href="#__codelineno-0-281">281</a></span> |
| <span class="normal"><a href="#__codelineno-0-282">282</a></span> |
| <span class="normal"><a href="#__codelineno-0-283">283</a></span> |
| <span class="normal"><a href="#__codelineno-0-284">284</a></span> |
| <span class="normal"><a href="#__codelineno-0-285">285</a></span> |
| <span class="normal"><a href="#__codelineno-0-286">286</a></span> |
| <span class="normal"><a href="#__codelineno-0-287">287</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-276" name="__codelineno-0-276"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-277" name="__codelineno-0-277"></a><span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">InputFile</span> <span class="o">|</span> <span class="n">OutputFile</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="w"> </span><span class="sd">"""Delete the file at the given path.</span> |
| <a id="__codelineno-0-279" name="__codelineno-0-279"></a> |
| <a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-281" name="__codelineno-0-281"></a><span class="sd"> location (Union[str, InputFile, OutputFile]): A URI or a path to a local file--if an InputFile instance or</span> |
| <a id="__codelineno-0-282" name="__codelineno-0-282"></a><span class="sd"> an OutputFile instance is provided, the location attribute for that instance is used as the URI to delete.</span> |
| <a id="__codelineno-0-283" name="__codelineno-0-283"></a> |
| <a id="__codelineno-0-284" name="__codelineno-0-284"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-285" name="__codelineno-0-285"></a><span class="sd"> PermissionError: If the file at location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-286" name="__codelineno-0-286"></a><span class="sd"> FileNotFoundError: When the file at the provided location does not exist.</span> |
| <a id="__codelineno-0-287" name="__codelineno-0-287"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.FileIO.new_input" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">new_input</span><span class="p">(</span><span class="n">location</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.FileIO.new_input" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Get an InputFile instance to read bytes from the file at the given location.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>location</code> |
| </td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A URI or a path to a local file.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-260">260</a></span> |
| <span class="normal"><a href="#__codelineno-0-261">261</a></span> |
| <span class="normal"><a href="#__codelineno-0-262">262</a></span> |
| <span class="normal"><a href="#__codelineno-0-263">263</a></span> |
| <span class="normal"><a href="#__codelineno-0-264">264</a></span> |
| <span class="normal"><a href="#__codelineno-0-265">265</a></span> |
| <span class="normal"><a href="#__codelineno-0-266">266</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-260" name="__codelineno-0-260"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-261" name="__codelineno-0-261"></a><span class="k">def</span><span class="w"> </span><span class="nf">new_input</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-262" name="__codelineno-0-262"></a><span class="w"> </span><span class="sd">"""Get an InputFile instance to read bytes from the file at the given location.</span> |
| <a id="__codelineno-0-263" name="__codelineno-0-263"></a> |
| <a id="__codelineno-0-264" name="__codelineno-0-264"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-265" name="__codelineno-0-265"></a><span class="sd"> location (str): A URI or a path to a local file.</span> |
| <a id="__codelineno-0-266" name="__codelineno-0-266"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.FileIO.new_output" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">new_output</span><span class="p">(</span><span class="n">location</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.FileIO.new_output" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Get an OutputFile instance to write bytes to the file at the given location.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>location</code> |
| </td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A URI or a path to a local file.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-268">268</a></span> |
| <span class="normal"><a href="#__codelineno-0-269">269</a></span> |
| <span class="normal"><a href="#__codelineno-0-270">270</a></span> |
| <span class="normal"><a href="#__codelineno-0-271">271</a></span> |
| <span class="normal"><a href="#__codelineno-0-272">272</a></span> |
| <span class="normal"><a href="#__codelineno-0-273">273</a></span> |
| <span class="normal"><a href="#__codelineno-0-274">274</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-268" name="__codelineno-0-268"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-269" name="__codelineno-0-269"></a><span class="k">def</span><span class="w"> </span><span class="nf">new_output</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">OutputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="w"> </span><span class="sd">"""Get an OutputFile instance to write bytes to the file at the given location.</span> |
| <a id="__codelineno-0-271" name="__codelineno-0-271"></a> |
| <a id="__codelineno-0-272" name="__codelineno-0-272"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-273" name="__codelineno-0-273"></a><span class="sd"> location (str): A URI or a path to a local file.</span> |
| <a id="__codelineno-0-274" name="__codelineno-0-274"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.io.InputFile" class="doc doc-heading"> |
| <code>InputFile</code> |
| |
| |
| <a href="#pyiceberg.io.InputFile" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| <p class="doc doc-class-bases"> |
| Bases: <code><span title="abc.ABC">ABC</span></code></p> |
| |
| |
| |
| <p>A base class for InputFile implementations.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>location</code> |
| </td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A URI or a path to a local file.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Attributes:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td><code><a class="autorefs autorefs-internal" title="location |
| |
| |
| property |
| (pyiceberg.io.InputFile.location)" href="#pyiceberg.io.InputFile.location">location</a></code></td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>The URI or path to a local file for an InputFile instance.</p> |
| </div> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td><code><a class="autorefs autorefs-internal" title="exists() |
| |
| |
| abstractmethod |
| (pyiceberg.io.InputFile.exists)" href="#pyiceberg.io.InputFile.exists">exists</a></code></td> |
| <td> |
| <code><span title="bool">bool</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>Whether the file exists or not.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-153">153</a></span> |
| <span class="normal"><a href="#__codelineno-0-154">154</a></span> |
| <span class="normal"><a href="#__codelineno-0-155">155</a></span> |
| <span class="normal"><a href="#__codelineno-0-156">156</a></span> |
| <span class="normal"><a href="#__codelineno-0-157">157</a></span> |
| <span class="normal"><a href="#__codelineno-0-158">158</a></span> |
| <span class="normal"><a href="#__codelineno-0-159">159</a></span> |
| <span class="normal"><a href="#__codelineno-0-160">160</a></span> |
| <span class="normal"><a href="#__codelineno-0-161">161</a></span> |
| <span class="normal"><a href="#__codelineno-0-162">162</a></span> |
| <span class="normal"><a href="#__codelineno-0-163">163</a></span> |
| <span class="normal"><a href="#__codelineno-0-164">164</a></span> |
| <span class="normal"><a href="#__codelineno-0-165">165</a></span> |
| <span class="normal"><a href="#__codelineno-0-166">166</a></span> |
| <span class="normal"><a href="#__codelineno-0-167">167</a></span> |
| <span class="normal"><a href="#__codelineno-0-168">168</a></span> |
| <span class="normal"><a href="#__codelineno-0-169">169</a></span> |
| <span class="normal"><a href="#__codelineno-0-170">170</a></span> |
| <span class="normal"><a href="#__codelineno-0-171">171</a></span> |
| <span class="normal"><a href="#__codelineno-0-172">172</a></span> |
| <span class="normal"><a href="#__codelineno-0-173">173</a></span> |
| <span class="normal"><a href="#__codelineno-0-174">174</a></span> |
| <span class="normal"><a href="#__codelineno-0-175">175</a></span> |
| <span class="normal"><a href="#__codelineno-0-176">176</a></span> |
| <span class="normal"><a href="#__codelineno-0-177">177</a></span> |
| <span class="normal"><a href="#__codelineno-0-178">178</a></span> |
| <span class="normal"><a href="#__codelineno-0-179">179</a></span> |
| <span class="normal"><a href="#__codelineno-0-180">180</a></span> |
| <span class="normal"><a href="#__codelineno-0-181">181</a></span> |
| <span class="normal"><a href="#__codelineno-0-182">182</a></span> |
| <span class="normal"><a href="#__codelineno-0-183">183</a></span> |
| <span class="normal"><a href="#__codelineno-0-184">184</a></span> |
| <span class="normal"><a href="#__codelineno-0-185">185</a></span> |
| <span class="normal"><a href="#__codelineno-0-186">186</a></span> |
| <span class="normal"><a href="#__codelineno-0-187">187</a></span> |
| <span class="normal"><a href="#__codelineno-0-188">188</a></span> |
| <span class="normal"><a href="#__codelineno-0-189">189</a></span> |
| <span class="normal"><a href="#__codelineno-0-190">190</a></span> |
| <span class="normal"><a href="#__codelineno-0-191">191</a></span> |
| <span class="normal"><a href="#__codelineno-0-192">192</a></span> |
| <span class="normal"><a href="#__codelineno-0-193">193</a></span> |
| <span class="normal"><a href="#__codelineno-0-194">194</a></span> |
| <span class="normal"><a href="#__codelineno-0-195">195</a></span> |
| <span class="normal"><a href="#__codelineno-0-196">196</a></span> |
| <span class="normal"><a href="#__codelineno-0-197">197</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-153" name="__codelineno-0-153"></a><span class="k">class</span><span class="w"> </span><span class="nc">InputFile</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span> |
| <a id="__codelineno-0-154" name="__codelineno-0-154"></a><span class="w"> </span><span class="sd">"""A base class for InputFile implementations.</span> |
| <a id="__codelineno-0-155" name="__codelineno-0-155"></a> |
| <a id="__codelineno-0-156" name="__codelineno-0-156"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-157" name="__codelineno-0-157"></a><span class="sd"> location (str): A URI or a path to a local file.</span> |
| <a id="__codelineno-0-158" name="__codelineno-0-158"></a> |
| <a id="__codelineno-0-159" name="__codelineno-0-159"></a><span class="sd"> Attributes:</span> |
| <a id="__codelineno-0-160" name="__codelineno-0-160"></a><span class="sd"> location (str): The URI or path to a local file for an InputFile instance.</span> |
| <a id="__codelineno-0-161" name="__codelineno-0-161"></a><span class="sd"> exists (bool): Whether the file exists or not.</span> |
| <a id="__codelineno-0-162" name="__codelineno-0-162"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-163" name="__codelineno-0-163"></a> |
| <a id="__codelineno-0-164" name="__codelineno-0-164"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span> |
| <a id="__codelineno-0-165" name="__codelineno-0-165"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_location</span> <span class="o">=</span> <span class="n">location</span> |
| <a id="__codelineno-0-166" name="__codelineno-0-166"></a> |
| <a id="__codelineno-0-167" name="__codelineno-0-167"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-168" name="__codelineno-0-168"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| <a id="__codelineno-0-169" name="__codelineno-0-169"></a><span class="w"> </span><span class="sd">"""Return the total length of the file, in bytes."""</span> |
| <a id="__codelineno-0-170" name="__codelineno-0-170"></a> |
| <a id="__codelineno-0-171" name="__codelineno-0-171"></a> <span class="nd">@property</span> |
| <a id="__codelineno-0-172" name="__codelineno-0-172"></a> <span class="k">def</span><span class="w"> </span><span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> |
| <a id="__codelineno-0-173" name="__codelineno-0-173"></a><span class="w"> </span><span class="sd">"""The fully-qualified location of the input file."""</span> |
| <a id="__codelineno-0-174" name="__codelineno-0-174"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_location</span> |
| <a id="__codelineno-0-175" name="__codelineno-0-175"></a> |
| <a id="__codelineno-0-176" name="__codelineno-0-176"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-177" name="__codelineno-0-177"></a> <span class="k">def</span><span class="w"> </span><span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| <a id="__codelineno-0-178" name="__codelineno-0-178"></a><span class="w"> </span><span class="sd">"""Check whether the location exists.</span> |
| <a id="__codelineno-0-179" name="__codelineno-0-179"></a> |
| <a id="__codelineno-0-180" name="__codelineno-0-180"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-181" name="__codelineno-0-181"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-182" name="__codelineno-0-182"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-183" name="__codelineno-0-183"></a> |
| <a id="__codelineno-0-184" name="__codelineno-0-184"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-185" name="__codelineno-0-185"></a> <span class="k">def</span><span class="w"> </span><span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seekable</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-186" name="__codelineno-0-186"></a><span class="w"> </span><span class="sd">"""Return an object that matches the InputStream protocol.</span> |
| <a id="__codelineno-0-187" name="__codelineno-0-187"></a> |
| <a id="__codelineno-0-188" name="__codelineno-0-188"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-189" name="__codelineno-0-189"></a><span class="sd"> seekable: If the stream should support seek, or if it is consumed sequential.</span> |
| <a id="__codelineno-0-190" name="__codelineno-0-190"></a> |
| <a id="__codelineno-0-191" name="__codelineno-0-191"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-192" name="__codelineno-0-192"></a><span class="sd"> InputStream: An object that matches the InputStream protocol.</span> |
| <a id="__codelineno-0-193" name="__codelineno-0-193"></a> |
| <a id="__codelineno-0-194" name="__codelineno-0-194"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-195" name="__codelineno-0-195"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-196" name="__codelineno-0-196"></a><span class="sd"> FileNotFoundError: If the file at self.location does not exist.</span> |
| <a id="__codelineno-0-197" name="__codelineno-0-197"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-attribute"> |
| |
| |
| |
| <h3 id="pyiceberg.io.InputFile.location" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">location</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-property"><code>property</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.InputFile.location" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>The fully-qualified location of the input file.</p> |
| |
| </div> |
| |
| </div> |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.InputFile.__len__" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="fm">__len__</span><span class="p">()</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.InputFile.__len__" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return the total length of the file, in bytes.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-167">167</a></span> |
| <span class="normal"><a href="#__codelineno-0-168">168</a></span> |
| <span class="normal"><a href="#__codelineno-0-169">169</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-167" name="__codelineno-0-167"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-168" name="__codelineno-0-168"></a><span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| <a id="__codelineno-0-169" name="__codelineno-0-169"></a><span class="w"> </span><span class="sd">"""Return the total length of the file, in bytes."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.InputFile.exists" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">exists</span><span class="p">()</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.InputFile.exists" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Check whether the location exists.</p> |
| |
| |
| <p><span class="doc-section-title">Raises:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="PermissionError">PermissionError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at self.location cannot be accessed due to a permission error.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-176">176</a></span> |
| <span class="normal"><a href="#__codelineno-0-177">177</a></span> |
| <span class="normal"><a href="#__codelineno-0-178">178</a></span> |
| <span class="normal"><a href="#__codelineno-0-179">179</a></span> |
| <span class="normal"><a href="#__codelineno-0-180">180</a></span> |
| <span class="normal"><a href="#__codelineno-0-181">181</a></span> |
| <span class="normal"><a href="#__codelineno-0-182">182</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-176" name="__codelineno-0-176"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-177" name="__codelineno-0-177"></a><span class="k">def</span><span class="w"> </span><span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| <a id="__codelineno-0-178" name="__codelineno-0-178"></a><span class="w"> </span><span class="sd">"""Check whether the location exists.</span> |
| <a id="__codelineno-0-179" name="__codelineno-0-179"></a> |
| <a id="__codelineno-0-180" name="__codelineno-0-180"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-181" name="__codelineno-0-181"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-182" name="__codelineno-0-182"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.InputFile.open" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="nb">open</span><span class="p">(</span><span class="n">seekable</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.InputFile.open" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return an object that matches the InputStream protocol.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>seekable</code> |
| </td> |
| <td> |
| <code><span title="bool">bool</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the stream should support seek, or if it is consumed sequential.</p> |
| </div> |
| </td> |
| <td> |
| <code>True</code> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Returns:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td><code>InputStream</code></td> <td> |
| <code><a class="autorefs autorefs-internal" title="InputStream (pyiceberg.io.InputStream)" href="#pyiceberg.io.InputStream">InputStream</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>An object that matches the InputStream protocol.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Raises:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="PermissionError">PermissionError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at self.location cannot be accessed due to a permission error.</p> |
| </div> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="FileNotFoundError">FileNotFoundError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at self.location does not exist.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-184">184</a></span> |
| <span class="normal"><a href="#__codelineno-0-185">185</a></span> |
| <span class="normal"><a href="#__codelineno-0-186">186</a></span> |
| <span class="normal"><a href="#__codelineno-0-187">187</a></span> |
| <span class="normal"><a href="#__codelineno-0-188">188</a></span> |
| <span class="normal"><a href="#__codelineno-0-189">189</a></span> |
| <span class="normal"><a href="#__codelineno-0-190">190</a></span> |
| <span class="normal"><a href="#__codelineno-0-191">191</a></span> |
| <span class="normal"><a href="#__codelineno-0-192">192</a></span> |
| <span class="normal"><a href="#__codelineno-0-193">193</a></span> |
| <span class="normal"><a href="#__codelineno-0-194">194</a></span> |
| <span class="normal"><a href="#__codelineno-0-195">195</a></span> |
| <span class="normal"><a href="#__codelineno-0-196">196</a></span> |
| <span class="normal"><a href="#__codelineno-0-197">197</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-185" name="__codelineno-0-185"></a><span class="k">def</span><span class="w"> </span><span class="nf">open</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">seekable</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-186" name="__codelineno-0-186"></a><span class="w"> </span><span class="sd">"""Return an object that matches the InputStream protocol.</span> |
| <a id="__codelineno-0-187" name="__codelineno-0-187"></a> |
| <a id="__codelineno-0-188" name="__codelineno-0-188"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-189" name="__codelineno-0-189"></a><span class="sd"> seekable: If the stream should support seek, or if it is consumed sequential.</span> |
| <a id="__codelineno-0-190" name="__codelineno-0-190"></a> |
| <a id="__codelineno-0-191" name="__codelineno-0-191"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-192" name="__codelineno-0-192"></a><span class="sd"> InputStream: An object that matches the InputStream protocol.</span> |
| <a id="__codelineno-0-193" name="__codelineno-0-193"></a> |
| <a id="__codelineno-0-194" name="__codelineno-0-194"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-195" name="__codelineno-0-195"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-196" name="__codelineno-0-196"></a><span class="sd"> FileNotFoundError: If the file at self.location does not exist.</span> |
| <a id="__codelineno-0-197" name="__codelineno-0-197"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.io.InputStream" class="doc doc-heading"> |
| <code>InputStream</code> |
| |
| |
| <a href="#pyiceberg.io.InputStream" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| <p class="doc doc-class-bases"> |
| Bases: <code><span title="typing.Protocol">Protocol</span></code></p> |
| |
| |
| |
| <p>A protocol for the file-like object returned by InputFile.open(...).</p> |
| <p>This outlines the minimally required methods for a seekable input stream returned from an InputFile |
| implementation's <code>open(...)</code> method. These methods are a subset of IOBase/RawIOBase.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-102">102</a></span> |
| <span class="normal"><a href="#__codelineno-0-103">103</a></span> |
| <span class="normal"><a href="#__codelineno-0-104">104</a></span> |
| <span class="normal"><a href="#__codelineno-0-105">105</a></span> |
| <span class="normal"><a href="#__codelineno-0-106">106</a></span> |
| <span class="normal"><a href="#__codelineno-0-107">107</a></span> |
| <span class="normal"><a href="#__codelineno-0-108">108</a></span> |
| <span class="normal"><a href="#__codelineno-0-109">109</a></span> |
| <span class="normal"><a href="#__codelineno-0-110">110</a></span> |
| <span class="normal"><a href="#__codelineno-0-111">111</a></span> |
| <span class="normal"><a href="#__codelineno-0-112">112</a></span> |
| <span class="normal"><a href="#__codelineno-0-113">113</a></span> |
| <span class="normal"><a href="#__codelineno-0-114">114</a></span> |
| <span class="normal"><a href="#__codelineno-0-115">115</a></span> |
| <span class="normal"><a href="#__codelineno-0-116">116</a></span> |
| <span class="normal"><a href="#__codelineno-0-117">117</a></span> |
| <span class="normal"><a href="#__codelineno-0-118">118</a></span> |
| <span class="normal"><a href="#__codelineno-0-119">119</a></span> |
| <span class="normal"><a href="#__codelineno-0-120">120</a></span> |
| <span class="normal"><a href="#__codelineno-0-121">121</a></span> |
| <span class="normal"><a href="#__codelineno-0-122">122</a></span> |
| <span class="normal"><a href="#__codelineno-0-123">123</a></span> |
| <span class="normal"><a href="#__codelineno-0-124">124</a></span> |
| <span class="normal"><a href="#__codelineno-0-125">125</a></span> |
| <span class="normal"><a href="#__codelineno-0-126">126</a></span> |
| <span class="normal"><a href="#__codelineno-0-127">127</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-102" name="__codelineno-0-102"></a><span class="nd">@runtime_checkable</span> |
| <a id="__codelineno-0-103" name="__codelineno-0-103"></a><span class="k">class</span><span class="w"> </span><span class="nc">InputStream</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span> |
| <a id="__codelineno-0-104" name="__codelineno-0-104"></a><span class="w"> </span><span class="sd">"""A protocol for the file-like object returned by InputFile.open(...).</span> |
| <a id="__codelineno-0-105" name="__codelineno-0-105"></a> |
| <a id="__codelineno-0-106" name="__codelineno-0-106"></a><span class="sd"> This outlines the minimally required methods for a seekable input stream returned from an InputFile</span> |
| <a id="__codelineno-0-107" name="__codelineno-0-107"></a><span class="sd"> implementation's `open(...)` method. These methods are a subset of IOBase/RawIOBase.</span> |
| <a id="__codelineno-0-108" name="__codelineno-0-108"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-109" name="__codelineno-0-109"></a> |
| <a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="k">def</span><span class="w"> </span><span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bytes</span><span class="p">:</span> <span class="o">...</span> |
| <a id="__codelineno-0-112" name="__codelineno-0-112"></a> |
| <a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="k">def</span><span class="w"> </span><span class="nf">seek</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">whence</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">SEEK_SET</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> <span class="o">...</span> |
| <a id="__codelineno-0-115" name="__codelineno-0-115"></a> |
| <a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-117" name="__codelineno-0-117"></a> <span class="k">def</span><span class="w"> </span><span class="nf">tell</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> <span class="o">...</span> |
| <a id="__codelineno-0-118" name="__codelineno-0-118"></a> |
| <a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> <span class="o">...</span> |
| <a id="__codelineno-0-121" name="__codelineno-0-121"></a> |
| <a id="__codelineno-0-122" name="__codelineno-0-122"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="w"> </span><span class="sd">"""Provide setup when opening an InputStream using a 'with' statement."""</span> |
| <a id="__codelineno-0-124" name="__codelineno-0-124"></a> |
| <a id="__codelineno-0-125" name="__codelineno-0-125"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-126" name="__codelineno-0-126"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exctype</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="ne">BaseException</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">excinst</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">exctb</span><span class="p">:</span> <span class="n">TracebackType</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="w"> </span><span class="sd">"""Perform cleanup when exiting the scope of a 'with' statement."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.InputStream.__enter__" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="fm">__enter__</span><span class="p">()</span></code> |
| |
| <a href="#pyiceberg.io.InputStream.__enter__" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Provide setup when opening an InputStream using a 'with' statement.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-122">122</a></span> |
| <span class="normal"><a href="#__codelineno-0-123">123</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="w"> </span><span class="sd">"""Provide setup when opening an InputStream using a 'with' statement."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.InputStream.__exit__" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="fm">__exit__</span><span class="p">(</span><span class="n">exctype</span><span class="p">,</span> <span class="n">excinst</span><span class="p">,</span> <span class="n">exctb</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.InputStream.__exit__" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Perform cleanup when exiting the scope of a 'with' statement.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-125">125</a></span> |
| <span class="normal"><a href="#__codelineno-0-126">126</a></span> |
| <span class="normal"><a href="#__codelineno-0-127">127</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-125" name="__codelineno-0-125"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-126" name="__codelineno-0-126"></a><span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exctype</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="ne">BaseException</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">excinst</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">exctb</span><span class="p">:</span> <span class="n">TracebackType</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="w"> </span><span class="sd">"""Perform cleanup when exiting the scope of a 'with' statement."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.io.OutputFile" class="doc doc-heading"> |
| <code>OutputFile</code> |
| |
| |
| <a href="#pyiceberg.io.OutputFile" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| <p class="doc doc-class-bases"> |
| Bases: <code><span title="abc.ABC">ABC</span></code></p> |
| |
| |
| |
| <p>A base class for OutputFile implementations.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>location</code> |
| </td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A URI or a path to a local file.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Attributes:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td><code><a class="autorefs autorefs-internal" title="location |
| |
| |
| property |
| (pyiceberg.io.OutputFile.location)" href="#pyiceberg.io.OutputFile.location">location</a></code></td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>The URI or path to a local file for an OutputFile instance.</p> |
| </div> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td><code><a class="autorefs autorefs-internal" title="exists() |
| |
| |
| abstractmethod |
| (pyiceberg.io.OutputFile.exists)" href="#pyiceberg.io.OutputFile.exists">exists</a></code></td> |
| <td> |
| <code><span title="bool">bool</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>Whether the file exists or not.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-200">200</a></span> |
| <span class="normal"><a href="#__codelineno-0-201">201</a></span> |
| <span class="normal"><a href="#__codelineno-0-202">202</a></span> |
| <span class="normal"><a href="#__codelineno-0-203">203</a></span> |
| <span class="normal"><a href="#__codelineno-0-204">204</a></span> |
| <span class="normal"><a href="#__codelineno-0-205">205</a></span> |
| <span class="normal"><a href="#__codelineno-0-206">206</a></span> |
| <span class="normal"><a href="#__codelineno-0-207">207</a></span> |
| <span class="normal"><a href="#__codelineno-0-208">208</a></span> |
| <span class="normal"><a href="#__codelineno-0-209">209</a></span> |
| <span class="normal"><a href="#__codelineno-0-210">210</a></span> |
| <span class="normal"><a href="#__codelineno-0-211">211</a></span> |
| <span class="normal"><a href="#__codelineno-0-212">212</a></span> |
| <span class="normal"><a href="#__codelineno-0-213">213</a></span> |
| <span class="normal"><a href="#__codelineno-0-214">214</a></span> |
| <span class="normal"><a href="#__codelineno-0-215">215</a></span> |
| <span class="normal"><a href="#__codelineno-0-216">216</a></span> |
| <span class="normal"><a href="#__codelineno-0-217">217</a></span> |
| <span class="normal"><a href="#__codelineno-0-218">218</a></span> |
| <span class="normal"><a href="#__codelineno-0-219">219</a></span> |
| <span class="normal"><a href="#__codelineno-0-220">220</a></span> |
| <span class="normal"><a href="#__codelineno-0-221">221</a></span> |
| <span class="normal"><a href="#__codelineno-0-222">222</a></span> |
| <span class="normal"><a href="#__codelineno-0-223">223</a></span> |
| <span class="normal"><a href="#__codelineno-0-224">224</a></span> |
| <span class="normal"><a href="#__codelineno-0-225">225</a></span> |
| <span class="normal"><a href="#__codelineno-0-226">226</a></span> |
| <span class="normal"><a href="#__codelineno-0-227">227</a></span> |
| <span class="normal"><a href="#__codelineno-0-228">228</a></span> |
| <span class="normal"><a href="#__codelineno-0-229">229</a></span> |
| <span class="normal"><a href="#__codelineno-0-230">230</a></span> |
| <span class="normal"><a href="#__codelineno-0-231">231</a></span> |
| <span class="normal"><a href="#__codelineno-0-232">232</a></span> |
| <span class="normal"><a href="#__codelineno-0-233">233</a></span> |
| <span class="normal"><a href="#__codelineno-0-234">234</a></span> |
| <span class="normal"><a href="#__codelineno-0-235">235</a></span> |
| <span class="normal"><a href="#__codelineno-0-236">236</a></span> |
| <span class="normal"><a href="#__codelineno-0-237">237</a></span> |
| <span class="normal"><a href="#__codelineno-0-238">238</a></span> |
| <span class="normal"><a href="#__codelineno-0-239">239</a></span> |
| <span class="normal"><a href="#__codelineno-0-240">240</a></span> |
| <span class="normal"><a href="#__codelineno-0-241">241</a></span> |
| <span class="normal"><a href="#__codelineno-0-242">242</a></span> |
| <span class="normal"><a href="#__codelineno-0-243">243</a></span> |
| <span class="normal"><a href="#__codelineno-0-244">244</a></span> |
| <span class="normal"><a href="#__codelineno-0-245">245</a></span> |
| <span class="normal"><a href="#__codelineno-0-246">246</a></span> |
| <span class="normal"><a href="#__codelineno-0-247">247</a></span> |
| <span class="normal"><a href="#__codelineno-0-248">248</a></span> |
| <span class="normal"><a href="#__codelineno-0-249">249</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-200" name="__codelineno-0-200"></a><span class="k">class</span><span class="w"> </span><span class="nc">OutputFile</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span> |
| <a id="__codelineno-0-201" name="__codelineno-0-201"></a><span class="w"> </span><span class="sd">"""A base class for OutputFile implementations.</span> |
| <a id="__codelineno-0-202" name="__codelineno-0-202"></a> |
| <a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-204" name="__codelineno-0-204"></a><span class="sd"> location (str): A URI or a path to a local file.</span> |
| <a id="__codelineno-0-205" name="__codelineno-0-205"></a> |
| <a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd"> Attributes:</span> |
| <a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd"> location (str): The URI or path to a local file for an OutputFile instance.</span> |
| <a id="__codelineno-0-208" name="__codelineno-0-208"></a><span class="sd"> exists (bool): Whether the file exists or not.</span> |
| <a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-210" name="__codelineno-0-210"></a> |
| <a id="__codelineno-0-211" name="__codelineno-0-211"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">location</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span> |
| <a id="__codelineno-0-212" name="__codelineno-0-212"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_location</span> <span class="o">=</span> <span class="n">location</span> |
| <a id="__codelineno-0-213" name="__codelineno-0-213"></a> |
| <a id="__codelineno-0-214" name="__codelineno-0-214"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-215" name="__codelineno-0-215"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| <a id="__codelineno-0-216" name="__codelineno-0-216"></a><span class="w"> </span><span class="sd">"""Return the total length of the file, in bytes."""</span> |
| <a id="__codelineno-0-217" name="__codelineno-0-217"></a> |
| <a id="__codelineno-0-218" name="__codelineno-0-218"></a> <span class="nd">@property</span> |
| <a id="__codelineno-0-219" name="__codelineno-0-219"></a> <span class="k">def</span><span class="w"> </span><span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> |
| <a id="__codelineno-0-220" name="__codelineno-0-220"></a><span class="w"> </span><span class="sd">"""The fully-qualified location of the output file."""</span> |
| <a id="__codelineno-0-221" name="__codelineno-0-221"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_location</span> |
| <a id="__codelineno-0-222" name="__codelineno-0-222"></a> |
| <a id="__codelineno-0-223" name="__codelineno-0-223"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-224" name="__codelineno-0-224"></a> <span class="k">def</span><span class="w"> </span><span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| <a id="__codelineno-0-225" name="__codelineno-0-225"></a><span class="w"> </span><span class="sd">"""Check whether the location exists.</span> |
| <a id="__codelineno-0-226" name="__codelineno-0-226"></a> |
| <a id="__codelineno-0-227" name="__codelineno-0-227"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-228" name="__codelineno-0-228"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-229" name="__codelineno-0-229"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-230" name="__codelineno-0-230"></a> |
| <a id="__codelineno-0-231" name="__codelineno-0-231"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-232" name="__codelineno-0-232"></a> <span class="k">def</span><span class="w"> </span><span class="nf">to_input_file</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-233" name="__codelineno-0-233"></a><span class="w"> </span><span class="sd">"""Return an InputFile for the location of this output file."""</span> |
| <a id="__codelineno-0-234" name="__codelineno-0-234"></a> |
| <a id="__codelineno-0-235" name="__codelineno-0-235"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-236" name="__codelineno-0-236"></a> <span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">overwrite</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-></span> <span class="n">OutputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-237" name="__codelineno-0-237"></a><span class="w"> </span><span class="sd">"""Return an object that matches the OutputStream protocol.</span> |
| <a id="__codelineno-0-238" name="__codelineno-0-238"></a> |
| <a id="__codelineno-0-239" name="__codelineno-0-239"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-240" name="__codelineno-0-240"></a><span class="sd"> overwrite (bool): If the file already exists at `self.location`</span> |
| <a id="__codelineno-0-241" name="__codelineno-0-241"></a><span class="sd"> and `overwrite` is False a FileExistsError should be raised.</span> |
| <a id="__codelineno-0-242" name="__codelineno-0-242"></a> |
| <a id="__codelineno-0-243" name="__codelineno-0-243"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="sd"> OutputStream: An object that matches the OutputStream protocol.</span> |
| <a id="__codelineno-0-245" name="__codelineno-0-245"></a> |
| <a id="__codelineno-0-246" name="__codelineno-0-246"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-247" name="__codelineno-0-247"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-248" name="__codelineno-0-248"></a><span class="sd"> FileExistsError: If the file at self.location already exists and `overwrite=False`.</span> |
| <a id="__codelineno-0-249" name="__codelineno-0-249"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-attribute"> |
| |
| |
| |
| <h3 id="pyiceberg.io.OutputFile.location" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">location</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-property"><code>property</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputFile.location" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>The fully-qualified location of the output file.</p> |
| |
| </div> |
| |
| </div> |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.OutputFile.__len__" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="fm">__len__</span><span class="p">()</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputFile.__len__" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return the total length of the file, in bytes.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-214">214</a></span> |
| <span class="normal"><a href="#__codelineno-0-215">215</a></span> |
| <span class="normal"><a href="#__codelineno-0-216">216</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-214" name="__codelineno-0-214"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-215" name="__codelineno-0-215"></a><span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| <a id="__codelineno-0-216" name="__codelineno-0-216"></a><span class="w"> </span><span class="sd">"""Return the total length of the file, in bytes."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.OutputFile.create" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">create</span><span class="p">(</span><span class="n">overwrite</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputFile.create" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return an object that matches the OutputStream protocol.</p> |
| |
| |
| <p><span class="doc-section-title">Parameters:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code>overwrite</code> |
| </td> |
| <td> |
| <code><span title="bool">bool</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file already exists at <code>self.location</code> |
| and <code>overwrite</code> is False a FileExistsError should be raised.</p> |
| </div> |
| </td> |
| <td> |
| <code>False</code> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Returns:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td><code>OutputStream</code></td> <td> |
| <code><a class="autorefs autorefs-internal" title="OutputStream (pyiceberg.io.OutputStream)" href="#pyiceberg.io.OutputStream">OutputStream</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>An object that matches the OutputStream protocol.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Raises:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="PermissionError">PermissionError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at self.location cannot be accessed due to a permission error.</p> |
| </div> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="FileExistsError">FileExistsError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at self.location already exists and <code>overwrite=False</code>.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-235">235</a></span> |
| <span class="normal"><a href="#__codelineno-0-236">236</a></span> |
| <span class="normal"><a href="#__codelineno-0-237">237</a></span> |
| <span class="normal"><a href="#__codelineno-0-238">238</a></span> |
| <span class="normal"><a href="#__codelineno-0-239">239</a></span> |
| <span class="normal"><a href="#__codelineno-0-240">240</a></span> |
| <span class="normal"><a href="#__codelineno-0-241">241</a></span> |
| <span class="normal"><a href="#__codelineno-0-242">242</a></span> |
| <span class="normal"><a href="#__codelineno-0-243">243</a></span> |
| <span class="normal"><a href="#__codelineno-0-244">244</a></span> |
| <span class="normal"><a href="#__codelineno-0-245">245</a></span> |
| <span class="normal"><a href="#__codelineno-0-246">246</a></span> |
| <span class="normal"><a href="#__codelineno-0-247">247</a></span> |
| <span class="normal"><a href="#__codelineno-0-248">248</a></span> |
| <span class="normal"><a href="#__codelineno-0-249">249</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-235" name="__codelineno-0-235"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-236" name="__codelineno-0-236"></a><span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">overwrite</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-></span> <span class="n">OutputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-237" name="__codelineno-0-237"></a><span class="w"> </span><span class="sd">"""Return an object that matches the OutputStream protocol.</span> |
| <a id="__codelineno-0-238" name="__codelineno-0-238"></a> |
| <a id="__codelineno-0-239" name="__codelineno-0-239"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-240" name="__codelineno-0-240"></a><span class="sd"> overwrite (bool): If the file already exists at `self.location`</span> |
| <a id="__codelineno-0-241" name="__codelineno-0-241"></a><span class="sd"> and `overwrite` is False a FileExistsError should be raised.</span> |
| <a id="__codelineno-0-242" name="__codelineno-0-242"></a> |
| <a id="__codelineno-0-243" name="__codelineno-0-243"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="sd"> OutputStream: An object that matches the OutputStream protocol.</span> |
| <a id="__codelineno-0-245" name="__codelineno-0-245"></a> |
| <a id="__codelineno-0-246" name="__codelineno-0-246"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-247" name="__codelineno-0-247"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-248" name="__codelineno-0-248"></a><span class="sd"> FileExistsError: If the file at self.location already exists and `overwrite=False`.</span> |
| <a id="__codelineno-0-249" name="__codelineno-0-249"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.OutputFile.exists" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">exists</span><span class="p">()</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputFile.exists" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Check whether the location exists.</p> |
| |
| |
| <p><span class="doc-section-title">Raises:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="PermissionError">PermissionError</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>If the file at self.location cannot be accessed due to a permission error.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-223">223</a></span> |
| <span class="normal"><a href="#__codelineno-0-224">224</a></span> |
| <span class="normal"><a href="#__codelineno-0-225">225</a></span> |
| <span class="normal"><a href="#__codelineno-0-226">226</a></span> |
| <span class="normal"><a href="#__codelineno-0-227">227</a></span> |
| <span class="normal"><a href="#__codelineno-0-228">228</a></span> |
| <span class="normal"><a href="#__codelineno-0-229">229</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-223" name="__codelineno-0-223"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-224" name="__codelineno-0-224"></a><span class="k">def</span><span class="w"> </span><span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| <a id="__codelineno-0-225" name="__codelineno-0-225"></a><span class="w"> </span><span class="sd">"""Check whether the location exists.</span> |
| <a id="__codelineno-0-226" name="__codelineno-0-226"></a> |
| <a id="__codelineno-0-227" name="__codelineno-0-227"></a><span class="sd"> Raises:</span> |
| <a id="__codelineno-0-228" name="__codelineno-0-228"></a><span class="sd"> PermissionError: If the file at self.location cannot be accessed due to a permission error.</span> |
| <a id="__codelineno-0-229" name="__codelineno-0-229"></a><span class="sd"> """</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.OutputFile.to_input_file" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">to_input_file</span><span class="p">()</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputFile.to_input_file" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return an InputFile for the location of this output file.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-231">231</a></span> |
| <span class="normal"><a href="#__codelineno-0-232">232</a></span> |
| <span class="normal"><a href="#__codelineno-0-233">233</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-231" name="__codelineno-0-231"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-232" name="__codelineno-0-232"></a><span class="k">def</span><span class="w"> </span><span class="nf">to_input_file</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-233" name="__codelineno-0-233"></a><span class="w"> </span><span class="sd">"""Return an InputFile for the location of this output file."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.io.OutputStream" class="doc doc-heading"> |
| <code>OutputStream</code> |
| |
| |
| <a href="#pyiceberg.io.OutputStream" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| <p class="doc doc-class-bases"> |
| Bases: <code><span title="typing.Protocol">Protocol</span></code></p> |
| |
| |
| |
| <p>A protocol for the file-like object returned by OutputFile.create(...).</p> |
| <p>This outlines the minimally required methods for a writable output stream returned from an OutputFile |
| implementation's <code>create(...)</code> method. These methods are a subset of IOBase/RawIOBase.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-130">130</a></span> |
| <span class="normal"><a href="#__codelineno-0-131">131</a></span> |
| <span class="normal"><a href="#__codelineno-0-132">132</a></span> |
| <span class="normal"><a href="#__codelineno-0-133">133</a></span> |
| <span class="normal"><a href="#__codelineno-0-134">134</a></span> |
| <span class="normal"><a href="#__codelineno-0-135">135</a></span> |
| <span class="normal"><a href="#__codelineno-0-136">136</a></span> |
| <span class="normal"><a href="#__codelineno-0-137">137</a></span> |
| <span class="normal"><a href="#__codelineno-0-138">138</a></span> |
| <span class="normal"><a href="#__codelineno-0-139">139</a></span> |
| <span class="normal"><a href="#__codelineno-0-140">140</a></span> |
| <span class="normal"><a href="#__codelineno-0-141">141</a></span> |
| <span class="normal"><a href="#__codelineno-0-142">142</a></span> |
| <span class="normal"><a href="#__codelineno-0-143">143</a></span> |
| <span class="normal"><a href="#__codelineno-0-144">144</a></span> |
| <span class="normal"><a href="#__codelineno-0-145">145</a></span> |
| <span class="normal"><a href="#__codelineno-0-146">146</a></span> |
| <span class="normal"><a href="#__codelineno-0-147">147</a></span> |
| <span class="normal"><a href="#__codelineno-0-148">148</a></span> |
| <span class="normal"><a href="#__codelineno-0-149">149</a></span> |
| <span class="normal"><a href="#__codelineno-0-150">150</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-130" name="__codelineno-0-130"></a><span class="nd">@runtime_checkable</span> |
| <a id="__codelineno-0-131" name="__codelineno-0-131"></a><span class="k">class</span><span class="w"> </span><span class="nc">OutputStream</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span> <span class="c1"># pragma: no cover</span> |
| <a id="__codelineno-0-132" name="__codelineno-0-132"></a><span class="w"> </span><span class="sd">"""A protocol for the file-like object returned by OutputFile.create(...).</span> |
| <a id="__codelineno-0-133" name="__codelineno-0-133"></a> |
| <a id="__codelineno-0-134" name="__codelineno-0-134"></a><span class="sd"> This outlines the minimally required methods for a writable output stream returned from an OutputFile</span> |
| <a id="__codelineno-0-135" name="__codelineno-0-135"></a><span class="sd"> implementation's `create(...)` method. These methods are a subset of IOBase/RawIOBase.</span> |
| <a id="__codelineno-0-136" name="__codelineno-0-136"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-137" name="__codelineno-0-137"></a> |
| <a id="__codelineno-0-138" name="__codelineno-0-138"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-139" name="__codelineno-0-139"></a> <span class="k">def</span><span class="w"> </span><span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> <span class="o">...</span> |
| <a id="__codelineno-0-140" name="__codelineno-0-140"></a> |
| <a id="__codelineno-0-141" name="__codelineno-0-141"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-142" name="__codelineno-0-142"></a> <span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> <span class="o">...</span> |
| <a id="__codelineno-0-143" name="__codelineno-0-143"></a> |
| <a id="__codelineno-0-144" name="__codelineno-0-144"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-145" name="__codelineno-0-145"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">OutputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-146" name="__codelineno-0-146"></a><span class="w"> </span><span class="sd">"""Provide setup when opening an OutputStream using a 'with' statement."""</span> |
| <a id="__codelineno-0-147" name="__codelineno-0-147"></a> |
| <a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exctype</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="ne">BaseException</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">excinst</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">exctb</span><span class="p">:</span> <span class="n">TracebackType</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-150" name="__codelineno-0-150"></a><span class="w"> </span><span class="sd">"""Perform cleanup when exiting the scope of a 'with' statement."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.OutputStream.__enter__" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="fm">__enter__</span><span class="p">()</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputStream.__enter__" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Provide setup when opening an OutputStream using a 'with' statement.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-144">144</a></span> |
| <span class="normal"><a href="#__codelineno-0-145">145</a></span> |
| <span class="normal"><a href="#__codelineno-0-146">146</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-144" name="__codelineno-0-144"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-145" name="__codelineno-0-145"></a><span class="k">def</span><span class="w"> </span><span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">OutputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-146" name="__codelineno-0-146"></a><span class="w"> </span><span class="sd">"""Provide setup when opening an OutputStream using a 'with' statement."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.io.OutputStream.__exit__" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="fm">__exit__</span><span class="p">(</span><span class="n">exctype</span><span class="p">,</span> <span class="n">excinst</span><span class="p">,</span> <span class="n">exctb</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.io.OutputStream.__exit__" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Perform cleanup when exiting the scope of a 'with' statement.</p> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/io/__init__.py</code></summary> |
| <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-148">148</a></span> |
| <span class="normal"><a href="#__codelineno-0-149">149</a></span> |
| <span class="normal"><a href="#__codelineno-0-150">150</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-148" name="__codelineno-0-148"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-149" name="__codelineno-0-149"></a><span class="k">def</span><span class="w"> </span><span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exctype</span><span class="p">:</span> <span class="nb">type</span><span class="p">[</span><span class="ne">BaseException</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">excinst</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">exctb</span><span class="p">:</span> <span class="n">TracebackType</span> <span class="o">|</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-150" name="__codelineno-0-150"></a><span class="w"> </span><span class="sd">"""Perform cleanup when exiting the scope of a 'with' statement."""</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </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">{"annotate": null, "base": "../../..", "features": ["navigation.top", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.7a47a382.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 matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> |
| |
| |
| <script src="../../../assets/javascripts/bundle.e71a0d61.min.js"></script> |
| |
| |
| </body> |
| </html> |
