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
333
334
335
336
337
338
339
340
341
342
343
344
|
<!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:08 PDT 2015 -->
<title>JdbcDialect</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="JdbcDialect";
}
//-->
</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><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">
<li><a href="../../../../../org/apache/spark/sql/jdbc/AggregatedDialect.html" title="class in org.apache.spark.sql.jdbc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialects.html" title="class in org.apache.spark.sql.jdbc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/jdbc/JdbcDialect.html" target="_top">Frames</a></li>
<li><a href="JdbcDialect.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </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 name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.spark.sql.jdbc</div>
<h2 title="Class JdbcDialect" class="title">Class JdbcDialect</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.sql.jdbc.JdbcDialect</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/spark/sql/jdbc/AggregatedDialect.html" title="class in org.apache.spark.sql.jdbc">AggregatedDialect</a>, <a href="../../../../../org/apache/spark/sql/jdbc/MySQLDialect.html" title="class in org.apache.spark.sql.jdbc">MySQLDialect</a>, <a href="../../../../../org/apache/spark/sql/jdbc/NoopDialect.html" title="class in org.apache.spark.sql.jdbc">NoopDialect</a>, <a href="../../../../../org/apache/spark/sql/jdbc/PostgresDialect.html" title="class in org.apache.spark.sql.jdbc">PostgresDialect</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">JdbcDialect</span>
extends java.lang.Object</pre>
<div class="block">:: DeveloperApi ::
Encapsulates everything (extensions, workarounds, quirks) to handle the
SQL dialect of a certain database or jdbc driver.
Lots of databases define types that aren't explicitly supported
by the JDBC spec. Some JDBC drivers also report inaccurate
information---for instance, BIT(n>1) being reported as a BIT type is quite
common, even though BIT in JDBC is meant for single-bit values. Also, there
does not appear to be a standard name for an unbounded string or binary
type; we use BLOB and CLOB by default but override with database-specific
alternatives when these are absent or do not behave correctly.
<p>
Currently, the only thing done by the dialect is type mapping.
<code>getCatalystType</code> is used when reading from a JDBC table and <code>getJDBCType</code>
is used when writing to a JDBC table. If <code>getCatalystType</code> returns <code>null</code>,
the default type handling is used for the given JDBC type. Similarly,
if <code>getJDBCType</code> returns <code>(null, None)</code>, the default type handling is used
for the given Catalyst type.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialect.html#JdbcDialect()">JdbcDialect</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialect.html#canHandle(java.lang.String)">canHandle</a></strong>(java.lang.String url)</code>
<div class="block">Check if this dialect instance can handle a certain jdbc url.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>scala.Option<<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialect.html#getCatalystType(int, java.lang.String, int, org.apache.spark.sql.types.MetadataBuilder)">getCatalystType</a></strong>(int sqlType,
java.lang.String typeName,
int size,
<a href="../../../../../org/apache/spark/sql/types/MetadataBuilder.html" title="class in org.apache.spark.sql.types">MetadataBuilder</a> md)</code>
<div class="block">Get the custom datatype mapping for the given jdbc meta information.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>scala.Option<<a href="../../../../../org/apache/spark/sql/jdbc/JdbcType.html" title="class in org.apache.spark.sql.jdbc">JdbcType</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialect.html#getJDBCType(org.apache.spark.sql.types.DataType)">getJDBCType</a></strong>(<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> dt)</code>
<div class="block">Retrieve the jdbc / sql type for a given datatype.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialect.html#quoteIdentifier(java.lang.String)">quoteIdentifier</a></strong>(java.lang.String colName)</code>
<div class="block">Quotes the identifier.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JdbcDialect()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JdbcDialect</h4>
<pre>public JdbcDialect()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="canHandle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canHandle</h4>
<pre>public abstract boolean canHandle(java.lang.String url)</pre>
<div class="block">Check if this dialect instance can handle a certain jdbc url.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the jdbc url.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if the dialect can be applied on the given jdbc url.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the url is null.</dd></dl>
</li>
</ul>
<a name="getCatalystType(int, java.lang.String, int, org.apache.spark.sql.types.MetadataBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCatalystType</h4>
<pre>public scala.Option<<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a>> getCatalystType(int sqlType,
java.lang.String typeName,
int size,
<a href="../../../../../org/apache/spark/sql/types/MetadataBuilder.html" title="class in org.apache.spark.sql.types">MetadataBuilder</a> md)</pre>
<div class="block">Get the custom datatype mapping for the given jdbc meta information.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlType</code> - The sql type (see java.sql.Types)</dd><dd><code>typeName</code> - The sql type name (e.g. "BIGINT UNSIGNED")</dd><dd><code>size</code> - The size of the type.</dd><dd><code>md</code> - Result metadata associated with this type.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The actual DataType (subclasses of <a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types"><code>DataType</code></a>)
or null if the default type mapping should be used.</dd></dl>
</li>
</ul>
<a name="getJDBCType(org.apache.spark.sql.types.DataType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJDBCType</h4>
<pre>public scala.Option<<a href="../../../../../org/apache/spark/sql/jdbc/JdbcType.html" title="class in org.apache.spark.sql.jdbc">JdbcType</a>> getJDBCType(<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> dt)</pre>
<div class="block">Retrieve the jdbc / sql type for a given datatype.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dt</code> - The datatype (e.g. <a href="../../../../../org/apache/spark/sql/types/StringType.html" title="class in org.apache.spark.sql.types"><code>StringType</code></a>)</dd>
<dt><span class="strong">Returns:</span></dt><dd>The new JdbcType if there is an override for this DataType</dd></dl>
</li>
</ul>
<a name="quoteIdentifier(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>quoteIdentifier</h4>
<pre>public java.lang.String quoteIdentifier(java.lang.String colName)</pre>
<div class="block">Quotes the identifier. This is used to put quotes around the identifier in case the column
name is a reserved keyword, or in case it contains characters that require quotes (e.g. space).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colName</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><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">
<li><a href="../../../../../org/apache/spark/sql/jdbc/AggregatedDialect.html" title="class in org.apache.spark.sql.jdbc"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/sql/jdbc/JdbcDialects.html" title="class in org.apache.spark.sql.jdbc"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/jdbc/JdbcDialect.html" target="_top">Frames</a></li>
<li><a href="JdbcDialect.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </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 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>
|
