| |
| <!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/serializers/"> |
| |
| |
| <link rel="prev" href="../schema/"> |
| |
| |
| <link rel="next" href="../table/"> |
| |
| |
| |
| |
| |
| <link rel="icon" href="../../../assets/images/iceberg-logo-icon.png"> |
| <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1"> |
| |
| |
| |
| <title>serializers - PyIceberg</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../../assets/stylesheets/main.484c7ddc.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.serializers" 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"> |
| |
| serializers |
| |
| </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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../catalog/rest/scan_planning/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| scan_planning |
| |
| |
| |
| </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--nested"> |
| |
| |
| |
| <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8_1_7" > |
| |
| |
| <div class="md-nav__link md-nav__container"> |
| <a href="../io/" class="md-nav__link "> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| io |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| |
| |
| <label class="md-nav__link " for="__nav_8_1_7" id="__nav_8_1_7_label" tabindex="0"> |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| |
| </div> |
| |
| <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_8_1_7_label" aria-expanded="false"> |
| <label class="md-nav__title" for="__nav_8_1_7"> |
| <span class="md-nav__icon md-icon"></span> |
| |
| |
| io |
| |
| |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../io/fsspec/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| fsspec |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../io/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 md-nav__item--active"> |
| |
| <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> |
| |
| |
| |
| <label class="md-nav__link md-nav__link--active" for="__toc"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| serializers |
| |
| |
| |
| </span> |
| |
| |
| |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| |
| <a href="./" class="md-nav__link md-nav__link--active"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| serializers |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| |
| |
| |
| <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.serializers" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| serializers |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.Compressor" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| Compressor |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="Compressor"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.Compressor.bytes_compressor" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| bytes_compressor |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.Compressor.stream_decompressor" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| stream_decompressor |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromByteStream" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| FromByteStream |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="FromByteStream"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromByteStream.table_metadata" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| table_metadata |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromInputFile" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| FromInputFile |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="FromInputFile"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromInputFile.table_metadata" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| table_metadata |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.ToOutputFile" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| ToOutputFile |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="ToOutputFile"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.ToOutputFile.table_metadata" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| table_metadata |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </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_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/delete_file_index/" class="md-nav__link"> |
| |
| |
| |
| <span class="md-ellipsis"> |
| |
| |
| delete_file_index |
| |
| |
| |
| </span> |
| |
| |
| |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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_12" > |
| |
| |
| <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_12" id="__nav_8_1_12_12_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_12_label" aria-expanded="false"> |
| <label class="md-nav__title" for="__nav_8_1_12_12"> |
| <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.serializers" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| serializers |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.Compressor" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| Compressor |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="Compressor"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.Compressor.bytes_compressor" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| bytes_compressor |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.Compressor.stream_decompressor" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| stream_decompressor |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromByteStream" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| FromByteStream |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="FromByteStream"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromByteStream.table_metadata" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| table_metadata |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromInputFile" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| FromInputFile |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="FromInputFile"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.FromInputFile.table_metadata" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| table_metadata |
| |
| </span> |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.ToOutputFile" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| ToOutputFile |
| |
| </span> |
| </a> |
| |
| <nav class="md-nav" aria-label="ToOutputFile"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#pyiceberg.serializers.ToOutputFile.table_metadata" class="md-nav__link"> |
| <span class="md-ellipsis"> |
| |
| table_metadata |
| |
| </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>serializers</h1> |
| |
| <div class="doc doc-object doc-module"> |
| |
| |
| |
| <a id="pyiceberg.serializers"></a> |
| <div class="doc doc-contents first"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.serializers.Compressor" class="doc doc-heading"> |
| <code>Compressor</code> |
| |
| |
| <a href="#pyiceberg.serializers.Compressor" 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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-32">32</a></span> |
| <span class="normal"><a href="#__codelineno-0-33">33</a></span> |
| <span class="normal"><a href="#__codelineno-0-34">34</a></span> |
| <span class="normal"><a href="#__codelineno-0-35">35</a></span> |
| <span class="normal"><a href="#__codelineno-0-36">36</a></span> |
| <span class="normal"><a href="#__codelineno-0-37">37</a></span> |
| <span class="normal"><a href="#__codelineno-0-38">38</a></span> |
| <span class="normal"><a href="#__codelineno-0-39">39</a></span> |
| <span class="normal"><a href="#__codelineno-0-40">40</a></span> |
| <span class="normal"><a href="#__codelineno-0-41">41</a></span> |
| <span class="normal"><a href="#__codelineno-0-42">42</a></span> |
| <span class="normal"><a href="#__codelineno-0-43">43</a></span> |
| <span class="normal"><a href="#__codelineno-0-44">44</a></span> |
| <span class="normal"><a href="#__codelineno-0-45">45</a></span> |
| <span class="normal"><a href="#__codelineno-0-46">46</a></span> |
| <span class="normal"><a href="#__codelineno-0-47">47</a></span> |
| <span class="normal"><a href="#__codelineno-0-48">48</a></span> |
| <span class="normal"><a href="#__codelineno-0-49">49</a></span> |
| <span class="normal"><a href="#__codelineno-0-50">50</a></span> |
| <span class="normal"><a href="#__codelineno-0-51">51</a></span> |
| <span class="normal"><a href="#__codelineno-0-52">52</a></span> |
| <span class="normal"><a href="#__codelineno-0-53">53</a></span> |
| <span class="normal"><a href="#__codelineno-0-54">54</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="k">class</span><span class="w"> </span><span class="nc">Compressor</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span> |
| <a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_compressor</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">Compressor</span><span class="p">:</span> |
| <a id="__codelineno-0-35" name="__codelineno-0-35"></a> <span class="k">return</span> <span class="n">GzipCompressor</span><span class="p">()</span> <span class="k">if</span> <span class="n">location</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".gz.metadata.json"</span><span class="p">)</span> <span class="k">else</span> <span class="n">NOOP_COMPRESSOR</span> |
| <a id="__codelineno-0-36" name="__codelineno-0-36"></a> |
| <a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="k">def</span><span class="w"> </span><span class="nf">stream_decompressor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inp</span><span class="p">:</span> <span class="n">InputStream</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-39" name="__codelineno-0-39"></a><span class="w"> </span><span class="sd">"""Return a stream decompressor.</span> |
| <a id="__codelineno-0-40" name="__codelineno-0-40"></a> |
| <a id="__codelineno-0-41" name="__codelineno-0-41"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-42" name="__codelineno-0-42"></a><span class="sd"> inp: The input stream that needs decompressing.</span> |
| <a id="__codelineno-0-43" name="__codelineno-0-43"></a> |
| <a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-45" name="__codelineno-0-45"></a><span class="sd"> The wrapped stream</span> |
| <a id="__codelineno-0-46" name="__codelineno-0-46"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-47" name="__codelineno-0-47"></a> |
| <a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="k">def</span><span class="w"> </span><span class="nf">bytes_compressor</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">bytes</span><span class="p">],</span> <span class="nb">bytes</span><span class="p">]:</span> |
| <a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="w"> </span><span class="sd">"""Return a function to compress bytes.</span> |
| <a id="__codelineno-0-51" name="__codelineno-0-51"></a> |
| <a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-53" name="__codelineno-0-53"></a><span class="sd"> A function that can be used to compress bytes.</span> |
| <a id="__codelineno-0-54" name="__codelineno-0-54"></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.serializers.Compressor.bytes_compressor" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">bytes_compressor</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.serializers.Compressor.bytes_compressor" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return a function to compress bytes.</p> |
| |
| |
| <p><span class="doc-section-title">Returns:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><span title="collections.abc.Callable">Callable</span>[[<span title="bytes">bytes</span>], <span title="bytes">bytes</span>]</code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A function that can be used to compress bytes.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-48">48</a></span> |
| <span class="normal"><a href="#__codelineno-0-49">49</a></span> |
| <span class="normal"><a href="#__codelineno-0-50">50</a></span> |
| <span class="normal"><a href="#__codelineno-0-51">51</a></span> |
| <span class="normal"><a href="#__codelineno-0-52">52</a></span> |
| <span class="normal"><a href="#__codelineno-0-53">53</a></span> |
| <span class="normal"><a href="#__codelineno-0-54">54</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-48" name="__codelineno-0-48"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="k">def</span><span class="w"> </span><span class="nf">bytes_compressor</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">bytes</span><span class="p">],</span> <span class="nb">bytes</span><span class="p">]:</span> |
| <a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="w"> </span><span class="sd">"""Return a function to compress bytes.</span> |
| <a id="__codelineno-0-51" name="__codelineno-0-51"></a> |
| <a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-53" name="__codelineno-0-53"></a><span class="sd"> A function that can be used to compress bytes.</span> |
| <a id="__codelineno-0-54" name="__codelineno-0-54"></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.serializers.Compressor.stream_decompressor" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">stream_decompressor</span><span class="p">(</span><span class="n">inp</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.serializers.Compressor.stream_decompressor" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Return a stream decompressor.</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>inp</code> |
| </td> |
| <td> |
| <code><a class="autorefs autorefs-internal" title="InputStream (pyiceberg.io.InputStream)" href="../io/#pyiceberg.io.InputStream">InputStream</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>The input stream that needs decompressing.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <p><span class="doc-section-title">Returns:</span></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="doc-section-item"> |
| <td> |
| <code><a class="autorefs autorefs-internal" title="InputStream (pyiceberg.io.InputStream)" href="../io/#pyiceberg.io.InputStream">InputStream</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>The wrapped stream</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-37">37</a></span> |
| <span class="normal"><a href="#__codelineno-0-38">38</a></span> |
| <span class="normal"><a href="#__codelineno-0-39">39</a></span> |
| <span class="normal"><a href="#__codelineno-0-40">40</a></span> |
| <span class="normal"><a href="#__codelineno-0-41">41</a></span> |
| <span class="normal"><a href="#__codelineno-0-42">42</a></span> |
| <span class="normal"><a href="#__codelineno-0-43">43</a></span> |
| <span class="normal"><a href="#__codelineno-0-44">44</a></span> |
| <span class="normal"><a href="#__codelineno-0-45">45</a></span> |
| <span class="normal"><a href="#__codelineno-0-46">46</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-37" name="__codelineno-0-37"></a><span class="nd">@abstractmethod</span> |
| <a id="__codelineno-0-38" name="__codelineno-0-38"></a><span class="k">def</span><span class="w"> </span><span class="nf">stream_decompressor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inp</span><span class="p">:</span> <span class="n">InputStream</span><span class="p">)</span> <span class="o">-></span> <span class="n">InputStream</span><span class="p">:</span> |
| <a id="__codelineno-0-39" name="__codelineno-0-39"></a><span class="w"> </span><span class="sd">"""Return a stream decompressor.</span> |
| <a id="__codelineno-0-40" name="__codelineno-0-40"></a> |
| <a id="__codelineno-0-41" name="__codelineno-0-41"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-42" name="__codelineno-0-42"></a><span class="sd"> inp: The input stream that needs decompressing.</span> |
| <a id="__codelineno-0-43" name="__codelineno-0-43"></a> |
| <a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-45" name="__codelineno-0-45"></a><span class="sd"> The wrapped stream</span> |
| <a id="__codelineno-0-46" name="__codelineno-0-46"></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.serializers.FromByteStream" class="doc doc-heading"> |
| <code>FromByteStream</code> |
| |
| |
| <a href="#pyiceberg.serializers.FromByteStream" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| |
| |
| |
| <p>A collection of methods that deserialize dictionaries into Iceberg objects.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-76">76</a></span> |
| <span class="normal"><a href="#__codelineno-0-77">77</a></span> |
| <span class="normal"><a href="#__codelineno-0-78">78</a></span> |
| <span class="normal"><a href="#__codelineno-0-79">79</a></span> |
| <span class="normal"><a href="#__codelineno-0-80">80</a></span> |
| <span class="normal"><a href="#__codelineno-0-81">81</a></span> |
| <span class="normal"><a href="#__codelineno-0-82">82</a></span> |
| <span class="normal"><a href="#__codelineno-0-83">83</a></span> |
| <span class="normal"><a href="#__codelineno-0-84">84</a></span> |
| <span class="normal"><a href="#__codelineno-0-85">85</a></span> |
| <span class="normal"><a href="#__codelineno-0-86">86</a></span> |
| <span class="normal"><a href="#__codelineno-0-87">87</a></span> |
| <span class="normal"><a href="#__codelineno-0-88">88</a></span> |
| <span class="normal"><a href="#__codelineno-0-89">89</a></span> |
| <span class="normal"><a href="#__codelineno-0-90">90</a></span> |
| <span class="normal"><a href="#__codelineno-0-91">91</a></span> |
| <span class="normal"><a href="#__codelineno-0-92">92</a></span> |
| <span class="normal"><a href="#__codelineno-0-93">93</a></span> |
| <span class="normal"><a href="#__codelineno-0-94">94</a></span> |
| <span class="normal"><a href="#__codelineno-0-95">95</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-76" name="__codelineno-0-76"></a><span class="k">class</span><span class="w"> </span><span class="nc">FromByteStream</span><span class="p">:</span> |
| <a id="__codelineno-0-77" name="__codelineno-0-77"></a><span class="w"> </span><span class="sd">"""A collection of methods that deserialize dictionaries into Iceberg objects."""</span> |
| <a id="__codelineno-0-78" name="__codelineno-0-78"></a> |
| <a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="k">def</span><span class="w"> </span><span class="nf">table_metadata</span><span class="p">(</span> |
| <a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="n">byte_stream</span><span class="p">:</span> <span class="n">InputStream</span><span class="p">,</span> <span class="n">encoding</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">UTF8</span><span class="p">,</span> <span class="n">compression</span><span class="p">:</span> <span class="n">Compressor</span> <span class="o">=</span> <span class="n">NOOP_COMPRESSOR</span> |
| <a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">TableMetadata</span><span class="p">:</span> |
| <a id="__codelineno-0-83" name="__codelineno-0-83"></a><span class="w"> </span><span class="sd">"""Instantiate a TableMetadata object from a byte stream.</span> |
| <a id="__codelineno-0-84" name="__codelineno-0-84"></a> |
| <a id="__codelineno-0-85" name="__codelineno-0-85"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-86" name="__codelineno-0-86"></a><span class="sd"> byte_stream: A file-like byte stream object.</span> |
| <a id="__codelineno-0-87" name="__codelineno-0-87"></a><span class="sd"> encoding (default "utf-8"): The byte encoder to use for the reader.</span> |
| <a id="__codelineno-0-88" name="__codelineno-0-88"></a><span class="sd"> compression: Optional compression method</span> |
| <a id="__codelineno-0-89" name="__codelineno-0-89"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="k">with</span> <span class="n">compression</span><span class="o">.</span><span class="n">stream_decompressor</span><span class="p">(</span><span class="n">byte_stream</span><span class="p">)</span> <span class="k">as</span> <span class="n">byte_stream</span><span class="p">:</span> |
| <a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="n">reader</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">getreader</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span> |
| <a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="n">json_bytes</span> <span class="o">=</span> <span class="n">reader</span><span class="p">(</span><span class="n">byte_stream</span><span class="p">)</span> |
| <a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="n">metadata</span> <span class="o">=</span> <span class="n">json_bytes</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> |
| <a id="__codelineno-0-94" name="__codelineno-0-94"></a> |
| <a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="k">return</span> <span class="n">TableMetadataUtil</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.serializers.FromByteStream.table_metadata" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">table_metadata</span><span class="p">(</span><span class="n">byte_stream</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">UTF8</span><span class="p">,</span> <span class="n">compression</span><span class="o">=</span><span class="n">NOOP_COMPRESSOR</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.serializers.FromByteStream.table_metadata" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Instantiate a TableMetadata object from a byte stream.</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>byte_stream</code> |
| </td> |
| <td> |
| <code><a class="autorefs autorefs-internal" title="InputStream (pyiceberg.io.InputStream)" href="../io/#pyiceberg.io.InputStream">InputStream</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A file-like byte stream object.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td> |
| <code>encoding</code> |
| </td> |
| <td> |
| <code>default "utf-8"</code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>The byte encoder to use for the reader.</p> |
| </div> |
| </td> |
| <td> |
| <code><span title="pyiceberg.typedef.UTF8">UTF8</span></code> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td> |
| <code>compression</code> |
| </td> |
| <td> |
| <code><a class="autorefs autorefs-internal" title="Compressor (pyiceberg.serializers.Compressor)" href="#pyiceberg.serializers.Compressor">Compressor</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>Optional compression method</p> |
| </div> |
| </td> |
| <td> |
| <code><span title="pyiceberg.serializers.NOOP_COMPRESSOR">NOOP_COMPRESSOR</span></code> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-79">79</a></span> |
| <span class="normal"><a href="#__codelineno-0-80">80</a></span> |
| <span class="normal"><a href="#__codelineno-0-81">81</a></span> |
| <span class="normal"><a href="#__codelineno-0-82">82</a></span> |
| <span class="normal"><a href="#__codelineno-0-83">83</a></span> |
| <span class="normal"><a href="#__codelineno-0-84">84</a></span> |
| <span class="normal"><a href="#__codelineno-0-85">85</a></span> |
| <span class="normal"><a href="#__codelineno-0-86">86</a></span> |
| <span class="normal"><a href="#__codelineno-0-87">87</a></span> |
| <span class="normal"><a href="#__codelineno-0-88">88</a></span> |
| <span class="normal"><a href="#__codelineno-0-89">89</a></span> |
| <span class="normal"><a href="#__codelineno-0-90">90</a></span> |
| <span class="normal"><a href="#__codelineno-0-91">91</a></span> |
| <span class="normal"><a href="#__codelineno-0-92">92</a></span> |
| <span class="normal"><a href="#__codelineno-0-93">93</a></span> |
| <span class="normal"><a href="#__codelineno-0-94">94</a></span> |
| <span class="normal"><a href="#__codelineno-0-95">95</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-79" name="__codelineno-0-79"></a><span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-80" name="__codelineno-0-80"></a><span class="k">def</span><span class="w"> </span><span class="nf">table_metadata</span><span class="p">(</span> |
| <a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="n">byte_stream</span><span class="p">:</span> <span class="n">InputStream</span><span class="p">,</span> <span class="n">encoding</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">UTF8</span><span class="p">,</span> <span class="n">compression</span><span class="p">:</span> <span class="n">Compressor</span> <span class="o">=</span> <span class="n">NOOP_COMPRESSOR</span> |
| <a id="__codelineno-0-82" name="__codelineno-0-82"></a><span class="p">)</span> <span class="o">-></span> <span class="n">TableMetadata</span><span class="p">:</span> |
| <a id="__codelineno-0-83" name="__codelineno-0-83"></a><span class="w"> </span><span class="sd">"""Instantiate a TableMetadata object from a byte stream.</span> |
| <a id="__codelineno-0-84" name="__codelineno-0-84"></a> |
| <a id="__codelineno-0-85" name="__codelineno-0-85"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-86" name="__codelineno-0-86"></a><span class="sd"> byte_stream: A file-like byte stream object.</span> |
| <a id="__codelineno-0-87" name="__codelineno-0-87"></a><span class="sd"> encoding (default "utf-8"): The byte encoder to use for the reader.</span> |
| <a id="__codelineno-0-88" name="__codelineno-0-88"></a><span class="sd"> compression: Optional compression method</span> |
| <a id="__codelineno-0-89" name="__codelineno-0-89"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="k">with</span> <span class="n">compression</span><span class="o">.</span><span class="n">stream_decompressor</span><span class="p">(</span><span class="n">byte_stream</span><span class="p">)</span> <span class="k">as</span> <span class="n">byte_stream</span><span class="p">:</span> |
| <a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="n">reader</span> <span class="o">=</span> <span class="n">codecs</span><span class="o">.</span><span class="n">getreader</span><span class="p">(</span><span class="n">encoding</span><span class="p">)</span> |
| <a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="n">json_bytes</span> <span class="o">=</span> <span class="n">reader</span><span class="p">(</span><span class="n">byte_stream</span><span class="p">)</span> |
| <a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="n">metadata</span> <span class="o">=</span> <span class="n">json_bytes</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> |
| <a id="__codelineno-0-94" name="__codelineno-0-94"></a> |
| <a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="k">return</span> <span class="n">TableMetadataUtil</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.serializers.FromInputFile" class="doc doc-heading"> |
| <code>FromInputFile</code> |
| |
| |
| <a href="#pyiceberg.serializers.FromInputFile" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| |
| |
| |
| <p>A collection of methods that deserialize InputFiles into Iceberg objects.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-98"> 98</a></span> |
| <span class="normal"><a href="#__codelineno-0-99"> 99</a></span> |
| <span class="normal"><a href="#__codelineno-0-100">100</a></span> |
| <span class="normal"><a href="#__codelineno-0-101">101</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-98" name="__codelineno-0-98"></a><span class="k">class</span><span class="w"> </span><span class="nc">FromInputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-99" name="__codelineno-0-99"></a><span class="w"> </span><span class="sd">"""A collection of methods that deserialize InputFiles into Iceberg objects."""</span> |
| <a id="__codelineno-0-100" name="__codelineno-0-100"></a> |
| <a id="__codelineno-0-101" name="__codelineno-0-101"></a> <span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-102" name="__codelineno-0-102"></a> <span class="k">def</span><span class="w"> </span><span class="nf">table_metadata</span><span class="p">(</span><span class="n">input_file</span><span class="p">:</span> <span class="n">InputFile</span><span class="p">,</span> <span class="n">encoding</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">UTF8</span><span class="p">)</span> <span class="o">-></span> <span class="n">TableMetadata</span><span class="p">:</span> |
| <a id="__codelineno-0-103" name="__codelineno-0-103"></a><span class="w"> </span><span class="sd">"""Create a TableMetadata instance from an input file.</span> |
| <a id="__codelineno-0-104" name="__codelineno-0-104"></a> |
| <a id="__codelineno-0-105" name="__codelineno-0-105"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-106" name="__codelineno-0-106"></a><span class="sd"> input_file (InputFile): A custom implementation of the iceberg.io.file.InputFile abstract base class.</span> |
| <a id="__codelineno-0-107" name="__codelineno-0-107"></a><span class="sd"> encoding (str): Encoding to use when loading bytestream.</span> |
| <a id="__codelineno-0-108" name="__codelineno-0-108"></a> |
| <a id="__codelineno-0-109" name="__codelineno-0-109"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-110" name="__codelineno-0-110"></a><span class="sd"> TableMetadata: A table metadata instance.</span> |
| <a id="__codelineno-0-111" name="__codelineno-0-111"></a> |
| <a id="__codelineno-0-112" name="__codelineno-0-112"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="k">with</span> <span class="n">input_file</span><span class="o">.</span><span class="n">open</span><span class="p">()</span> <span class="k">as</span> <span class="n">input_stream</span><span class="p">:</span> |
| <a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="k">return</span> <span class="n">FromByteStream</span><span class="o">.</span><span class="n">table_metadata</span><span class="p">(</span> |
| <a id="__codelineno-0-115" name="__codelineno-0-115"></a> <span class="n">byte_stream</span><span class="o">=</span><span class="n">input_stream</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">,</span> <span class="n">compression</span><span class="o">=</span><span class="n">Compressor</span><span class="o">.</span><span class="n">get_compressor</span><span class="p">(</span><span class="n">location</span><span class="o">=</span><span class="n">input_file</span><span class="o">.</span><span class="n">location</span><span class="p">)</span> |
| <a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="p">)</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.serializers.FromInputFile.table_metadata" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">table_metadata</span><span class="p">(</span><span class="n">input_file</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">UTF8</span><span class="p">)</span></code> |
| |
| <span class="doc doc-labels"> |
| <small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.serializers.FromInputFile.table_metadata" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Create a TableMetadata instance from an input file.</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>input_file</code> |
| </td> |
| <td> |
| <code><a class="autorefs autorefs-internal" title="InputFile (pyiceberg.io.InputFile)" href="../io/#pyiceberg.io.InputFile">InputFile</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A custom implementation of the iceberg.io.file.InputFile abstract base class.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| <tr class="doc-section-item"> |
| <td> |
| <code>encoding</code> |
| </td> |
| <td> |
| <code><span title="str">str</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>Encoding to use when loading bytestream.</p> |
| </div> |
| </td> |
| <td> |
| <code><span title="pyiceberg.typedef.UTF8">UTF8</span></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>TableMetadata</code></td> <td> |
| <code><span title="pyiceberg.table.metadata.TableMetadata">TableMetadata</span></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A table metadata instance.</p> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-101">101</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-101" name="__codelineno-0-101"></a><span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-102" name="__codelineno-0-102"></a><span class="k">def</span><span class="w"> </span><span class="nf">table_metadata</span><span class="p">(</span><span class="n">input_file</span><span class="p">:</span> <span class="n">InputFile</span><span class="p">,</span> <span class="n">encoding</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">UTF8</span><span class="p">)</span> <span class="o">-></span> <span class="n">TableMetadata</span><span class="p">:</span> |
| <a id="__codelineno-0-103" name="__codelineno-0-103"></a><span class="w"> </span><span class="sd">"""Create a TableMetadata instance from an input file.</span> |
| <a id="__codelineno-0-104" name="__codelineno-0-104"></a> |
| <a id="__codelineno-0-105" name="__codelineno-0-105"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-106" name="__codelineno-0-106"></a><span class="sd"> input_file (InputFile): A custom implementation of the iceberg.io.file.InputFile abstract base class.</span> |
| <a id="__codelineno-0-107" name="__codelineno-0-107"></a><span class="sd"> encoding (str): Encoding to use when loading bytestream.</span> |
| <a id="__codelineno-0-108" name="__codelineno-0-108"></a> |
| <a id="__codelineno-0-109" name="__codelineno-0-109"></a><span class="sd"> Returns:</span> |
| <a id="__codelineno-0-110" name="__codelineno-0-110"></a><span class="sd"> TableMetadata: A table metadata instance.</span> |
| <a id="__codelineno-0-111" name="__codelineno-0-111"></a> |
| <a id="__codelineno-0-112" name="__codelineno-0-112"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="k">with</span> <span class="n">input_file</span><span class="o">.</span><span class="n">open</span><span class="p">()</span> <span class="k">as</span> <span class="n">input_stream</span><span class="p">:</span> |
| <a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="k">return</span> <span class="n">FromByteStream</span><span class="o">.</span><span class="n">table_metadata</span><span class="p">(</span> |
| <a id="__codelineno-0-115" name="__codelineno-0-115"></a> <span class="n">byte_stream</span><span class="o">=</span><span class="n">input_stream</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">,</span> <span class="n">compression</span><span class="o">=</span><span class="n">Compressor</span><span class="o">.</span><span class="n">get_compressor</span><span class="p">(</span><span class="n">location</span><span class="o">=</span><span class="n">input_file</span><span class="o">.</span><span class="n">location</span><span class="p">)</span> |
| <a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="p">)</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| </div> |
| |
| </div> |
| |
| |
| |
| </div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="doc doc-object doc-class"> |
| |
| |
| |
| <h2 id="pyiceberg.serializers.ToOutputFile" class="doc doc-heading"> |
| <code>ToOutputFile</code> |
| |
| |
| <a href="#pyiceberg.serializers.ToOutputFile" class="headerlink" title="Permanent link">¶</a></h2> |
| |
| |
| <div class="doc doc-contents "> |
| |
| |
| |
| <p>A collection of methods that serialize Iceberg objects into files given an OutputFile instance.</p> |
| |
| |
| |
| |
| |
| |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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-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> |
| <span class="normal"><a href="#__codelineno-0-128">128</a></span> |
| <span class="normal"><a href="#__codelineno-0-129">129</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="k">class</span><span class="w"> </span><span class="nc">ToOutputFile</span><span class="p">:</span> |
| <a id="__codelineno-0-120" name="__codelineno-0-120"></a><span class="w"> </span><span class="sd">"""A collection of methods that serialize Iceberg objects into files given an OutputFile instance."""</span> |
| <a id="__codelineno-0-121" name="__codelineno-0-121"></a> |
| <a id="__codelineno-0-122" name="__codelineno-0-122"></a> <span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-123" name="__codelineno-0-123"></a> <span class="k">def</span><span class="w"> </span><span class="nf">table_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">:</span> <span class="n">TableMetadata</span><span class="p">,</span> <span class="n">output_file</span><span class="p">:</span> <span class="n">OutputFile</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="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="w"> </span><span class="sd">"""Write a TableMetadata instance to an output file.</span> |
| <a id="__codelineno-0-125" name="__codelineno-0-125"></a> |
| <a id="__codelineno-0-126" name="__codelineno-0-126"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="sd"> output_file (OutputFile): A custom implementation of the iceberg.io.file.OutputFile abstract base class.</span> |
| <a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="sd"> overwrite (bool): Where to overwrite the file if it already exists. Defaults to `False`.</span> |
| <a id="__codelineno-0-129" name="__codelineno-0-129"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-130" name="__codelineno-0-130"></a> <span class="k">with</span> <span class="n">output_file</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">overwrite</span><span class="o">=</span><span class="n">overwrite</span><span class="p">)</span> <span class="k">as</span> <span class="n">output_stream</span><span class="p">:</span> |
| <a id="__codelineno-0-131" name="__codelineno-0-131"></a> <span class="c1"># We need to serialize None values, in order to dump `None` current-snapshot-id as `-1`</span> |
| <a id="__codelineno-0-132" name="__codelineno-0-132"></a> <span class="n">exclude_none</span> <span class="o">=</span> <span class="kc">False</span> <span class="k">if</span> <span class="n">Config</span><span class="p">()</span><span class="o">.</span><span class="n">get_bool</span><span class="p">(</span><span class="s2">"legacy-current-snapshot-id"</span><span class="p">)</span> <span class="k">else</span> <span class="kc">True</span> |
| <a id="__codelineno-0-133" name="__codelineno-0-133"></a> |
| <a id="__codelineno-0-134" name="__codelineno-0-134"></a> <span class="n">json_bytes</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">model_dump_json</span><span class="p">(</span><span class="n">exclude_none</span><span class="o">=</span><span class="n">exclude_none</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">UTF8</span><span class="p">)</span> |
| <a id="__codelineno-0-135" name="__codelineno-0-135"></a> <span class="n">json_bytes</span> <span class="o">=</span> <span class="n">Compressor</span><span class="o">.</span><span class="n">get_compressor</span><span class="p">(</span><span class="n">output_file</span><span class="o">.</span><span class="n">location</span><span class="p">)</span><span class="o">.</span><span class="n">bytes_compressor</span><span class="p">()(</span><span class="n">json_bytes</span><span class="p">)</span> |
| <a id="__codelineno-0-136" name="__codelineno-0-136"></a> <span class="n">output_stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json_bytes</span><span class="p">)</span> |
| </code></pre></div></td></tr></table></div> |
| </details> |
| |
| |
| |
| <div class="doc doc-children"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="doc doc-object doc-function"> |
| |
| |
| <h3 id="pyiceberg.serializers.ToOutputFile.table_metadata" class="doc doc-heading"> |
| <code class="highlight language-python"><span class="n">table_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">output_file</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-staticmethod"><code>staticmethod</code></small> |
| </span> |
| |
| <a href="#pyiceberg.serializers.ToOutputFile.table_metadata" class="headerlink" title="Permanent link">¶</a></h3> |
| |
| |
| <div class="doc doc-contents "> |
| |
| <p>Write a TableMetadata instance to an output file.</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>output_file</code> |
| </td> |
| <td> |
| <code><a class="autorefs autorefs-internal" title="OutputFile (pyiceberg.io.OutputFile)" href="../io/#pyiceberg.io.OutputFile">OutputFile</a></code> |
| </td> |
| <td> |
| <div class="doc-md-description"> |
| <p>A custom implementation of the iceberg.io.file.OutputFile abstract base class.</p> |
| </div> |
| </td> |
| <td> |
| <em>required</em> |
| </td> |
| </tr> |
| <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>Where to overwrite the file if it already exists. Defaults to <code>False</code>.</p> |
| </div> |
| </td> |
| <td> |
| <code>False</code> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| |
| |
| <details class="mkdocstrings-source"> |
| <summary>Source code in <code>pyiceberg/serializers.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> |
| <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> |
| <span class="normal"><a href="#__codelineno-0-128">128</a></span> |
| <span class="normal"><a href="#__codelineno-0-129">129</a></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></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="nd">@staticmethod</span> |
| <a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="k">def</span><span class="w"> </span><span class="nf">table_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">:</span> <span class="n">TableMetadata</span><span class="p">,</span> <span class="n">output_file</span><span class="p">:</span> <span class="n">OutputFile</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="kc">None</span><span class="p">:</span> |
| <a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="w"> </span><span class="sd">"""Write a TableMetadata instance to an output file.</span> |
| <a id="__codelineno-0-125" name="__codelineno-0-125"></a> |
| <a id="__codelineno-0-126" name="__codelineno-0-126"></a><span class="sd"> Args:</span> |
| <a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="sd"> output_file (OutputFile): A custom implementation of the iceberg.io.file.OutputFile abstract base class.</span> |
| <a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="sd"> overwrite (bool): Where to overwrite the file if it already exists. Defaults to `False`.</span> |
| <a id="__codelineno-0-129" name="__codelineno-0-129"></a><span class="sd"> """</span> |
| <a id="__codelineno-0-130" name="__codelineno-0-130"></a> <span class="k">with</span> <span class="n">output_file</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">overwrite</span><span class="o">=</span><span class="n">overwrite</span><span class="p">)</span> <span class="k">as</span> <span class="n">output_stream</span><span class="p">:</span> |
| <a id="__codelineno-0-131" name="__codelineno-0-131"></a> <span class="c1"># We need to serialize None values, in order to dump `None` current-snapshot-id as `-1`</span> |
| <a id="__codelineno-0-132" name="__codelineno-0-132"></a> <span class="n">exclude_none</span> <span class="o">=</span> <span class="kc">False</span> <span class="k">if</span> <span class="n">Config</span><span class="p">()</span><span class="o">.</span><span class="n">get_bool</span><span class="p">(</span><span class="s2">"legacy-current-snapshot-id"</span><span class="p">)</span> <span class="k">else</span> <span class="kc">True</span> |
| <a id="__codelineno-0-133" name="__codelineno-0-133"></a> |
| <a id="__codelineno-0-134" name="__codelineno-0-134"></a> <span class="n">json_bytes</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">model_dump_json</span><span class="p">(</span><span class="n">exclude_none</span><span class="o">=</span><span class="n">exclude_none</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">UTF8</span><span class="p">)</span> |
| <a id="__codelineno-0-135" name="__codelineno-0-135"></a> <span class="n">json_bytes</span> <span class="o">=</span> <span class="n">Compressor</span><span class="o">.</span><span class="n">get_compressor</span><span class="p">(</span><span class="n">output_file</span><span class="o">.</span><span class="n">location</span><span class="p">)</span><span class="o">.</span><span class="n">bytes_compressor</span><span class="p">()(</span><span class="n">json_bytes</span><span class="p">)</span> |
| <a id="__codelineno-0-136" name="__codelineno-0-136"></a> <span class="n">output_stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">json_bytes</span><span class="p">)</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.2c215733.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.79ae519e.min.js"></script> |
| |
| |
| </body> |
| </html> |
