summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/sql/sources/SchemaRelationProvider.html
blob: 9c83754f2bbcf1cde1eec14cafe83418420d24f2 (plain) (tree) 
443d7fc27 ^




10bf7477e ^

443d7fc27 ^

10bf7477e ^

443d7fc27 ^






























10bf7477e ^


443d7fc27 ^
















































443d7fc27 ^









































































































10bf7477e ^


443d7fc27 ^









































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




                                                                                                      
                                                                                
                                     
                                       





























                                                                                               

                                                                                                                                                                                 















































                                                                                                                              








































































































                                                                                                                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                 








































                                                                                                                                                                                               
<!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 10:26:35 PDT 2015 -->
<title>SchemaRelationProvider</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="SchemaRelationProvider";
    }
//-->
</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/sources/RelationProvider.html" title="interface in org.apache.spark.sql.sources"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/sql/sources/StringContains.html" title="class in org.apache.spark.sql.sources"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/sources/SchemaRelationProvider.html" target="_top">Frames</a></li>
<li><a href="SchemaRelationProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.sources</div>
<h2 title="Interface SchemaRelationProvider" class="title">Interface SchemaRelationProvider</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">SchemaRelationProvider</span></pre>
<div class="block">::DeveloperApi::
 Implemented by objects that produce relations for a specific kind of data source
 with a given schema.  When Spark SQL is given a DDL operation with a USING clause specified (
 to specify the implemented SchemaRelationProvider) and a user defined schema, this interface
 is used to pass in the parameters specified by a user.
 <p>
 Users may specify the fully qualified class name of a given data source.  When that class is
 not found Spark SQL will append the class name <code>DefaultSource</code> to the path, allowing for
 less verbose invocation.  For example, 'org.apache.spark.sql.json' would resolve to the
 data source 'org.apache.spark.sql.json.DefaultSource'
 <p>
 A new instance of this class with be instantiated each time a DDL call is made.
 <p>
 The difference between a <a href="../../../../../org/apache/spark/sql/sources/RelationProvider.html" title="interface in org.apache.spark.sql.sources"><code>RelationProvider</code></a> and a <a href="../../../../../org/apache/spark/sql/sources/SchemaRelationProvider.html" title="interface in org.apache.spark.sql.sources"><code>SchemaRelationProvider</code></a> is that
 users need to provide a schema when using a <a href="../../../../../org/apache/spark/sql/sources/SchemaRelationProvider.html" title="interface in org.apache.spark.sql.sources"><code>SchemaRelationProvider</code></a>.
 A relation provider can inherits both <a href="../../../../../org/apache/spark/sql/sources/RelationProvider.html" title="interface in org.apache.spark.sql.sources"><code>RelationProvider</code></a> and <a href="../../../../../org/apache/spark/sql/sources/SchemaRelationProvider.html" title="interface in org.apache.spark.sql.sources"><code>SchemaRelationProvider</code></a>
 if it can support both schema inference and user-specified schemas.
 <p></div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>1.3.0</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</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><a href="../../../../../org/apache/spark/sql/sources/BaseRelation.html" title="class in org.apache.spark.sql.sources">BaseRelation</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/sql/sources/SchemaRelationProvider.html#createRelation(org.apache.spark.sql.SQLContext, scala.collection.immutable.Map, org.apache.spark.sql.types.StructType)">createRelation</a></strong>(<a href="../../../../../org/apache/spark/sql/SQLContext.html" title="class in org.apache.spark.sql">SQLContext</a>&nbsp;sqlContext,
              scala.collection.immutable.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;parameters,
              <a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;schema)</code>
<div class="block">Returns a new base relation with the given parameters and user defined schema.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createRelation(org.apache.spark.sql.SQLContext, scala.collection.immutable.Map, org.apache.spark.sql.types.StructType)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createRelation</h4>
<pre><a href="../../../../../org/apache/spark/sql/sources/BaseRelation.html" title="class in org.apache.spark.sql.sources">BaseRelation</a>&nbsp;createRelation(<a href="../../../../../org/apache/spark/sql/SQLContext.html" title="class in org.apache.spark.sql">SQLContext</a>&nbsp;sqlContext,
                          scala.collection.immutable.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;parameters,
                          <a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a>&nbsp;schema)</pre>
<div class="block">Returns a new base relation with the given parameters and user defined schema.
 Note: the parameters' keywords are case insensitive and this insensitivity is enforced
 by the Map that is passed to the function.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sqlContext</code> - (undocumented)</dd><dd><code>parameters</code> - (undocumented)</dd><dd><code>schema</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/sources/RelationProvider.html" title="interface in org.apache.spark.sql.sources"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/sql/sources/StringContains.html" title="class in org.apache.spark.sql.sources"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/sql/sources/SchemaRelationProvider.html" target="_top">Frames</a></li>
<li><a href="SchemaRelationProvider.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-11 10:10:06 +0000