| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.drill.exec.record.metadata (Drill : 1.20.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.drill.exec.record.metadata (Drill : 1.20.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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"> |
| <li><a href="../../../../../../org/apache/drill/exec/record/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/record/metadata/schema/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/record/metadata/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.drill.exec.record.metadata</h1> |
| <div class="docSummary"> |
| <div class="block">Provides a fluent schema builder.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.html" title="interface in org.apache.drill.exec.record.metadata">ColumnMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Metadata description of a column including names, types and structure |
| information.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/Propertied.html" title="interface in org.apache.drill.exec.record.metadata">Propertied</a></td> |
| <td class="colLast"> |
| <div class="block">Interface for an object that defines properties.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/TupleMetadata.html" title="interface in org.apache.drill.exec.record.metadata">TupleMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Metadata description of the schema of a row or a map.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantMetadata.html" title="interface in org.apache.drill.exec.record.metadata">VariantMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Describes the contents of a list or union field.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/AbstractColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">AbstractColumnMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract definition of column metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/AbstractMapColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">AbstractMapColumnMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Describes a base column type for map, dict, repeated map and repeated dict.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/AbstractPropertied.html" title="class in org.apache.drill.exec.record.metadata">AbstractPropertied</a></td> |
| <td class="colLast"> |
| <div class="block">Base class for an object with properties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnBuilder.html" title="class in org.apache.drill.exec.record.metadata">ColumnBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Build a column schema (AKA "materialized field") based on name and a |
| variety of schema options.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/DictBuilder.html" title="class in org.apache.drill.exec.record.metadata">DictBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Internal structure for building a dict.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/DictColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">DictColumnMetadata</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/DynamicColumn.html" title="class in org.apache.drill.exec.record.metadata">DynamicColumn</a></td> |
| <td class="colLast"> |
| <div class="block">A dynamic column has a name but not a type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/MapBuilder.html" title="class in org.apache.drill.exec.record.metadata">MapBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Internal structure for building a map.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/MapColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">MapColumnMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Describes a map and repeated map.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/MetadataUtils.html" title="class in org.apache.drill.exec.record.metadata">MetadataUtils</a></td> |
| <td class="colLast"> |
| <div class="block">A collection of utility methods for working with column and tuple metadata.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/PrimitiveColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">PrimitiveColumnMetadata</a></td> |
| <td class="colLast"> |
| <div class="block">Primitive (non-map) column.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/PropertyAccessor.html" title="class in org.apache.drill.exec.record.metadata">PropertyAccessor</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities to get/set typed values within a propertied object</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/RepeatedListBuilder.html" title="class in org.apache.drill.exec.record.metadata">RepeatedListBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Builder for a repeated list.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/RepeatedListColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">RepeatedListColumnMetadata</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/SchemaBuilder.html" title="class in org.apache.drill.exec.record.metadata">SchemaBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Builder of a row set schema expressed as a list of materialized |
| fields.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/TupleBuilder.html" title="class in org.apache.drill.exec.record.metadata">TupleBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Internal tuple builder shared by the schema and map builders.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/TupleNameSpace.html" title="class in org.apache.drill.exec.record.metadata">TupleNameSpace</a><T></td> |
| <td class="colLast"> |
| <div class="block">Implementation of a tuple name space.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/TupleSchema.html" title="class in org.apache.drill.exec.record.metadata">TupleSchema</a></td> |
| <td class="colLast"> |
| <div class="block">Defines the schema of a tuple: either the top-level row or a nested |
| "map" (really structure).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/UnionBuilder.html" title="class in org.apache.drill.exec.record.metadata">UnionBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Builds unions or (non-repeated) lists (which implicitly contain |
| unions.) |
| <p/> |
| Class can be created with and without parent container.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantColumnMetadata.html" title="class in org.apache.drill.exec.record.metadata">VariantColumnMetadata</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/VariantSchema.html" title="class in org.apache.drill.exec.record.metadata">VariantSchema</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/drill/exec/record/metadata/ColumnMetadata.StructureType.html" title="enum in org.apache.drill.exec.record.metadata">ColumnMetadata.StructureType</a></td> |
| <td class="colLast"> |
| <div class="block">Rough characterization of Drill types into metadata categories.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.drill.exec.record.metadata Description">Package org.apache.drill.exec.record.metadata Description</h2> |
| <div class="block">Provides a fluent schema builder. Handles all |
| forms of Drill schemas, with emphasis on ease of use for the typical |
| cases (flat schema or nested maps.) Enables construction of unions, |
| union lists (AKA "list vector") repeated lists and combinations of |
| the above structures. |
| <dt>SchemaBuilder</dt> |
| <dd>Drill normally writes data to vectors, then "discovers" the row set schema based on the |
| data written. It is usually far easier to simply declare a schema, then |
| read and write data according to that schema. The schema builder provides a simple, |
| fluent tool to create a row set schema. That schema then drives the row set readers |
| and writers, the row set printer and the row set comparison.</dd> |
| </dl></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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"> |
| <li><a href="../../../../../../org/apache/drill/exec/record/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/drill/exec/record/metadata/schema/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/drill/exec/record/metadata/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.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> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
