blob: a51fd850b251a8f63600209ede5a90650fc3fd09 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>PartitionSpec.Builder</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="PartitionSpec.Builder";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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>Nested&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</a></div>
<h2 title="Class PartitionSpec.Builder" class="title">Class PartitionSpec.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.PartitionSpec.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">PartitionSpec.Builder</span>
extends java.lang.Object</pre>
<div class="block">Used to create valid <a href="PartitionSpec.html" title="class in org.apache.iceberg"><code>partition specs</code></a>.
<p>
Call <a href="PartitionSpec.html#builderFor(org.apache.iceberg.Schema)"><code>PartitionSpec.builderFor(Schema)</code></a> to create a new builder.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alwaysNull(java.lang.String)">alwaysNull</a></span>&#8203;(java.lang.String&nbsp;sourceName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alwaysNull(java.lang.String,java.lang.String)">alwaysNull</a></span>&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bucket(java.lang.String,int)">bucket</a></span>&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;numBuckets)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bucket(java.lang.String,int,java.lang.String)">bucket</a></span>&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;numBuckets,
java.lang.String&nbsp;targetName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><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="#build()">build</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#day(java.lang.String)">day</a></span>&#8203;(java.lang.String&nbsp;sourceName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#day(java.lang.String,java.lang.String)">day</a></span>&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hour(java.lang.String)">hour</a></span>&#8203;(java.lang.String&nbsp;sourceName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hour(java.lang.String,java.lang.String)">hour</a></span>&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identity(java.lang.String)">identity</a></span>&#8203;(java.lang.String&nbsp;sourceName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#month(java.lang.String)">month</a></span>&#8203;(java.lang.String&nbsp;sourceName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#month(java.lang.String,java.lang.String)">month</a></span>&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#truncate(java.lang.String,int)">truncate</a></span>&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;width)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#truncate(java.lang.String,int,java.lang.String)">truncate</a></span>&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;width,
java.lang.String&nbsp;targetName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withSpecId(int)">withSpecId</a></span>&#8203;(int&nbsp;newSpecId)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#year(java.lang.String)">year</a></span>&#8203;(java.lang.String&nbsp;sourceName)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#year(java.lang.String,java.lang.String)">year</a></span>&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</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="withSpecId(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withSpecId</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;withSpecId&#8203;(int&nbsp;newSpecId)</pre>
</li>
</ul>
<a id="identity(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identity</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;identity&#8203;(java.lang.String&nbsp;sourceName)</pre>
</li>
</ul>
<a id="year(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>year</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;year&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="year(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>year</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;year&#8203;(java.lang.String&nbsp;sourceName)</pre>
</li>
</ul>
<a id="month(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>month</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;month&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="month(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>month</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;month&#8203;(java.lang.String&nbsp;sourceName)</pre>
</li>
</ul>
<a id="day(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>day</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;day&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="day(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>day</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;day&#8203;(java.lang.String&nbsp;sourceName)</pre>
</li>
</ul>
<a id="hour(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hour</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;hour&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="hour(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hour</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;hour&#8203;(java.lang.String&nbsp;sourceName)</pre>
</li>
</ul>
<a id="bucket(java.lang.String,int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bucket</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;bucket&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;numBuckets,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="bucket(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bucket</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;bucket&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;numBuckets)</pre>
</li>
</ul>
<a id="truncate(java.lang.String,int,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truncate</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;truncate&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;width,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="truncate(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>truncate</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;truncate&#8203;(java.lang.String&nbsp;sourceName,
int&nbsp;width)</pre>
</li>
</ul>
<a id="alwaysNull(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>alwaysNull</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;alwaysNull&#8203;(java.lang.String&nbsp;sourceName,
java.lang.String&nbsp;targetName)</pre>
</li>
</ul>
<a id="alwaysNull(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>alwaysNull</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.Builder.html" title="class in org.apache.iceberg">PartitionSpec.Builder</a>&nbsp;alwaysNull&#8203;(java.lang.String&nbsp;sourceName)</pre>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;build()</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>Nested&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>