| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.12) on Mon Nov 08 18:33:49 PST 2021 --> |
| <title>SparkDataFile</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <meta name="dc.created" content="2021-11-08"> |
| <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="SparkDataFile"; |
| } |
| } |
| 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,"i17":10,"i18":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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.iceberg.spark</a></div> |
| <h2 title="Class SparkDataFile" class="title">Class SparkDataFile</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.iceberg.spark.SparkDataFile</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code>, <code><a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SparkDataFile</span> |
| extends java.lang.Object |
| implements <a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.iceberg.DataFile"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.iceberg.<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></h3> |
| <code><a href="../DataFile.html#COLUMN_SIZES">COLUMN_SIZES</a>, <a href="../DataFile.html#CONTENT">CONTENT</a>, <a href="../DataFile.html#EQUALITY_IDS">EQUALITY_IDS</a>, <a href="../DataFile.html#FILE_FORMAT">FILE_FORMAT</a>, <a href="../DataFile.html#FILE_PATH">FILE_PATH</a>, <a href="../DataFile.html#FILE_SIZE">FILE_SIZE</a>, <a href="../DataFile.html#KEY_METADATA">KEY_METADATA</a>, <a href="../DataFile.html#LOWER_BOUNDS">LOWER_BOUNDS</a>, <a href="../DataFile.html#NAN_VALUE_COUNTS">NAN_VALUE_COUNTS</a>, <a href="../DataFile.html#NULL_VALUE_COUNTS">NULL_VALUE_COUNTS</a>, <a href="../DataFile.html#PARTITION_DOC">PARTITION_DOC</a>, <a href="../DataFile.html#PARTITION_ID">PARTITION_ID</a>, <a href="../DataFile.html#PARTITION_NAME">PARTITION_NAME</a>, <a href="../DataFile.html#RECORD_COUNT">RECORD_COUNT</a>, <a href="../DataFile.html#SORT_ORDER_ID">SORT_ORDER_ID</a>, <a href="../DataFile.html#SPLIT_OFFSETS">SPLIT_OFFSETS</a>, <a href="../DataFile.html#UPPER_BOUNDS">UPPER_BOUNDS</a>, <a href="../DataFile.html#VALUE_COUNTS">VALUE_COUNTS</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.iceberg.types.Types.StructType,org.apache.spark.sql.types.StructType)">SparkDataFile</a></span>​(<a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> type, |
| org.apache.spark.sql.types.StructType sparkType)</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>java.util.Map<java.lang.Integer,​java.lang.Long></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#columnSizes()">columnSizes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns if collected, map from column ID to the size of the column in bytes, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy()">copy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Copies this file.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copyWithoutStats()">copyWithoutStats</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Copies this file without file stats.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fileSizeInBytes()">fileSizeInBytes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the file size in bytes.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format()">format</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns format of the file.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyMetadata()">keyMetadata</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns metadata about how this file is encrypted, or null if the file is stored in plain text.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,​java.nio.ByteBuffer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lowerBounds()">lowerBounds</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns if collected, map from column ID to value lower bounds, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,​java.lang.Long></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nanValueCounts()">nanValueCounts</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns if collected, map from column ID to its NaN value count, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,​java.lang.Long></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nullValueCounts()">nullValueCounts</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns if collected, map from column ID to its null value count, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#partition()">partition</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns partition for this file as a <a href="../StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.CharSequence</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#path()">path</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns fully qualified path to the file, suitable for constructing a Hadoop Path.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pos()">pos</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recordCount()">recordCount</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of top-level records in the file.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sortOrderId()">sortOrderId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the sort order id of this file, which describes how the file is ordered.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#specId()">specId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns id of the partition spec used for partition metadata.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.Long></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#splitOffsets()">splitOffsets</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns list of recommended split locations, if applicable, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,​java.nio.ByteBuffer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upperBounds()">upperBounds</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns if collected, map from column ID to value upper bounds, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.Integer,​java.lang.Long></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueCounts()">valueCounts</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns if collected, map from column ID to the count of its non-null values, null otherwise.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="SparkDataFile.html" title="class in org.apache.iceberg.spark">SparkDataFile</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrap(org.apache.spark.sql.Row)">wrap</a></span>​(org.apache.spark.sql.Row row)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.DataFile"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></h3> |
| <code><a href="../DataFile.html#content()">content</a>, <a href="../DataFile.html#equalityFieldIds()">equalityFieldIds</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.iceberg.types.Types.StructType,org.apache.spark.sql.types.StructType)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SparkDataFile</h4> |
| <pre>public SparkDataFile​(<a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> type, |
| org.apache.spark.sql.types.StructType sparkType)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="wrap(org.apache.spark.sql.Row)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre class="methodSignature">public <a href="SparkDataFile.html" title="class in org.apache.iceberg.spark">SparkDataFile</a> wrap​(org.apache.spark.sql.Row row)</pre> |
| </li> |
| </ul> |
| <a id="pos()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pos</h4> |
| <pre class="methodSignature">public java.lang.Long pos()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#pos()">ContentFile</a></code></span></div> |
| <div class="block">Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#pos()">pos</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="specId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>specId</h4> |
| <pre class="methodSignature">public int specId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#specId()">ContentFile</a></code></span></div> |
| <div class="block">Returns id of the partition spec used for partition metadata.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#specId()">specId</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="path()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>path</h4> |
| <pre class="methodSignature">public java.lang.CharSequence path()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#path()">ContentFile</a></code></span></div> |
| <div class="block">Returns fully qualified path to the file, suitable for constructing a Hadoop Path.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#path()">path</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="format()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre class="methodSignature">public <a href="../FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a> format()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#format()">ContentFile</a></code></span></div> |
| <div class="block">Returns format of the file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#format()">format</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="partition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partition</h4> |
| <pre class="methodSignature">public <a href="../StructLike.html" title="interface in org.apache.iceberg">StructLike</a> partition()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#partition()">ContentFile</a></code></span></div> |
| <div class="block">Returns partition for this file as a <a href="../StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#partition()">partition</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="recordCount()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recordCount</h4> |
| <pre class="methodSignature">public long recordCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#recordCount()">ContentFile</a></code></span></div> |
| <div class="block">Returns the number of top-level records in the file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#recordCount()">recordCount</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="fileSizeInBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fileSizeInBytes</h4> |
| <pre class="methodSignature">public long fileSizeInBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#fileSizeInBytes()">ContentFile</a></code></span></div> |
| <div class="block">Returns the file size in bytes.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#fileSizeInBytes()">fileSizeInBytes</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="columnSizes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnSizes</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Integer,​java.lang.Long> columnSizes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#columnSizes()">ContentFile</a></code></span></div> |
| <div class="block">Returns if collected, map from column ID to the size of the column in bytes, null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#columnSizes()">columnSizes</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="valueCounts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueCounts</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Integer,​java.lang.Long> valueCounts()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#valueCounts()">ContentFile</a></code></span></div> |
| <div class="block">Returns if collected, map from column ID to the count of its non-null values, null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#valueCounts()">valueCounts</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="nullValueCounts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nullValueCounts</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Integer,​java.lang.Long> nullValueCounts()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#nullValueCounts()">ContentFile</a></code></span></div> |
| <div class="block">Returns if collected, map from column ID to its null value count, null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#nullValueCounts()">nullValueCounts</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="nanValueCounts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nanValueCounts</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Integer,​java.lang.Long> nanValueCounts()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#nanValueCounts()">ContentFile</a></code></span></div> |
| <div class="block">Returns if collected, map from column ID to its NaN value count, null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#nanValueCounts()">nanValueCounts</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="lowerBounds()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lowerBounds</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Integer,​java.nio.ByteBuffer> lowerBounds()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#lowerBounds()">ContentFile</a></code></span></div> |
| <div class="block">Returns if collected, map from column ID to value lower bounds, null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#lowerBounds()">lowerBounds</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="upperBounds()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>upperBounds</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.Integer,​java.nio.ByteBuffer> upperBounds()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#upperBounds()">ContentFile</a></code></span></div> |
| <div class="block">Returns if collected, map from column ID to value upper bounds, null otherwise.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#upperBounds()">upperBounds</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="keyMetadata()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keyMetadata</h4> |
| <pre class="methodSignature">public java.nio.ByteBuffer keyMetadata()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#keyMetadata()">ContentFile</a></code></span></div> |
| <div class="block">Returns metadata about how this file is encrypted, or null if the file is stored in plain text.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#keyMetadata()">keyMetadata</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre class="methodSignature">public <a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a> copy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#copy()">ContentFile</a></code></span></div> |
| <div class="block">Copies this file. Manifest readers can reuse file instances; use |
| this method to copy data when collecting files from tasks.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#copy()">copy</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of this data file</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="copyWithoutStats()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyWithoutStats</h4> |
| <pre class="methodSignature">public <a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a> copyWithoutStats()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#copyWithoutStats()">ContentFile</a></code></span></div> |
| <div class="block">Copies this file without file stats. Manifest readers can reuse file instances; use |
| this method to copy data without stats when collecting files.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#copyWithoutStats()">copyWithoutStats</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a copy of this data file, without lower bounds, upper bounds, value counts, |
| null value counts, or nan value counts</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="splitOffsets()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitOffsets</h4> |
| <pre class="methodSignature">public java.util.List<java.lang.Long> splitOffsets()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#splitOffsets()">ContentFile</a></code></span></div> |
| <div class="block">Returns list of recommended split locations, if applicable, null otherwise. |
| <p> |
| When available, this information is used for planning scan tasks whose boundaries |
| are determined by these offsets. The returned list must be sorted in ascending order.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#splitOffsets()">splitOffsets</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sortOrderId()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>sortOrderId</h4> |
| <pre class="methodSignature">public java.lang.Integer sortOrderId()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../ContentFile.html#sortOrderId()">ContentFile</a></code></span></div> |
| <div class="block">Returns the sort order id of this file, which describes how the file is ordered. |
| This information will be useful for merging data and equality delete files more efficiently |
| when they share the same sort order id.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../ContentFile.html#sortOrderId()">sortOrderId</a></code> in interface <code><a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </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 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |