site/docs/1.5.0/api/python/_modules/pyspark/storagelevel.html


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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>pyspark.storagelevel &mdash; PySpark master documentation</title>
    
    <link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../',
        VERSION:     'master',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../_static/doctools.js"></script>
    <link rel="top" title="PySpark master documentation" href="../../index.html" />
    <link rel="up" title="Module code" href="../index.html" /> 
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="nav-item nav-item-0"><a href="../../index.html">PySpark master documentation</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <h1>Source code for pyspark.storagelevel</h1><div class="highlight"><pre>
<span class="c">#</span>
<span class="c"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c"># contributor license agreements.  See the NOTICE file distributed with</span>
<span class="c"># this work for additional information regarding copyright ownership.</span>
<span class="c"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c"># the License.  You may obtain a copy of the License at</span>
<span class="c">#</span>
<span class="c">#    http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c"># See the License for the specific language governing permissions and</span>
<span class="c"># limitations under the License.</span>
<span class="c">#</span>

<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s">&quot;StorageLevel&quot;</span><span class="p">]</span>


<div class="viewcode-block" id="StorageLevel"><a class="viewcode-back" href="../../pyspark.html#pyspark.StorageLevel">[docs]</a><span class="k">class</span> <span class="nc">StorageLevel</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

    <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">    Flags for controlling the storage of an RDD. Each StorageLevel records whether to use memory,</span>
<span class="sd">    whether to drop the RDD to disk if it falls out of memory, whether to keep the data in memory</span>
<span class="sd">    in a serialized format, and whether to replicate the RDD partitions on multiple nodes.</span>
<span class="sd">    Also contains static constants for some commonly used storage levels, such as MEMORY_ONLY.</span>
<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">useDisk</span><span class="p">,</span> <span class="n">useMemory</span><span class="p">,</span> <span class="n">useOffHeap</span><span class="p">,</span> <span class="n">deserialized</span><span class="p">,</span> <span class="n">replication</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">useDisk</span> <span class="o">=</span> <span class="n">useDisk</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">useMemory</span> <span class="o">=</span> <span class="n">useMemory</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">useOffHeap</span> <span class="o">=</span> <span class="n">useOffHeap</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deserialized</span> <span class="o">=</span> <span class="n">deserialized</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">replication</span> <span class="o">=</span> <span class="n">replication</span>

    <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="s">&quot;StorageLevel(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)&quot;</span> <span class="o">%</span> <span class="p">(</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">useDisk</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">useMemory</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">useOffHeap</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">deserialized</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">replication</span><span class="p">)</span>

    <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="n">result</span> <span class="o">=</span> <span class="s">&quot;&quot;</span>
        <span class="n">result</span> <span class="o">+=</span> <span class="s">&quot;Disk &quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">useDisk</span> <span class="k">else</span> <span class="s">&quot;&quot;</span>
        <span class="n">result</span> <span class="o">+=</span> <span class="s">&quot;Memory &quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">useMemory</span> <span class="k">else</span> <span class="s">&quot;&quot;</span>
        <span class="n">result</span> <span class="o">+=</span> <span class="s">&quot;Tachyon &quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">useOffHeap</span> <span class="k">else</span> <span class="s">&quot;&quot;</span>
        <span class="n">result</span> <span class="o">+=</span> <span class="s">&quot;Deserialized &quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">deserialized</span> <span class="k">else</span> <span class="s">&quot;Serialized &quot;</span>
        <span class="n">result</span> <span class="o">+=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">x Replicated&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">replication</span>
        <span class="k">return</span> <span class="n">result</span>
</div>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">DISK_ONLY</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">DISK_ONLY_2</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_ONLY</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_ONLY_2</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_ONLY_SER</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_ONLY_SER_2</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_AND_DISK</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_AND_DISK_2</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_AND_DISK_SER</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_AND_DISK_SER_2</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">True</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">OFF_HEAP</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="bp">True</span><span class="p">,</span> <span class="bp">False</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="../../index.html">
              <img class="logo" src="../../_static/spark-logo-hd.png" alt="Logo"/>
            </a></p>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="nav-item nav-item-0"><a href="../../index.html">PySpark master documentation</a> &raquo;</li>
          <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright .
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
    </div>
  </body>
</html>