diff --git a/README.md b/README.md index d4ece2000e2df..3ecc921e58a4b 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,8 @@ Here are some of the major database solutions that are supported: hologres netezza pinot + teradata + yugabyte

**A more comprehensive list of supported databases** along with the configuration instructions can be found diff --git a/docs/docs/databases/installing-database-drivers.mdx b/docs/docs/databases/installing-database-drivers.mdx index 850b76ff1641f..446591b8d5f98 100644 --- a/docs/docs/databases/installing-database-drivers.mdx +++ b/docs/docs/databases/installing-database-drivers.mdx @@ -52,10 +52,11 @@ A list of some of the recommended packages. | [Presto](/docs/databases/presto) | `pip install pyhive` | `presto://` | | [SAP Hana](/docs/databases/hana) | `pip install hdbcli sqlalchemy-hana or pip install apache-superset[hana]` | `hana://{username}:{password}@{host}:{port}` | | [Snowflake](/docs/databases/snowflake) | `pip install snowflake-sqlalchemy` | `snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}` | -| SQLite | | `sqlite://` | +| SQLite | No additional library needed | `sqlite://` | | [SQL Server](/docs/databases/sql-server) | `pip install pymssql` | `mssql://` | -| [Teradata](/docs/databases/teradata) | `pip install sqlalchemy-teradata` | `teradata://{user}:{password}@{host}` | +| [Teradata](/docs/databases/teradata) | `pip install teradatasqlalchemy ` | `teradata://{user}:{password}@{host}` | | [Vertica](/docs/databases/vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://:@/` | +| [Yugabyte](/docs/databases/yugabyte) | `pip install psycopg2` | `postgresql://:@/` | --- @@ -68,6 +69,5 @@ exists, please file an issue on the [Superset GitHub repo](https://github.com/apache/superset/issues), so we can work on documenting and supporting it. -[StackOverflow](https://stackoverflow.com/questions/tagged/apache-superset+superset) and the -[Superset community Slack](https://join.slack.com/t/apache-superset/shared_invite/zt-uxbh5g36-AISUtHbzOXcu0BIj7kgUaw) -are great places to get help with connecting to databases in Superset. +If you'd like to build a database connector for Superset integration, +read the [following tutorial](https://preset.io/blog/building-database-connector/). diff --git a/docs/docs/databases/teradata.mdx b/docs/docs/databases/teradata.mdx index 14ae0a46d53ae..2f765a2146cfe 100644 --- a/docs/docs/databases/teradata.mdx +++ b/docs/docs/databases/teradata.mdx @@ -8,7 +8,7 @@ version: 1 ## Teradata The recommended connector library is -[sqlalchemy-teradata](https://github.com/Teradata/sqlalchemy-teradata). +[teradatasqlalchemy](https://pypi.org/project/teradatasqlalchemy/). The connection string for Teradata looks like this: @@ -16,13 +16,21 @@ The connection string for Teradata looks like this: teradata://{user}:{password}@{host} ``` -Note: Its required to have Teradata ODBC drivers installed and environment variables configured for -proper work of sqlalchemy dialect. Teradata ODBC Drivers available here: -https://downloads.teradata.com/download/connectivity/odbc-driver/linux +## ODBC Driver -Required environment variables: +There's also an older connector named + [sqlalchemy-teradata](https://github.com/Teradata/sqlalchemy-teradata) that + requires the installation of ODBC drivers. The Teradata ODBC Drivers + are available +here: https://downloads.teradata.com/download/connectivity/odbc-driver/linux + +Here are the required environment variables: ``` export ODBCINI=/.../teradata/client/ODBC_64/odbc.ini export ODBCINST=/.../teradata/client/ODBC_64/odbcinst.ini ``` + +We recommend using the first library because of the + lack of requirement around ODBC drivers and + because it's more regularly updated. diff --git a/docs/docs/databases/yugabyte.mdx b/docs/docs/databases/yugabyte.mdx new file mode 100644 index 0000000000000..431ba1e2f178c --- /dev/null +++ b/docs/docs/databases/yugabyte.mdx @@ -0,0 +1,20 @@ +--- +title: Postgres +hide_title: true +sidebar_position: 38 +version: 1 +--- + +## YugabyteDB + +[YugabyteDB](https://www.yugabyte.com/) is a distributed SQL database built on top of PostgreSQL. + +Note that, if you're using docker-compose, the +Postgres connector library [psycopg2](https://www.psycopg.org/docs/) +comes out of the box with Superset. + +The connection string looks like: + +``` +postgresql://{username}:{password}@{host}:{port}/{database} +``` diff --git a/docs/src/resources/data.js b/docs/src/resources/data.js index 42292dd851374..3c0cf718a4b16 100644 --- a/docs/src/resources/data.js +++ b/docs/src/resources/data.js @@ -133,4 +133,14 @@ export const Databases = [ href: 'https://www.ibm.com/products/netezza', imgName: 'netezza.png', }, + { + title: 'Teradata', + href: "www.teradata.com", + imgName: 'teradata.png' + }, + { + title: 'YugabyteDB', + href: "www.yugabyte.com", + imgName: 'yugabyte.png' + } ]; diff --git a/docs/static/img/databases/teradata.png b/docs/static/img/databases/teradata.png new file mode 100644 index 0000000000000..9b6e006117540 Binary files /dev/null and b/docs/static/img/databases/teradata.png differ diff --git a/docs/static/img/databases/yugabyte.png b/docs/static/img/databases/yugabyte.png new file mode 100644 index 0000000000000..576dd3848d299 Binary files /dev/null and b/docs/static/img/databases/yugabyte.png differ diff --git a/superset-frontend/src/assets/images/teradata.png b/superset-frontend/src/assets/images/teradata.png new file mode 100644 index 0000000000000..9b6e006117540 Binary files /dev/null and b/superset-frontend/src/assets/images/teradata.png differ diff --git a/superset-frontend/src/assets/images/yugabyte.png b/superset-frontend/src/assets/images/yugabyte.png new file mode 100644 index 0000000000000..576dd3848d299 Binary files /dev/null and b/superset-frontend/src/assets/images/yugabyte.png differ