Updating the docs

2026-05-12 19:35:17 +00:00 · 2017-06-07 21:41:47 -07:00
parent 7f66807a57
commit bb9870a3bb
21 changed files with 4721 additions and 27 deletions
--- a/_modules/index.html
+++ b/_modules/index.html
@@ -83,6 +83,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../druid.html">Druid</a></li>
--- a/_sources/faq.txt
+++ b/_sources/faq.txt
@@ -78,6 +78,11 @@ The widget also has a checkbox ``Date Filter``, which enables time filtering
 capabilities to your dashboard. After checking the box and refreshing, you'll
 see a ``from`` and a ``to`` dropdown show up.

+By default, the filtering will be applied to all the slices that are built
+on top of a datasource that shares the column name that the filter is based
+on. It's also a requirement for that column to be checked as "filterable"
+in the column tab of the table editor.
+
 But what about if you don't want certain widgets to get filtered on your
 dashboard? You can do that by editing your dashboard, and in the form,
 edit the ``JSON Metadata`` field, more specifically the
@@ -119,3 +124,16 @@ __ https://www.sqlite.org/lockingv3.html
 One work around is to create a symlink from ~/.superset to a directory located on a non-NFS partition.

 Another work around is to change where superset stores the sqlite database by adding ``SQLALCHEMY_DATABASE_URI = 'sqlite:////new/localtion/superset.db'`` in superset_config.py (create the file if needed), then adding the directory where superset_config.py lives to PYTHONPATH environment variable (e.g. ``export PYTHONPATH=/opt/logs/sandbox/airbnb/``).
+
+How do I add new columns to an existing table
+---------------------------------------------
+
+Table schemas evolve, and Superset needs to reflect that. It's pretty common
+in the life cycle of a dashboard to want to add a new dimension or metric.
+To get Superset to discover your new columns, all you have to do is to
+go to ``Menu -> Sources -> Tables``, click the ``edit`` icon next to the
+table who's schema has changed, and hit ``Save`` from the ``Detail`` tab.
+Behind the scene, the new columns will get merged it. Following this,
+you may want to
+re-edit the table afterwards to configure the ``Column`` tab, check the
+appropriate boxes and save again.
--- a/_sources/index.txt
+++ b/_sources/index.txt
@@ -58,6 +58,7 @@ Contents
    tutorial
    security
    sqllab
+    visualization
    videos
    gallery
    druid
--- a/_sources/installation.txt
+++ b/_sources/installation.txt
@@ -455,7 +455,7 @@ Blueprints

 `Blueprints are Flask's reusable apps <http://flask.pocoo.org/docs/0.12/blueprints/>`_.
 Superset allows you to specify an array of Blueprints
-an array of Blueprints in your ``superset_config`` module. Here's
+in your ``superset_config`` module. Here's
 an example on how this can work with a simple Blueprint. By doing
 so, you can expect Superset to serve a page that says "OK"
 at the ``/simple_page`` url. This can allow you to run other things such
--- a/_sources/sqllab.txt
+++ b/_sources/sqllab.txt
@@ -13,9 +13,11 @@ Feature Overview
  visualization capabilities
 - Browse database metadata: tables, columns, indexes, partitions
 - Support for long-running queries
+
  - uses the `Celery distributed queue <http://www.python.org/>`_
    to dispatch query handling to workers
  - supports defining a "results backend" to persist query results
+
 - A search engine to find queries executed in the past
 - Supports templating using the
  `Jinja templating language <http://jinja.pocoo.org/docs/dev/>`_
--- a/_sources/visualization.txt
+++ b/_sources/visualization.txt
--- a/_static/img/viz_thumbnails/country_map.png
+++ b/_static/img/viz_thumbnails/country_map.png
--- a/druid.html
+++ b/druid.html
@@ -85,6 +85,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Druid</a><ul>
--- a/faq.html
+++ b/faq.html
@@ -84,6 +84,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
@@ -95,6 +96,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#why-is-the-map-not-visible-in-the-mapbox-visualization">Why is the map not visible in the mapbox visualization?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#how-to-add-dynamic-filters-to-a-dashboard">How to add dynamic filters to a dashboard?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#why-does-fabmanager-or-superset-freezed-hung-not-responding-when-started-my-home-directory-is-nfs-mounted">Why does fabmanager or superset freezed/hung/not responding when started (my home directory is NFS mounted)?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#how-do-i-add-new-columns-to-an-existing-table">How do I add new columns to an existing table</a></li>
 </ul>
 </li>
 </ul>
@@ -199,6 +201,10 @@ descending.</p>
 <p>The widget also has a checkbox <code class="docutils literal"><span class="pre">Date</span> <span class="pre">Filter</span></code>, which enables time filtering
 capabilities to your dashboard. After checking the box and refreshing, you&#8217;ll
 see a <code class="docutils literal"><span class="pre">from</span></code> and a <code class="docutils literal"><span class="pre">to</span></code> dropdown show up.</p>
