| <!doctype html><html lang=en dir=ltr> |
| <head> |
| <meta charset=utf-8> |
| <meta name=viewport content="width=device-width,initial-scale=1"> |
| <meta name=description content="Iceberg Python API # Much of the python api conforms to the java api. You can get more info about the java api here. |
| Catalog # The Catalog interface, like java provides search and management operations for tables. |
| To create a catalog: |
| from iceberg.hive import HiveTables # instantiate Hive Tables conf = {"hive.metastore.uris": 'thrift://{hms_host}:{hms_port}'} tables = HiveTables(conf) and to create a table from a catalog: |
| from iceberg.api.schema import Schema\ from iceberg."> |
| <meta name=theme-color content="#FFFFFF"> |
| <meta name=color-scheme content="light dark"><meta property="og:title" content="Python API"> |
| <meta property="og:description" content="Iceberg Python API # Much of the python api conforms to the java api. You can get more info about the java api here. |
| Catalog # The Catalog interface, like java provides search and management operations for tables. |
| To create a catalog: |
| from iceberg.hive import HiveTables # instantiate Hive Tables conf = {"hive.metastore.uris": 'thrift://{hms_host}:{hms_port}'} tables = HiveTables(conf) and to create a table from a catalog: |
| from iceberg.api.schema import Schema\ from iceberg."> |
| <meta property="og:type" content="article"> |
| <meta property="og:url" content="https://iceberg.apache.org/docs/FixSparkArtifactVersion/python-api-intro/"><meta property="article:section" content="docs"> |
| <title>Python API | Apache Iceberg</title> |
| <link rel=manifest href=/docs/FixSparkArtifactVersion/manifest.json> |
| <link rel=icon href=/docs/FixSparkArtifactVersion/favicon.png type=image/x-icon> |
| <link rel=stylesheet href=/docs/FixSparkArtifactVersion/book.min.179e158d24f3ef709534173fd8b1c1e541a4fa3e23c1b5d8e887464c58949cc9.css integrity="sha256-F54VjSTz73CVNBc/2LHB5UGk+j4jwbXY6IdGTFiUnMk=" crossorigin=anonymous> |
| <script defer src=/docs/FixSparkArtifactVersion/flexsearch.min.js></script> |
| <script defer src=/docs/FixSparkArtifactVersion/en.search.min.22e67e1125667c60fd7b9b24ba8c036274712b6ce8b2ee4cf165beead757bc10.js integrity="sha256-IuZ+ESVmfGD9e5skuowDYnRxK2zosu5M8WW+6tdXvBA=" crossorigin=anonymous></script> |
| </head> |
| <body dir=ltr> |
| <input type=checkbox class="hidden toggle" id=menu-control> |
| <input type=checkbox class="hidden toggle" id=toc-control> |
| <main class="container flex"> |
| <aside class=book-menu> |
| <div class=book-menu-content> |
| <nav> |
| <h2 class=book-brand> |
| <a class="flex align-center" href=/docs/FixSparkArtifactVersion/../../><img src=/docs/FixSparkArtifactVersion/img/iceberg-logo-icon.png alt=Logo><span>Apache Iceberg</span> |
| </a> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../releases> |
| <img id=version-shield src=https://img.shields.io/badge/version-FixSparkArtifactVersion-blue alt> |
| </a> |
| </h2> |
| <div class=book-search> |
| <input type=text id=book-search-input placeholder=Search aria-label=Search maxlength=64 data-hotkeys=s/> |
| <div class="book-search-spinner hidden"></div> |
| <ul id=book-search-results></ul> |
| <a href=https://github.com/apache/iceberg target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/GitHub-Mark.png target=_blank class=top-external-icon> |
| </a> |
| <a href=https://join.slack.com/t/apache-iceberg/shared_invite/zt-tlv0zjz6-jGJEkHfb1~heMCJA3Uycrg target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/Slack_Mark_Web.png target=_blank class=top-external-icon> |
| </a> |
| </div> |
| <ul> |
| <li class=book-section-flats> |
| <span> |
| <i class="fa fa-table fa-fw"></i> |
| Tables</span> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/configuration/> |
| Configuration</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/evolution/> |
| Evolution</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/maintenance/> |
| Maintenance</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/partitioning/> |
| Partitioning</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/performance/> |
| Performance</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/reliability/> |
| Reliability</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/schemas/> |
| Schemas</a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-flats> |
| <span> |
| <i class="fa fa-star-o fa-fw"></i> |
| Spark</span> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/getting-started/> |
| Getting Started</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/spark-configuration/> |
| Configuration</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/spark-ddl/> |
| DDL</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/spark-procedures/> |
| Procedures</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/spark-queries/> |
| Queries</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/spark-structured-streaming/> |
| Structured Streaming</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/spark-writes/> |
| Writes</a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-flats> |
| <span> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/flink-logo.png class="navigation-icon fa-fw">Flink</span> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/flink/> |
| Getting Started</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/flink-connector/> |
| Flink Connector</a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-flats> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/hive/> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/hive-logo.png class="navigation-icon fa-fw">Hive</a> |
| <ul> |
| </ul> |
| </li> |
| <li> |
| <a href=https://trino.io/docs/current/connector/iceberg.html target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/trino-logo.png class="navigation-icon fa-fw"> |
| Trino |
| </a> |
| </li> |
| <li> |
| <a href=https://prestodb.io/docs/current/connector/iceberg.html target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/prestodb-logo.png class="navigation-icon fa-fw"> |
| Presto |
| </a> |
| </li> |
| <li> |
| <a href=https://docs.dremio.com/data-formats/apache-iceberg/ target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/dremio-logo.png class="navigation-icon fa-fw"> |
| Dremio |
| </a> |
| </li> |
| <li> |
| <a href=https://docs.aws.amazon.com/athena/latest/ug/querying-iceberg.html target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/athena-logo.png class="navigation-icon fa-fw"> |
| Amazon Athena |
| </a> |
| </li> |
| <li> |
| <a href=https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-iceberg-create-cluster.html target=_blank> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/emr-logo.png class="navigation-icon fa-fw"> |
| Amazon EMR |
| </a> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-56605d8e971a871885e28ee5142728bf class=toggle> |
| <label for=section-56605d8e971a871885e28ee5142728bf class="flex justify-between"> |
| <a role=button> |
| <i class="fa fa-handshake-o fa-fw"></i> |
| Integrations</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/aws/> |
| AWS</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/jdbc/> |
| JDBC</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/nessie/> |
| Nessie</a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-bf7b3283e3790c00c8caaa140299052b class=toggle checked> |
| <label for=section-bf7b3283e3790c00c8caaa140299052b class="flex justify-between"> |
| <a role=button> |
| <i class="fa fa-connectdevelop fa-fw"></i> |
| API</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/java-api-quickstart/> |
| Java Quickstart</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/api/> |
| Java API</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/custom-catalog/> |
| Java Custom Catalog</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../javadoc/FixSparkArtifactVersion> |
| Javadocs |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/python-quickstart/> |
| Python Quickstart</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/python-api-intro/ class=active> |
| Python API</a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/python-feature-support/> |
| Python Feature Support</a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-7e66f1754ca5d93e20ecdc89df5b8b28 class=toggle> |
| <label for=section-7e66f1754ca5d93e20ecdc89df5b8b28 class="flex justify-between"> |
| <a role=button> |
| <i class="fa fa-users fa-fw"></i> |
| Community</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../blogs> |
| Blogs |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../community> |
| Join |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../talks> |
| Talks |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-87dda23e9104fe3231cee3bc88a2d754 class=toggle> |
| <label for=section-87dda23e9104fe3231cee3bc88a2d754 class="flex justify-between"> |
| <a role=button> |
| <i class="fa fa-object-ungroup fa-fw"></i> |
| Format</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../spec> |
| Spec |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../terms> |
| Terms |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-2e5d3f5f142758d8dd368e9c281dd08e class=toggle> |
| <label for=section-2e5d3f5f142758d8dd368e9c281dd08e class="flex justify-between"> |
| <a role=button> |
| <i class="fa fa-wrench fa-fw"></i> |
| Project</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../how-to-release> |
| How to Release |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../roadmap> |
| Roadmap |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../security> |
| Security |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../trademarks> |
| Trademarks |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-4ddb27a8612bc8118c0b36386905d332 class=toggle> |
| <label for=section-4ddb27a8612bc8118c0b36386905d332 class="flex justify-between"> |
| <a role=button> |
| <i class="fa fa-code-fork fa-fw"></i> |
| Releases</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../latest> |
| Latest |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../0.13.0> |
| 0.13.0 |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../0.12.1> |
| 0.12.1 |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://iceberg.apache.org/docs/FixSparkArtifactVersion/../../../releases> |
| Release Notes |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class=book-section-collapsed> |
| <input type=checkbox id=section-296746d27808aa768e500824aaf2adea class=toggle> |
| <label for=section-296746d27808aa768e500824aaf2adea class="flex justify-between"> |
| <a role=button> |
| <img src=https://iceberg.apache.org/docs/FixSparkArtifactVersion/img/../img/asf.png class="navigation-icon fa-fw">ASF</a> |
| </label> |
| <ul> |
| <li class=navigation-icon-pad> |
| <a href=https://www.apache.org/licenses/ target=_blank> |
| <i class="fa fa-external-link fa-fw"></i> |
| License |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://www.apache.org/security/ target=_blank> |
| <i class="fa fa-external-link fa-fw"></i> |
| Security |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://www.apache.org/foundation/thanks.html target=_blank> |
| <i class="fa fa-external-link fa-fw"></i> |
| Sponsors |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://www.apache.org/foundation/sponsorship.html target=_blank> |
| <i class="fa fa-external-link fa-fw"></i> |
| Donate |
| </a> |
| </li> |
| <li class=navigation-icon-pad> |
| <a href=https://www.apache.org/events/current-event.html target=_blank> |
| <i class="fa fa-external-link fa-fw"></i> |
| Events |
| </a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| <script>(function(){var a=document.querySelector("aside .book-menu-content");addEventListener("beforeunload",function(b){localStorage.setItem("menu.scrollTop",a.scrollTop)}),a.scrollTop=localStorage.getItem("menu.scrollTop")})()</script> |
| </div> |
| </aside> |
| <div class=book-page> |
| <header class=book-header> |
| <div class="flex align-center justify-between"> |
| <link rel=stylesheet href=/docs/FixSparkArtifactVersion/fontawesome/css/font-awesome.min.css> |
| <label for=menu-control> |
| <img src=/docs/FixSparkArtifactVersion/svg/menu.svg class=book-icon alt=Menu> |
| </label> |
| <strong>Python API</strong> |
| <label for=toc-control> |
| <img src=/docs/FixSparkArtifactVersion/svg/toc.svg class=book-icon alt="Table of Contents"> |
| </label> |
| </div> |
| <aside class="hidden clearfix"> |
| <nav id=TableOfContents> |
| <ul> |
| <li><a href=#catalog>Catalog</a></li> |
| <li><a href=#tables>Tables</a> |
| <ul> |
| <li><a href=#scanning>Scanning</a></li> |
| </ul> |
| </li> |
| <li><a href=#types>Types</a> |
| <ul> |
| <li><a href=#primitives>Primitives</a></li> |
| <li><a href=#nested-types>Nested types</a></li> |
| </ul> |
| </li> |
| <li><a href=#expressions>Expressions</a></li> |
| </ul> |
| </nav> |
| </aside> |
| </header> |
| <article class=markdown> |
| <h1 id=iceberg-python-api> |
| Iceberg Python API |
| <a class=anchor href=#iceberg-python-api>#</a> |
| </h1> |
| <p>Much of the python api conforms to the java api. You can get more info about the java api <a href=../api>here</a>.</p> |
| <h2 id=catalog> |
| Catalog |
| <a class=anchor href=#catalog>#</a> |
| </h2> |
| <p>The Catalog interface, like java provides search and management operations for tables.</p> |
| <p>To create a catalog:</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python><span style=color:#f92672>from</span> iceberg.hive <span style=color:#f92672>import</span> HiveTables |
| |
| <span style=color:#75715e># instantiate Hive Tables</span> |
| conf <span style=color:#f92672>=</span> {<span style=color:#e6db74>"hive.metastore.uris"</span>: <span style=color:#e6db74>'thrift://</span><span style=color:#e6db74>{hms_host}</span><span style=color:#e6db74>:</span><span style=color:#e6db74>{hms_port}</span><span style=color:#e6db74>'</span>} |
| tables <span style=color:#f92672>=</span> HiveTables(conf) |
| </code></pre></div><p>and to create a table from a catalog:</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python><span style=color:#f92672>from</span> iceberg.api.schema <span style=color:#f92672>import</span> Schema\ |
| <span style=color:#f92672>from</span> iceberg.api.types <span style=color:#f92672>import</span> TimestampType, DoubleType, StringType, NestedField |
| <span style=color:#f92672>from</span> iceberg.api.partition_spec <span style=color:#f92672>import</span> PartitionSpecBuilder |
| |
| schema <span style=color:#f92672>=</span> Schema(NestedField<span style=color:#f92672>.</span>optional(<span style=color:#ae81ff>1</span>, <span style=color:#e6db74>"DateTime"</span>, TimestampType<span style=color:#f92672>.</span>with_timezone()), |
| NestedField<span style=color:#f92672>.</span>optional(<span style=color:#ae81ff>2</span>, <span style=color:#e6db74>"Bid"</span>, DoubleType<span style=color:#f92672>.</span>get()), |
| NestedField<span style=color:#f92672>.</span>optional(<span style=color:#ae81ff>3</span>, <span style=color:#e6db74>"Ask"</span>, DoubleType<span style=color:#f92672>.</span>get()), |
| NestedField<span style=color:#f92672>.</span>optional(<span style=color:#ae81ff>4</span>, <span style=color:#e6db74>"symbol"</span>, StringType<span style=color:#f92672>.</span>get())) |
| partition_spec <span style=color:#f92672>=</span> PartitionSpecBuilder(schema)<span style=color:#f92672>.</span>add(<span style=color:#ae81ff>1</span>, <span style=color:#ae81ff>1000</span>, <span style=color:#e6db74>"DateTime_day"</span>, <span style=color:#e6db74>"day"</span>)<span style=color:#f92672>.</span>build() |
| |
| tables<span style=color:#f92672>.</span>create(schema, <span style=color:#e6db74>"test.test_123"</span>, partition) |
| </code></pre></div><h2 id=tables> |
| Tables |
| <a class=anchor href=#tables>#</a> |
| </h2> |
| <p>The Table interface provides access to table metadata</p> |
| <ul> |
| <li>schema returns the current table <code>Schema</code></li> |
| <li>spec returns the current table <code>PartitonSpec</code></li> |
| <li>properties returns a map of key-value <code>TableProperties</code></li> |
| <li>currentSnapshot returns the current table <code>Snapshot</code></li> |
| <li>snapshots returns all valid snapshots for the table</li> |
| <li>snapshot(id) returns a specific snapshot by ID</li> |
| <li>location returns the table’s base location</li> |
| </ul> |
| <p>Tables also provide refresh to update the table to the latest version.</p> |
| <h3 id=scanning> |
| Scanning |
| <a class=anchor href=#scanning>#</a> |
| </h3> |
| <p>Iceberg table scans start by creating a <code>TableScan</code> object with <code>newScan</code>.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>scan <span style=color:#f92672>=</span> table<span style=color:#f92672>.</span>new_scan(); |
| </code></pre></div><p>To configure a scan, call filter and select on the <code>TableScan</code> to get a new <code>TableScan</code> with those changes.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>filtered_scan <span style=color:#f92672>=</span> scan<span style=color:#f92672>.</span>filter(Expressions<span style=color:#f92672>.</span>equal(<span style=color:#e6db74>"id"</span>, <span style=color:#ae81ff>5</span>)) |
| </code></pre></div><p>String expressions can also be passed to the filter method.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>filtered_scan <span style=color:#f92672>=</span> scan<span style=color:#f92672>.</span>filter(<span style=color:#e6db74>"id=5"</span>) |
| </code></pre></div><p><code>Schema</code> projections can be applied against a <code>TableScan</code> by passing a list of column names.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>filtered_scan <span style=color:#f92672>=</span> scan<span style=color:#f92672>.</span>select([<span style=color:#e6db74>"col_1"</span>, <span style=color:#e6db74>"col_2"</span>, <span style=color:#e6db74>"col_3"</span>]) |
| </code></pre></div><p>Because some data types cannot be read using the python library, a convenience method for excluding columns from projection is provided.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>filtered_scan <span style=color:#f92672>=</span> scan<span style=color:#f92672>.</span>select_except([<span style=color:#e6db74>"unsupported_col_1"</span>, <span style=color:#e6db74>"unsupported_col_2"</span>]) |
| </code></pre></div><p>Calls to configuration methods create a new <code>TableScan</code> so that each <code>TableScan</code> is immutable.</p> |
| <p>When a scan is configured, <code>planFiles</code>, <code>planTasks</code>, and <code>Schema</code> are used to return files, tasks, and the read projection.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>scan <span style=color:#f92672>=</span> table<span style=color:#f92672>.</span>new_scan() \ |
| <span style=color:#f92672>.</span>filter(<span style=color:#e6db74>"id=5"</span>) \ |
| <span style=color:#f92672>.</span>select([<span style=color:#e6db74>"id"</span>, <span style=color:#e6db74>"data"</span>]) |
| |
| projection <span style=color:#f92672>=</span> scan<span style=color:#f92672>.</span>schema |
| <span style=color:#66d9ef>for</span> task <span style=color:#f92672>in</span> scan<span style=color:#f92672>.</span>plan_tasks(): |
| print(task) |
| </code></pre></div><h2 id=types> |
| Types |
| <a class=anchor href=#types>#</a> |
| </h2> |
| <p>Iceberg data types are located in <code>iceberg.api.types.types</code></p> |
| <h3 id=primitives> |
| Primitives |
| <a class=anchor href=#primitives>#</a> |
| </h3> |
| <p>Primitive type instances are available from static methods in each type class. Types without parameters use <code>get</code>, and types like <code>DecimalType</code> use factory methods:</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python>IntegerType<span style=color:#f92672>.</span>get() <span style=color:#75715e># int</span> |
| DoubleType<span style=color:#f92672>.</span>get() <span style=color:#75715e># double</span> |
| DecimalType<span style=color:#f92672>.</span>of(<span style=color:#ae81ff>9</span>, <span style=color:#ae81ff>2</span>) <span style=color:#75715e># decimal(9, 2)</span> |
| </code></pre></div><h3 id=nested-types> |
| Nested types |
| <a class=anchor href=#nested-types>#</a> |
| </h3> |
| <p>Structs, maps, and lists are created using factory methods in type classes.</p> |
| <p>Like struct fields, map keys or values and list elements are tracked as nested fields. Nested fields track <a href=https://iceberg.apache.org/evolution/#correctness>field IDs</a> and nullability.</p> |
| <p>Struct fields are created using <code>NestedField.optional</code> or <code>NestedField.required</code>. Map value and list element nullability is set in the map and list factory methods.</p> |
| <div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python><span style=color:#75715e># struct<1 id: int, 2 data: optional string></span> |
| struct <span style=color:#f92672>=</span> StructType<span style=color:#f92672>.</span>of([NestedField<span style=color:#f92672>.</span>required(<span style=color:#ae81ff>1</span>, <span style=color:#e6db74>"id"</span>, IntegerType<span style=color:#f92672>.</span>get()), |
| NestedField<span style=color:#f92672>.</span>optional(<span style=color:#ae81ff>2</span>, <span style=color:#e6db74>"data"</span>, StringType<span style=color:#f92672>.</span>get()]) |
| ) |
| </code></pre></div><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python><span style=color:#75715e># map<1 key: int, 2 value: optional string></span> |
| map_var <span style=color:#f92672>=</span> MapType<span style=color:#f92672>.</span>of_optional(<span style=color:#ae81ff>1</span>, IntegerType<span style=color:#f92672>.</span>get(), |
| <span style=color:#ae81ff>2</span>, StringType<span style=color:#f92672>.</span>get()) |
| </code></pre></div><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-python data-lang=python><span style=color:#75715e># array<1 element: int></span> |
| list_var <span style=color:#f92672>=</span> ListType<span style=color:#f92672>.</span>of_required(<span style=color:#ae81ff>1</span>, IntegerType<span style=color:#f92672>.</span>get()); |
| </code></pre></div><h2 id=expressions> |
| Expressions |
| <a class=anchor href=#expressions>#</a> |
| </h2> |
| <p>Iceberg’s <code>Expressions</code> are used to configure table scans. To create <code>Expressions</code>, use the factory methods in <code>Expressions</code>.</p> |
| <p>Supported <code>Predicate</code> expressions are:</p> |
| <ul> |
| <li><code>is_null</code></li> |
| <li><code>not_null</code></li> |
| <li><code>equal</code></li> |
| <li><code>not_equal</code></li> |
| <li><code>less_than</code></li> |
| <li><code>less_than_or_equal</code></li> |
| <li><code>greater_than</code></li> |
| <li><code>greater_than_or_equal</code></li> |
| </ul> |
| <p>Supported expression <code>Operations</code>are:</p> |
| <ul> |
| <li><code>and</code></li> |
| <li><code>or</code></li> |
| <li><code>not</code></li> |
| </ul> |
| <p>Constant expressions are:</p> |
| <ul> |
| <li><code>always_true</code></li> |
| <li><code>always_false</code></li> |
| </ul> |
| </article> |
| <footer class=book-footer> |
| <div class="flex flex-wrap justify-between"> |
| </div> |
| <script>(function(){function a(c){const a=window.getSelection(),b=document.createRange();b.selectNodeContents(c),a.removeAllRanges(),a.addRange(b)}document.querySelectorAll("pre code").forEach(b=>{b.addEventListener("click",function(c){a(b.parentElement),navigator.clipboard&&navigator.clipboard.writeText(b.parentElement.textContent)})})})()</script> |
| </footer> |
| <div class=book-comments> |
| </div> |
| <label for=menu-control class="hidden book-menu-overlay"></label> |
| </div> |
| <aside class=book-toc> |
| <div class=book-toc-content> |
| <nav id=TableOfContents> |
| <ul> |
| <li><a href=#catalog>Catalog</a></li> |
| <li><a href=#tables>Tables</a> |
| <ul> |
| <li><a href=#scanning>Scanning</a></li> |
| </ul> |
| </li> |
| <li><a href=#types>Types</a> |
| <ul> |
| <li><a href=#primitives>Primitives</a></li> |
| <li><a href=#nested-types>Nested types</a></li> |
| </ul> |
| </li> |
| <li><a href=#expressions>Expressions</a></li> |
| </ul> |
| </nav> |
| </div> |
| </aside> |
| </main> |
| </body> |
| </html> |