(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{x4ZV:function(e,t,a){"use strict";a.r(t),a.d(t,"_frontmatter",(function(){return s})),a.d(t,"default",(function(){return i}));var r=a("wx14"),b=a("zLVn"),n=(a("q1tI"),a("7ljp")),d=a("hhGP"),s=(a("qKvR"),{});void 0!==s&&s&&s===Object(s)&&Object.isExtensible(s)&&!s.hasOwnProperty("__filemeta")&&Object.defineProperty(s,"__filemeta",{configurable:!0,value:{name:"_frontmatter",filename:"src/pages/docs/Connecting to Databases/index.mdx"}});var p={_frontmatter:s},c=d.a;function i(e){var t=e.components,a=Object(b.a)(e,["components"]);return Object(n.b)(c,Object(r.a)({},p,a,{components:t,mdxType:"MDXLayout"}),Object(n.b)("h2",{id:"install-database-drivers"},"Install Database Drivers"),Object(n.b)("p",null,"Superset requires a Python database driver to be installed for each additional type of database you\nwant to connect to."),Object(n.b)("p",null,"Superset interacts with the underlying databases using the provided SQL interface (often times\nthrough a SQLAlchemy library)."),Object(n.b)("h3",{id:"supported-databases-and-dependecies"},"Supported Databases and Dependecies"),Object(n.b)("p",null,"Superset does not ship bundled with connectivity to databases, except for Sqlite, which is part of the Python standard library. You’ll need to install the required packages for the database you want to use as your metadata database as well as the packages needed to connect to the databases you want to access through Superset."),Object(n.b)("p",null,"A list of some of the recommended packages."),Object(n.b)("table",null,Object(n.b)("thead",{parentName:"table"},Object(n.b)("tr",{parentName:"thead"},Object(n.b)("th",{parentName:"tr"},"Database"),Object(n.b)("th",{parentName:"tr"},"PyPI package"),Object(n.b)("th",{parentName:"tr"},"Connection String"))),Object(n.b)("tbody",{parentName:"table"},Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/athena",parentName:"td"},"Amazon Athena")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},'pip install "PyAthenaJDBC>1.0.9')," , ",Object(n.b)("inlineCode",{parentName:"td"},'pip install "PyAthena>1.2.0')),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{ "))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/redshift",parentName:"td"},"Amazon Redshift")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-redshift")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"}," redshift+psycopg2://<userName>:<DBPassword>@<AWS End Point>:5439/<Database Name>"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/drill",parentName:"td"},"Apache Drill")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-drill")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"drill+sadrill:// For JDBC drill+jdbc://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/druid",parentName:"td"},"Apache Druid")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pydruid")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"druid://<User>:<password>@<Host>:<Port-default-9088>/druid/v2/sql"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/hive",parentName:"td"},"Apache Hive")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pyhive")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"hive://hive@{hostname}:{port}/{database}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/impala",parentName:"td"},"Apache Impala")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install impala")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"impala://{hostname}:{port}/{database}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/kylin",parentName:"td"},"Apache Kylin")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install kylinpy")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"kylin://<username>:<password>@<hostname>:<port>/<project>?<param1>=<value1>&<param2>=<value2>"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/pinot",parentName:"td"},"Apache Pinot")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pinotdb")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pinot+http://CONTROLLER:5436/ query?server=http://CONTROLLER:5983/"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/spark",parentName:"td"},"Apache Spark SQL")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pyhive")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"hive://hive@{hostname}:{port}/{database}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/sqlserver",parentName:"td"},"Azure MS SQL")),Object(n.b)("td",{parentName:"tr"}),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/bigquery",parentName:"td"},"Big Query")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pybigquery")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"bigquery://{project_id}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/clickhouse",parentName:"td"},"ClickHouse")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-clickhouse")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"clickhouse://{username}:{password}@{hostname}:{port}/{database}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/cockroachdb",parentName:"td"},"CockroachDB")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install cockroachdb")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/dremio",parentName:"td"},"Dremio")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy_dremio")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"dremio://user:pwd@host:31010/"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/elasticsearch",parentName:"td"},"Elasticsearch")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-exasol")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"elasticsearch+http://{user}:{password}@{host}:9200/"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/exasol",parentName:"td"},"Exasol")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-exasol")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/google-sheets",parentName:"td"},"Google Sheets")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install gsheetsdb")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"gsheets://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/ibm-db2",parentName:"td"},"IBM Db2")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install ibm_db_sa")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"db2+ibm_db://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/mysql",parentName:"td"},"MySQL")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install mysqlclient")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/oracle",parentName:"td"},"Oracle")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install cx_Oracle")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"oracle://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/postgresql",parentName:"td"},"PostgreSQL")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install psycopg2")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"postgresql:://<UserName>:<DBPassword>@<Database Host>/<Database Name>"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/presto",parentName:"td"},"Presto")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pyhive")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"presto://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/hana",parentName:"td"},"SAP Hana")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install hdbcli sqlalchemy-hana or pip install apache-superset[hana]")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"hana://{username}:{password}@{host}:{port}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/snowflake",parentName:"td"},"Snowflake")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install snowflake-sqlalchemy")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"ssnowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},"SQLite"),Object(n.b)("td",{parentName:"tr"}),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"sqlite://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/sqlserver",parentName:"td"},"SQL Server")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install pymssql")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"mssql://"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/teradata",parentName:"td"},"Teradata")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-teradata")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"teradata://{user}:{password}@{host}"))),Object(n.b)("tr",{parentName:"tbody"},Object(n.b)("td",{parentName:"tr"},Object(n.b)("a",{href:"/docs/databases/vertica",parentName:"td"},"Vertica")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"pip install sqlalchemy-vertica-python")),Object(n.b)("td",{parentName:"tr"},Object(n.b)("inlineCode",{parentName:"td"},"vertica+vertica_python://<UserName>:<DBPassword>@<Database Host>/<Database Name>"))))),Object(n.b)("hr",null),Object(n.b)("p",null,"Note that many other databases are supported, the main criteria being the existence of a functional SqlAlchemy dialect and Python driver. Googling the keyword sqlalchemy in addition of a keyword that describes the database you want to connect to should get you to the right place."),Object(n.b)("p",null,"If your database or data engine isn't on the list but a SQL interface\nexists, please file an issue on the\n",Object(n.b)("a",{href:"https://github.com/apache/incubator-superset/issues",parentName:"p"},"Superset GitHub repo"),", so we can work on\nsupporting it."),Object(n.b)("p",null,Object(n.b)("a",{href:"https://stackoverflow.com/questions/tagged/apache-superset+superset",parentName:"p"},"StackOverflow")," and the\n",Object(n.b)("a",{href:"https://join.slack.com/t/apache-superset/shared_invite/enQtNDMxMDY5NjM4MDU0LWJmOTcxYjlhZTRhYmEyYTMzOWYxOWEwMjcwZDZiNWRiNDY2NDUwNzcwMDFhNzE1ZmMxZTZlZWY0ZTQ2MzMyNTU",parentName:"p"},"Superset community Slack"),"\nare great places to get help with connecting to databases in Superset."),Object(n.b)("p",null,"In the end, you should be looking for a Python package compatible with your database. One part that\nmakes database driver installation tricky is the fact that local binaries are sometimes required in\norder for them to bind properly, which means that various apt packages might need to be installed\nbefore pip can get things set up."))}void 0!==i&&i&&i===Object(i)&&Object.isExtensible(i)&&!i.hasOwnProperty("__filemeta")&&Object.defineProperty(i,"__filemeta",{configurable:!0,value:{name:"MDXContent",filename:"src/pages/docs/Connecting to Databases/index.mdx"}}),i.isMDXComponent=!0}}]);
//# sourceMappingURL=component---src-pages-docs-connecting-to-databases-index-mdx-7b14807eb90e26e021b6.js.map