Google Git
Sign in
apache / spark-website / 28656f2c00baf1bc2d26570a16b4f96f9a890723 / . / site / docs / 3.2.2 / api / python / _modules / pyspark / storagelevel.html
blob: 827b08db25142f35f355ee0da356d957a9f03631 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>pyspark.storagelevel &#8212; PySpark 3.2.2 documentation</title>
<link rel="stylesheet" href="../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css">
<link rel="stylesheet"
href="../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet"
href="../../_static/vendor/open-sans_all/1.44.1/index.css">
<link rel="stylesheet"
href="../../_static/vendor/lato_latin-ext/1.44.1/index.css">
<link rel="stylesheet" href="../../_static/basic.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/css/pyspark.css" />
<link rel="preload" as="script" href="../../_static/js/index.3da636dd464baa7582d2.js">
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script src="../../_static/copybutton.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
<link rel="search" title="Search" href="../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
<div class="container-xl">
<a class="navbar-brand" href="../../index.html">
<img src="../../_static/spark-logo-reverse.png" class="logo" alt="logo" />
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
<li class="nav-item ">
<a class="nav-link" href="../../getting_started/index.html">Getting Started</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../user_guide/index.html">User Guide</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../reference/index.html">API Reference</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../development/index.html">Development</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../migration_guide/index.html">Migration Guide</a>
</li>
</ul>
<ul class="navbar-nav">
</ul>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
</ul>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<nav id="bd-toc-nav">
<ul class="nav section-nav flex-column">
</ul>
</nav>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<h1>Source code for pyspark.storagelevel</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;StorageLevel&quot;</span><span class="p">]</span>
<div class="viewcode-block" id="StorageLevel"><a class="viewcode-back" href="../../reference/api/pyspark.StorageLevel.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 JAVA-specific serialized format, and whether to replicate the RDD partitions on multiple</span>
<span class="sd"> nodes. Also contains static constants for some commonly used storage levels, MEMORY_ONLY.</span>
<span class="sd"> Since the data is always serialized on the Python side, all the constants use the serialized</span>
<span class="sd"> formats.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="fm">__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="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">&quot;StorageLevel(</span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">, </span><span class="si">%s</span><span class="s2">)&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="fm">__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="s2">&quot;&quot;</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&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="s2">&quot;&quot;</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&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="s2">&quot;&quot;</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&quot;OffHeap &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="s2">&quot;&quot;</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&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="s2">&quot;Serialized &quot;</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2">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="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">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="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">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">DISK_ONLY_3</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="mi">3</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="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</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="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">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="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</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="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">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="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_AND_DISK_DESER</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<div class='prev-next-bottom'>
</div>
</main>
</div>
</div>
<script src="../../_static/js/index.3da636dd464baa7582d2.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>