| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-intro" data-has-hydrated="false"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v3.8.1"> |
| <title data-rh="true">intro | Superset</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://superset.apache.org/docs/intro"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="intro | Superset"><meta data-rh="true" name="description" content="<!--"><meta data-rh="true" property="og:description" content="<!--"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://superset.apache.org/docs/intro"><link data-rh="true" rel="alternate" href="https://superset.apache.org/docs/intro" hreflang="en"><link data-rh="true" rel="alternate" href="https://superset.apache.org/docs/intro" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://WR5FASX5ED-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Introduction","item":"https://superset.apache.org/docs/intro"}]}</script><link rel="search" type="application/opensearchdescription+xml" title="Superset" href="/opensearch.xml"> |
| |
| |
| |
| |
| <script src="/script/matomo.js"></script> |
| <script src="https://widget.kapa.ai/kapa-widget.bundle.js" async data-website-id="c6a8a8b8-3127-48f9-97a7-51e9e10d20d0" data-project-name="Apache Superset" data-project-color="#FFFFFF" data-project-logo="https://images.seeklogo.com/logo-png/50/2/superset-icon-logo-png_seeklogo-500354.png" data-modal-override-open-id="ask-ai-input" data-modal-override-open-class="search-input" data-modal-disclaimer="This is a custom LLM for Apache Superset with access to all [documentation](superset.apache.org/docs/intro/), [GitHub Open Issues, PRs and READMEs](github.com/apache/superset).&#10;&#10;Companies deploy assistants like this ([built by kapa.ai](https://kapa.ai)) on docs via [website widget](https://docs.kapa.ai/integrations/website-widget) (Docker, Reddit), in [support forms](https://docs.kapa.ai/integrations/support-form-deflector) for ticket deflection (Monday.com, Mapbox), or as [Slack bots](https://docs.kapa.ai/integrations/slack-bot) with private sources." data-modal-example-questions="How do I install Superset?,How can I contribute to Superset?" data-button-text-color="rgb(81,166,197)" data-modal-header-bg-color="#ffffff" data-modal-title-color="rgb(81,166,197)" data-modal-title="Apache Superset AI" data-modal-disclaimer-text-color="#000000" data-consent-required="true" data-consent-screen-disclaimer="By clicking "I agree, let's chat", you consent to the use of the AI assistant in accordance with kapa.ai's [Privacy Policy](https://www.kapa.ai/content/privacy-policy). This service uses reCAPTCHA, which requires your consent to Google's [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms). By proceeding, you explicitly agree to both kapa.ai's and Google's privacy policies."></script><link rel="stylesheet" href="/assets/css/styles.f45235af.css"> |
| <script src="/assets/js/runtime~main.8a0ac6f2.js" defer="defer"></script> |
| <script src="/assets/js/main.40d5d6fa.js" defer="defer"></script> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"><defs> |
| <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol> |
| </defs></svg> |
| <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a aria-current="page" class="navbar__link active" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/intro">Documentation</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/faq">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/community">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/quickstart">Quickstart</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/installation/architecture">Installation</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/configuration/configuring-superset">Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/using-superset/creating-your-first-dashboard">Using Superset</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/contributing/">Contributing</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/security/">Security</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/faq">FAQ</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li></ul></nav><button type="button" title="Collapse sidebar" aria-label="Collapse sidebar" class="button button--secondary button--outline collapseSidebarButton_PEFL"><svg width="20" height="20" aria-hidden="true" class="collapseSidebarButtonIcon_kv0_"><g fill="#7a7a7a"><path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"></path><path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"></path></g></svg></button></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Introduction</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Superset</h1></header> |
| <p><a href="https://opensource.org/license/apache-2-0" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License" class="img_ev3q"></a> |
| <a href="https://github.com/apache/superset/releases/latest" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://img.shields.io/github/v/release/apache/superset?sort=semver" alt="Latest Release on Github" class="img_ev3q"></a> |
| <a href="https://github.com/apache/superset/actions" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://github.com/apache/superset/actions/workflows/superset-python-unittest.yml/badge.svg" alt="Build Status" class="img_ev3q"></a> |
| <a href="https://badge.fury.io/py/apache_superset" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://badge.fury.io/py/apache_superset.svg" alt="PyPI version" class="img_ev3q"></a> |
| <a href="https://codecov.io/github/apache/superset" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://codecov.io/github/apache/superset/coverage.svg?branch=master" alt="Coverage Status" class="img_ev3q"></a> |
| <a href="https://pypi.python.org/pypi/apache_superset" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://img.shields.io/pypi/pyversions/apache_superset.svg?maxAge=2592000" alt="PyPI" class="img_ev3q"></a> |
| <a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://img.shields.io/badge/slack-join-orange.svg" alt="Get on Slack" class="img_ev3q"></a> |
| <a href="https://superset.apache.org" target="_blank" rel="noopener noreferrer"><img decoding="async" loading="lazy" src="https://img.shields.io/badge/docs-apache.org-blue.svg" alt="Documentation" class="img_ev3q"></a></p> |
| <picture width="500"><source width="600" media="(prefers-color-scheme: dark)" src="https://superset.apache.org/img/superset-logo-horiz-dark.svg" alt="Superset logo (dark)"><img width="600" src="https://superset.apache.org/img/superset-logo-horiz-apache.svg" alt="Superset logo (light)"></picture> |
| <p>A modern, enterprise-ready business intelligence web application.</p> |
| <p><a href="#why-superset"><strong>Why Superset?</strong></a> | |
| <a href="#supported-databases"><strong>Supported Databases</strong></a> | |
| <a href="#installation-and-configuration"><strong>Installation and Configuration</strong></a> | |
| <a href="https://github.com/apache/superset/blob/master/RELEASING/README.md#release-notes-for-recent-releases" target="_blank" rel="noopener noreferrer"><strong>Release Notes</strong></a> | |
| <a href="#get-involved"><strong>Get Involved</strong></a> | |
| <a href="#contributor-guide"><strong>Contributor Guide</strong></a> | |
| <a href="#resources"><strong>Resources</strong></a> | |
| <a href="https://github.com/apache/superset/blob/master/RESOURCES/INTHEWILD.md" target="_blank" rel="noopener noreferrer"><strong>Organizations Using Superset</strong></a></p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="why-superset">Why Superset?<a href="#why-superset" class="hash-link" aria-label="Direct link to Why Superset?" title="Direct link to Why Superset?"></a></h2> |
| <p>Superset is a modern data exploration and data visualization platform. Superset can replace or augment proprietary business intelligence tools for many teams. Superset integrates well with a variety of data sources.</p> |
| <p>Superset provides:</p> |
| <ul> |
| <li>A <strong>no-code interface</strong> for building charts quickly</li> |
| <li>A powerful, web-based <strong>SQL Editor</strong> for advanced querying</li> |
| <li>A <strong>lightweight semantic layer</strong> for quickly defining custom dimensions and metrics</li> |
| <li>Out of the box support for <strong>nearly any SQL</strong> database or data engine</li> |
| <li>A wide array of <strong>beautiful visualizations</strong> to showcase your data, ranging from simple bar charts to geospatial visualizations</li> |
| <li>Lightweight, configurable <strong>caching layer</strong> to help ease database load</li> |
| <li>Highly extensible <strong>security roles and authentication</strong> options</li> |
| <li>An <strong>API</strong> for programmatic customization</li> |
| <li>A <strong>cloud-native architecture</strong> designed from the ground up for scale</li> |
| </ul> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="screenshots--gifs">Screenshots & Gifs<a href="#screenshots--gifs" class="hash-link" aria-label="Direct link to Screenshots & Gifs" title="Direct link to Screenshots & Gifs"></a></h2> |
| <p><strong>Video Overview</strong></p> |
| <p><a href="https://github.com/user-attachments/assets/b37388f7-a971-409c-96a7-90c4e31322e6" target="_blank" rel="noopener noreferrer">superset-video-1080p.webm</a></p> |
| <br> |
| <p><strong>Large Gallery of Visualizations</strong></p> |
| <kbd><img title="Gallery" src="https://superset.apache.org/img/screenshots/gallery.jpg"></kbd> |
| <br> |
| <p><strong>Craft Beautiful, Dynamic Dashboards</strong></p> |
| <kbd><img title="View Dashboards" src="https://superset.apache.org/img/screenshots/slack_dash.jpg"></kbd> |
| <br> |
| <p><strong>No-Code Chart Builder</strong></p> |
| <kbd><img title="Slice & dice your data" src="https://superset.apache.org/img/screenshots/explore.jpg"></kbd> |
| <br> |
| <p><strong>Powerful SQL Editor</strong></p> |
| <kbd><img title="SQL Lab" src="https://superset.apache.org/img/screenshots/sql_lab.jpg"></kbd> |
| <br> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="supported-databases">Supported Databases<a href="#supported-databases" class="hash-link" aria-label="Direct link to Supported Databases" title="Direct link to Supported Databases"></a></h2> |
| <p>Superset can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, <a href="https://superset.apache.org/docs/configuration/databases" target="_blank" rel="noopener noreferrer">and more</a>) that has a Python DB-API driver and a SQLAlchemy dialect.</p> |
| <p>Here are some of the major database solutions that are supported:</p> |
| <p align="center"><img src="https://superset.apache.org/img/databases/redshift.png" alt="redshift" border="0" width="200"><img src="https://superset.apache.org/img/databases/google-biquery.png" alt="google-bigquery" border="0" width="200"><img src="https://superset.apache.org/img/databases/snowflake.png" alt="snowflake" border="0" width="200"><img src="https://superset.apache.org/img/databases/trino.png" alt="trino" border="0" width="150"><img src="https://superset.apache.org/img/databases/presto.png" alt="presto" border="0" width="200"><img src="https://superset.apache.org/img/databases/databricks.png" alt="databricks" border="0" width="160"><img src="https://superset.apache.org/img/databases/druid.png" alt="druid" border="0" width="200"><img src="https://superset.apache.org/img/databases/firebolt.png" alt="firebolt" border="0" width="200"><img src="https://superset.apache.org/img/databases/timescale.png" alt="timescale" border="0" width="200"><img src="https://superset.apache.org/img/databases/postgresql.png" alt="postgresql" border="0" width="200"><img src="https://superset.apache.org/img/databases/mysql.png" alt="mysql" border="0" width="200"><img src="https://superset.apache.org/img/databases/mssql-server.png" alt="mssql-server" border="0" width="200"><img src="https://superset.apache.org/img/databases/ibm-db2.svg" alt="db2" border="0" width="220"><img src="https://superset.apache.org/img/databases/sqlite.png" alt="sqlite" border="0" width="200"><img src="https://superset.apache.org/img/databases/sybase.png" alt="sybase" border="0" width="200"><img src="https://superset.apache.org/img/databases/mariadb.png" alt="mariadb" border="0" width="200"><img src="https://superset.apache.org/img/databases/vertica.png" alt="vertica" border="0" width="200"><img src="https://superset.apache.org/img/databases/oracle.png" alt="oracle" border="0" width="200"><img src="https://superset.apache.org/img/databases/firebird.png" alt="firebird" border="0" width="200"><img src="https://superset.apache.org/img/databases/greenplum.png" alt="greenplum" border="0" width="200"><img src="https://superset.apache.org/img/databases/clickhouse.png" alt="clickhouse" border="0" width="200"><img src="https://superset.apache.org/img/databases/exasol.png" alt="exasol" border="0" width="160"><img src="https://superset.apache.org/img/databases/monet-db.png" alt="monet-db" border="0" width="200"><img src="https://superset.apache.org/img/databases/apache-kylin.png" alt="apache-kylin" border="0" width="80"><img src="https://superset.apache.org/img/databases/hologres.png" alt="hologres" border="0" width="80"><img src="https://superset.apache.org/img/databases/netezza.png" alt="netezza" border="0" width="80"><img src="https://superset.apache.org/img/databases/pinot.png" alt="pinot" border="0" width="200"><img src="https://superset.apache.org/img/databases/teradata.png" alt="teradata" border="0" width="200"><img src="https://superset.apache.org/img/databases/yugabyte.png" alt="yugabyte" border="0" width="200"><img src="https://superset.apache.org/img/databases/databend.png" alt="databend" border="0" width="200"><img src="https://superset.apache.org/img/databases/starrocks.png" alt="starrocks" border="0" width="200"><img src="https://superset.apache.org/img/databases/doris.png" alt="doris" border="0" width="200"><img src="https://superset.apache.org/img/databases/oceanbase.svg" alt="oceanbase" border="0" width="220"><img src="https://superset.apache.org/img/databases/sap-hana.png" alt="sap-hana" border="0" width="220"><img src="https://superset.apache.org/img/databases/denodo.png" alt="denodo" border="0" width="200"><img src="https://superset.apache.org/img/databases/ydb.svg" alt="ydb" border="0" width="200"><img src="https://superset.apache.org/img/databases/tdengine.png" alt="TDengine" border="0" width="200"></p> |
| <p><strong>A more comprehensive list of supported databases</strong> along with the configuration instructions can be found <a href="https://superset.apache.org/docs/configuration/databases" target="_blank" rel="noopener noreferrer">here</a>.</p> |
| <p>Want to add support for your datastore or data engine? Read more <a href="https://superset.apache.org/docs/frequently-asked-questions#does-superset-work-with-insert-database-engine-here" target="_blank" rel="noopener noreferrer">here</a> about the technical requirements.</p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="installation-and-configuration">Installation and Configuration<a href="#installation-and-configuration" class="hash-link" aria-label="Direct link to Installation and Configuration" title="Direct link to Installation and Configuration"></a></h2> |
| <p>Try out Superset's <a href="https://superset.apache.org/docs/quickstart/" target="_blank" rel="noopener noreferrer">quickstart</a> guide or learn about <a href="https://superset.apache.org/docs/installation/architecture/" target="_blank" rel="noopener noreferrer">the options for production deployments</a>.</p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-involved">Get Involved<a href="#get-involved" class="hash-link" aria-label="Direct link to Get Involved" title="Direct link to Get Involved"></a></h2> |
| <ul> |
| <li>Ask and answer questions on <a href="https://stackoverflow.com/questions/tagged/apache-superset" target="_blank" rel="noopener noreferrer">StackOverflow</a> using the <strong>apache-superset</strong> tag</li> |
| <li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer">Join our community's Slack</a> |
| and please read our <a href="https://github.com/apache/superset/blob/master/CODE_OF_CONDUCT.md#slack-community-guidelines" target="_blank" rel="noopener noreferrer">Slack Community Guidelines</a></li> |
| <li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer">Join our dev@superset.apache.org Mailing list</a>. To join, simply send an email to <a href="mailto:dev-subscribe@superset.apache.org" target="_blank" rel="noopener noreferrer">dev-subscribe@superset.apache.org</a></li> |
| <li>If you want to help troubleshoot GitHub Issues involving the numerous database drivers that Superset supports, please consider adding your name and the databases you have access to on the <a href="https://docs.google.com/spreadsheets/d/1U1qxiLvOX0kBTUGME1AHHi6Ywel6ECF8xk_Qy-V9R8c/edit#gid=0" target="_blank" rel="noopener noreferrer">Superset Database Familiarity Rolodex</a></li> |
| <li>Join Superset's Town Hall and <a href="https://preset.io/blog/the-superset-operational-model-wants-you/" target="_blank" rel="noopener noreferrer">Operational Model</a> recurring meetings. Meeting info is available on the <a href="https://superset.apache.org/community" target="_blank" rel="noopener noreferrer">Superset Community Calendar</a></li> |
| </ul> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="contributor-guide">Contributor Guide<a href="#contributor-guide" class="hash-link" aria-label="Direct link to Contributor Guide" title="Direct link to Contributor Guide"></a></h2> |
| <p>Interested in contributing? Check out our |
| <a href="https://github.com/apache/superset/blob/master/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">CONTRIBUTING.md</a> |
| to find resources around contributing along with a detailed guide on |
| how to set up a development environment.</p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="resources">Resources<a href="#resources" class="hash-link" aria-label="Direct link to Resources" title="Direct link to Resources"></a></h2> |
| <ul> |
| <li><a href="https://github.com/apache/superset/blob/master/RESOURCES/INTHEWILD.md" target="_blank" rel="noopener noreferrer">Superset "In the Wild"</a> - open a PR to add your org to the list!</li> |
| <li><a href="https://github.com/apache/superset/blob/master/RESOURCES/FEATURE_FLAGS.md" target="_blank" rel="noopener noreferrer">Feature Flags</a> - the status of Superset's Feature Flags.</li> |
| <li><a href="https://github.com/apache/superset/blob/master/RESOURCES/STANDARD_ROLES.md" target="_blank" rel="noopener noreferrer">Standard Roles</a> - How RBAC permissions map to roles.</li> |
| <li><a href="https://github.com/apache/superset/wiki" target="_blank" rel="noopener noreferrer">Superset Wiki</a> - Tons of additional community resources: best practices, community content and other information.</li> |
| <li><a href="https://github.com/orgs/apache/projects/170" target="_blank" rel="noopener noreferrer">Superset SIPs</a> - The status of Superset's SIPs (Superset Improvement Proposals) for both consensus and implementation status.</li> |
| </ul> |
| <p>Understanding the Superset Points of View</p> |
| <ul> |
| <li> |
| <p><a href="https://preset.io/blog/dataset-centric-visualization/" target="_blank" rel="noopener noreferrer">The Case for Dataset-Centric Visualization</a></p> |
| </li> |
| <li> |
| <p><a href="https://preset.io/blog/understanding-superset-semantic-layer/" target="_blank" rel="noopener noreferrer">Understanding the Superset Semantic Layer</a></p> |
| </li> |
| <li> |
| <p>Getting Started with Superset</p> |
| <ul> |
| <li><a href="https://superset.apache.org/docs/installation/docker-compose#installing-superset-locally-using-docker-compose" target="_blank" rel="noopener noreferrer">Superset in 2 Minutes using Docker Compose</a></li> |
| <li><a href="https://superset.apache.org/docs/configuration/databases#installing-database-drivers" target="_blank" rel="noopener noreferrer">Installing Database Drivers</a></li> |
| <li><a href="https://preset.io/blog/building-database-connector/" target="_blank" rel="noopener noreferrer">Building New Database Connectors</a></li> |
| <li><a href="https://superset.apache.org/docs/using-superset/creating-your-first-dashboard/" target="_blank" rel="noopener noreferrer">Create Your First Dashboard</a></li> |
| <li><a href="https://preset.io/blog/tutorial-contributing-code-to-apache-superset/" target="_blank" rel="noopener noreferrer">Comprehensive Tutorial for Contributing Code to Apache Superset |
| </a></li> |
| </ul> |
| </li> |
| <li> |
| <p><a href="https://preset.io/resources/" target="_blank" rel="noopener noreferrer">Resources to master Superset by Preset</a></p> |
| </li> |
| <li> |
| <p>Deploying Superset</p> |
| <ul> |
| <li><a href="https://hub.docker.com/r/apache/superset" target="_blank" rel="noopener noreferrer">Official Docker image</a></li> |
| <li><a href="https://github.com/apache/superset/tree/master/helm/superset" target="_blank" rel="noopener noreferrer">Helm Chart</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Recordings of Past <a href="https://preset.io/events" target="_blank" rel="noopener noreferrer">Superset Community Events</a></p> |
| <ul> |
| <li><a href="https://preset.io/events/mixed-time-series-visualization-in-superset-workshop/" target="_blank" rel="noopener noreferrer">Mixed Time Series Charts</a></li> |
| <li><a href="https://preset.io/events/how-the-bing-team-heavily-customized-superset-for-their-internal-data/" target="_blank" rel="noopener noreferrer">How the Bing Team Customized Superset for the Internal Self-Serve Data & Analytics Platform</a></li> |
| <li><a href="https://preset.io/events/2021-04-13-visualizing-mongodb-and-pinot-data-using-trino/" target="_blank" rel="noopener noreferrer">Live Demo: Visualizing MongoDB and Pinot Data using Trino</a></li> |
| <li><a href="https://preset.io/events/introduction-to-the-superset-api/" target="_blank" rel="noopener noreferrer">Introduction to the Superset API</a></li> |
| <li><a href="https://preset.io/events/2021-02-16-building-a-database-connector-for-superset/" target="_blank" rel="noopener noreferrer">Building a Database Connector for Superset</a></li> |
| </ul> |
| </li> |
| <li> |
| <p>Visualizations</p> |
| <ul> |
| <li><a href="https://superset.apache.org/docs/contributing/creating-viz-plugins/" target="_blank" rel="noopener noreferrer">Creating Viz Plugins</a></li> |
| <li><a href="https://medium.com/nmc-techblog/apache-superset-manage-custom-viz-plugins-in-production-9fde1a708e55" target="_blank" rel="noopener noreferrer">Managing and Deploying Custom Viz Plugins</a></li> |
| <li><a href="https://preset.io/blog/2021-4-1-why-echarts/" target="_blank" rel="noopener noreferrer">Why Apache Superset is Betting on Apache ECharts</a></li> |
| </ul> |
| </li> |
| <li> |
| <p><a href="https://superset.apache.org/docs/rest-api" target="_blank" rel="noopener noreferrer">Superset API</a></p> |
| </li> |
| </ul> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="repo-activity">Repo Activity<a href="#repo-activity" class="hash-link" aria-label="Direct link to Repo Activity" title="Direct link to Repo Activity"></a></h2> |
| <a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=39464018" target="_blank" align="center"><picture><source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=39464018&image_size=auto&color_scheme=dark" width="655" height="auto"><img alt="Performance Stats of apache/superset - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=39464018&image_size=auto&color_scheme=light" width="655" height="auto"></picture></a> |
| <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=bc1c90cd-bc04-4e11-8c7b-289fb2839492"></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/apache/superset/edit/master/README.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/docs/quickstart"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Quickstart</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#why-superset" class="table-of-contents__link toc-highlight">Why Superset?</a></li><li><a href="#screenshots--gifs" class="table-of-contents__link toc-highlight">Screenshots & Gifs</a></li><li><a href="#supported-databases" class="table-of-contents__link toc-highlight">Supported Databases</a></li><li><a href="#installation-and-configuration" class="table-of-contents__link toc-highlight">Installation and Configuration</a></li><li><a href="#get-involved" class="table-of-contents__link toc-highlight">Get Involved</a></li><li><a href="#contributor-guide" class="table-of-contents__link toc-highlight">Contributor Guide</a></li><li><a href="#resources" class="table-of-contents__link toc-highlight">Resources</a></li><li><a href="#repo-activity" class="table-of-contents__link toc-highlight">Repo Activity</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright"> |
| <div class="footer__applitools"> |
| We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a> |
| </div> |
| <p>Copyright © 2024, |
| The <a href="https://www.apache.org/" target="_blank" rel="noreferrer">Apache Software Foundation</a>, |
| Licensed under the Apache <a href="https://apache.org/licenses/LICENSE-2.0" target="_blank" rel="noreferrer">License</a>.</p> |
| <p><small>Apache Superset, Apache, Superset, the Superset logo, and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation. All other products or name brands are trademarks of their respective holders, including The Apache Software Foundation. |
| <a href="https://www.apache.org/" target="_blank">Apache Software Foundation</a> resources</small></p> |
| <img class="footer__divider" src="/img/community/line.png" alt="Divider"> |
| <p> |
| <small> |
| <a href="/docs/security/" target="_blank" rel="noreferrer">Security</a> | |
| <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noreferrer">Donate</a> | |
| <a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noreferrer">Thanks</a> | |
| <a href="https://apache.org/events/current-event" target="_blank" rel="noreferrer">Events</a> | |
| <a href="https://apache.org/licenses/" target="_blank" rel="noreferrer">License</a> | |
| <a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank" rel="noreferrer">Privacy</a> |
| </small> |
| </p> |
| <!-- telemetry/analytics pixel: --> |
| <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68"> |
| </div></div></div></footer></div> |
| </body> |
| </html> |