+<p>By default, the filtering will be applied to all the slices that are built
+on top of a datasource that shares the column name that the filter is based
+on. It&#8217;s also a requirement for that column to be checked as &#8220;filterable&#8221;
+in the column tab of the table editor.</p>
 <p>But what about if you don&#8217;t want certain widgets to get filtered on your
 dashboard? You can do that by editing your dashboard, and in the form,
 edit the <code class="docutils literal"><span class="pre">JSON</span> <span class="pre">Metadata</span></code> field, more specifically the
@@ -232,6 +238,18 @@ be applied, it&#8217;s as simple as that.</p>
 <p>One work around is to create a symlink from ~/.superset to a directory located on a non-NFS partition.</p>
 <p>Another work around is to change where superset stores the sqlite database by adding <code class="docutils literal"><span class="pre">SQLALCHEMY_DATABASE_URI</span> <span class="pre">=</span> <span class="pre">'sqlite:////new/localtion/superset.db'</span></code> in superset_config.py (create the file if needed), then adding the directory where superset_config.py lives to PYTHONPATH environment variable (e.g. <code class="docutils literal"><span class="pre">export</span> <span class="pre">PYTHONPATH=/opt/logs/sandbox/airbnb/</span></code>).</p>
 </div>
+<div class="section" id="how-do-i-add-new-columns-to-an-existing-table">
+<h2>How do I add new columns to an existing table<a class="headerlink" href="#how-do-i-add-new-columns-to-an-existing-table" title="Permalink to this headline">¶</a></h2>
+<p>Table schemas evolve, and Superset needs to reflect that. It&#8217;s pretty common
+in the life cycle of a dashboard to want to add a new dimension or metric.
+To get Superset to discover your new columns, all you have to do is to
+go to <code class="docutils literal"><span class="pre">Menu</span> <span class="pre">-&gt;</span> <span class="pre">Sources</span> <span class="pre">-&gt;</span> <span class="pre">Tables</span></code>, click the <code class="docutils literal"><span class="pre">edit</span></code> icon next to the
+table who&#8217;s schema has changed, and hit <code class="docutils literal"><span class="pre">Save</span></code> from the <code class="docutils literal"><span class="pre">Detail</span></code> tab.
+Behind the scene, the new columns will get merged it. Following this,
+you may want to
+re-edit the table afterwards to configure the <code class="docutils literal"><span class="pre">Column</span></code> tab, check the
+appropriate boxes and save again.</p>
+</div>
 </div>


--- a/gallery.html
+++ b/gallery.html
@@ -85,6 +85,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
--- a/genindex.html
+++ b/genindex.html
@@ -84,6 +84,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
--- a/index.html
+++ b/index.html
@@ -84,6 +84,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
@@ -215,6 +216,12 @@ to the user</li>
 <li class="toctree-l2"><a class="reference internal" href="sqllab.html#templating-with-jinja">Templating with Jinja</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="visualization.html#country-map-tools">Country Map Tools</a></li>
+<li class="toctree-l2"><a class="reference internal" href="visualization.html#list-of-countries">List of Countries</a></li>
+<li class="toctree-l2"><a class="reference internal" href="visualization.html#you-need-to-add-a-new-country">You need to add a new Country ?</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="videos.html#quick-intro">Quick Intro</a></li>
 <li class="toctree-l2"><a class="reference internal" href="videos.html#dashboard-creation">Dashboard Creation</a></li>
@@ -239,6 +246,7 @@ to the user</li>
 <li class="toctree-l2"><a class="reference internal" href="faq.html#why-is-the-map-not-visible-in-the-mapbox-visualization">Why is the map not visible in the mapbox visualization?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-add-dynamic-filters-to-a-dashboard">How to add dynamic filters to a dashboard?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="faq.html#why-does-fabmanager-or-superset-freezed-hung-not-responding-when-started-my-home-directory-is-nfs-mounted">Why does fabmanager or superset freezed/hung/not responding when started (my home directory is NFS mounted)?</a></li>
+<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-add-new-columns-to-an-existing-table">How do I add new columns to an existing table</a></li>
 </ul>
 </li>
 </ul>
--- a/installation.html
+++ b/installation.html
@@ -107,6 +107,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
@@ -601,7 +602,7 @@ python setup.py install
 <h2>Blueprints<a class="headerlink" href="#blueprints" title="Permalink to this headline">¶</a></h2>
 <p><a class="reference external" href="http://flask.pocoo.org/docs/0.12/blueprints/">Blueprints are Flask&#8217;s reusable apps</a>.
 Superset allows you to specify an array of Blueprints
