blob: 3401b1975c68c28d2cc784ec9b72e4755bb2c0ce [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Spark3Util</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Spark3Util";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.spark</a></div>
<h2 title="Class Spark3Util" class="title">Class Spark3Util</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.spark.Spark3Util</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">Spark3Util</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></span></code></th>
<td class="colLast">
<div class="block">This mimics a class inside of Spark which is private inside of LookupCatalog.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Spark3Util.DescribeSchemaVisitor.html" title="class in org.apache.iceberg.spark">Spark3Util.DescribeSchemaVisitor</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../UpdateProperties.html" title="interface in org.apache.iceberg">UpdateProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyPropertyChanges(org.apache.iceberg.UpdateProperties,java.util.List)">applyPropertyChanges</a></span>&#8203;(<a href="../UpdateProperties.html" title="interface in org.apache.iceberg">UpdateProperties</a>&nbsp;pendingUpdate,
java.util.List&lt;org.apache.spark.sql.connector.catalog.TableChange&gt;&nbsp;changes)</code></th>
<td class="colLast">
<div class="block">Applies a list of Spark table changes to an <a href="../UpdateProperties.html" title="interface in org.apache.iceberg"><code>UpdateProperties</code></a> operation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../UpdateSchema.html" title="interface in org.apache.iceberg">UpdateSchema</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applySchemaChanges(org.apache.iceberg.UpdateSchema,java.util.List)">applySchemaChanges</a></span>&#8203;(<a href="../UpdateSchema.html" title="interface in org.apache.iceberg">UpdateSchema</a>&nbsp;pendingUpdate,
java.util.List&lt;org.apache.spark.sql.connector.catalog.TableChange&gt;&nbsp;changes)</code></th>
<td class="colLast">
<div class="block">Applies a list of Spark table changes to an <a href="../UpdateSchema.html" title="interface in org.apache.iceberg"><code>UpdateSchema</code></a> operation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#catalogAndIdentifier(java.lang.String,org.apache.spark.sql.SparkSession,java.lang.String)">catalogAndIdentifier</a></span>&#8203;(java.lang.String&nbsp;description,
org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#catalogAndIdentifier(java.lang.String,org.apache.spark.sql.SparkSession,java.lang.String,org.apache.spark.sql.connector.catalog.CatalogPlugin)">catalogAndIdentifier</a></span>&#8203;(java.lang.String&nbsp;description,
org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name,
org.apache.spark.sql.connector.catalog.CatalogPlugin&nbsp;defaultCatalog)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.lang.String)">catalogAndIdentifier</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.lang.String,org.apache.spark.sql.connector.catalog.CatalogPlugin)">catalogAndIdentifier</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name,
org.apache.spark.sql.connector.catalog.CatalogPlugin&nbsp;defaultCatalog)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.util.List)">catalogAndIdentifier</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.util.List&lt;java.lang.String&gt;&nbsp;nameParts)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.util.List,org.apache.spark.sql.connector.catalog.CatalogPlugin)">catalogAndIdentifier</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.util.List&lt;java.lang.String&gt;&nbsp;nameParts,
org.apache.spark.sql.connector.catalog.CatalogPlugin&nbsp;defaultCatalog)</code></th>
<td class="colLast">
<div class="block">A modified version of Spark's LookupCatalog.CatalogAndIdentifier.unapply
Attempts to find the catalog and identifier a multipart identifier represents</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describe(org.apache.iceberg.expressions.Expression)">describe</a></span>&#8203;(<a href="../expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describe(org.apache.iceberg.Schema)">describe</a></span>&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describe(org.apache.iceberg.SortOrder)">describe</a></span>&#8203;(<a href="../SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;order)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describe(org.apache.iceberg.types.Type)">describe</a></span>&#8203;(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a>&nbsp;type)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extensionsEnabled(org.apache.spark.sql.SparkSession)">extensionsEnabled</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static java.util.List&lt;<a href="SparkTableUtil.SparkPartition.html" title="class in org.apache.iceberg.spark">SparkTableUtil.SparkPartition</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitions(org.apache.spark.sql.SparkSession,org.apache.hadoop.fs.Path,java.lang.String,java.util.Map)">getPartitions</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
org.apache.hadoop.fs.Path&nbsp;rootPath,
java.lang.String&nbsp;format,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;partitionFilter)</code></th>
<td class="colLast">
<div class="block">Use Spark to list all partitions in the table.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a href="../catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identifierToTableIdentifier(org.apache.spark.sql.connector.catalog.Identifier)">identifierToTableIdentifier</a></span>&#8203;(org.apache.spark.sql.connector.catalog.Identifier&nbsp;identifier)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadIcebergTable(org.apache.spark.sql.SparkSession,java.lang.String)">loadIcebergTable</a></span>&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns an Iceberg Table by its name from a Spark V2 Catalog.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rebuildCreateProperties(java.util.Map)">rebuildCreateProperties</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;createProperties)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static org.apache.spark.sql.util.CaseInsensitiveStringMap</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOption(java.lang.String,java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)">setOption</a></span>&#8203;(java.lang.String&nbsp;key,
java.lang.String&nbsp;value,
org.apache.spark.sql.util.CaseInsensitiveStringMap&nbsp;options)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toIcebergTable(org.apache.spark.sql.connector.catalog.Table)">toIcebergTable</a></span>&#8203;(org.apache.spark.sql.connector.catalog.Table&nbsp;table)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static <a href="../expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toIcebergTerm(org.apache.spark.sql.connector.expressions.Expression)">toIcebergTerm</a></span>&#8203;(org.apache.spark.sql.connector.expressions.Expression&nbsp;expr)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static org.apache.spark.sql.connector.expressions.NamedReference</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toNamedReference(java.lang.String)">toNamedReference</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static <a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toPartitionSpec(org.apache.iceberg.Schema,org.apache.spark.sql.connector.expressions.Transform%5B%5D)">toPartitionSpec</a></span>&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
org.apache.spark.sql.connector.expressions.Transform[]&nbsp;partitioning)</code></th>
<td class="colLast">
<div class="block">Converts Spark transforms into a <a href="../PartitionSpec.html" title="class in org.apache.iceberg"><code>PartitionSpec</code></a>.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static org.apache.spark.sql.connector.expressions.Transform[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toTransforms(org.apache.iceberg.PartitionSpec)">toTransforms</a></span>&#8203;(<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec)</code></th>
<td class="colLast">
<div class="block">Converts a PartitionSpec to Spark transforms.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static org.apache.spark.sql.catalyst.TableIdentifier</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toV1TableIdentifier(org.apache.spark.sql.connector.catalog.Identifier)">toV1TableIdentifier</a></span>&#8203;(org.apache.spark.sql.connector.catalog.Identifier&nbsp;identifier)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setOption(java.lang.String,java.lang.String,org.apache.spark.sql.util.CaseInsensitiveStringMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOption</h4>
<pre class="methodSignature">public static&nbsp;org.apache.spark.sql.util.CaseInsensitiveStringMap&nbsp;setOption&#8203;(java.lang.String&nbsp;key,
java.lang.String&nbsp;value,
org.apache.spark.sql.util.CaseInsensitiveStringMap&nbsp;options)</pre>
</li>
</ul>
<a id="rebuildCreateProperties(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rebuildCreateProperties</h4>
<pre class="methodSignature">public static&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;rebuildCreateProperties&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;createProperties)</pre>
</li>
</ul>
<a id="applyPropertyChanges(org.apache.iceberg.UpdateProperties,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyPropertyChanges</h4>
<pre class="methodSignature">public static&nbsp;<a href="../UpdateProperties.html" title="interface in org.apache.iceberg">UpdateProperties</a>&nbsp;applyPropertyChanges&#8203;(<a href="../UpdateProperties.html" title="interface in org.apache.iceberg">UpdateProperties</a>&nbsp;pendingUpdate,
java.util.List&lt;org.apache.spark.sql.connector.catalog.TableChange&gt;&nbsp;changes)</pre>
<div class="block">Applies a list of Spark table changes to an <a href="../UpdateProperties.html" title="interface in org.apache.iceberg"><code>UpdateProperties</code></a> operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pendingUpdate</code> - an uncommitted UpdateProperties operation to configure</dd>
<dd><code>changes</code> - a list of Spark table changes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the UpdateProperties operation configured with the changes</dd>
</dl>
</li>
</ul>
<a id="applySchemaChanges(org.apache.iceberg.UpdateSchema,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applySchemaChanges</h4>
<pre class="methodSignature">public static&nbsp;<a href="../UpdateSchema.html" title="interface in org.apache.iceberg">UpdateSchema</a>&nbsp;applySchemaChanges&#8203;(<a href="../UpdateSchema.html" title="interface in org.apache.iceberg">UpdateSchema</a>&nbsp;pendingUpdate,
java.util.List&lt;org.apache.spark.sql.connector.catalog.TableChange&gt;&nbsp;changes)</pre>
<div class="block">Applies a list of Spark table changes to an <a href="../UpdateSchema.html" title="interface in org.apache.iceberg"><code>UpdateSchema</code></a> operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pendingUpdate</code> - an uncommitted UpdateSchema operation to configure</dd>
<dd><code>changes</code> - a list of Spark table changes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the UpdateSchema operation configured with the changes</dd>
</dl>
</li>
</ul>
<a id="toIcebergTable(org.apache.spark.sql.connector.catalog.Table)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toIcebergTable</h4>
<pre class="methodSignature">public static&nbsp;<a href="../Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;toIcebergTable&#8203;(org.apache.spark.sql.connector.catalog.Table&nbsp;table)</pre>
</li>
</ul>
<a id="toTransforms(org.apache.iceberg.PartitionSpec)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toTransforms</h4>
<pre class="methodSignature">public static&nbsp;org.apache.spark.sql.connector.expressions.Transform[]&nbsp;toTransforms&#8203;(<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec)</pre>
<div class="block">Converts a PartitionSpec to Spark transforms.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spec</code> - a PartitionSpec</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array of Transforms</dd>
</dl>
</li>
</ul>
<a id="toNamedReference(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toNamedReference</h4>
<pre class="methodSignature">public static&nbsp;org.apache.spark.sql.connector.expressions.NamedReference&nbsp;toNamedReference&#8203;(java.lang.String&nbsp;name)</pre>
</li>
</ul>
<a id="toIcebergTerm(org.apache.spark.sql.connector.expressions.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toIcebergTerm</h4>
<pre class="methodSignature">public static&nbsp;<a href="../expressions/Term.html" title="interface in org.apache.iceberg.expressions">Term</a>&nbsp;toIcebergTerm&#8203;(org.apache.spark.sql.connector.expressions.Expression&nbsp;expr)</pre>
</li>
</ul>
<a id="toPartitionSpec(org.apache.iceberg.Schema,org.apache.spark.sql.connector.expressions.Transform[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPartitionSpec</h4>
<pre class="methodSignature">public static&nbsp;<a href="../PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;toPartitionSpec&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
org.apache.spark.sql.connector.expressions.Transform[]&nbsp;partitioning)</pre>
<div class="block">Converts Spark transforms into a <a href="../PartitionSpec.html" title="class in org.apache.iceberg"><code>PartitionSpec</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - the table schema</dd>
<dd><code>partitioning</code> - Spark Transforms</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a PartitionSpec</dd>
</dl>
</li>
</ul>
<a id="describe(org.apache.iceberg.expressions.Expression)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describe</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;describe&#8203;(<a href="../expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr)</pre>
</li>
</ul>
<a id="describe(org.apache.iceberg.Schema)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describe</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;describe&#8203;(<a href="../Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema)</pre>
</li>
</ul>
<a id="describe(org.apache.iceberg.types.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describe</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;describe&#8203;(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a>&nbsp;type)</pre>
</li>
</ul>
<a id="describe(org.apache.iceberg.SortOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>describe</h4>
<pre class="methodSignature">public static&nbsp;java.lang.String&nbsp;describe&#8203;(<a href="../SortOrder.html" title="class in org.apache.iceberg">SortOrder</a>&nbsp;order)</pre>
</li>
</ul>
<a id="extensionsEnabled(org.apache.spark.sql.SparkSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensionsEnabled</h4>
<pre class="methodSignature">public static&nbsp;boolean&nbsp;extensionsEnabled&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark)</pre>
</li>
</ul>
<a id="loadIcebergTable(org.apache.spark.sql.SparkSession,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadIcebergTable</h4>
<pre class="methodSignature">public static&nbsp;<a href="../Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;loadIcebergTable&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name)
throws org.apache.spark.sql.catalyst.parser.ParseException,
org.apache.spark.sql.catalyst.analysis.NoSuchTableException</pre>
<div class="block">Returns an Iceberg Table by its name from a Spark V2 Catalog. If cache is enabled in <a href="SparkCatalog.html" title="class in org.apache.iceberg.spark"><code>SparkCatalog</code></a>,
the <a href="../TableOperations.html" title="interface in org.apache.iceberg"><code>TableOperations</code></a> of the table may be stale, please refresh the table to get the latest one.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spark</code> - SparkSession used for looking up catalog references and tables</dd>
<dd><code>name</code> - The multipart identifier of the Iceberg table</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Iceberg table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.spark.sql.catalyst.parser.ParseException</code></dd>
<dd><code>org.apache.spark.sql.catalyst.analysis.NoSuchTableException</code></dd>
</dl>
</li>
</ul>
<a id="catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>catalogAndIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a>&nbsp;catalogAndIdentifier&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name)
throws org.apache.spark.sql.catalyst.parser.ParseException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.spark.sql.catalyst.parser.ParseException</code></dd>
</dl>
</li>
</ul>
<a id="catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.lang.String,org.apache.spark.sql.connector.catalog.CatalogPlugin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>catalogAndIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a>&nbsp;catalogAndIdentifier&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name,
org.apache.spark.sql.connector.catalog.CatalogPlugin&nbsp;defaultCatalog)
throws org.apache.spark.sql.catalyst.parser.ParseException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.spark.sql.catalyst.parser.ParseException</code></dd>
</dl>
</li>
</ul>
<a id="catalogAndIdentifier(java.lang.String,org.apache.spark.sql.SparkSession,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>catalogAndIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a>&nbsp;catalogAndIdentifier&#8203;(java.lang.String&nbsp;description,
org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name)</pre>
</li>
</ul>
<a id="catalogAndIdentifier(java.lang.String,org.apache.spark.sql.SparkSession,java.lang.String,org.apache.spark.sql.connector.catalog.CatalogPlugin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>catalogAndIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a>&nbsp;catalogAndIdentifier&#8203;(java.lang.String&nbsp;description,
org.apache.spark.sql.SparkSession&nbsp;spark,
java.lang.String&nbsp;name,
org.apache.spark.sql.connector.catalog.CatalogPlugin&nbsp;defaultCatalog)</pre>
</li>
</ul>
<a id="catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>catalogAndIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a>&nbsp;catalogAndIdentifier&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.util.List&lt;java.lang.String&gt;&nbsp;nameParts)</pre>
</li>
</ul>
<a id="catalogAndIdentifier(org.apache.spark.sql.SparkSession,java.util.List,org.apache.spark.sql.connector.catalog.CatalogPlugin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>catalogAndIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="Spark3Util.CatalogAndIdentifier.html" title="class in org.apache.iceberg.spark">Spark3Util.CatalogAndIdentifier</a>&nbsp;catalogAndIdentifier&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
java.util.List&lt;java.lang.String&gt;&nbsp;nameParts,
org.apache.spark.sql.connector.catalog.CatalogPlugin&nbsp;defaultCatalog)</pre>
<div class="block">A modified version of Spark's LookupCatalog.CatalogAndIdentifier.unapply
Attempts to find the catalog and identifier a multipart identifier represents</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spark</code> - Spark session to use for resolution</dd>
<dd><code>nameParts</code> - Multipart identifier representing a table</dd>
<dd><code>defaultCatalog</code> - Catalog to use if none is specified</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CatalogPlugin and Identifier for the table</dd>
</dl>
</li>
</ul>
<a id="identifierToTableIdentifier(org.apache.spark.sql.connector.catalog.Identifier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identifierToTableIdentifier</h4>
<pre class="methodSignature">public static&nbsp;<a href="../catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifierToTableIdentifier&#8203;(org.apache.spark.sql.connector.catalog.Identifier&nbsp;identifier)</pre>
</li>
</ul>
<a id="getPartitions(org.apache.spark.sql.SparkSession,org.apache.hadoop.fs.Path,java.lang.String,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitions</h4>
<pre class="methodSignature">public static&nbsp;java.util.List&lt;<a href="SparkTableUtil.SparkPartition.html" title="class in org.apache.iceberg.spark">SparkTableUtil.SparkPartition</a>&gt;&nbsp;getPartitions&#8203;(org.apache.spark.sql.SparkSession&nbsp;spark,
org.apache.hadoop.fs.Path&nbsp;rootPath,
java.lang.String&nbsp;format,
java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;partitionFilter)</pre>
<div class="block">Use Spark to list all partitions in the table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spark</code> - a Spark session</dd>
<dd><code>rootPath</code> - a table identifier</dd>
<dd><code>format</code> - format of the file</dd>
<dd><code>partitionFilter</code> - partitionFilter of the file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all table's partitions</dd>
</dl>
</li>
</ul>
<a id="toV1TableIdentifier(org.apache.spark.sql.connector.catalog.Identifier)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toV1TableIdentifier</h4>
<pre class="methodSignature">public static&nbsp;org.apache.spark.sql.catalyst.TableIdentifier&nbsp;toV1TableIdentifier&#8203;(org.apache.spark.sql.connector.catalog.Identifier&nbsp;identifier)</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>