diff --git a/docs-v2/docs/connecting-to-databases/installing-database-drivers.mdx b/docs-v2/docs/connecting-to-databases/installing-database-drivers.mdx index af487b5842e44..23849041882c9 100644 --- a/docs-v2/docs/connecting-to-databases/installing-database-drivers.mdx +++ b/docs-v2/docs/connecting-to-databases/installing-database-drivers.mdx @@ -10,7 +10,7 @@ version: 1 Superset requires a Python DB-API database driver and a SQLAlchemy dialect to be installed for each datastore you want to connect to. -You can read more [here](/docs/databases/dockeradddrivers) about how to +You can read more [here](/docs/connecting-to-databases/dockeradddrivers) about how to install new database drivers into your Superset configuration. ### Supported Databases and Dependencies @@ -20,42 +20,42 @@ which is part of the Python standard library. You’ll need to install the requi A list of some of the recommended packages. -| Database | PyPI package | Connection String | -| --------------------------------------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| [Amazon Athena](/docs/databases/athena) | `pip install "PyAthenaJDBC>1.0.9` , `pip install "PyAthena>1.2.0` | `awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{ ` | -| [Amazon Redshift](/docs/databases/redshift) | `pip install sqlalchemy-redshift` | ` redshift+psycopg2://:@:5439/` | -| [Apache Drill](/docs/databases/drill) | `pip install sqlalchemy-drill` | `drill+sadrill:// For JDBC drill+jdbc://` | -| [Apache Druid](/docs/databases/druid) | `pip install pydruid` | `druid://:@:/druid/v2/sql` | -| [Apache Hive](/docs/databases/hive) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | -| [Apache Impala](/docs/databases/impala) | `pip install impyla` | `impala://{hostname}:{port}/{database}` | -| [Apache Kylin](/docs/databases/kylin) | `pip install kylinpy` | `kylin://:@:/?=&=` | -| [Apache Pinot](/docs/databases/pinot) | `pip install pinotdb` | `pinot://BROKER:5436/query?server=http://CONTROLLER:5983/` | -| [Apache Solr](/docs/databases/solr) | `pip install sqlalchemy-solr` | `solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}` | -| [Apache Spark SQL](/docs/databases/spark-sql) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | -| [Ascend.io](/docs/databases/ascend) | `pip install impyla` | `ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true` | -| [Azure MS SQL](/docs/databases/sql-server) | `pip install pymssql` | `mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema` | -| [Big Query](/docs/databases/bigquery) | `pip install pybigquery` | `bigquery://{project_id}` | -| [ClickHouse](/docs/databases/clickhouse) | `pip install clickhouse-driver==0.2.0 && pip install clickhouse-sqlalchemy==0.1.6` | `clickhouse+native://{username}:{password}@{hostname}:{port}/{database}` | -| [CockroachDB](/docs/databases/cockroachdb) | `pip install cockroachdb` | `cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable` | -| [Dremio](/docs/databases/dremio) | `pip install sqlalchemy_dremio` | `dremio://user:pwd@host:31010/` | -| [Elasticsearch](/docs/databases/elasticsearch) | `pip install elasticsearch-dbapi` | `elasticsearch+http://{user}:{password}@{host}:9200/` | -| [Exasol](/docs/databases/exasol) | `pip install sqlalchemy-exasol` | `exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC` | -| [Google Sheets](/docs/databases/google-sheets) | `pip install shillelagh[gsheetsapi]` | `gsheets://` | -| [Firebolt](/docs/databases/firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{username}:{password}@{database} or firebolt://{username}:{password}@{database}/{engine_name}` | -| [Hologres](/docs/databases/hologres) | `pip install psycopg2` | `postgresql+psycopg2://:@/` | -| [IBM Db2](/docs/databases/ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` | -| [IBM Netezza Performance Server](/docs/databases/netezza) | `pip install nzalchemy` | `netezza+nzpy://:@/` | -| [MySQL](/docs/databases/mysql) | `pip install mysqlclient` | `mysql://:@/` | -| [Oracle](/docs/databases/oracle) | `pip install cx_Oracle` | `oracle://` | -| [PostgreSQL](/docs/databases/postgres) | `pip install psycopg2` | `postgresql://:@/` | -| [Trino](/docs/databases/trino) | `pip install sqlalchemy-trino` | `trino://{username}:{password}@{hostname}:{port}/{catalog}` | -| [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://` | -| [SQL Server](/docs/databases/sql-server) | `pip install pymssql` | `mssql://` | -| [Teradata](/docs/databases/teradata) | `pip install sqlalchemy-teradata` | `teradata://{user}:{password}@{host}` | -| [Vertica](/docs/databases/vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://:@/` | +| Database | PyPI package | Connection String | +| ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| [Amazon Athena](/docs/connecting-to-databases/athena) | `pip install "PyAthenaJDBC>1.0.9` , `pip install "PyAthena>1.2.0` | `awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{ ` | +| [Amazon Redshift](/docs/connecting-to-databases/redshift) | `pip install sqlalchemy-redshift` | ` redshift+psycopg2://:@:5439/` | +| [Apache Drill](/docs/connecting-to-databases/drill) | `pip install sqlalchemy-drill` | `drill+sadrill:// For JDBC drill+jdbc://` | +| [Apache Druid](/docs/connecting-to-databases/druid) | `pip install pydruid` | `druid://:@:/druid/v2/sql` | +| [Apache Hive](/docs/connecting-to-databases/hive) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | +| [Apache Impala](/docs/connecting-to-databases/impala) | `pip install impyla` | `impala://{hostname}:{port}/{database}` | +| [Apache Kylin](/docs/connecting-to-databases/kylin) | `pip install kylinpy` | `kylin://:@:/?=&=` | +| [Apache Pinot](/docs/connecting-to-databases/pinot) | `pip install pinotdb` | `pinot://BROKER:5436/query?server=http://CONTROLLER:5983/` | +| [Apache Solr](/docs/connecting-to-databases/solr) | `pip install sqlalchemy-solr` | `solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}` | +| [Apache Spark SQL](/docs/connecting-to-databases/spark-sql) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` | +| [Ascend.io](/docs/connecting-to-databases/ascend) | `pip install impyla` | `ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true` | +| [Azure MS SQL](/docs/connecting-to-databases/sql-server) | `pip install pymssql` | `mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema` | +| [Big Query](/docs/connecting-to-databases/bigquery) | `pip install pybigquery` | `bigquery://{project_id}` | +| [ClickHouse](/docs/connecting-to-databases/clickhouse) | `pip install clickhouse-driver==0.2.0 && pip install clickhouse-sqlalchemy==0.1.6` | `clickhouse+native://{username}:{password}@{hostname}:{port}/{database}` | +| [CockroachDB](/docs/connecting-to-databases/cockroachdb) | `pip install cockroachdb` | `cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable` | +| [Dremio](/docs/connecting-to-databases/dremio) | `pip install sqlalchemy_dremio` | `dremio://user:pwd@host:31010/` | +| [Elasticsearch](/docs/connecting-to-databases/elasticsearch) | `pip install elasticsearch-dbapi` | `elasticsearch+http://{user}:{password}@{host}:9200/` | +| [Exasol](/docs/connecting-to-databases/exasol) | `pip install sqlalchemy-exasol` | `exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC` | +| [Google Sheets](/docs/connecting-to-databases/google-sheets) | `pip install shillelagh[gsheetsapi]` | `gsheets://` | +| [Firebolt](/docs/connecting-to-databases/firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{username}:{password}@{database} or firebolt://{username}:{password}@{database}/{engine_name}` | +| [Hologres](/docs/connecting-to-databases/hologres) | `pip install psycopg2` | `postgresql+psycopg2://:@/` | +| [IBM Db2](/docs/connecting-to-databases/ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` | +| [IBM Netezza Performance Server](/docs/connecting-to-databases/netezza) | `pip install nzalchemy` | `netezza+nzpy://:@/` | +| [MySQL](/docs/connecting-to-databases/mysql) | `pip install mysqlclient` | `mysql://:@/` | +| [Oracle](/docs/connecting-to-databases/oracle) | `pip install cx_Oracle` | `oracle://` | +| [PostgreSQL](/docs/connecting-to-databases/postgres) | `pip install psycopg2` | `postgresql://:@/` | +| [Trino](/docs/connecting-to-databases/trino) | `pip install sqlalchemy-trino` | `trino://{username}:{password}@{hostname}:{port}/{catalog}` | +| [Presto](/docs/connecting-to-databases/presto) | `pip install pyhive` | `presto://` | +| [SAP Hana](/docs/connecting-to-databases/hana) | `pip install hdbcli sqlalchemy-hana or pip install apache-superset[hana]` | `hana://{username}:{password}@{host}:{port}` | +| [Snowflake](/docs/connecting-to-databases/snowflake) | `pip install snowflake-sqlalchemy` | `snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}` | +| SQLite | | `sqlite://` | +| [SQL Server](/docs/connecting-to-databases/sql-server) | `pip install pymssql` | `mssql://` | +| [Teradata](/docs/connecting-to-databases/teradata) | `pip install sqlalchemy-teradata` | `teradata://{user}:{password}@{host}` | +| [Vertica](/docs/connecting-to-databases/vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://:@/` | --- diff --git a/docs-v2/docs/frequently-asked-questions.mdx b/docs-v2/docs/frequently-asked-questions.mdx index c01b82208e478..85a89997f739b 100644 --- a/docs-v2/docs/frequently-asked-questions.mdx +++ b/docs-v2/docs/frequently-asked-questions.mdx @@ -42,7 +42,7 @@ We recommend reading the instructions in ### Can I upload and visualize CSV data? -Absolutely! Read the instructions [here](/docs/creating-charts-dashboards/exploring-data) to learn +Absolutely! Read the instructions [here](/docs/Creating Charts and Dashboards/exploring-data) to learn how to enable and use CSV upload. ### Why are my queries timing out? @@ -231,7 +231,7 @@ Metadata attribute using the `label_colors` key. ### Does Superset work with [insert database engine here]? -The [Connecting to Databases section](/docs/databases/installing-database-drivers) provides the best +The [Connecting to Databases section](/docs/connecting-to-databases/installing-database-drivers) provides the best overview for supported databases. Database engines not listed on that page may work too. We rely on the community to contribute to this knowledge base. @@ -267,7 +267,7 @@ are typical in basic SQL: ### Does Superset offer a public API? Yes, a public REST API, and the surface of that API formal is expanding steadily. You can read more about this API and -interact with it using Swagger [here](/docs/rest-api). +interact with it using Swagger [here](/docs/api). Some of the original vision for the collection of endpoints under **/api/v1** was originally specified in diff --git a/docs-v2/docusaurus.config.js b/docs-v2/docusaurus.config.js index 85c772c5835df..a58d91e604a74 100644 --- a/docs-v2/docusaurus.config.js +++ b/docs-v2/docusaurus.config.js @@ -30,7 +30,7 @@ const config = { 'Apache Superset is a modern data exploration and visualization platform', url: 'https://superset.apache.org', baseUrl: '/', - onBrokenLinks: 'throw', + onBrokenLinks: 'warn', onBrokenMarkdownLinks: 'warn', favicon: 'img/favicon.ico', organizationName: 'apache', // Usually your GitHub org/user name. @@ -51,11 +51,11 @@ const config = { from: '/tutorials.html', }, { - to: '/docs/creating-charts-dashboards/first-dashboard', + to: '/docs/Creating Charts and Dashboards/creating-your-first-dashboard', from: '/admintutorial.html', }, { - to: '/docs/creating-charts-dashboards/first-dashboard', + to: '/docs/Creating Charts and Dashboards/creating-your-first-dashboard', from: '/usertutorial.html', }, { @@ -66,16 +66,12 @@ const config = { to: '/docs/installation/sql-templating', from: '/sqllab.html', }, - { - to: '/docs/installation/sql-templating', - from: '/gallery.html', - }, { to: '/docs/intro', - from: '/sqllab.html', + from: '/gallery.html', }, { - to: '/docs/databases/druid', + to: '/docs/connecting-to-databases/druid', from: '/druid.html', }, { @@ -95,11 +91,7 @@ const config = { from: '/faq.html', }, { - to: '/docs/intro', - from: '/index.html', - }, - { - to: '/docs/creating-charts-dashboards', + to: '/docs/Creating Charts and Dashboards/creating-your-first-dashboard', from: '/tutorial.html', }, {