summaryrefslogtreecommitdiff
path: root/site/docs/1.0.1/api/python/pyspark-module.html
blob: f36ced0fa82e14f87a4f4710b40eeaa85723867a (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
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pyspark</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spark.apache.org">Spark 1.0.0 Python API Docs</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;pyspark
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pyspark-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package pyspark</h1><p class="nomargin-top"><span class="codelink"><a href="pyspark-pysrc.html">source&nbsp;code</a></span></p>
<p>PySpark is the Python API for Spark.</p>
  <p>Public classes:</p>
  <ul>
    <li>
      <a href="pyspark.context.SparkContext-class.html" 
      class="link">SparkContext</a> Main entry point for Spark 
      functionality.
    </li>
    <li>
      <a href="pyspark.rdd.RDD-class.html" class="link">RDD</a> A Resilient
      Distributed Dataset (RDD), the basic abstraction in Spark.
    </li>
    <li>
      <a href="pyspark.broadcast.Broadcast-class.html" 
      class="link">Broadcast</a> A broadcast variable that gets reused 
      across tasks.
    </li>
    <li>
      <a href="pyspark.accumulators.Accumulator-class.html" 
      class="link">Accumulator</a> An &quot;add-only&quot; shared variable 
      that tasks can only add values to.
    </li>
    <li>
      <a href="pyspark.conf.SparkConf-class.html" 
      class="link">SparkConf</a> For configuring Spark.
    </li>
    <li>
      <a href="pyspark.files.SparkFiles-class.html" 
      class="link">SparkFiles</a> Access files shipped with jobs.
    </li>
    <li>
      <a href="pyspark.storagelevel.StorageLevel-class.html" 
      class="link">StorageLevel</a> Finer-grained cache persistence levels.
    </li>
  </ul>
  <p>Spark SQL:</p>
  <ul>
    <li>
      <a href="pyspark.sql.SQLContext-class.html" 
      class="link">SQLContext</a> Main entry point for SQL functionality.
    </li>
    <li>
      <a href="pyspark.sql.SchemaRDD-class.html" class="link">SchemaRDD</a>
      A Resilient Distributed Dataset (RDD) with Schema information for the
      data contained. In addition to normal RDD operations, SchemaRDDs also
      support SQL.
    </li>
    <li>
      <a href="pyspark.sql.Row-class.html" class="link">Row</a> A Row of 
      data returned by a Spark SQL query.
    </li>
  </ul>
  <p>Hive:</p>
  <ul>
    <li>
      <a href="pyspark.sql.HiveContext-class.html" 
      class="link">HiveContext</a> Main entry point for accessing data 
      stored in Apache Hive..
    </li>
  </ul>

<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Submodules</span></td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="pyspark.accumulators-module.html">pyspark.accumulators</a></strong>: <em class="summary">&nbsp;</em>    </li>
    <li> <strong class="uidlink"><a href="pyspark.broadcast-module.html">pyspark.broadcast</a></strong>: <em class="summary">&nbsp;</em>    </li>
    <li> <strong class="uidlink"><a href="pyspark.conf-module.html">pyspark.conf</a></strong>: <em class="summary">&nbsp;</em>    </li>
    <li> <strong class="uidlink"><a href="pyspark.context-module.html">pyspark.context</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.files-module.html">pyspark.files</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.mllib-module.html">pyspark.mllib</a></strong>: <em class="summary">Python bindings for MLlib.</em>
    <ul>
    <li> <strong class="uidlink"><a href="pyspark.mllib.classification-module.html">pyspark.mllib.classification</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.mllib.clustering-module.html">pyspark.mllib.clustering</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.mllib.linalg-module.html">pyspark.mllib.linalg</a></strong>: <em class="summary">MLlib utilities for linear algebra.</em>    </li>
    <li> <strong class="uidlink"><a href="pyspark.mllib.recommendation-module.html">pyspark.mllib.recommendation</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.mllib.regression-module.html">pyspark.mllib.regression</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.mllib.util-module.html">pyspark.mllib.util</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="pyspark.rdd-module.html">pyspark.rdd</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.resultiterable-module.html">pyspark.resultiterable</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.serializers-module.html">pyspark.serializers</a></strong>: <em class="summary">PySpark supports custom serializers for transferring data; this can
        improve performance.</em>    </li>
    <li> <strong class="uidlink"><a href="pyspark.sql-module.html">pyspark.sql</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.statcounter-module.html">pyspark.statcounter</a></strong>    </li>
    <li> <strong class="uidlink"><a href="pyspark.storagelevel-module.html">pyspark.storagelevel</a></strong>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="SparkConf"></a><span class="summary-name">SparkConf</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="SparkContext"></a><span class="summary-name">SparkContext</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="SQLContext"></a><span class="summary-name">SQLContext</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="RDD"></a><span class="summary-name">RDD</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="SchemaRDD"></a><span class="summary-name">SchemaRDD</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="Row"></a><span class="summary-name">Row</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="SparkFiles"></a><span class="summary-name">SparkFiles</span>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="StorageLevel"></a><span class="summary-name">StorageLevel</span>
    </td>
  </tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spark.apache.org">Spark 1.0.0 Python API Docs</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Jul  4 18:52:26 2014
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>