summaryrefslogtreecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/sql/types/package-summary.html
blob: b6ed479dce3f6156fea90ee5927d6ead5f4436e6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<!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 (version 1.7.0_51) on Wed Sep 16 15:55:14 PDT 2015 -->
<title>org.apache.spark.sql.types</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="org.apache.spark.sql.types";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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-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/spark/sql/sources/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/spark/status/api/v1/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/types/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&nbsp;org.apache.spark.sql.types</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</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/spark/sql/types/ArrayBasedMapData.html" title="class in org.apache.spark.sql.types">ArrayBasedMapData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/ArrayData.html" title="class in org.apache.spark.sql.types">ArrayData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/ArrayType.html" title="class in org.apache.spark.sql.types">ArrayType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/BinaryType.html" title="class in org.apache.spark.sql.types">BinaryType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Array[Byte]</code> values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/BooleanType.html" title="class in org.apache.spark.sql.types">BooleanType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Boolean</code> values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/ByteType.html" title="class in org.apache.spark.sql.types">ByteType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Byte</code> values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/CalendarIntervalType.html" title="class in org.apache.spark.sql.types">CalendarIntervalType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing calendar time intervals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The base type of all Spark SQL data types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/DataTypes.html" title="class in org.apache.spark.sql.types">DataTypes</a></td>
<td class="colLast">
<div class="block">To get/create specific data type, users should use singleton objects and factory methods
 provided by this class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/DateType.html" title="class in org.apache.spark.sql.types">DateType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 A date type, supporting "0001-01-01" through "9999-12-31".</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/Decimal.html" title="class in org.apache.spark.sql.types">Decimal</a></td>
<td class="colLast">
<div class="block">A mutable implementation of BigDecimal that can hold a Long if values are small enough.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/DecimalType.html" title="class in org.apache.spark.sql.types">DecimalType</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/DoubleType.html" title="class in org.apache.spark.sql.types">DoubleType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Double</code> values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/FloatType.html" title="class in org.apache.spark.sql.types">FloatType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Float</code> values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/GenericArrayData.html" title="class in org.apache.spark.sql.types">GenericArrayData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/IntegerType.html" title="class in org.apache.spark.sql.types">IntegerType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Int</code> values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/LongType.html" title="class in org.apache.spark.sql.types">LongType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Long</code> values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/MapData.html" title="class in org.apache.spark.sql.types">MapData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/MapType.html" title="class in org.apache.spark.sql.types">MapType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type for Maps.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/Metadata.html" title="class in org.apache.spark.sql.types">Metadata</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/MetadataBuilder.html" title="class in org.apache.spark.sql.types">MetadataBuilder</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/NullType.html" title="class in org.apache.spark.sql.types">NullType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>NULL</code> values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/NumericType.html" title="class in org.apache.spark.sql.types">NumericType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 Numeric data types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/PrecisionInfo.html" title="class in org.apache.spark.sql.types">PrecisionInfo</a></td>
<td class="colLast">
<div class="block">Precision parameters for a Decimal</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/ShortType.html" title="class in org.apache.spark.sql.types">ShortType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>Short</code> values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/StringType.html" title="class in org.apache.spark.sql.types">StringType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>String</code> values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/StructField.html" title="class in org.apache.spark.sql.types">StructField</a></td>
<td class="colLast">
<div class="block">A field inside a StructType.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 A <a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types"><code>StructType</code></a> object can be constructed by</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/TimestampType.html" title="class in org.apache.spark.sql.types">TimestampType</a></td>
<td class="colLast">
<div class="block">:: DeveloperApi ::
 The data type representing <code>java.sql.Timestamp</code> values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/UserDefinedType.html" title="class in org.apache.spark.sql.types">UserDefinedType</a>&lt;UserType&gt;</td>
<td class="colLast">
<div class="block">::DeveloperApi::
 The data type for User Defined Types (UDTs).</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/spark/sql/types/SQLUserDefinedType.html" title="annotation in org.apache.spark.sql.types">SQLUserDefinedType</a></td>
<td class="colLast">
<div class="block">::DeveloperApi::
 A user-defined type which can be automatically recognized by a SQLContext and registered.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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-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/spark/sql/sources/package-summary.html">Prev Package</a></li>
<li><a href="../../../../../org/apache/spark/status/api/v1/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/types/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 ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>