| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>pyspark.sql.Catalog — PySpark 3.2.4 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="canonical" href="https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.Catalog.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyspark.sql.DataFrame" href="pyspark.sql.DataFrame.html" /> |
| <link rel="prev" title="pyspark.sql.SparkSession" href="pyspark.sql.SparkSession.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 active"> |
| <a class="nav-link" href="../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"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="active"> |
| <a href="../pyspark.sql.html">Spark SQL</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.pandas/index.html">Pandas API on Spark</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.ss.html">Structured Streaming</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.ml.html">MLlib (DataFrame-based)</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.streaming.html">Spark Streaming</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.mllib.html">MLlib (RDD-based)</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.html">Spark Core</a> |
| </li> |
| |
| |
| |
| <li class=""> |
| <a href="../pyspark.resource.html">Resource Management</a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| </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> |
| |
| <div class="section" id="pyspark-sql-catalog"> |
| <h1>pyspark.sql.Catalog<a class="headerlink" href="#pyspark-sql-catalog" title="Permalink to this headline">¶</a></h1> |
| <dl class="py class"> |
| <dt id="pyspark.sql.Catalog"> |
| <em class="property">class </em><code class="sig-prename descclassname">pyspark.sql.</code><code class="sig-name descname">Catalog</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sparkSession</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pyspark/sql/catalog.html#Catalog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.sql.Catalog" title="Permalink to this definition">¶</a></dt> |
| <dd><p>User-facing catalog API, accessible through <cite>SparkSession.catalog</cite>.</p> |
| <p>This is a thin wrapper around its Scala implementation org.apache.spark.sql.catalog.Catalog.</p> |
| <p class="rubric">Methods</p> |
| <table class="longtable table autosummary"> |
| <colgroup> |
| <col style="width: 10%" /> |
| <col style="width: 90%" /> |
| </colgroup> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.cacheTable.html#pyspark.sql.Catalog.cacheTable" title="pyspark.sql.Catalog.cacheTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cacheTable</span></code></a>(tableName)</p></td> |
| <td><p>Caches the specified table in-memory.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.clearCache.html#pyspark.sql.Catalog.clearCache" title="pyspark.sql.Catalog.clearCache"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clearCache</span></code></a>()</p></td> |
| <td><p>Removes all cached tables from the in-memory cache.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.createExternalTable.html#pyspark.sql.Catalog.createExternalTable" title="pyspark.sql.Catalog.createExternalTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createExternalTable</span></code></a>(tableName[, path, …])</p></td> |
| <td><p>Creates a table based on the dataset in a data source.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.createTable.html#pyspark.sql.Catalog.createTable" title="pyspark.sql.Catalog.createTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">createTable</span></code></a>(tableName[, path, source, …])</p></td> |
| <td><p>Creates a table based on the dataset in a data source.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.currentDatabase.html#pyspark.sql.Catalog.currentDatabase" title="pyspark.sql.Catalog.currentDatabase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">currentDatabase</span></code></a>()</p></td> |
| <td><p>Returns the current default database in this session.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.dropGlobalTempView.html#pyspark.sql.Catalog.dropGlobalTempView" title="pyspark.sql.Catalog.dropGlobalTempView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dropGlobalTempView</span></code></a>(viewName)</p></td> |
| <td><p>Drops the global temporary view with the given view name in the catalog.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.dropTempView.html#pyspark.sql.Catalog.dropTempView" title="pyspark.sql.Catalog.dropTempView"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dropTempView</span></code></a>(viewName)</p></td> |
| <td><p>Drops the local temporary view with the given view name in the catalog.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.isCached.html#pyspark.sql.Catalog.isCached" title="pyspark.sql.Catalog.isCached"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isCached</span></code></a>(tableName)</p></td> |
| <td><p>Returns true if the table is currently cached in-memory.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.listColumns.html#pyspark.sql.Catalog.listColumns" title="pyspark.sql.Catalog.listColumns"><code class="xref py py-obj docutils literal notranslate"><span class="pre">listColumns</span></code></a>(tableName[, dbName])</p></td> |
| <td><p>Returns a list of columns for the given table/view in the specified database.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.listDatabases.html#pyspark.sql.Catalog.listDatabases" title="pyspark.sql.Catalog.listDatabases"><code class="xref py py-obj docutils literal notranslate"><span class="pre">listDatabases</span></code></a>()</p></td> |
| <td><p>Returns a list of databases available across all sessions.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.listFunctions.html#pyspark.sql.Catalog.listFunctions" title="pyspark.sql.Catalog.listFunctions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">listFunctions</span></code></a>([dbName])</p></td> |
| <td><p>Returns a list of functions registered in the specified database.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.listTables.html#pyspark.sql.Catalog.listTables" title="pyspark.sql.Catalog.listTables"><code class="xref py py-obj docutils literal notranslate"><span class="pre">listTables</span></code></a>([dbName])</p></td> |
| <td><p>Returns a list of tables/views in the specified database.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.recoverPartitions.html#pyspark.sql.Catalog.recoverPartitions" title="pyspark.sql.Catalog.recoverPartitions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">recoverPartitions</span></code></a>(tableName)</p></td> |
| <td><p>Recovers all the partitions of the given table and update the catalog.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.refreshByPath.html#pyspark.sql.Catalog.refreshByPath" title="pyspark.sql.Catalog.refreshByPath"><code class="xref py py-obj docutils literal notranslate"><span class="pre">refreshByPath</span></code></a>(path)</p></td> |
| <td><p>Invalidates and refreshes all the cached data (and the associated metadata) for any DataFrame that contains the given data source path.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.refreshTable.html#pyspark.sql.Catalog.refreshTable" title="pyspark.sql.Catalog.refreshTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">refreshTable</span></code></a>(tableName)</p></td> |
| <td><p>Invalidates and refreshes all the cached data and metadata of the given table.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.registerFunction.html#pyspark.sql.Catalog.registerFunction" title="pyspark.sql.Catalog.registerFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">registerFunction</span></code></a>(name, f[, returnType])</p></td> |
| <td><p>An alias for <code class="xref py py-func docutils literal notranslate"><span class="pre">spark.udf.register()</span></code>.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="pyspark.sql.Catalog.setCurrentDatabase.html#pyspark.sql.Catalog.setCurrentDatabase" title="pyspark.sql.Catalog.setCurrentDatabase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setCurrentDatabase</span></code></a>(dbName)</p></td> |
| <td><p>Sets the current default database in this session.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="pyspark.sql.Catalog.uncacheTable.html#pyspark.sql.Catalog.uncacheTable" title="pyspark.sql.Catalog.uncacheTable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">uncacheTable</span></code></a>(tableName)</p></td> |
| <td><p>Removes the specified table from the in-memory cache.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class='prev-next-bottom'> |
| |
| <a class='left-prev' id="prev-link" href="pyspark.sql.SparkSession.html" title="previous page">pyspark.sql.SparkSession</a> |
| <a class='right-next' id="next-link" href="pyspark.sql.DataFrame.html" title="next page">pyspark.sql.DataFrame</a> |
| |
| </div> |
| |
| </main> |
| |
| |
| </div> |
| </div> |
| |
| |
| <script src="../../_static/js/index.3da636dd464baa7582d2.js"></script> |
| |
| |
| <footer class="footer mt-5 mt-md-0"> |
| <div class="container"> |
| <p> |
| © Copyright .<br/> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/> |
| </p> |
| </div> |
| </footer> |
| </body> |
| </html> |
