| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Superset’s documentation — Superset's documentation documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="index" title="Index" |
| href="genindex.html"/> |
| <link rel="search" title="Search" href="search.html"/> |
| <link rel="top" title="Superset's documentation documentation" href="#"/> |
| <link rel="next" title="Installation & Configuration" href="installation.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="#" class="icon icon-home"> Superset's documentation |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation & Configuration</a></li> |
| <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> |
| <li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="#">Superset's documentation</a> |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="#">Docs</a> »</li> |
| |
| <li>Superset’s documentation</li> |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <img alt="_images/s.png" src="_images/s.png" /> |
| <div class="section" id="superset-s-documentation"> |
| <h1>Superset’s documentation<a class="headerlink" href="#superset-s-documentation" title="Permalink to this headline">¶</a></h1> |
| <p>Superset is a data exploration platform designed to be visual, intuitive |
| and interactive.</p> |
| <hr class="docutils" /> |
| <div class="admonition warning"> |
| <p class="first admonition-title">Warning</p> |
| <p class="last">This project was originally named Panoramix, was renamed to |
| Caravel in March 2016, and is currently named Superset as of November 2016</p> |
| </div> |
| <div class="section" id="overview"> |
| <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2> |
| <div class="section" id="features"> |
| <h3>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h3> |
| <ul class="simple"> |
| <li>A rich set of data visualizations, integrated from some of the best |
| visualization libraries</li> |
| <li>Create and share simple dashboards</li> |
| <li>An extensible, high-granularity security/permission model allowing |
| intricate rules on who can access individual features and the dataset</li> |
| <li>Enterprise-ready authentication with integration with major authentication |
| providers (database, OpenID, LDAP, OAuth & REMOTE_USER through |
| Flask AppBuilder)</li> |
| <li>A simple semantic layer, allowing users to control how data sources are |
| displayed in the UI by defining which fields should show up in which |
| drop-down and which aggregation and function metrics are made available |
| to the user</li> |
| <li>Integration with most RDBMS through SqlAlchemy</li> |
| <li>Deep integration with Druid.io</li> |
| </ul> |
| <hr class="docutils" /> |
| <img alt="https://camo.githubusercontent.com/82e264ef777ba06e1858766fe3b8817ee108eb7e/687474703a2f2f672e7265636f726469742e636f2f784658537661475574732e676966" src="https://camo.githubusercontent.com/82e264ef777ba06e1858766fe3b8817ee108eb7e/687474703a2f2f672e7265636f726469742e636f2f784658537661475574732e676966" /> |
| <hr class="docutils" /> |
| <img alt="https://camo.githubusercontent.com/4991ff37a0005ea4e4267919a52786fda82d2d21/687474703a2f2f672e7265636f726469742e636f2f755a6767594f645235672e676966" src="https://camo.githubusercontent.com/4991ff37a0005ea4e4267919a52786fda82d2d21/687474703a2f2f672e7265636f726469742e636f2f755a6767594f645235672e676966" /> |
| <hr class="docutils" /> |
| <img alt="https://camo.githubusercontent.com/a389af15ac1e32a3d0fee941b4c62c850b1d583b/687474703a2f2f672e7265636f726469742e636f2f55373046574c704c76682e676966" src="https://camo.githubusercontent.com/a389af15ac1e32a3d0fee941b4c62c850b1d583b/687474703a2f2f672e7265636f726469742e636f2f55373046574c704c76682e676966" /> |
| </div> |
| <hr class="docutils" /> |
| <div class="section" id="contents"> |
| <h3>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h3> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation & Configuration</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#getting-started">Getting Started</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#os-dependencies">OS dependencies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#python-virtualenv">Python virtualenv</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#python-s-setup-tools-and-pip">Python’s setup tools and pip</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#superset-installation-and-initialization">Superset installation and initialization</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#configuration-behind-a-load-balancer">Configuration behind a load balancer</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#configuration">Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#database-dependencies">Database dependencies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#aws-athena">(AWS) Athena</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#caching">Caching</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#deeper-sqlalchemy-integration">Deeper SQLAlchemy integration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#schemas-postgres-redshift">Schemas (Postgres & Redshift)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#ssl-access-to-databases">SSL Access to databases</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#druid">Druid</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#cors">CORS</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#middleware">MIDDLEWARE</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#upgrading">Upgrading</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#sql-lab">SQL Lab</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#making-your-own-build">Making your own build</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="installation.html#blueprints">Blueprints</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial for Superset Administrators</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial.html#connecting-to-a-new-database">Connecting to a new database</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial.html#adding-a-new-table">Adding a new table</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial.html#exploring-your-data">Exploring your data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tutorial.html#creating-a-slice-and-dashboard">Creating a slice and dashboard</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="security.html#provided-roles">Provided Roles</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="security.html#managing-gamma-per-data-source-access">Managing Gamma per data source access</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="security.html#customizing">Customizing</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="sqllab.html">SQL Lab</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="sqllab.html#feature-overview">Feature Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="sqllab.html#extra-features">Extra features</a></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> |
| <li class="toctree-l2"><a class="reference internal" href="videos.html#dashboard-filtering">Dashboard Filtering</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="videos.html#customize-css-and-dashboard-themes">Customize CSS and dashboard themes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="videos.html#slice-annotations">Slice Annotations</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="videos.html#adding-a-table">Adding a Table</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="videos.html#define-sql-expressions">Define SQL Expressions</a></li> |
| </ul> |
| </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><ul> |
| <li class="toctree-l2"><a class="reference internal" href="druid.html#supported">Supported</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="druid.html#not-yet-supported">Not yet supported</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="faq.html#can-i-query-join-multiple-tables-at-one-time">Can I query/join multiple tables at one time?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="faq.html#how-big-can-my-data-source-be">How BIG can my data source be?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-create-my-own-visualization">How do I create my own visualization?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="faq.html#why-are-my-queries-timing-out">Why are my queries timing out?</a></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> |
| <li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-go-about-developing-a-new-visualization-type">How do I go about developing a new visualization type?</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="indices-and-tables"> |
| <h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h3> |
| <ul class="simple"> |
| <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li> |
| <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li> |
| <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="installation.html" class="btn btn-neutral float-right" title="Installation & Configuration" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'', |
| 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> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