-an array of Blueprints in your <code class="docutils literal"><span class="pre">superset_config</span></code> module. Here&#8217;s
+in your <code class="docutils literal"><span class="pre">superset_config</span></code> module. Here&#8217;s
 an example on how this can work with a simple Blueprint. By doing
 so, you can expect Superset to serve a page that says &#8220;OK&#8221;
 at the <code class="docutils literal"><span class="pre">/simple_page</span></code> url. This can allow you to run other things such
--- a/objects.inv
+++ b/objects.inv
--- a/search.html
+++ b/search.html
@@ -83,6 +83,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
--- a/searchindex.js
+++ b/searchindex.js
--- a/security.html
+++ b/security.html
@@ -102,6 +102,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
--- a/sqllab.html
+++ b/sqllab.html
@@ -34,7 +34,7 @@
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="Superset&#39;s documentation  documentation" href="index.html"/>
-        <link rel="next" title="Videos" href="videos.html"/>
+        <link rel="next" title="Visualization Tools" href="visualization.html"/>
        <link rel="prev" title="Security" href="security.html"/> 

  
@@ -93,6 +93,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
@@ -145,31 +146,22 @@
 <a class="reference external" href="https://facebook.github.io/react/">React</a>.</p>
 <div class="section" id="feature-overview">
 <h2>Feature Overview<a class="headerlink" href="#feature-overview" title="Permalink to this headline">¶</a></h2>
-<ul>
-<li><p class="first">Connects to just about any database backend</p>
-</li>
-<li><p class="first">A multi-tab environment to work on multiple queries at a time</p>
-</li>
-<li><p class="first">A smooth flow to visualize your query results using Superset&#8217;s rich
-visualization capabilities</p>
-</li>
-<li><p class="first">Browse database metadata: tables, columns, indexes, partitions</p>
-</li>
-<li><p class="first">Support for long-running queries
- uses the <a class="reference external" href="http://www.python.org/">Celery distributed queue</a></p>
-<blockquote>
-<div><p>to dispatch query handling to workers</p>
-</div></blockquote>
 <ul class="simple">
+<li>Connects to just about any database backend</li>
+<li>A multi-tab environment to work on multiple queries at a time</li>
+<li>A smooth flow to visualize your query results using Superset&#8217;s rich
+visualization capabilities</li>
+<li>Browse database metadata: tables, columns, indexes, partitions</li>
+<li>Support for long-running queries<ul>
+<li>uses the <a class="reference external" href="http://www.python.org/">Celery distributed queue</a>
+to dispatch query handling to workers</li>
 <li>supports defining a &#8220;results backend&#8221; to persist query results</li>
 </ul>
 </li>
-<li><p class="first">A search engine to find queries executed in the past</p>
-</li>
-<li><p class="first">Supports templating using the
+<li>A search engine to find queries executed in the past</li>
+<li>Supports templating using the
 <a class="reference external" href="http://jinja.pocoo.org/docs/dev/">Jinja templating language</a>
-which allows for using macros in your SQL code</p>
-</li>
+which allows for using macros in your SQL code</li>
 </ul>
 </div>
 <div class="section" id="extra-features">
@@ -237,7 +229,7 @@ jinja context as in <code class="docutils literal"><span class="pre">SELECT</spa
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
-        <a href="videos.html" class="btn btn-neutral float-right" title="Videos" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="visualization.html" class="btn btn-neutral float-right" title="Visualization Tools" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="security.html" class="btn btn-neutral" title="Security" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
--- a/tutorial.html
+++ b/tutorial.html
@@ -91,6 +91,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
 <li class="toctree-l1"><a class="reference internal" href="gallery.html">Gallery</a></li>
 <li class="toctree-l1"><a class="reference internal" href="druid.html">Druid</a></li>
--- a/videos.html
+++ b/videos.html
@@ -35,7 +35,7 @@
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="Superset&#39;s documentation  documentation" href="index.html"/>
        <link rel="next" title="Gallery" href="gallery.html"/>
-        <link rel="prev" title="SQL Lab" href="sqllab.html"/> 
+        <link rel="prev" title="Visualization Tools" href="visualization.html"/> 

  
  <script src="_static/js/modernizr.min.js"></script>
@@ -85,6 +85,7 @@
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a></li>
 <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
 <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a></li>
+<li class="toctree-l1"><a class="reference internal" href="visualization.html">Visualization Tools</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Videos</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#quick-intro">Quick Intro</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#dashboard-creation">Dashboard Creation</a></li>
@@ -209,7 +210,7 @@ and <code class="docutils literal"><span class="pre">Dashboard</span></code> vie
        <a href="gallery.html" class="btn btn-neutral float-right" title="Gallery" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
-        <a href="sqllab.html" class="btn btn-neutral" title="SQL Lab" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="visualization.html" class="btn btn-neutral" title="Visualization Tools" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  
--- a/visualization.html
+++ b/visualization.html