| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SparkDataFile</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <meta name="description" content="declaration: package: org.apache.iceberg.spark, class: SparkDataFile"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.iceberg.spark</a></div> |
| <h1 title="Class SparkDataFile" class="title">Class SparkDataFile</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="SparkContentFile.html" title="class in org.apache.iceberg.spark">org.apache.iceberg.spark.SparkContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>> |
| <div class="inheritance">org.apache.iceberg.spark.SparkDataFile</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <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> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SparkDataFile</span> |
| <span class="extends-implements">extends <a href="SparkContentFile.html" title="class in org.apache.iceberg.spark">SparkContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>> |
| implements <a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.iceberg.DataFile">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#CONTENT_OFFSET">CONTENT_OFFSET</a>, <a href="../DataFile.html#CONTENT_SIZE">CONTENT_SIZE</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#FIRST_ROW_ID">FIRST_ROW_ID</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#REFERENCED_DATA_FILE">REFERENCED_DATA_FILE</a>, <a href="../DataFile.html#SORT_ORDER_ID">SORT_ORDER_ID</a>, <a href="../DataFile.html#SPEC_ID">SPEC_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></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.iceberg.types.Types.StructType,org.apache.iceberg.types.Types.StructType,org.apache.spark.sql.types.StructType)" class="member-name-link">SparkDataFile</a><wbr>(<a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> type, |
| <a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> projectedType, |
| org.apache.spark.sql.types.StructType sparkType)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.iceberg.types.Types.StructType,org.apache.spark.sql.types.StructType)" class="member-name-link">SparkDataFile</a><wbr>(<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></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#asFile()" class="member-name-link">asFile</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equalityFieldIds()" class="member-name-link">equalityFieldIds</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the set of field IDs used for equality comparison, in equality delete files.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.iceberg.spark.SparkContentFile">Methods inherited from class org.apache.iceberg.spark.<a href="SparkContentFile.html" title="class in org.apache.iceberg.spark">SparkContentFile</a></h3> |
| <code><a href="SparkContentFile.html#columnSizes()">columnSizes</a>, <a href="SparkContentFile.html#content()">content</a>, <a href="SparkContentFile.html#contentOffset()">contentOffset</a>, <a href="SparkContentFile.html#contentSizeInBytes()">contentSizeInBytes</a>, <a href="SparkContentFile.html#copy()">copy</a>, <a href="SparkContentFile.html#copyWithoutStats()">copyWithoutStats</a>, <a href="SparkContentFile.html#fileSizeInBytes()">fileSizeInBytes</a>, <a href="SparkContentFile.html#format()">format</a>, <a href="SparkContentFile.html#keyMetadata()">keyMetadata</a>, <a href="SparkContentFile.html#lowerBounds()">lowerBounds</a>, <a href="SparkContentFile.html#nanValueCounts()">nanValueCounts</a>, <a href="SparkContentFile.html#nullValueCounts()">nullValueCounts</a>, <a href="SparkContentFile.html#partition()">partition</a>, <a href="SparkContentFile.html#path()">path</a>, <a href="SparkContentFile.html#pos()">pos</a>, <a href="SparkContentFile.html#recordCount()">recordCount</a>, <a href="SparkContentFile.html#referencedDataFile()">referencedDataFile</a>, <a href="SparkContentFile.html#sortOrderId()">sortOrderId</a>, <a href="SparkContentFile.html#specId()">specId</a>, <a href="SparkContentFile.html#splitOffsets()">splitOffsets</a>, <a href="SparkContentFile.html#upperBounds()">upperBounds</a>, <a href="SparkContentFile.html#valueCounts()">valueCounts</a>, <a href="SparkContentFile.html#wrap(org.apache.spark.sql.Row)">wrap</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.iceberg.ContentFile">Methods inherited from interface org.apache.iceberg.<a href="../ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a></h3> |
| <code><a href="../ContentFile.html#columnSizes()">columnSizes</a>, <a href="../ContentFile.html#copy()">copy</a>, <a href="../ContentFile.html#copy(boolean)">copy</a>, <a href="../ContentFile.html#copyWithoutStats()">copyWithoutStats</a>, <a href="../ContentFile.html#copyWithStats(java.util.Set)">copyWithStats</a>, <a href="../ContentFile.html#dataSequenceNumber()">dataSequenceNumber</a>, <a href="../ContentFile.html#fileSequenceNumber()">fileSequenceNumber</a>, <a href="../ContentFile.html#fileSizeInBytes()">fileSizeInBytes</a>, <a href="../ContentFile.html#firstRowId()">firstRowId</a>, <a href="../ContentFile.html#format()">format</a>, <a href="../ContentFile.html#keyMetadata()">keyMetadata</a>, <a href="../ContentFile.html#location()">location</a>, <a href="../ContentFile.html#lowerBounds()">lowerBounds</a>, <a href="../ContentFile.html#manifestLocation()">manifestLocation</a>, <a href="../ContentFile.html#nanValueCounts()">nanValueCounts</a>, <a href="../ContentFile.html#nullValueCounts()">nullValueCounts</a>, <a href="../ContentFile.html#partition()">partition</a>, <a href="../ContentFile.html#path()">path</a>, <a href="../ContentFile.html#pos()">pos</a>, <a href="../ContentFile.html#recordCount()">recordCount</a>, <a href="../ContentFile.html#sortOrderId()">sortOrderId</a>, <a href="../ContentFile.html#specId()">specId</a>, <a href="../ContentFile.html#splitOffsets()">splitOffsets</a>, <a href="../ContentFile.html#upperBounds()">upperBounds</a>, <a href="../ContentFile.html#valueCounts()">valueCounts</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.iceberg.DataFile">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></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.iceberg.types.Types.StructType,org.apache.spark.sql.types.StructType)"> |
| <h3>SparkDataFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SparkDataFile</span><wbr><span class="parameters">(<a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> type, |
| org.apache.spark.sql.types.StructType sparkType)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.iceberg.types.Types.StructType,org.apache.iceberg.types.Types.StructType,org.apache.spark.sql.types.StructType)"> |
| <h3>SparkDataFile</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SparkDataFile</span><wbr><span class="parameters">(<a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> type, |
| <a href="../types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a> projectedType, |
| org.apache.spark.sql.types.StructType sparkType)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="asFile()"> |
| <h3>asFile</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></span> <span class="element-name">asFile</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SparkContentFile.html#asFile()">asFile</a></code> in class <code><a href="SparkContentFile.html" title="class in org.apache.iceberg.spark">SparkContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equalityFieldIds()"> |
| <h3>equalityFieldIds</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">equalityFieldIds</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ContentFile.html#equalityFieldIds()">ContentFile</a></code></span></div> |
| <div class="block">Returns the set of field IDs used for equality comparison, in equality delete files. |
| |
| <p>An equality delete file may contain additional data fields that are not used by equality |
| comparison. The subset of columns in a delete file to be used in equality comparison are |
| tracked by ID. Extra columns can be used to reconstruct changes and metrics from extra columns |
| are used during job planning.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ContentFile.html#equalityFieldIds()">equalityFieldIds</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>Specified by:</dt> |
| <dd><code><a href="../DataFile.html#equalityFieldIds()">equalityFieldIds</a></code> in interface <code><a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="SparkContentFile.html#equalityFieldIds()">equalityFieldIds</a></code> in class <code><a href="SparkContentFile.html" title="class in org.apache.iceberg.spark">SparkContentFile</a><<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></dd> |
| <dt>Returns:</dt> |
| <dd>IDs of the fields used in equality comparison with the records in this delete file</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
