QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-08-04 04:52:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(build): migrate from Prettier to Oxfmt for docs

Browse Source 
Signed-off-by: hainenber <dotronghai96@gmail.com>
This commit is contained in:
hainenber
2026-07-28 21:38:39 +07:00
parent af9729a861
commit 1bbc63099b
2163 changed files with 89307 additions and 32009 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/user_docs_versioned_docs/version-6.0.0/api.mdx
View File

@@ -21,8 +21,8 @@ documented here. The docs below are generated using
message={
<div>
<strong>NOTE! </strong>
You can find an interactive version of this documentation on your local Superset
instance at <strong>/swagger/v1</strong> (unless disabled)
You can find an interactive version of this documentation on your local
Superset instance at <strong>/swagger/v1</strong> (unless disabled)
</div>
}
/>

36
docs/user_docs_versioned_docs/version-6.0.0/configuration/alerts-reports.mdx
View File

@@ -9,8 +9,8 @@ version: 2
Users can configure automated alerts and reports to send dashboards or charts to an email recipient or Slack channel.
- *Alerts* are sent when a SQL condition is reached
- *Reports* are sent on a schedule
- _Alerts_ are sent when a SQL condition is reached
- _Reports_ are sent on a schedule
Alerts and reports are disabled by default. To turn them on, you need to do some setup, described here.
@@ -26,25 +26,25 @@ Alerts and reports are disabled by default. To turn them on, you need to do some
- emails: `SMTP_*` settings
- Slack messages: `SLACK_API_TOKEN`
- Users can customize the email subject by including date code placeholders, which will automatically be replaced with the corresponding UTC date when the email is sent. To enable this functionality, activate the `"DATE_FORMAT_IN_EMAIL_SUBJECT"` [feature flag](/user-docs/6.0.0/configuration/configuring-superset#feature-flags). This enables date formatting in email subjects, preventing all reporting emails from being grouped into the same thread (optional for the reporting feature).
- Use date codes from [strftime.org](https://strftime.org/) to create the email subject.
- If no date code is provided, the original string will be used as the email subject.
- Use date codes from [strftime.org](https://strftime.org/) to create the email subject.
- If no date code is provided, the original string will be used as the email subject.
##### Disable dry-run mode
Screenshots will be taken but no messages actually sent as long as `ALERT_REPORTS_NOTIFICATION_DRY_RUN = True`, its default value in `docker/pythonpath_dev/superset_config.py`. To disable dry-run mode and start receiving email/Slack notifications, set `ALERT_REPORTS_NOTIFICATION_DRY_RUN` to `False` in [superset config](https://github.com/apache/superset/blob/master/docker/pythonpath_dev/superset_config.py).
Screenshots will be taken but no messages actually sent as long as `ALERT_REPORTS_NOTIFICATION_DRY_RUN = True`, its default value in `docker/pythonpath_dev/superset_config.py`. To disable dry-run mode and start receiving email/Slack notifications, set `ALERT_REPORTS_NOTIFICATION_DRY_RUN` to `False` in [superset config](https://github.com/apache/superset/blob/master/docker/pythonpath_dev/superset_config.py).
#### In your `Dockerfile`
- You must install a headless browser, for taking screenshots of the charts and dashboards. Only Firefox and Chrome are currently supported.
> If you choose Chrome, you must also change the value of `WEBDRIVER_TYPE` to `"chrome"` in your `superset_config.py`.
Note: All the components required (Firefox headless browser, Redis, Postgres db, celery worker and celery beat) are present in the *dev* docker image if you are following [Installing Superset Locally](/user-docs/6.0.0/installation/docker-compose/).
Note: All the components required (Firefox headless browser, Redis, Postgres db, celery worker and celery beat) are present in the _dev_ docker image if you are following [Installing Superset Locally](/user-docs/6.0.0/installation/docker-compose/).
All you need to do is add the required config variables described in this guide (See `Detailed Config`).
If you are running a non-dev docker image, e.g., a stable release like `apache/superset:3.1.0`, that image does not include a headless browser. Only the `superset_worker` container needs this headless browser to browse to the target chart or dashboard.
If you are running a non-dev docker image, e.g., a stable release like `apache/superset:3.1.0`, that image does not include a headless browser. Only the `superset_worker` container needs this headless browser to browse to the target chart or dashboard.
You can either install and configure the headless browser - see "Custom Dockerfile" section below - or when deploying via `docker compose`, modify your `docker-compose.yml` file to use a dev image for the worker container and a stable release image for the `superset_app` container.
*Note*: In this context, a "dev image" is the same application software as its corresponding non-dev image, just bundled with additional tools. So an image like `3.1.0-dev` is identical to `3.1.0` when it comes to stability, functionality, and running in production. The actual "in-development" versions of Superset - cutting-edge and unstable - are not tagged with version numbers on Docker Hub and will display version `0.0.0-dev` within the Superset UI.
_Note_: In this context, a "dev image" is the same application software as its corresponding non-dev image, just bundled with additional tools. So an image like `3.1.0-dev` is identical to `3.1.0` when it comes to stability, functionality, and running in production. The actual "in-development" versions of Superset - cutting-edge and unstable - are not tagged with version numbers on Docker Hub and will display version `0.0.0-dev` within the Superset UI.
### Slack integration
@@ -94,7 +94,7 @@ You need to replace default values with your custom Redis, Slack and/or SMTP con
Superset uses Celery beat and Celery worker(s) to send alerts and reports.
- The beat is the scheduler that tells the worker when to perform its tasks. This schedule is defined when you create the alert or report.
- The worker will process the tasks that need to be performed when an alert or report is fired.
- The worker will process the tasks that need to be performed when an alert or report is fired.
In the `CeleryConfig`, only the `beat_schedule` is relevant to this feature, the rest of the `CeleryConfig` can be changed for your needs.
@@ -201,7 +201,7 @@ Please refer to `ExecutorType` in the codebase for other executor types.
It's also possible to specify a minimum interval between each report's execution through the config file:
``` python
```python
# Set a minimum interval threshold between executions (for each Alert/Report)
# Value should be an integer
ALERT_MINIMUM_INTERVAL = int(timedelta(minutes=10).total_seconds())
@@ -210,7 +210,7 @@ REPORT_MINIMUM_INTERVAL = int(timedelta(minutes=5).total_seconds())
Alternatively, you can assign a function to `ALERT_MINIMUM_INTERVAL` and/or `REPORT_MINIMUM_INTERVAL`. This is useful to dynamically retrieve a value as needed:
``` python
```python
def alert_dynamic_minimal_interval(**kwargs) -> int:
"""
Define logic here to retrieve the value dynamically
@@ -277,17 +277,17 @@ Don't forget to set `WEBDRIVER_TYPE` and `WEBDRIVER_OPTION_ARGS` in your config
## Troubleshooting
There are many reasons that reports might not be working. Try these steps to check for specific issues.
There are many reasons that reports might not be working. Try these steps to check for specific issues.
### Confirm feature flag is enabled and you have sufficient permissions
If you don't see "Alerts & Reports" under the *Manage* section of the Settings dropdown in the Superset UI, you need to enable the `ALERT_REPORTS` feature flag (see above). Enable another feature flag and check to see that it took effect, to verify that your config file is getting loaded.
If you don't see "Alerts & Reports" under the _Manage_ section of the Settings dropdown in the Superset UI, you need to enable the `ALERT_REPORTS` feature flag (see above). Enable another feature flag and check to see that it took effect, to verify that your config file is getting loaded.
Log in as an admin user to ensure you have adequate permissions.
### Check the logs of your Celery worker
This is the best source of information about the problem. In a docker compose deployment, you can do this with a command like `docker logs superset_worker --since 1h`.
This is the best source of information about the problem. In a docker compose deployment, you can do this with a command like `docker logs superset_worker --since 1h`.
### Check web browser and webdriver installation
@@ -301,7 +301,7 @@ If you are handling the installation of that software on your own, or wish to us
One symptom of an invalid connection to an email server is receiving an error of `[Errno 110] Connection timed out` in your logs when the report tries to send.
Confirm via testing that your outbound email configuration is correct. Here is the simplest test, for an un-authenticated email SMTP email service running on port 25. If you are sending over SSL, for instance, study how [Superset's codebase sends emails](https://github.com/apache/superset/blob/master/superset/utils/core.py#L818) and then test with those commands and arguments.
Confirm via testing that your outbound email configuration is correct. Here is the simplest test, for an un-authenticated email SMTP email service running on port 25. If you are sending over SSL, for instance, study how [Superset's codebase sends emails](https://github.com/apache/superset/blob/master/superset/utils/core.py#L818) and then test with those commands and arguments.
Start Python in your worker environment, replace all example values, and run:
@@ -327,16 +327,16 @@ This should send an email.
Possible fixes:
- Some cloud hosts disable outgoing unauthenticated SMTP email to prevent spam. For instance, [Azure blocks port 25 by default on some machines](https://learn.microsoft.com/en-us/azure/virtual-network/troubleshoot-outbound-smtp-connectivity). Enable that port or use another sending method.
- Some cloud hosts disable outgoing unauthenticated SMTP email to prevent spam. For instance, [Azure blocks port 25 by default on some machines](https://learn.microsoft.com/en-us/azure/virtual-network/troubleshoot-outbound-smtp-connectivity). Enable that port or use another sending method.
- Use another set of SMTP credentials that you verify works in this setup.
### Browse to your report from the worker
The worker may be unable to reach the report. It will use the value of `WEBDRIVER_BASEURL` to browse to the report. If that route is invalid, or presents an authentication challenge that the worker can't pass, the report screenshot will fail.
The worker may be unable to reach the report. It will use the value of `WEBDRIVER_BASEURL` to browse to the report. If that route is invalid, or presents an authentication challenge that the worker can't pass, the report screenshot will fail.
Check this by attempting to `curl` the URL of a report that you see in the error logs of your worker. For instance, from the worker environment, run `curl http://superset_app:8088/superset/dashboard/1/`. You may get different responses depending on whether the dashboard exists - for example, you may need to change the `1` in that URL. If there's a URL in your logs from a failed report screenshot, that's a good place to start. The goal is to determine a valid value for `WEBDRIVER_BASEURL` and determine if an issue like HTTPS or authentication is redirecting your worker.
In a deployment with authentication measures enabled like HTTPS and Single Sign-On, it may make sense to have the worker navigate directly to the Superset application running in the same location, avoiding the need to sign in. For instance, you could use `WEBDRIVER_BASEURL="http://superset_app:8088"` for a docker compose deployment, and set `"force_https": False,` in your `TALISMAN_CONFIG`.
In a deployment with authentication measures enabled like HTTPS and Single Sign-On, it may make sense to have the worker navigate directly to the Superset application running in the same location, avoiding the need to sign in. For instance, you could use `WEBDRIVER_BASEURL="http://superset_app:8088"` for a docker compose deployment, and set `"force_https": False,` in your `TALISMAN_CONFIG`.
## Scheduling Queries as Reports

5
docs/user_docs_versioned_docs/version-6.0.0/configuration/configuring-superset.mdx
View File

@@ -225,7 +225,7 @@ RequestHeader set X-Forwarded-Proto "https"
## Configuring the application root
*Please be advised that this feature is in BETA.*
_Please be advised that this feature is in BETA._
Superset supports running the application under a non-root path. The root path
prefix can be specified in one of two ways:
@@ -311,10 +311,13 @@ AUTH_USER_REGISTRATION_ROLE = "Public"
```
In case you want to assign the `Admin` role on new user registration, it can be assigned as follows:
```python
AUTH_USER_REGISTRATION_ROLE = "Admin"
```
If you encounter the [issue](https://github.com/apache/superset/issues/13243) of not being able to list users from the Superset main page settings, although a newly registered user has an `Admin` role, please re-run `superset init` to sync the required permissions. Below is the command to re-run `superset init` using docker compose.
```
docker-compose exec superset superset init
```

8
docs/user_docs_versioned_docs/version-6.0.0/configuration/country-map-tools.mdx
View File

@@ -22,10 +22,10 @@ The current list of countries can be found in the src
The Country Maps visualization already ships with the maps for the following countries:
<ul style={{columns: 3}}>
{countriesData.countries.map((country, index) => (
<li key={index}>{country}</li>
))}
<ul style={{ columns: 3 }}>
{countriesData.countries.map((country, index) => (
<li key={index}>{country}</li>
))}
</ul>
## Adding a New Country

283
docs/user_docs_versioned_docs/version-6.0.0/configuration/databases.mdx
View File

@@ -4,6 +4,7 @@ hide_title: true
sidebar_position: 1
version: 1
---
# Connecting to Databases
Superset does not ship bundled with connectivity to databases. The main step in connecting
@@ -35,55 +36,55 @@ Some of the recommended packages are shown below. Please refer to
[pyproject.toml](https://github.com/apache/superset/blob/master/pyproject.toml) for the versions that
are compatible with Superset.
| <div style={{width: '150px'}}>Database</div> | PyPI package | Connection String |
| --------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [AWS Athena](/user-docs/6.0.0/configuration/databases#aws-athena) | `pip install pyathena[pandas]` , `pip install PyAthenaJDBC` | `awsathena+rest://{access_key_id}:{access_key}@athena.{region}.amazonaws.com/{schema}?s3_staging_dir={s3_staging_dir}&...` |
| [AWS DynamoDB](/user-docs/6.0.0/configuration/databases#aws-dynamodb) | `pip install pydynamodb` | `dynamodb://{access_key_id}:{secret_access_key}@dynamodb.{region_name}.amazonaws.com?connector=superset` |
| [AWS Redshift](/user-docs/6.0.0/configuration/databases#aws-redshift) | `pip install sqlalchemy-redshift` | `redshift+psycopg2://<userName>:<DBPassword>@<AWS End Point>:5439/<Database Name>` |
| [Apache Doris](/user-docs/6.0.0/configuration/databases#apache-doris) | `pip install pydoris` | `doris://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>` |
| [Apache Drill](/user-docs/6.0.0/configuration/databases#apache-drill) | `pip install sqlalchemy-drill` | `drill+sadrill://<username>:<password>@<host>:<port>/<storage_plugin>`, often useful: `?use_ssl=True/False` |
| [Apache Druid](/user-docs/6.0.0/configuration/databases#apache-druid) | `pip install pydruid` | `druid://<User>:<password>@<Host>:<Port-default-9088>/druid/v2/sql` |
| [Apache Hive](/user-docs/6.0.0/configuration/databases#hive) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` |
| [Apache Impala](/user-docs/6.0.0/configuration/databases#apache-impala) | `pip install impyla` | `impala://{hostname}:{port}/{database}` |
| [Apache Kylin](/user-docs/6.0.0/configuration/databases#apache-kylin) | `pip install kylinpy` | `kylin://<username>:<password>@<hostname>:<port>/<project>?<param1>=<value1>&<param2>=<value2>` |
| [Apache Pinot](/user-docs/6.0.0/configuration/databases#apache-pinot) | `pip install pinotdb` | `pinot://BROKER:5436/query?server=http://CONTROLLER:5983/` |
| [Apache Solr](/user-docs/6.0.0/configuration/databases#apache-solr) | `pip install sqlalchemy-solr` | `solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}` |
| [Apache Spark SQL](/user-docs/6.0.0/configuration/databases#apache-spark-sql) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` |
| [Ascend.io](/user-docs/6.0.0/configuration/databases#ascendio) | `pip install impyla` | `ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true` |
| [Azure MS SQL](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema` |
| [ClickHouse](/user-docs/6.0.0/configuration/databases#clickhouse) | `pip install clickhouse-connect` | `clickhousedb://{username}:{password}@{hostname}:{port}/{database}` |
| [CockroachDB](/user-docs/6.0.0/configuration/databases#cockroachdb) | `pip install cockroachdb` | `cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable` |
| [Couchbase](/user-docs/6.0.0/configuration/databases#couchbase) | `pip install couchbase-sqlalchemy` | `couchbase://{username}:{password}@{hostname}:{port}?truststorepath={ssl certificate path}` |
| [CrateDB](/user-docs/6.0.0/configuration/databases#cratedb) | `pip install sqlalchemy-cratedb` | `crate://{username}:{password}@{hostname}:{port}`, often useful: `?ssl=true/false` or `?schema=testdrive`. |
| [Denodo](/user-docs/6.0.0/configuration/databases#denodo) | `pip install denodo-sqlalchemy` | `denodo://{username}:{password}@{hostname}:{port}/{database}` |
| [Dremio](/user-docs/6.0.0/configuration/databases#dremio) | `pip install sqlalchemy_dremio` |`dremio+flight://{username}:{password}@{host}:32010`, often useful: `?UseEncryption=true/false`. For Legacy ODBC: `dremio+pyodbc://{username}:{password}@{host}:31010` |
| [Elasticsearch](/user-docs/6.0.0/configuration/databases#elasticsearch) | `pip install elasticsearch-dbapi` | `elasticsearch+http://{user}:{password}@{host}:9200/` |
| [Exasol](/user-docs/6.0.0/configuration/databases#exasol) | `pip install sqlalchemy-exasol` | `exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC` |
| [Google BigQuery](/user-docs/6.0.0/configuration/databases#google-bigquery) | `pip install sqlalchemy-bigquery` | `bigquery://{project_id}` |
| [Google Sheets](/user-docs/6.0.0/configuration/databases#google-sheets) | `pip install shillelagh[gsheetsapi]` | `gsheets://` |
| [Firebolt](/user-docs/6.0.0/configuration/databases#firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={name}` |
| [Hologres](/user-docs/6.0.0/configuration/databases#hologres) | `pip install psycopg2` | `postgresql+psycopg2://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [IBM Db2](/user-docs/6.0.0/configuration/databases#ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` |
| [IBM Netezza Performance Server](/user-docs/6.0.0/configuration/databases#ibm-netezza-performance-server) | `pip install nzalchemy` | `netezza+nzpy://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [MySQL](/user-docs/6.0.0/configuration/databases#mysql) | `pip install mysqlclient` | `mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [OceanBase](/user-docs/6.0.0/configuration/databases#oceanbase) | `pip install oceanbase_py` | `oceanbase://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [Oracle](/user-docs/6.0.0/configuration/databases#oracle) | `pip install cx_Oracle` | `oracle://<username>:<password>@<hostname>:<port>` |
| [Parseable](/user-docs/6.0.0/configuration/databases#parseable) | `pip install sqlalchemy-parseable` | `parseable://<UserName>:<DBPassword>@<Database Host>/<Stream Name>` |
| [PostgreSQL](/user-docs/6.0.0/configuration/databases#postgres) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [Presto](/user-docs/6.0.0/configuration/databases#presto) | `pip install pyhive` | `presto://{username}:{password}@{hostname}:{port}/{database}` |
| [SAP Hana](/user-docs/6.0.0/configuration/databases#hana) | `pip install hdbcli sqlalchemy-hana` or `pip install apache_superset[hana]` | `hana://{username}:{password}@{host}:{port}` |
| [SingleStore](/user-docs/6.0.0/configuration/databases#singlestore) | `pip install sqlalchemy-singlestoredb` | `singlestoredb://{username}:{password}@{host}:{port}/{database}` |
| [StarRocks](/user-docs/6.0.0/configuration/databases#starrocks) | `pip install starrocks` | `starrocks://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>` |
| [Snowflake](/user-docs/6.0.0/configuration/databases#snowflake) | `pip install snowflake-sqlalchemy` | `snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}` |
| SQLite | No additional library needed | `sqlite://path/to/file.db?check_same_thread=false` |
| [SQL Server](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://<Username>:<Password>@<Host>:<Port-default:1433>/<Database Name>` |
| [TDengine](/user-docs/6.0.0/configuration/databases#tdengine) | `pip install taospy` `pip install taos-ws-py` | `taosws://<user>:<password>@<host>:<port>` |
| [Teradata](/user-docs/6.0.0/configuration/databases#teradata) | `pip install teradatasqlalchemy` | `teradatasql://{user}:{password}@{host}` |
| [TimescaleDB](/user-docs/6.0.0/configuration/databases#timescaledb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>:<Port>/<Database Name>` |
| [Trino](/user-docs/6.0.0/configuration/databases#trino) | `pip install trino` | `trino://{username}:{password}@{hostname}:{port}/{catalog}` |
| [Vertica](/user-docs/6.0.0/configuration/databases#vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [YDB](/user-docs/6.0.0/configuration/databases#ydb) | `pip install ydb-sqlalchemy` | `ydb://{host}:{port}/{database_name}` |
| [YugabyteDB](/user-docs/6.0.0/configuration/databases#yugabytedb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| <div style={{width: '150px'}}>Database</div> | PyPI package | Connection String |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [AWS Athena](/user-docs/6.0.0/configuration/databases#aws-athena) | `pip install pyathena[pandas]` , `pip install PyAthenaJDBC` | `awsathena+rest://{access_key_id}:{access_key}@athena.{region}.amazonaws.com/{schema}?s3_staging_dir={s3_staging_dir}&...` |
| [AWS DynamoDB](/user-docs/6.0.0/configuration/databases#aws-dynamodb) | `pip install pydynamodb` | `dynamodb://{access_key_id}:{secret_access_key}@dynamodb.{region_name}.amazonaws.com?connector=superset` |
| [AWS Redshift](/user-docs/6.0.0/configuration/databases#aws-redshift) | `pip install sqlalchemy-redshift` | `redshift+psycopg2://<userName>:<DBPassword>@<AWS End Point>:5439/<Database Name>` |
| [Apache Doris](/user-docs/6.0.0/configuration/databases#apache-doris) | `pip install pydoris` | `doris://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>` |
| [Apache Drill](/user-docs/6.0.0/configuration/databases#apache-drill) | `pip install sqlalchemy-drill` | `drill+sadrill://<username>:<password>@<host>:<port>/<storage_plugin>`, often useful: `?use_ssl=True/False` |
| [Apache Druid](/user-docs/6.0.0/configuration/databases#apache-druid) | `pip install pydruid` | `druid://<User>:<password>@<Host>:<Port-default-9088>/druid/v2/sql` |
| [Apache Hive](/user-docs/6.0.0/configuration/databases#hive) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` |
| [Apache Impala](/user-docs/6.0.0/configuration/databases#apache-impala) | `pip install impyla` | `impala://{hostname}:{port}/{database}` |
| [Apache Kylin](/user-docs/6.0.0/configuration/databases#apache-kylin) | `pip install kylinpy` | `kylin://<username>:<password>@<hostname>:<port>/<project>?<param1>=<value1>&<param2>=<value2>` |
| [Apache Pinot](/user-docs/6.0.0/configuration/databases#apache-pinot) | `pip install pinotdb` | `pinot://BROKER:5436/query?server=http://CONTROLLER:5983/` |
| [Apache Solr](/user-docs/6.0.0/configuration/databases#apache-solr) | `pip install sqlalchemy-solr` | `solr://{username}:{password}@{hostname}:{port}/{server_path}/{collection}` |
| [Apache Spark SQL](/user-docs/6.0.0/configuration/databases#apache-spark-sql) | `pip install pyhive` | `hive://hive@{hostname}:{port}/{database}` |
| [Ascend.io](/user-docs/6.0.0/configuration/databases#ascendio) | `pip install impyla` | `ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true` |
| [Azure MS SQL](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://UserName@presetSQL:TestPassword@presetSQL.database.windows.net:1433/TestSchema` |
| [ClickHouse](/user-docs/6.0.0/configuration/databases#clickhouse) | `pip install clickhouse-connect` | `clickhousedb://{username}:{password}@{hostname}:{port}/{database}` |
| [CockroachDB](/user-docs/6.0.0/configuration/databases#cockroachdb) | `pip install cockroachdb` | `cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable` |
| [Couchbase](/user-docs/6.0.0/configuration/databases#couchbase) | `pip install couchbase-sqlalchemy` | `couchbase://{username}:{password}@{hostname}:{port}?truststorepath={ssl certificate path}` |
| [CrateDB](/user-docs/6.0.0/configuration/databases#cratedb) | `pip install sqlalchemy-cratedb` | `crate://{username}:{password}@{hostname}:{port}`, often useful: `?ssl=true/false` or `?schema=testdrive`. |
| [Denodo](/user-docs/6.0.0/configuration/databases#denodo) | `pip install denodo-sqlalchemy` | `denodo://{username}:{password}@{hostname}:{port}/{database}` |
| [Dremio](/user-docs/6.0.0/configuration/databases#dremio) | `pip install sqlalchemy_dremio` | `dremio+flight://{username}:{password}@{host}:32010`, often useful: `?UseEncryption=true/false`. For Legacy ODBC: `dremio+pyodbc://{username}:{password}@{host}:31010` |
| [Elasticsearch](/user-docs/6.0.0/configuration/databases#elasticsearch) | `pip install elasticsearch-dbapi` | `elasticsearch+http://{user}:{password}@{host}:9200/` |
| [Exasol](/user-docs/6.0.0/configuration/databases#exasol) | `pip install sqlalchemy-exasol` | `exa+pyodbc://{username}:{password}@{hostname}:{port}/my_schema?CONNECTIONLCALL=en_US.UTF-8&driver=EXAODBC` |
| [Google BigQuery](/user-docs/6.0.0/configuration/databases#google-bigquery) | `pip install sqlalchemy-bigquery` | `bigquery://{project_id}` |
| [Google Sheets](/user-docs/6.0.0/configuration/databases#google-sheets) | `pip install shillelagh[gsheetsapi]` | `gsheets://` |
| [Firebolt](/user-docs/6.0.0/configuration/databases#firebolt) | `pip install firebolt-sqlalchemy` | `firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={name}` |
| [Hologres](/user-docs/6.0.0/configuration/databases#hologres) | `pip install psycopg2` | `postgresql+psycopg2://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [IBM Db2](/user-docs/6.0.0/configuration/databases#ibm-db2) | `pip install ibm_db_sa` | `db2+ibm_db://` |
| [IBM Netezza Performance Server](/user-docs/6.0.0/configuration/databases#ibm-netezza-performance-server) | `pip install nzalchemy` | `netezza+nzpy://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [MySQL](/user-docs/6.0.0/configuration/databases#mysql) | `pip install mysqlclient` | `mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [OceanBase](/user-docs/6.0.0/configuration/databases#oceanbase) | `pip install oceanbase_py` | `oceanbase://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [Oracle](/user-docs/6.0.0/configuration/databases#oracle) | `pip install cx_Oracle` | `oracle://<username>:<password>@<hostname>:<port>` |
| [Parseable](/user-docs/6.0.0/configuration/databases#parseable) | `pip install sqlalchemy-parseable` | `parseable://<UserName>:<DBPassword>@<Database Host>/<Stream Name>` |
| [PostgreSQL](/user-docs/6.0.0/configuration/databases#postgres) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [Presto](/user-docs/6.0.0/configuration/databases#presto) | `pip install pyhive` | `presto://{username}:{password}@{hostname}:{port}/{database}` |
| [SAP Hana](/user-docs/6.0.0/configuration/databases#hana) | `pip install hdbcli sqlalchemy-hana` or `pip install apache_superset[hana]` | `hana://{username}:{password}@{host}:{port}` |
| [SingleStore](/user-docs/6.0.0/configuration/databases#singlestore) | `pip install sqlalchemy-singlestoredb` | `singlestoredb://{username}:{password}@{host}:{port}/{database}` |
| [StarRocks](/user-docs/6.0.0/configuration/databases#starrocks) | `pip install starrocks` | `starrocks://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>` |
| [Snowflake](/user-docs/6.0.0/configuration/databases#snowflake) | `pip install snowflake-sqlalchemy` | `snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}` |
| SQLite | No additional library needed | `sqlite://path/to/file.db?check_same_thread=false` |
| [SQL Server](/user-docs/6.0.0/configuration/databases#sql-server) | `pip install pymssql` | `mssql+pymssql://<Username>:<Password>@<Host>:<Port-default:1433>/<Database Name>` |
| [TDengine](/user-docs/6.0.0/configuration/databases#tdengine) | `pip install taospy` `pip install taos-ws-py` | `taosws://<user>:<password>@<host>:<port>` |
| [Teradata](/user-docs/6.0.0/configuration/databases#teradata) | `pip install teradatasqlalchemy` | `teradatasql://{user}:{password}@{host}` |
| [TimescaleDB](/user-docs/6.0.0/configuration/databases#timescaledb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>:<Port>/<Database Name>` |
| [Trino](/user-docs/6.0.0/configuration/databases#trino) | `pip install trino` | `trino://{username}:{password}@{hostname}:{port}/{catalog}` |
| [Vertica](/user-docs/6.0.0/configuration/databases#vertica) | `pip install sqlalchemy-vertica-python` | `vertica+vertica_python://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [YDB](/user-docs/6.0.0/configuration/databases#ydb) | `pip install ydb-sqlalchemy` | `ydb://{host}:{port}/{database_name}` |
| [YugabyteDB](/user-docs/6.0.0/configuration/databases#yugabytedb) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
---
@@ -133,7 +134,7 @@ exists in the directory with your `docker-compose.yml` or `docker-compose-non-de
touch ./docker/requirements-local.txt
```
Add the driver identified in step above. You can use a text editor or do
Add the driver identified in step above. You can use a text editor or do
it from the command line like:
```bash
@@ -145,7 +146,7 @@ Launch Superset with `docker compose -f docker-compose-non-dev.yml up` and
the driver should be present.
You can check its presence by entering the running container with
`docker exec -it <container_name> bash` and running `pip freeze`. The PyPI package should
`docker exec -it <container_name> bash` and running `pip freeze`. The PyPI package should
be present in the printed list.
**If you're running a customized docker image**, rebuild your local image with the new
@@ -168,7 +169,7 @@ From there, follow the steps on the
[Using Database Connection UI page](/user-docs/6.0.0/configuration/databases#connecting-through-the-ui).
Consult the page for your specific database type in the Superset documentation to determine
the connection string and any other parameters you need to input. For instance,
the connection string and any other parameters you need to input. For instance,
on the [MySQL page](/user-docs/6.0.0/configuration/databases#mysql), we see that the connection string
to a local MySQL database differs depending on whether the setup is running on Linux or Mac.
@@ -177,7 +178,7 @@ Click the “Test Connection” button, which should result in a popup message s
#### 4. Troubleshooting
If the test fails, review your docker logs for error messages. Superset uses SQLAlchemy
If the test fails, review your docker logs for error messages. Superset uses SQLAlchemy
to connect to databases; to troubleshoot the connection string for your database, you might
start Python in the Superset application container or host environment and try to connect
directly to the desired database and fetch data. This eliminates Superset for the
@@ -248,9 +249,9 @@ The PyAthena library also allows to assume a specific IAM role which you can def
```json
{
"connect_args": {
"role_arn": "<role arn>"
}
"connect_args": {
"role_arn": "<role arn>"
}
}
```
@@ -464,7 +465,7 @@ You also need to add the following configuration to "Other" -> "Engine Parameter
```json
{
"connect_args": {"http_path": "sql/protocolv1/o/****"}
"connect_args": { "http_path": "sql/protocolv1/o/****" }
}
```
@@ -489,7 +490,7 @@ databricks+pyhive://token:{access_token}@{server_hostname}:{port}/{database_name
You also need to add the following configuration to "Other" -> "Engine Parameters", with your HTTP path:
```json
{"connect_args": {"http_path": "sql/protocolv1/o/****"}}
{ "connect_args": { "http_path": "sql/protocolv1/o/****" } }
```
#### ODBC
@@ -505,7 +506,12 @@ databricks+pyodbc://token:{access_token}@{server_hostname}:{port}/{database_name
And for the connection arguments:
```json
{"connect_args": {"http_path": "sql/protocolv1/o/****", "driver_path": "/path/to/odbc/driver"}}
{
"connect_args": {
"http_path": "sql/protocolv1/o/****",
"driver_path": "/path/to/odbc/driver"
}
}
```
The driver path should be:
@@ -516,7 +522,12 @@ The driver path should be:
For a connection to a SQL endpoint you need to use the HTTP path from the endpoint:
```json
{"connect_args": {"http_path": "/sql/1.0/endpoints/****", "driver_path": "/path/to/odbc/driver"}}
{
"connect_args": {
"http_path": "/sql/1.0/endpoints/****",
"driver_path": "/path/to/odbc/driver"
}
}
```
##### OAuth2 Authentication
@@ -561,6 +572,7 @@ DATABASE_OAUTH2_TIMEOUT = timedelta(seconds=30)
```
Replace the following placeholders:
- `your-databricks-client-id`: Your Databricks OAuth2 application client ID
- `your-databricks-client-secret`: Your Databricks OAuth2 application client secret
- `your-superset-host:port`: Your Superset instance hostname and port
@@ -665,7 +677,7 @@ We recommend reading the
the [GitHub README](https://github.com/JohnOmernik/sqlalchemy-drill#usage-with-odbc) to learn how to
work with Drill through ODBC.
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
#### Apache Druid
@@ -696,7 +708,7 @@ When adding a connection to Druid, you can customize the connection a few differ
You can add certificates in the **Root Certificate** field when configuring the new database
connection to Druid:
<img src={useBaseUrl("/img/root-cert-example.png")} />{" "}
<img src={useBaseUrl('/img/root-cert-example.png')} />
When using a custom certificate, pydruid will automatically use https scheme.
@@ -781,9 +793,9 @@ please edit your Database and enter the settings of your specified time zone in
```json
{
"connect_args": {
"time_zone": "Asia/Shanghai"
}
"connect_args": {
"time_zone": "Asia/Shanghai"
}
}
```
@@ -874,17 +886,17 @@ credentials file (as a JSON).
```json
{
"type": "service_account",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
"client_email": "...",
"client_id": "...",
"auth_uri": "...",
"token_uri": "...",
"auth_provider_x509_cert_url": "...",
"client_x509_cert_url": "..."
}
"type": "service_account",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
"client_email": "...",
"client_id": "...",
"auth_uri": "...",
"token_uri": "...",
"auth_provider_x509_cert_url": "...",
"client_x509_cert_url": "..."
}
```
![CleanShot 2021-10-22 at 04 18 11](https://user-images.githubusercontent.com/52086618/138352958-a18ef9cb-8880-4ef1-88c1-452a9f1b8105.gif)
@@ -910,19 +922,19 @@ credentials file (as a JSON).
```json
{
"credentials_info": {
"type": "service_account",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
"client_email": "...",
"client_id": "...",
"auth_uri": "...",
"token_uri": "...",
"auth_provider_x509_cert_url": "...",
"client_x509_cert_url": "..."
}
}
"credentials_info": {
"type": "service_account",
"project_id": "...",
"private_key_id": "...",
"private_key": "...",
"client_email": "...",
"client_id": "...",
"auth_uri": "...",
"token_uri": "...",
"auth_provider_x509_cert_url": "...",
"client_x509_cert_url": "..."
}
}
```
You should then be able to connect to your BigQuery datasets.
@@ -1134,7 +1146,8 @@ parseable://admin:admin@demo.parseable.com:443/ingress-nginx
Note: The stream_name in the URI represents the Parseable logstream you want to query. You can use both HTTP (port 80) and HTTPS (port 443) connections.
>>>>>>>
> > > > > > >
#### Apache Pinot
The recommended connector library for Apache Pinot is [pinotdb](https://pypi.org/project/pinotdb/).
@@ -1155,7 +1168,7 @@ If you want to use explore view or joins, window functions, etc. then enable [mu
Add below argument while creating database connection in Advanced -> Other -> ENGINE PARAMETERS
```json
{"connect_args":{"use_multistage_engine":"true"}}
{ "connect_args": { "use_multistage_engine": "true" } }
```
#### Postgres
@@ -1221,17 +1234,17 @@ datasource. If you’re using an older version of Presto, you can configure it i
```json
{
"version": "0.123"
"version": "0.123"
}
```
SSL Secure extra add json config to extra connection information.
```json
{
"connect_args":
{"protocol": "https",
"requests_kwargs":{"verify":false}
{
"connect_args": {
"protocol": "https",
"requests_kwargs": { "verify": false }
}
}
```
@@ -1285,27 +1298,27 @@ And if you want connect Snowflake with [Key Pair Authentication](https://docs.sn
Please make sure you have the key pair and the public key is registered in Snowflake.
To connect Snowflake with Key Pair Authentication, you need to add the following parameters to "SECURE EXTRA" field.
***Please note that you need to merge multi-line private key content to one line and insert `\n` between each line***
**_Please note that you need to merge multi-line private key content to one line and insert `\n` between each line_**
```json
{
"auth_method": "keypair",
"auth_params": {
"privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\n...\n...\n-----END ENCRYPTED PRIVATE KEY-----",
"privatekey_pass":"Your Private Key Password"
}
}
"auth_method": "keypair",
"auth_params": {
"privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\n...\n...\n-----END ENCRYPTED PRIVATE KEY-----",
"privatekey_pass": "Your Private Key Password"
}
}
```
If your private key is stored on server, you can replace "privatekey_body" with “privatekey_path” in parameter.
```json
{
"auth_method": "keypair",
"auth_params": {
"privatekey_path":"Your Private Key Path",
"privatekey_pass":"Your Private Key Password"
}
"auth_method": "keypair",
"auth_params": {
"privatekey_path": "Your Private Key Path",
"privatekey_pass": "Your Private Key Password"
}
}
```
@@ -1421,9 +1434,9 @@ teradatasql://{user}:{password}@{host}
#### ODBC Driver
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
[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:
@@ -1434,8 +1447,8 @@ 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.
lack of requirement around ODBC drivers and
because it's more regularly updated.
#### TimescaleDB
@@ -1496,21 +1509,21 @@ You can provide `username`/`password` in the connection string or in the `Secure
- In Connection String
```
trino://{username}:{password}@{hostname}:{port}/{catalog}
```
```
trino://{username}:{password}@{hostname}:{port}/{catalog}
```
- In `Secure Extra` field
```json
{
"auth_method": "basic",
"auth_params": {
"username": "<username>",
"password": "<password>"
}
```json
{
"auth_method": "basic",
"auth_params": {
"username": "<username>",
"password": "<password>"
}
```
}
```
NOTE: if both are provided, `Secure Extra` always takes higher priority.
@@ -1539,11 +1552,11 @@ In `Secure Extra` field, config as following example:
```json
{
"auth_method": "certificate",
"auth_params": {
"cert": "/path/to/cert.pem",
"key": "/path/to/key.pem"
}
"auth_method": "certificate",
"auth_params": {
"cert": "/path/to/cert.pem",
"key": "/path/to/key.pem"
}
}
```
@@ -1555,10 +1568,10 @@ Config `auth_method` and provide token in `Secure Extra` field
```json
{
"auth_method": "jwt",
"auth_params": {
"token": "<your-jwt-token>"
}
"auth_method": "jwt",
"auth_params": {
"token": "<your-jwt-token>"
}
}
```
@@ -1883,11 +1896,11 @@ If you enable DML in the meta database users will be able to run DML queries on
Second, you might want to change the value of `SUPERSET_META_DB_LIMIT`. The default value is 1000, and defines how many are read from each database before any aggregations and joins are executed. You can also set this value `None` if you only have small tables.
:::warning
`SUPERSET_META_DB_LIMIT` is applied to **each** underlying table *before* the in-memory join runs, not to the final result. If any table involved in a join has more rows than the limit, the meta database will read only the first `SUPERSET_META_DB_LIMIT` rows of that table, which means matching rows can be silently dropped and the join can return **incomplete or even empty** results with no error. If you join tables larger than the limit, raise `SUPERSET_META_DB_LIMIT` to comfortably exceed your largest joined table, or set it to `None` when working only with small tables, to get correct results.
`SUPERSET_META_DB_LIMIT` is applied to **each** underlying table _before_ the in-memory join runs, not to the final result. If any table involved in a join has more rows than the limit, the meta database will read only the first `SUPERSET_META_DB_LIMIT` rows of that table, which means matching rows can be silently dropped and the join can return **incomplete or even empty** results with no error. If you join tables larger than the limit, raise `SUPERSET_META_DB_LIMIT` to comfortably exceed your largest joined table, or set it to `None` when working only with small tables, to get correct results.
:::
Additionally, you might want to restrict the databases to with the meta database has access to. This can be done in the database configuration, under "Advanced" -> "Other" -> "ENGINE PARAMETERS" and adding:
```json
{"allowed_dbs":["Google Sheets","examples"]}
{ "allowed_dbs": ["Google Sheets", "examples"] }
```

12
docs/user_docs_versioned_docs/version-6.0.0/configuration/importing-exporting-datasources.mdx
View File

@@ -117,10 +117,10 @@ datasets by saving the following YAML to file and then running the **import_data
```yaml
databases:
- database_name: main
tables:
- table_name: random_time_series
columns:
- column_name: ds
verbose_name: datetime
- database_name: main
tables:
- table_name: random_time_series
columns:
- column_name: ds
verbose_name: datetime
```

4
docs/user_docs_versioned_docs/version-6.0.0/configuration/map-tiles.mdx
View File

@@ -18,7 +18,9 @@ DECKGL_BASE_MAP = [
['tile://https://your_personal_url/{z}/{x}/{y}.png', 'MyTile']
]
```
Openstreetmap tiles url can be added without prefix.
```python
DECKGL_BASE_MAP = [
['https://c.tile.openstreetmap.org/{z}/{x}/{y}.png', 'OpenStreetMap']
@@ -26,6 +28,7 @@ DECKGL_BASE_MAP = [
```
Default values are:
```python
DECKGL_BASE_MAP = [
['https://tile.openstreetmap.org/{z}/{x}/{y}.png', 'Streets (OSM)'],
@@ -46,6 +49,7 @@ Setting `DECKGL_BASE_MAP` overwrite default values
:::
After defining your map tiles, set them in these variables:
- `CORS_OPTIONS`
- `connect-src` of `TALISMAN_CONFIG` and `TALISMAN_CONFIG_DEV` variables.

18
docs/user_docs_versioned_docs/version-6.0.0/configuration/networking-settings.mdx
View File

@@ -8,12 +8,10 @@ version: 1
## CORS
:::note
In Superset versions prior to `5.x` you have to install to install `flask-cors` with `pip install flask-cors` to enable CORS support.
:::
The following keys in `superset_config.py` can be specified to configure CORS:
- `ENABLE_CORS`: Must be set to `True` in order to enable CORS
@@ -63,7 +61,7 @@ Now anybody can directly access the dashboard's URL. You can embed it in an ifra
width="600"
height="400"
seamless
frameBorder="0"
frameborder="0"
scrolling="no"
src="https://superset.my-domain.com/superset/dashboard/10/?standalone=1&height=400"
>
@@ -93,17 +91,17 @@ running a custom auth postback endpoint), you can add the endpoints to `WTF_CSRF
## SSH Tunneling
1. Turn on feature flag
- Change [`SSH_TUNNELING`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489) to `True`
- If you want to add more security when establishing the tunnel we allow users to overwrite the `SSHTunnelManager` class [here](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507)
- You can also set the [`SSH_TUNNEL_LOCAL_BIND_ADDRESS`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508) this the host address where the tunnel will be accessible on your VPC
- Change [`SSH_TUNNELING`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489) to `True`
- If you want to add more security when establishing the tunnel we allow users to overwrite the `SSHTunnelManager` class [here](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507)
- You can also set the [`SSH_TUNNEL_LOCAL_BIND_ADDRESS`](https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508) this the host address where the tunnel will be accessible on your VPC
2. Create database w/ ssh tunnel enabled
- With the feature flag enabled you should now see ssh tunnel toggle.
- Click the toggle to enable SSH tunneling and add your credentials accordingly.
- Superset allows for two different types of authentication (Basic + Private Key). These credentials should come from your service provider.
- With the feature flag enabled you should now see ssh tunnel toggle.
- Click the toggle to enable SSH tunneling and add your credentials accordingly.
- Superset allows for two different types of authentication (Basic + Private Key). These credentials should come from your service provider.
3. Verify data is flowing
- Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing.
- Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing.
## Domain Sharding

11
docs/user_docs_versioned_docs/version-6.0.0/configuration/sql-templating.mdx
View File

@@ -84,6 +84,7 @@ WHERE dttm_col > '{{ from_dttm | default("2024-01-01", true) }}'
**Option 2: Use SQL Lab Parameters**
Set parameters in the SQL Lab UI (Parameters menu):
```json
{
"from_dttm": "2024-01-01",
@@ -129,7 +130,7 @@ In the UI you can assign a set of parameters as JSON
The parameters become available in your SQL (example: `SELECT * FROM {{ my_table }}` ) by using Jinja templating syntax.
SQL Lab template parameters are stored with the dataset as `TEMPLATE PARAMETERS`.
There is a special ``_filters`` parameter which can be used to test filters used in the jinja template.
There is a special `_filters` parameter which can be used to test filters used in the jinja template.
```json
{
@@ -150,7 +151,7 @@ WHERE action in {{ filter_values('action_type')|where_in }}
GROUP BY action
```
Note ``_filters`` is not stored with the dataset. It's only used within the SQL Lab UI.
Note `_filters` is not stored with the dataset. It's only used within the SQL Lab UI.
Besides default Jinja templating, SQL lab also supports self-defined template processor by setting
the `CUSTOM_TEMPLATE_PROCESSORS` in your superset configuration. The values in this dictionary
@@ -284,16 +285,19 @@ cache key by adding the following parameter to your Jinja code:
```
You can json-stringify the array by adding `|tojson` to your Jinja code:
```python
{{ current_user_roles()|tojson }}
```
You can use the `|where_in` filter to use your roles in a SQL statement. For example, if `current_user_roles()` returns `['admin', 'viewer']`, the following template:
```python
SELECT * FROM users WHERE role IN {{ current_user_roles()|where_in }}
```
Will be rendered as:
```sql
SELECT * FROM users WHERE role IN ('admin', 'viewer')
```
@@ -447,7 +451,7 @@ The macro takes the following parameters:
- `column`: Name of the temporal column. Leave undefined to reference the time range from a Dashboard Native Time Range
filter (when present).
- `default`: The default value to fall back to if the time filter is not present, or has the value `No filter`
- `target_type`: The target temporal type as recognized by the target database (e.g. `TIMESTAMP`, `DATE` or
- `target_type`: The target temporal type as recognized by the target database (e.g. `TIMESTAMP`, `DATE` or
`DATETIME`). If `column` is defined, the format will default to the type of the column. This is used to produce
the format of the `from_expr` and `to_expr` properties of the returned `TimeFilter` object.
- `strftime`: format using the `strftime` method of `datetime` for custom time formatting.
@@ -572,6 +576,7 @@ Dashboard filter without any value applied
**To Datetime**
Loads a string as a `datetime` object. This is useful when performing date operations. For example:
```
{% set from_expr = get_time_filter("dttm", strftime="%Y-%m-%d").from_expr %}
{% set to_expr = get_time_filter("dttm", strftime="%Y-%m-%d").to_expr %}

4
docs/user_docs_versioned_docs/version-6.0.0/configuration/theming.mdx
View File

@@ -4,6 +4,7 @@ hide_title: true
sidebar_position: 12
version: 1
---
# Theming Superset
:::note
@@ -34,11 +35,13 @@ You can also extend with Superset-specific tokens (documented in the default the
When `ENABLE_UI_THEME_ADMINISTRATION = True` is configured, administrators can manage system-wide themes directly from the UI:
#### Setting System Themes
- **System Default Theme**: Click the sun icon on any theme to set it as the system-wide default
- **System Dark Theme**: Click the moon icon on any theme to set it as the system dark mode theme
- **Automatic OS Detection**: When both default and dark themes are set, Superset automatically detects and applies the appropriate theme based on OS preferences
#### Managing System Themes
- System themes are indicated with special badges in the theme list
- Only administrators with write permissions can modify system theme settings
- Removing a system theme designation reverts to configuration file defaults
@@ -46,6 +49,7 @@ When `ENABLE_UI_THEME_ADMINISTRATION = True` is configured, administrators can m
### Applying Themes to Dashboards
Once created, themes can be applied to individual dashboards:
- Edit any dashboard and select your custom theme from the theme dropdown
- Each dashboard can have its own theme, allowing for branded or context-specific styling

2
docs/user_docs_versioned_docs/version-6.0.0/contributing/contributing.mdx
View File

@@ -129,7 +129,7 @@ Security team members must:
- Have an [ICLA](https://www.apache.org/licenses/contributor-agreements.html) signed with Apache Software Foundation.
- Not reveal information about pending and unfixed security issues to anyone (including their employers) unless specifically authorised by the security team members, e.g., if the security team agrees that diagnosing and solving an issue requires the involvement of external experts.
A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues.
A release manager, the contributor overseeing the release of a specific version of Apache Superset, is by default a member of the security team. However, they are not expected to be active in assessing, discussing, and fixing security issues.
Security team members should also follow these general expectations:

15
docs/user_docs_versioned_docs/version-6.0.0/contributing/development.mdx
View File

@@ -3,6 +3,7 @@ title: Setting up a Development Environment
sidebar_position: 3
version: 1
---
# Setting up a Development Environment
The documentation in this section is a bit of a patchwork of knowledge representing the
@@ -123,6 +124,7 @@ docker-compose up
## GitHub Codespaces (Cloud Development)
GitHub Codespaces provides a complete, pre-configured development environment in the cloud. This is ideal for:
- Quick contributions without local setup
- Consistent development environments across team members
- Working from devices that can't run Docker locally
@@ -269,17 +271,21 @@ You can also run the pre-commit checks manually in various ways:
## Working with LLMs
### Environment Setup
Ensure Docker Compose is running before starting LLM sessions:
```bash
docker compose up
```
Validate your environment:
```bash
curl -f http://localhost:8088/health && echo "✅ Superset ready"
```
### LLM Session Best Practices
- Always validate environment setup first using the health checks above
- Use focused validation commands: `pre-commit run` (not `--all-files`)
- **Read [LLMS.md](https://github.com/apache/superset/blob/master/LLMS.md) first** - Contains comprehensive development guidelines, coding standards, and critical refactor information
@@ -291,6 +297,7 @@ curl -f http://localhost:8088/health && echo "✅ Superset ready"
- Follow the TypeScript migration guidelines and avoid deprecated patterns listed in LLMS.md
### Key Development Commands
```bash
# Frontend development
cd superset-frontend
@@ -591,7 +598,7 @@ If you want to use the same flag in the client code, also add it to the FeatureF
```typescript
export enum FeatureFlag {
SCOPED_FILTER = "SCOPED_FILTER",
SCOPED_FILTER = 'SCOPED_FILTER',
}
```
@@ -884,9 +891,9 @@ VSCode will not stop on breakpoints right away. We've attached to PID 6 however
To debug Flask running in POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the SYS_TRACE capability.These settings should not be used in production environments.
```yaml
securityContext:
capabilities:
add: ["SYS_PTRACE"]
securityContext:
capabilities:
add: ['SYS_PTRACE']
```
See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details.

4
docs/user_docs_versioned_docs/version-6.0.0/contributing/guidelines.mdx
View File

@@ -107,8 +107,8 @@ Triaging goals
First, add **Category labels (a.k.a. hash labels)**. Every issue/PR must have one hash label (except spam entry). Labels that begin with `#` defines issue/PR type:
| Label | for Issue | for PR |
| --------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Label | for Issue | for PR |
| --------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `#bug` | Bug report | Bug fix |
| `#code-quality` | Describe problem with code, architecture or productivity | Refactor, tests, tooling |
| `#feature` | New feature request | New feature implementation |

48
docs/user_docs_versioned_docs/version-6.0.0/contributing/howtos.mdx
View File

@@ -4,6 +4,7 @@ hide_title: true
sidebar_position: 4
version: 1
---
# Development How-tos
## Contributing to Documentation
@@ -230,10 +231,11 @@ For E2E testing, we recommend that you use a `docker compose` backend
```bash
CYPRESS_CONFIG=true docker compose up --build
```
`docker compose` will get to work and expose a Cypress-ready Superset app.
This app uses a different database schema (`superset_cypress`) to keep it isolated from
your other dev environment(s), a specific set of examples, and a set of configurations that
aligns with the expectations within the end-to-end tests. Also note that it's served on a
aligns with the expectations within the end-to-end tests. Also note that it's served on a
different port than the default port for the backend (`8088`).
Now in another terminal, let's get ready to execute some Cypress commands. First, tell cypress
@@ -374,24 +376,24 @@ You are now ready to attach a debugger to the process. Using VSCode you can conf
```json
{
"version": "0.2.0",
"configurations": [
"version": "0.2.0",
"configurations": [
{
"name": "Attach to Superset App in Docker Container",
"type": "python",
"request": "attach",
"connect": {
"host": "127.0.0.1",
"port": 5678
},
"pathMappings": [
{
"name": "Attach to Superset App in Docker Container",
"type": "python",
"request": "attach",
"connect": {
"host": "127.0.0.1",
"port": 5678
},
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "/app"
}
]
},
]
"localRoot": "${workspaceFolder}",
"remoteRoot": "/app"
}
]
}
]
}
```
@@ -402,9 +404,9 @@ VSCode will not stop on breakpoints right away. We've attached to PID 6 however
To debug Flask running in POD inside a kubernetes cluster, you'll need to make sure the pod runs as root and is granted the `SYS_TRACE` capability. These settings should not be used in production environments.
```yaml
securityContext:
capabilities:
add: ["SYS_PTRACE"]
securityContext:
capabilities:
add: ['SYS_PTRACE']
```
See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details.
@@ -459,7 +461,7 @@ In TypeScript/JavaScript, the technique is similar:
we import `t` (simple translation), `tn` (translation containing a number).
```javascript
import { t, tn } from "@superset-ui/translation";
import { t, tn } from '@superset-ui/translation';
```
### Enabling language selection
@@ -612,7 +614,7 @@ If using the eslint extension with vscode, put the following in your workspace `
## GitHub Ephemeral Environments
On any given pull request on GitHub, it's possible to create a temporary environment/deployment
by simply adding the label `testenv-up` to the PR. Once you add the `testenv-up` label, a
by simply adding the label `testenv-up` to the PR. Once you add the `testenv-up` label, a
GitHub Action will be triggered that will:
- build a docker image

106
docs/user_docs_versioned_docs/version-6.0.0/contributing/resources.mdx
View File

@@ -9,23 +9,24 @@ import Mermaid from '@theme/Mermaid';
# Resources
## High Level Architecture
<div style={{ maxWidth: "600px", margin: "0 auto", marginLeft: 0, marginRight: "auto" }}>
```mermaid
flowchart TD
%% Top Level
LB["<b>Load Balancer(s)</b><br/>(optional)"]
LB -.-> WebServers
%% Top Level
LB["<b>Load Balancer(s)</b><br/>(optional)"]
LB -.-> WebServers
%% Web Servers
subgraph WebServers ["<b>Web Server(s)</b>"]
WS1["<b>Frontend</b><br/>(React, AntD, ECharts, AGGrid)"]
WS2["<b>Backend</b><br/>(Python, Flask, SQLAlchemy, Pandas, ...)"]
end
%% Web Servers
subgraph WebServers ["<b>Web Server(s)</b>"]
WS1["<b>Frontend</b><br/>(React, AntD, ECharts, AGGrid)"]
WS2["<b>Backend</b><br/>(Python, Flask, SQLAlchemy, Pandas, ...)"]
end
%% Infra
subgraph InfraServices ["<b>Infra</b>"]
DB[("<b>Metadata Database</b><br/>(Postgres / MySQL)")]
%% Infra
subgraph InfraServices ["<b>Infra</b>"]
DB[("<b>Metadata Database</b><br/>(Postgres / MySQL)")]
subgraph Caching ["<b>Caching Subservices<br/></b>(Redis, memcache, S3, ...)"]
direction LR
@@ -34,62 +35,62 @@ flowchart TD
CsvCache["<b>CSV Exports Cache</b>"]
ThumbnailCache["<b>Thumbnails Cache</b>"]
AlertImageCache["<b>Alert/Report Images Cache</b>"]
QueryCache -- " " --> CsvCache
linkStyle 1 stroke:transparent;
QueryCache -- " " --> CsvCache
linkStyle 1 stroke:transparent;
ThumbnailCache -- " " --> AlertImageCache
linkStyle 2 stroke:transparent;
linkStyle 2 stroke:transparent;
end
Broker(("<b>Message Queue</b><br/>(Redis / RabbitMQ / SQS)"))
end
AsyncBackend["<b>Async Workers (Celery)</b><br>required for Alerts & Reports, thumbnails, CSV exports, long-running workloads, ..."]
end
%% External DBs
subgraph ExternalDatabases ["<b>Analytics Databases</b>"]
direction LR
BigQuery[(BigQuery)]
Snowflake[(Snowflake)]
Redshift[(Redshift)]
Postgres[(Postgres)]
Postgres[(... any ...)]
end
AsyncBackend["<b>Async Workers (Celery)</b><br>required for Alerts & Reports, thumbnails, CSV exports, long-running workloads, ..."]
%% Connections
LB -.-> WebServers
WebServers --> DB
WebServers -.-> Caching
WebServers -.-> Broker
WebServers -.-> ExternalDatabases
%% External DBs
subgraph ExternalDatabases ["<b>Analytics Databases</b>"]
direction LR
BigQuery[(BigQuery)]
Snowflake[(Snowflake)]
Redshift[(Redshift)]
Postgres[(Postgres)]
Postgres[(... any ...)]
end
Broker -.-> AsyncBackend
%% Connections
LB -.-> WebServers
WebServers --> DB
WebServers -.-> Caching
WebServers -.-> Broker
WebServers -.-> ExternalDatabases
AsyncBackend -.-> ExternalDatabases
AsyncBackend -.-> Caching
Broker -.-> AsyncBackend
AsyncBackend -.-> ExternalDatabases
AsyncBackend -.-> Caching
%% Legend styling
classDef requiredNode stroke-width:2px,stroke:black;
class Required requiredNode;
class Optional optionalNode;
%% Legend styling
classDef requiredNode stroke-width:2px,stroke:black;
class Required requiredNode;
class Optional optionalNode;
%% Hide real arrow
linkStyle 0 stroke:transparent;
%% Hide real arrow
linkStyle 0 stroke:transparent;
%% Styling
classDef optionalNode stroke-dasharray: 5 5, opacity:0.9;
class LB optionalNode;
class Caching optionalNode;
class AsyncBackend optionalNode;
class Broker optionalNode;
class QueryCache optionalNode;
class CsvCache optionalNode;
class ThumbnailCache optionalNode;
class AlertImageCache optionalNode;
class Celery optionalNode;
%% Styling
classDef optionalNode stroke-dasharray: 5 5, opacity:0.9;
class LB optionalNode;
class Caching optionalNode;
class AsyncBackend optionalNode;
class Broker optionalNode;
class QueryCache optionalNode;
class CsvCache optionalNode;
class ThumbnailCache optionalNode;
class AlertImageCache optionalNode;
class Celery optionalNode;
classDef invisible fill:transparent,stroke:transparent;
classDef invisible fill:transparent,stroke:transparent;
```
</div>
@@ -102,3 +103,4 @@ Here is our interactive ERD:
<br />
[Download the .svg](https://github.com/apache/superset/tree/master/docs/static/img/erd.svg)
```

34
docs/user_docs_versioned_docs/version-6.0.0/faq.mdx
View File

@@ -7,7 +7,7 @@ sidebar_position: 9
## How big of a dataset can Superset handle?
Superset can work with even gigantic databases! Superset acts as a thin layer above your underlying
databases or data engines, which do all the processing. Superset simply visualizes the results of
databases or data engines, which do all the processing. Superset simply visualizes the results of
the query.
The key to achieving acceptable performance in Superset is whether your database can execute queries
@@ -17,7 +17,7 @@ Superset, benchmark and tune your data warehouse.
## What are the computing specifications required to run Superset?
The specs of your Superset installation depend on how many users you have and what their activity is, not
on the size of your data. Superset admins in the community have reported 8GB RAM, 2vCPUs as adequate to
on the size of your data. Superset admins in the community have reported 8GB RAM, 2vCPUs as adequate to
run a moderately-sized instance. To develop Superset, e.g., compile code or build images, you may
need more power.
@@ -101,10 +101,10 @@ Metadata field:
```json
{
"filter_immune_slices": [],
"expanded_slices": {},
"filter_immune_slice_fields": {},
"timed_refresh_immune_slices": [324]
"filter_immune_slices": [],
"expanded_slices": {},
"filter_immune_slice_fields": {},
"timed_refresh_immune_slices": [324]
}
```
@@ -117,8 +117,8 @@ value in milliseconds in the JSON Metadata field:
```json
{
"stagger_refresh": false,
"stagger_time": 2500
"stagger_refresh": false,
"stagger_time": 2500
}
```
@@ -161,8 +161,8 @@ information like your list of users and dashboard definitions. While Superset su
only a few database engines are supported for use as the OLTP backend / metadata store.
Superset is tested using MySQL, PostgreSQL, and SQLite backends. It’s recommended you install
Superset on one of these database servers for production. Installation on other OLTP databases
may work but isn’t tested. It has been reported that [Microsoft SQL Server does _not_
Superset on one of these database servers for production. Installation on other OLTP databases
may work but isn’t tested. It has been reported that [Microsoft SQL Server does _not_
work as a Superset backend](https://github.com/apache/superset/issues/18961). Column-store,
non-OLTP databases are not designed for this type of workload.
@@ -180,11 +180,11 @@ second etc). Example:
```json
{
"label_colors": {
"foo": "#FF69B4",
"bar": "lightblue",
"baz": 0
}
"label_colors": {
"foo": "#FF69B4",
"bar": "lightblue",
"baz": 0
}
}
```
@@ -250,8 +250,8 @@ guarantees and are not recommended but may fit your use case temporarily:
## How can I see usage statistics (e.g., monthly active users)?
This functionality is not included with Superset, but you can extract and analyze Superset's application
metadata to see what actions have occurred. By default, user activities are logged in the `logs` table
in Superset's metadata database. One company has published a write-up of [how they analyzed Superset
metadata to see what actions have occurred. By default, user activities are logged in the `logs` table
in Superset's metadata database. One company has published a write-up of [how they analyzed Superset
usage, including example queries](https://engineering.hometogo.com/monitor-superset-usage-via-superset-c7f9fba79525).
## What Does Hours Offset in the Edit Dataset view do?

2
docs/user_docs_versioned_docs/version-6.0.0/installation/architecture.mdx
View File

@@ -5,7 +5,7 @@ sidebar_position: 1
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
# Architecture

3
docs/user_docs_versioned_docs/version-6.0.0/installation/docker-builds.mdx
View File

@@ -11,8 +11,7 @@ The Apache Superset community extensively uses Docker for development, release,
and productionizing Superset. This page details our Docker builds and tag naming
schemes to help users navigate our offerings.
Images are built and pushed to the [Superset Docker Hub repository](
https://hub.docker.com/r/apache/superset) using GitHub Actions.
Images are built and pushed to the [Superset Docker Hub repository](https://hub.docker.com/r/apache/superset) using GitHub Actions.
Different sets of images are built and/or published at different times:
- **Published releases** (`release`): published using

76
docs/user_docs_versioned_docs/version-6.0.0/installation/docker-compose.mdx
View File

@@ -5,12 +5,13 @@ sidebar_position: 5
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
# Using Docker Compose
<img src={useBaseUrl("/img/docker-compose.webp" )} width="150" />
<br /><br />
<img src={useBaseUrl('/img/docker-compose.webp')} width="150" />
<br />
<br />
:::caution
Since `docker compose` is primarily designed to run a set of containers on **a single host**
@@ -29,23 +30,23 @@ way to launch a fully functioning **development environment** quickly.
Note that there are 4 major ways we support to run `docker compose`:
1. **docker-compose.yml:** for interactive development, where we mount your local folder with the
frontend/backend files that you can edit and experience the changes you
make in the app in real time
frontend/backend files that you can edit and experience the changes you
make in the app in real time
1. **docker-compose-light.yml:** a lightweight configuration with minimal services (database,
Superset app, and frontend dev server) for development. Uses in-memory caching instead of Redis
and is designed for running multiple instances simultaneously
Superset app, and frontend dev server) for development. Uses in-memory caching instead of Redis
and is designed for running multiple instances simultaneously
1. **docker-compose-non-dev.yml** where we just build a more immutable image based on the
local branch and get all the required images running. Changes in the local branch
at the time you fire this up will be reflected, but changes to the code
while `up` won't be reflected in the app
local branch and get all the required images running. Changes in the local branch
at the time you fire this up will be reflected, but changes to the code
while `up` won't be reflected in the app
1. **docker-compose-image-tag.yml** where we fetch an image from docker-hub say for the
`5.0.0` release for instance, and fire it up so you can try it. Here what's in
the local branch has no effects on what's running, we just fetch and run
pre-built images from docker-hub. For `docker compose` to work along with the
Postgres image it boots up, you'll want to point to a `-dev`-suffixed TAG, as in
`export TAG=5.0.0-dev` or `export TAG=4.1.2-dev`, with `latest-dev` being the default.
The `dev` builds include the `psycopg2-binary` required to connect
to the Postgres database launched as part of the `docker compose` builds.
`5.0.0` release for instance, and fire it up so you can try it. Here what's in
the local branch has no effects on what's running, we just fetch and run
pre-built images from docker-hub. For `docker compose` to work along with the
Postgres image it boots up, you'll want to point to a `-dev`-suffixed TAG, as in
`export TAG=5.0.0-dev` or `export TAG=4.1.2-dev`, with `latest-dev` being the default.
The `dev` builds include the `psycopg2-binary` required to connect
to the Postgres database launched as part of the `docker compose` builds.
More on these approaches after setting up the requirements for either.
@@ -92,7 +93,7 @@ like to try out Superset without making any code changes follow the steps docume
:::tip
By default, we mount the local superset-frontend folder here and run `npm install` as well
as `npm run dev` which triggers webpack to compile/bundle the frontend code. Depending
on your local setup, especially if you have less than 16GB of memory, it may be very slow to
on your local setup, especially if you have less than 16GB of memory, it may be very slow to
perform those operations. In this case, we recommend you set the env var
`BUILD_SUPERSET_FRONTEND_IN_DOCKER` to `false`, and to run this locally instead in a terminal.
Simply trigger `npm i && npm run dev`, this should be MUCH faster.
@@ -121,6 +122,7 @@ NODE_PORT=9003 docker compose -p superset-3 -f docker-compose-light.yml up
```
This configuration includes:
- PostgreSQL database (internal network only)
- Superset application server
- Frontend development server with webpack hot reloading
@@ -165,7 +167,7 @@ looking to fire up.
:::caution
All of the content belonging to a Superset instance - charts, dashboards, users, etc. - is stored in
its metadata database. In production, this database should be backed up. The default installation
its metadata database. In production, this database should be backed up. The default installation
with docker compose will store that data in a PostgreSQL database contained in a Docker
[volume](https://docs.docker.com/storage/volumes/), which is not backed up.
@@ -174,7 +176,7 @@ Again, **THE DOCKER-COMPOSE INSTALLATION IS NOT PRODUCTION-READY OUT OF THE BOX.
:::
You should see a stream of logging output from the containers being launched on your machine. Once
this output slows, you should have a running instance of Superset on your local machine! To avoid
this output slows, you should have a running instance of Superset on your local machine! To avoid
the wall of text on future runs, add the `-d` option to the end of the `docker compose up` command.
### Configuring Further
@@ -258,24 +260,24 @@ Superset (which is running in its docker container). Other databases may have sl
configurations but gist would be same and boils down to 2 steps -
1. **(Mac users may skip this step)** Configuring the local postgresql/database instance to accept
public incoming connections. By default, postgresql only allows incoming connections from
`localhost` and under Docker, unless you use `--network=host`, `localhost` will refer to different
endpoints on the host machine and in a docker container respectively. Allowing postgresql to accept
connections from the Docker involves making one-line changes to the files `postgresql.conf` and
`pg_hba.conf`; you can find helpful links tailored to your OS / PG version on the web easily for
this task. For Docker it suffices to only whitelist IPs `172.0.0.0/8` instead of `*`, but in any
case you are _warned_ that doing this in a production database _may_ have disastrous consequences as
you are opening your database to the public internet.
public incoming connections. By default, postgresql only allows incoming connections from
`localhost` and under Docker, unless you use `--network=host`, `localhost` will refer to different
endpoints on the host machine and in a docker container respectively. Allowing postgresql to accept
connections from the Docker involves making one-line changes to the files `postgresql.conf` and
`pg_hba.conf`; you can find helpful links tailored to your OS / PG version on the web easily for
this task. For Docker it suffices to only whitelist IPs `172.0.0.0/8` instead of `*`, but in any
case you are _warned_ that doing this in a production database _may_ have disastrous consequences as
you are opening your database to the public internet.
1. Instead of `localhost`, try using `host.docker.internal` (Mac users, Ubuntu) or `172.18.0.1`
(Linux users) as the hostname when attempting to connect to the database. This is a Docker internal
detail -- what is happening is that, in Mac systems, Docker Desktop creates a dns entry for the
hostname `host.docker.internal` which resolves to the correct address for the host machine, whereas
in Linux this is not the case (at least by default). If neither of these 2 hostnames work then you
may want to find the exact hostname you want to use, for that you can do `ifconfig` or
`ip addr show` and look at the IP address of `docker0` interface that must have been created by
Docker for you. Alternately if you don't even see the `docker0` interface try (if needed with sudo)
`docker network inspect bridge` and see if there is an entry for `"Gateway"` and note the IP
address.
(Linux users) as the hostname when attempting to connect to the database. This is a Docker internal
detail -- what is happening is that, in Mac systems, Docker Desktop creates a dns entry for the
hostname `host.docker.internal` which resolves to the correct address for the host machine, whereas
in Linux this is not the case (at least by default). If neither of these 2 hostnames work then you
may want to find the exact hostname you want to use, for that you can do `ifconfig` or
`ip addr show` and look at the IP address of `docker0` interface that must have been created by
Docker for you. Alternately if you don't even see the `docker0` interface try (if needed with sudo)
`docker network inspect bridge` and see if there is an entry for `"Gateway"` and note the IP
address.
## 4. To build or not to build

2
docs/user_docs_versioned_docs/version-6.0.0/installation/installation-methods.mdx
View File

@@ -5,7 +5,7 @@ sidebar_position: 2
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
# Installation Methods

15
docs/user_docs_versioned_docs/version-6.0.0/installation/kubernetes.mdx
View File

@@ -1,16 +1,17 @@
---
title: Kubernetes
title: Kubernetes
hide_title: true
sidebar_position: 3
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
# Installing on Kubernetes
<img src={useBaseUrl("/img/k8s.png" )} width="150" />
<br /><br />
<img src={useBaseUrl('/img/k8s.png')} width="150" />
<br />
<br />
Running Superset on Kubernetes is supported with the provided [Helm](https://helm.sh/) chart
found in the official [Superset helm repository](https://apache.github.io/superset/index.yaml).
@@ -134,7 +135,7 @@ init:
```
:::note
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.
To opt-out of this data collection in your Helm-based installation, edit the `repository:` line in your `helm/superset/values.yaml` file, replacing `apachesuperset.docker.scarf.sh/apache/superset` with `apache/superset` to pull the image directly from Docker Hub.
:::
@@ -195,7 +196,7 @@ Those can be passed as key/values either with `extraEnv` or `extraSecretEnv` if
extraEnv:
SMTP_HOST: smtp.gmail.com
SMTP_USER: user@gmail.com
SMTP_PORT: "587"
SMTP_PORT: '587'
SMTP_MAIL_FROM: user@gmail.com
extraSecretEnv:
@@ -356,7 +357,7 @@ supersetCeleryBeat:
extraEnv:
SMTP_HOST: smtp.gmail.com
SMTP_USER: user@gmail.com
SMTP_PORT: "587"
SMTP_PORT: '587'
SMTP_MAIL_FROM: user@gmail.com
extraSecretEnv:

9
docs/user_docs_versioned_docs/version-6.0.0/installation/pypi.mdx
View File

@@ -5,12 +5,13 @@ sidebar_position: 4
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
# Installing Superset from PyPI
<img src={useBaseUrl("/img/pypi.png" )} width="150" />
<br /><br />
<img src={useBaseUrl('/img/pypi.png')} width="150" />
<br />
<br />
This page describes how to install Superset using the `apache_superset` package [published on PyPI](https://pypi.org/project/apache_superset/).
@@ -23,6 +24,7 @@ level dependencies.
**Debian and Ubuntu**
Ubuntu **24.04** uses python 3.12 per default, which currently is not supported by Superset. You need to add a second python installation of 3.11 and install the required additional dependencies.
```bash
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
@@ -133,6 +135,7 @@ pip install apache_superset
```
Then, define mandatory configurations, SECRET_KEY and FLASK_APP:
```bash
export SUPERSET_SECRET_KEY=YOUR-SECRET-KEY # For production use, make sure this is a strong key, for example generated using `openssl rand -base64 42`. See https://superset.apache.org/docs/configuration/configuring-superset#specifying-a-secret_key
export FLASK_APP=superset

1
docs/user_docs_versioned_docs/version-6.0.0/intro.md
View File

@@ -2,6 +2,7 @@
hide_title: true
sidebar_position: 1
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file

113
docs/user_docs_versioned_docs/version-6.0.0/security/cves.mdx
View File

@@ -2,31 +2,32 @@
title: CVEs fixed by release
sidebar_position: 2
---
#### Version 5.0.0
| CVE | Title | Affected |
|:---------------|:-----------------------------------------------------------------------------------|---------:|
| CVE-2025-55673 | Exposure of Sensitive Information to an Unauthorized Actor | < 5.0.0 |
| CVE-2025-55674 | Improper Neutralization of Special Elements used in an SQL Command | < 5.0.0 |
| CVE-2025-55675 | Improper Access Control leading to Information Disclosure | < 5.0.0 |
| CVE | Title | Affected |
| :------------- | :----------------------------------------------------------------- | -------: |
| CVE-2025-55673 | Exposure of Sensitive Information to an Unauthorized Actor | < 5.0.0 |
| CVE-2025-55674 | Improper Neutralization of Special Elements used in an SQL Command | < 5.0.0 |
| CVE-2025-55675 | Improper Access Control leading to Information Disclosure | < 5.0.0 |
#### Version 4.1.3
| CVE | Title | Affected |
|:---------------|:-----------------------------------------------------------------------------------|---------:|
| CVE-2025-55672 | Improper Neutralization of Input During Web Page Generation | < 4.1.3 |
| CVE | Title | Affected |
| :------------- | :---------------------------------------------------------- | -------: |
| CVE-2025-55672 | Improper Neutralization of Input During Web Page Generation | < 4.1.3 |
#### Version 4.1.2
| CVE | Title | Affected |
|:---------------|:-----------------------------------------------------------------------------------|---------:|
| CVE-2025-27696 | Improper authorization leading to resource ownership takeover | < 4.1.2 |
| CVE-2025-48912 | Improper authorization bypass on row level security via SQL Injection | < 4.1.2 |
| CVE | Title | Affected |
| :------------- | :-------------------------------------------------------------------- | -------: |
| CVE-2025-27696 | Improper authorization leading to resource ownership takeover | < 4.1.2 |
| CVE-2025-48912 | Improper authorization bypass on row level security via SQL Injection | < 4.1.2 |
#### Version 4.1.0
| CVE | Title | Affected |
|:---------------|:-----------------------------------------------------------------------------------|---------:|
| :------------- | :--------------------------------------------------------------------------------- | -------: |
| CVE-2024-53947 | Improper SQL authorisation, parse for specific postgres functions | < 4.1.0 |
| CVE-2024-53948 | Error verbosity exposes metadata in analytics databases | < 4.1.0 |
| CVE-2024-53949 | Lower privilege users are able to create Role when FAB_ADD_SECURITY_API is enabled | < 4.1.0 |
@@ -34,84 +35,84 @@ sidebar_position: 2
#### Version 4.0.2
| CVE | Title | Affected |
|:---------------|:----------------------------|---------:|
| CVE-2024-39887 | Improper SQL authorization | < 4.0.1 |
| CVE | Title | Affected |
| :------------- | :------------------------- | -------: |
| CVE-2024-39887 | Improper SQL authorization | < 4.0.1 |
#### Version 3.1.3, 4.0.1
| CVE | Title | Affected |
|:---------------|:----------------------------|----------------------------:|
| CVE-2024-34693 | Server arbitrary file read | < 3.1.3, >= 4.0.0, < 4.0.1 |
| CVE | Title | Affected |
| :------------- | :------------------------- | -------------------------: |
| CVE-2024-34693 | Server arbitrary file read | < 3.1.3, >= 4.0.0, < 4.0.1 |
#### Version 3.1.2
| CVE | Title | Affected |
|:---------------|:--------------------------------------------------------|---------:|
| CVE-2024-28148 | Incorrect datasource authorization on explore REST API | < 3.1.2 |
| CVE | Title | Affected |
| :------------- | :----------------------------------------------------- | -------: |
| CVE-2024-28148 | Incorrect datasource authorization on explore REST API | < 3.1.2 |
#### Version 3.0.4, 3.1.1
| CVE | Title | Affected |
|:---------------|:-----------------------------------------------------------------------------|----------------------------:|
| CVE-2024-27315 | Improper error handling on alerts | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-24773 | Improper validation of SQL statements allows for unauthorized access to data | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-24772 | Improper Neutralisation of custom SQL on embedded context | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-24779 | Improper data authorization when creating a new dataset | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-26016 | Improper authorization validation on dashboards and charts import | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE | Title | Affected |
| :------------- | :--------------------------------------------------------------------------- | -------------------------: |
| CVE-2024-27315 | Improper error handling on alerts | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-24773 | Improper validation of SQL statements allows for unauthorized access to data | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-24772 | Improper Neutralisation of custom SQL on embedded context | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-24779 | Improper data authorization when creating a new dataset | < 3.0.4, >= 3.1.0, < 3.1.1 |
| CVE-2024-26016 | Improper authorization validation on dashboards and charts import | < 3.0.4, >= 3.1.0, < 3.1.1 |
#### Version 3.0.3
| CVE | Title | Affected |
|:---------------|:----------------------------------------------|---------:|
| :------------- | :-------------------------------------------- | -------: |
| CVE-2023-49657 | Stored XSS in Dashboard Title and Chart Title | < 3.0.3 |
#### Version 3.0.2, 2.1.3
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------|---------------------------:|
| :------------- | :---------------------------------------------------------- | -------------------------: |
| CVE-2023-46104 | Allows for uncontrolled resource consumption via a ZIP bomb | < 2.1.3, >= 3.0.0, < 3.0.2 |
| CVE-2023-49736 | SQL Injection on where_in JINJA macro | < 2.1.3, >= 3.0.0, < 3.0.2 |
| CVE-2023-49734 | Privilege Escalation Vulnerability | < 2.1.3, >= 3.0.0, < 3.0.2 |
#### Version 3.0.0
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------------------|---------:|
| CVE-2023-42502 | Open Redirect Vulnerability | < 3.0.0 |
| CVE-2023-42505 | Sensitive information disclosure on db connection details | < 3.0.0 |
| CVE | Title | Affected |
| :------------- | :-------------------------------------------------------- | -------: |
| CVE-2023-42502 | Open Redirect Vulnerability | < 3.0.0 |
| CVE-2023-42505 | Sensitive information disclosure on db connection details | < 3.0.0 |
#### Version 2.1.3
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------------------|---------:|
| CVE-2023-42504 | Lack of rate limiting allows for possible denial of service | < 2.1.3 |
| CVE | Title | Affected |
| :------------- | :---------------------------------------------------------- | -------: |
| CVE-2023-42504 | Lack of rate limiting allows for possible denial of service | < 2.1.3 |
#### Version 2.1.2
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------------------|---------:|
| CVE-2023-40610 | Privilege escalation with default examples database | < 2.1.2 |
| CVE-2023-42501 | Unnecessary read permissions within the Gamma role | < 2.1.2 |
| CVE-2023-43701 | Stored XSS on API endpoint | < 2.1.2 |
| CVE | Title | Affected |
| :------------- | :-------------------------------------------------- | -------: |
| CVE-2023-40610 | Privilege escalation with default examples database | < 2.1.2 |
| CVE-2023-42501 | Unnecessary read permissions within the Gamma role | < 2.1.2 |
| CVE-2023-43701 | Stored XSS on API endpoint | < 2.1.2 |
#### Version 2.1.1
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------------------|---------:|
| CVE-2023-36387 | Improper API permission for low privilege users | < 2.1.1 |
| CVE-2023-36388 | Improper API permission for low privilege users allows for SSRF | < 2.1.1 |
| CVE-2023-27523 | Improper data permission validation on Jinja templated queries | < 2.1.1 |
| CVE-2023-27526 | Improper Authorization check on import charts | < 2.1.1 |
| CVE-2023-39264 | Stack traces enabled by default | < 2.1.1 |
| CVE-2023-39265 | Possible Unauthorized Registration of SQLite Database Connections | < 2.1.1 |
| CVE-2023-37941 | Metadata db write access can lead to remote code execution | < 2.1.1 |
| CVE-2023-32672 | SQL parser edge case bypasses data access authorization | < 2.1.1 |
| CVE | Title | Affected |
| :------------- | :---------------------------------------------------------------- | -------: |
| CVE-2023-36387 | Improper API permission for low privilege users | < 2.1.1 |
| CVE-2023-36388 | Improper API permission for low privilege users allows for SSRF | < 2.1.1 |
| CVE-2023-27523 | Improper data permission validation on Jinja templated queries | < 2.1.1 |
| CVE-2023-27526 | Improper Authorization check on import charts | < 2.1.1 |
| CVE-2023-39264 | Stack traces enabled by default | < 2.1.1 |
| CVE-2023-39265 | Possible Unauthorized Registration of SQLite Database Connections | < 2.1.1 |
| CVE-2023-37941 | Metadata db write access can lead to remote code execution | < 2.1.1 |
| CVE-2023-32672 | SQL parser edge case bypasses data access authorization | < 2.1.1 |
#### Version 2.1.0
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------------------|---------:|
| :------------- | :---------------------------------------------------------------------- | -------: |
| CVE-2023-25504 | Possible SSRF on import datasets | < 2.1.0 |
| CVE-2023-27524 | Session validation vulnerability when using provided default SECRET_KEY | < 2.1.0 |
| CVE-2023-27525 | Incorrect default permissions for Gamma role | < 2.1.0 |
@@ -119,8 +120,8 @@ sidebar_position: 2
#### Version 2.0.1
| CVE | Title | Affected |
|:---------------|:------------------------------------------------------------|------------------: |
| CVE | Title | Affected |
| :------------- | :---------------------------------------------------------- | -----------------: |
| CVE-2022-41703 | SQL injection vulnerability in adhoc clauses | < 2.0.1 or < 1.5.2 |
| CVE-2022-43717 | Cross-Site Scripting on dashboards | < 2.0.1 or < 1.5.2 |
| CVE-2022-43718 | Cross-Site Scripting vulnerability on upload forms | < 2.0.1 or < 1.5.2 |

29
docs/user_docs_versioned_docs/version-6.0.0/security/security.mdx
View File

@@ -77,10 +77,11 @@ However, it is crucial to understand the following:
**Database Security is Paramount**: The ultimate responsibility for securing database access, controlling permissions, and preventing unauthorized function execution lies with the database administrators (DBAs) and security teams managing the underlying database instance.
**Recommended Database Practices**: We strongly recommend implementing security best practices at the database level, including:
* **Least Privilege**: Connecting Superset using dedicated database user accounts with the minimum permissions required for Superset's operation (typically read-only access to necessary schemas/tables).
* **Database Roles & Permissions**: Utilizing database-native roles and permissions to restrict access to sensitive functions, system variables (like `@@hostname`), schemas, or tables.
* **Network Security**: Employing network-level controls like database firewalls or proxies to restrict connections.
* **Auditing**: Enabling database-level auditing to monitor executed queries and access patterns.
- **Least Privilege**: Connecting Superset using dedicated database user accounts with the minimum permissions required for Superset's operation (typically read-only access to necessary schemas/tables).
- **Database Roles & Permissions**: Utilizing database-native roles and permissions to restrict access to sensitive functions, system variables (like `@@hostname`), schemas, or tables.
- **Network Security**: Employing network-level controls like database firewalls or proxies to restrict connections.
- **Auditing**: Enabling database-level auditing to monitor executed queries and access patterns.
By combining Superset's configurable safeguards with strong database-level security practices, you can achieve a more robust and layered security posture.
@@ -199,13 +200,13 @@ This reduces the risk for replay attacks and session hijacking.
Superset uses [Flask-Session](https://flask-session.readthedocs.io/en/latest/) to manage server side sessions.
To enable this extension you have to set:
``` python
```python
SESSION_SERVER_SIDE = True
```
Flask-Session offers multiple backend session interfaces for Flask, here's an example for Redis:
``` python
```python
from redis import Redis
SESSION_TYPE = "redis"
@@ -234,8 +235,8 @@ It's extremely important to correctly configure a Content Security Policy when d
prevent many types of attacks. Superset provides two variables in `config.py` for deploying a CSP:
- `TALISMAN_ENABLED` defaults to `True`; set this to `False` in order to disable CSP
- `TALISMAN_CONFIG` holds the actual the policy definition (*see example below*) as well as any
other arguments to be passed to Talisman.
- `TALISMAN_CONFIG` holds the actual the policy definition (_see example below_) as well as any
other arguments to be passed to Talisman.
When running in production mode, Superset will check at startup for the presence
of a CSP. If one is not found, it will issue a warning with the security risks. For environments
@@ -251,12 +252,12 @@ this warning using the `CONTENT_SECURITY_POLICY_WARNING` key in `config.py`.
```
- Only scripts marked with a [nonce](https://content-security-policy.com/nonce/) can be loaded and executed.
Nonce is a random string automatically generated by Talisman on each page load.
You can get current nonce value by calling jinja macro `csp_nonce()`.
Nonce is a random string automatically generated by Talisman on each page load.
You can get current nonce value by calling jinja macro `csp_nonce()`.
```html
<script nonce="{{ csp_nonce() }}">
/* my script */
/* my script */
</script>
```
@@ -274,7 +275,7 @@ You can get current nonce value by calling jinja macro `csp_nonce()`.
```
- Cartodiagram charts request map data (image and json) from external resources that can be edited by users,
and therefore either require a list of allowed domains to request from or a wildcard (`'*'`) for `img-src` and `connect-src`.
and therefore either require a list of allowed domains to request from or a wildcard (`'*'`) for `img-src` and `connect-src`.
- Other CSP directives default to `'self'` to limit content to the same origin as the Superset server.
@@ -285,12 +286,12 @@ In order to adjust provided CSP configuration to your needs, follow the instruct
Setting `TALISMAN_ENABLED = True` will invoke Talisman's protection with its default arguments,
of which `content_security_policy` is only one. Those can be found in the
[Talisman documentation](https://pypi.org/project/flask-talisman/) under *Options*.
[Talisman documentation](https://pypi.org/project/flask-talisman/) under _Options_.
These generally improve security, but administrators should be aware of their existence.
In particular, the option of `force_https = True` (`False` by default) may break Superset's Alerts & Reports
if workers are configured to access charts via a `WEBDRIVER_BASEURL` beginning
with `http://`. As long as a Superset deployment enforces https upstream, e.g.,
with `http://`. As long as a Superset deployment enforces https upstream, e.g.,
through a load balancer or application gateway, it should be acceptable to keep this
option disabled. Otherwise, you may want to enable `force_https` like this:

100
docs/user_docs_versioned_docs/version-6.0.0/using-superset/creating-your-first-dashboard.mdx
View File

@@ -5,13 +5,13 @@ sidebar_position: 1
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
## Creating Your First Dashboard
This section is focused on documentation for end-users who will be using Superset
for the data analysis and exploration workflow
(data analysts, business analysts, data
(data analysts, business analysts, data
scientists, etc).
:::tip
@@ -37,22 +37,44 @@ pre-configured in Superset for you.
Under the **+** menu in the top right, select Data, and then the _Connect Database_ option:
<img src={useBaseUrl("/img/tutorial/tutorial_01_add_database_connection.png")} width="600" />{" "} <br/><br/>
<img
src={useBaseUrl('/img/tutorial/tutorial_01_add_database_connection.png')}
width="600"
/>
<br />
<br />
Then select your database type in the resulting modal:
<img src={useBaseUrl("/img/tutorial/tutorial_02_select_database.png" )} width="600" />{" "} <br/><br/>
<img
src={useBaseUrl('/img/tutorial/tutorial_02_select_database.png')}
width="600"
/>
<br />
<br />
Once you've selected a database, you can configure a number of advanced options in this window,
or for the purposes of this walkthrough, you can click the link below all these fields:
<img src={useBaseUrl("/img/tutorial/tutorial_03a_database_connection_string_link.png" )} width="600" />{" "} <br/><br/>
<img
src={useBaseUrl(
'/img/tutorial/tutorial_03a_database_connection_string_link.png',
)}
width="600"
/>
<br />
<br />
Please note, if you are trying to connect to another locally running database (whether on host or another container), and you get the message `The port is closed.`, then you need to adjust the HOST to `host.docker.internal`
Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI):
<img src={useBaseUrl("/img/tutorial/tutorial_03b_connection_string_details.png" )} width="600" />{" "} <br/><br/>
<img
src={useBaseUrl('/img/tutorial/tutorial_03b_connection_string_details.png')}
width="600"
/>
<br />
<br />
As noted in the text below the form, you should refer to the SQLAlchemy documentation on
[creating new connection URIs](https://docs.sqlalchemy.org/en/12/core/engines.html#database-urls)
@@ -70,28 +92,28 @@ that you want exposed in Superset for querying.
Navigate to **Data ‣ Datasets** and select the **+ Dataset** button in the top right corner.
<img src={useBaseUrl("/img/tutorial/tutorial_08_sources_tables.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_08_sources_tables.png')} />
A modal window should pop up in front of you. Select your **Database**,
**Schema**, and **Table** using the drop downs that appear. In the following example,
we register the **cleaned_sales_data** table from the **examples** database.
<img src={useBaseUrl("/img/tutorial/tutorial_09_add_new_table.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_09_add_new_table.png')} />
To finish, click the **Add** button in the bottom right corner. You should now see your dataset in the list of datasets.
### Customizing column properties
Now that you've registered your dataset, you can configure column properties
for how the column should be treated in the Explore workflow:
for how the column should be treated in the Explore workflow:
- Is the column temporal? (should it be used for slicing & dicing in time series charts?)
- Should the column be filterable?
- Is the column dimensional?
- If it's a datetime column, how should Superset parse
the datetime format? (using the [ISO-8601 string pattern](https://en.wikipedia.org/wiki/ISO_8601))
the datetime format? (using the [ISO-8601 string pattern](https://en.wikipedia.org/wiki/ISO_8601))
<img src={useBaseUrl("/img/tutorial/tutorial_column_properties.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_column_properties.png')} />
### Superset semantic layer
@@ -99,53 +121,55 @@ Superset has a thin semantic layer that adds many quality of life improvements f
The Superset semantic layer can store 2 types of computed data:
1. Virtual metrics: you can write SQL queries that aggregate values
from multiple column (e.g. `SUM(recovered) / SUM(confirmed)`) and make them
available as columns for (e.g. `recovery_rate`) visualization in Explore.
Aggregate functions are allowed and encouraged for metrics.
from multiple column (e.g. `SUM(recovered) / SUM(confirmed)`) and make them
available as columns for (e.g. `recovery_rate`) visualization in Explore.
Aggregate functions are allowed and encouraged for metrics.
<img src={useBaseUrl("/img/tutorial/tutorial_sql_metric.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_sql_metric.png')} />
You can also certify metrics if you'd like for your team in this view.
1. Virtual calculated columns: you can write SQL queries that
customize the appearance and behavior
of a specific column (e.g. `CAST(recovery_rate as float)`).
Aggregate functions aren't allowed in calculated columns.
customize the appearance and behavior
of a specific column (e.g. `CAST(recovery_rate as float)`).
Aggregate functions aren't allowed in calculated columns.
<img src={useBaseUrl("/img/tutorial/tutorial_calculated_column.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_calculated_column.png')} />
### Creating charts in Explore view
Superset has 2 main interfaces for exploring data:
- **Explore**: no-code viz builder. Select your dataset, select the chart,
customize the appearance, and publish.
customize the appearance, and publish.
- **SQL Lab**: SQL IDE for cleaning, joining, and preparing data for Explore workflow
We'll focus on the Explore view for creating charts right now.
To start the Explore workflow from the **Datasets** tab, start by clicking the name
of the dataset that will be powering your chart.
<img src={useBaseUrl("/img/tutorial/tutorial_launch_explore.png" )} /><br/><br/>
<img src={useBaseUrl('/img/tutorial/tutorial_launch_explore.png')} />
<br />
<br />
You're now presented with a powerful workflow for exploring data and iterating on charts.
- The **Dataset** view on the left-hand side has a list of columns and metrics,
scoped to the current dataset you selected.
scoped to the current dataset you selected.
- The **Data** preview below the chart area also gives you helpful data context.
- Using the **Data** tab and **Customize** tabs, you can change the visualization type,
select the temporal column, select the metric to group by, and customize
the aesthetics of the chart.
select the temporal column, select the metric to group by, and customize
the aesthetics of the chart.
As you customize your chart using drop-down menus, make sure to click the **Run** button
to get visual feedback.
<img src={useBaseUrl("/img/tutorial/tutorial_explore_run.jpg" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_explore_run.jpg')} />
In the following screenshot, we craft a grouped Time-series Bar Chart to visualize
our quarterly sales data by product line just by clicking options in drop-down menus.
<img src={useBaseUrl("/img/tutorial/tutorial_explore_settings.jpg" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_explore_settings.jpg')} />
### Creating a slice and dashboard
@@ -156,26 +180,32 @@ To save your chart, first click the **Save** button. You can either:
In the following screenshot, we save the chart to a new "Superset Duper Sales Dashboard":
<img src={useBaseUrl("/img/tutorial/tutorial_save_slice.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_save_slice.png')} />
To publish, click **Save and goto Dashboard**.
Behind the scenes, Superset will create a slice and store all the information needed
to create your chart in its thin data layer
(the query, chart type, options selected, name, etc).
(the query, chart type, options selected, name, etc).
<img src={useBaseUrl("/img/tutorial/tutorial_first_dashboard.png" )} style={{width: "100%", maxWidth: "500px"}} />
<img
src={useBaseUrl('/img/tutorial/tutorial_first_dashboard.png')}
style={{ width: '100%', maxWidth: '500px' }}
/>
To resize the chart, start by clicking the Edit Dashboard button in the top right corner.
To resize the chart, start by clicking the Edit Dashboard button in the top right corner.
<img src={useBaseUrl("/img/tutorial/tutorial_edit_button.png" )} width="300" />
<img src={useBaseUrl('/img/tutorial/tutorial_edit_button.png')} width="300" />
Then, click and drag the bottom right corner of the chart until the chart layout snaps
into a position you like onto the underlying grid.
<img src={useBaseUrl("/img/tutorial/tutorial_chart_resize.png" )} style={{width: "100%", maxWidth: "500px"}} />
<img
src={useBaseUrl('/img/tutorial/tutorial_chart_resize.png')}
style={{ width: '100%', maxWidth: '500px' }}
/>
Click **Save** to persist the changes.
Click **Save** to persist the changes.
Congrats! You’ve successfully linked, analyzed, and visualized data in Superset. There are a wealth
of other table configuration and visualization options, so please start exploring and creating
@@ -192,14 +222,14 @@ Non-owner users access can be managed in two different ways. The dashboard needs
- Granting a role access to a dashboard will bypass dataset level checks. Having dashboard access implicitly grants read access to all the featured charts in the dashboard, and thereby also all the associated datasets.
- If no roles are specified for a dashboard, regular **Dataset permissions** will apply.
<img src={useBaseUrl("/img/tutorial/tutorial_dashboard_access.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_dashboard_access.png')} />
### Publishing a Dashboard
If you would like to make your dashboard available to other users, click on the `Draft` button next to the
title of your dashboard.
<img src={useBaseUrl("/img/tutorial/publish_button_dashboard.png" )} />
<img src={useBaseUrl('/img/tutorial/publish_button_dashboard.png')} />
:::warning
Draft dashboards are only visible to the dashboard owners and admins. Published dashboards are visible to all users with access to the underlying datasets or if RBAC is enabled, to the roles that have been granted access to the dashboard.

64
docs/user_docs_versioned_docs/version-6.0.0/using-superset/exploring-data.mdx
View File

@@ -5,7 +5,7 @@ sidebar_position: 2
version: 1
---
import useBaseUrl from "@docusaurus/useBaseUrl";
import useBaseUrl from '@docusaurus/useBaseUrl';
## Exploring Data in Superset
@@ -30,12 +30,12 @@ explains how to enable this functionality for the examples database.
In the top menu, select **Settings ‣ Data ‣ Database Connections**. Find the **examples** database in the list and
select the **Edit** button.
<img src={useBaseUrl("/img/tutorial/edit-record.png" )} />
<img src={useBaseUrl('/img/tutorial/edit-record.png')} />
In the resulting modal window, switch to the **Advanced** tab and open **Security** section.
Then, tick the checkbox for **Allow file uploads to database**. End by clicking the **Finish** button.
<img src={useBaseUrl("/img/tutorial/allow-file-uploads.png" )} />
<img src={useBaseUrl('/img/tutorial/allow-file-uploads.png')} />
### Loading CSV Data
@@ -43,16 +43,16 @@ Download the CSV dataset to your computer from
[GitHub](https://raw.githubusercontent.com/apache-superset/examples-data/master/tutorial_flights.csv).
In the top menu, select **Settings ‣ Data ‣ Database Connections**. Then, **Upload file to database ‣ Upload CSV**.
<img src={useBaseUrl("/img/tutorial/upload_a_csv.png" )} />
<img src={useBaseUrl('/img/tutorial/upload_a_csv.png')} />
Then, select select the CSV file from your computer, select **Database** and **Schema**, and enter the **Table Name**
as _tutorial_flights_.
<img src={useBaseUrl("/img/tutorial/csv_to_database_configuration.png" )} />
<img src={useBaseUrl('/img/tutorial/csv_to_database_configuration.png')} />
Next enter the text _Travel Date_ into the **File settings ‣ Columns to be parsed as dates** field.
<img src={useBaseUrl("/img/tutorial/parse_dates_column.png" )} />
<img src={useBaseUrl('/img/tutorial/parse_dates_column.png')} />
Leaving all the other options in their default settings, select **Upload** at the bottom of the page.
@@ -68,7 +68,7 @@ By default, Apache Superset only shows the last week of data. In our example, we
of the data in the dataset. Click the **Time ‣ Time Range** section and change
the **Range Type** to **No Filter**.
<img src={useBaseUrl("/img/tutorial/no_filter_on_time_filter.png" )} />
<img src={useBaseUrl('/img/tutorial/no_filter_on_time_filter.png')} />
Click **Apply** to save.
@@ -78,24 +78,24 @@ example, we want to understand different Travel Classes, we select **Travel Clas
Next, we can specify the metrics we would like to see in our table with the **Metrics** option.
- `COUNT(*)`, which represents the number of rows in the table
(in this case, quantity of flights in each Travel Class)
(in this case, quantity of flights in each Travel Class)
- `SUM(Cost)`, which represents the total cost spent by each Travel Class
<img src={useBaseUrl("/img/tutorial/sum_cost_column.png" )} />
<img src={useBaseUrl('/img/tutorial/sum_cost_column.png')} />
Finally, select **Run Query** to see the results of the table.
<img src={useBaseUrl("/img/tutorial/tutorial_table.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_table.png')} />
To save the visualization, click on **Save** in the top left of the screen. In the following modal,
- Select the **Save as**
option and enter the chart name as Tutorial Table (you will be able to find it again through the
**Charts** screen, accessible in the top menu).
option and enter the chart name as Tutorial Table (you will be able to find it again through the
**Charts** screen, accessible in the top menu).
- Select **Add To Dashboard** and enter
Tutorial Dashboard. Finally, select **Save & Go To Dashboard**.
Tutorial Dashboard. Finally, select **Save & Go To Dashboard**.
<img src={useBaseUrl("/img/tutorial/save_tutorial_table.png" )} />
<img src={useBaseUrl('/img/tutorial/save_tutorial_table.png')} />
### Dashboard Basics
@@ -107,7 +107,7 @@ On this dashboard you should see the table you created in the previous section.
dashboard** and then hover over the table. By selecting the bottom right hand corner of the table
(the cursor will change too), you can resize it by dragging and dropping.
<img src={useBaseUrl("/img/tutorial/resize_tutorial_table_on_dashboard.png" )} />
<img src={useBaseUrl('/img/tutorial/resize_tutorial_table_on_dashboard.png')} />
Finally, save your changes by selecting Save changes in the top right.
@@ -122,7 +122,7 @@ tutorial_flights again as a datasource, then click on the visualization type to
visualization menu. Select the **Pivot Table** visualization (you can filter by entering text in the
search box) and then **Create New Chart**.
<img src={useBaseUrl("/img/tutorial/create_pivot.png" )} />
<img src={useBaseUrl('/img/tutorial/create_pivot.png')} />
In the **Time** section, keep the Time Column as Travel Date (this is selected automatically as we
only have one time column in our dataset). Then select Time Grain to be month as having daily data
@@ -132,7 +132,7 @@ January 2011 and 30th June 2011 respectively by either entering directly the dat
calendar widget (by selecting the month name and then the year, you can move more quickly to far
away dates).
<img src={useBaseUrl("/img/tutorial/select_dates_pivot_table.png" )} />
<img src={useBaseUrl('/img/tutorial/select_dates_pivot_table.png')} />
Next, within the **Query** section, remove the default COUNT(\*) and add Cost, keeping the default
SUM aggregate. Note that Apache Superset will indicate the type of the metric by the symbol on the
@@ -144,7 +144,7 @@ selections we defined in the Time section.
Within **Columns**, first select Department and then Travel Class. All set – let’s **Run Query** to
see some data!
<img src={useBaseUrl("/img/tutorial/tutorial_pivot_table.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_pivot_table.png')} />
You should see months in the rows and Department and Travel Class in the columns. Publish this chart
to your existing Tutorial Dashboard you created earlier.
@@ -159,7 +159,7 @@ time for the Time range select No filter as we want to look at entire dataset.
Within Metrics, remove the default `COUNT(*)` metric and instead add `AVG(Cost)`, to show the mean value.
<img src={useBaseUrl("/img/tutorial/average_aggregate_for_cost.png" )} />
<img src={useBaseUrl('/img/tutorial/average_aggregate_for_cost.png')} />
Next, select **Run Query** to show the data on the chart.
@@ -176,7 +176,7 @@ tab on the left hand pane. Within this pane, try changing the Color Scheme, remo
filter by selecting No in the Show Range Filter drop down and adding some labels using X Axis Label
and Y Axis Label.
<img src={useBaseUrl("/img/tutorial/tutorial_line_chart.png" )} />
<img src={useBaseUrl('/img/tutorial/tutorial_line_chart.png')} />
Once you’re done, publish the chart in your Tutorial Dashboard.
@@ -189,14 +189,14 @@ dashboards. Got into edit mode by selecting **Edit dashboard**.
Within the Insert components pane, drag and drop a Markdown box on the dashboard. Look for the blue
lines which indicate the anchor where the box will go.
<img src={useBaseUrl("/img/tutorial/blue_bar_insert_component.png" )} />
<img src={useBaseUrl('/img/tutorial/blue_bar_insert_component.png')} />
Now, to edit the text, select the box. You can enter text, in markdown format (see
[this Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) for
more information about this format). You can toggle between Edit and Preview using the menu on the
top of the box.
<img src={useBaseUrl("/img/tutorial/markdown.png" )} />
<img src={useBaseUrl('/img/tutorial/markdown.png')} />
To exit, select any other part of the dashboard. Finally, don’t forget to keep your changes using
**Save changes**.
@@ -211,7 +211,7 @@ If you would like to make your dashboard available to other users, simply select
title of your dashboard on the top left to change your dashboard to be in Published state. You can
also favorite this dashboard by selecting the star.
<img src={useBaseUrl("/img/tutorial/publish_dashboard.png" )} />
<img src={useBaseUrl('/img/tutorial/publish_dashboard.png')} />
### Annotations
@@ -228,7 +228,7 @@ Next, add an annotation by navigating to Manage ‣ Annotations and then create
selecting the green plus sign. Then, select the Volcanic Eruptions layer, add a short description
Grímsvötn and the eruption dates (23-25 May 2011) before finally saving.
<img src={useBaseUrl("/img/tutorial/edit_annotation.png" )} />
<img src={useBaseUrl('/img/tutorial/edit_annotation.png')} />
Then, navigate to the line chart by going to Charts then selecting Tutorial Line Chart from the
list. Next, go to the Annotations and Layers section and select Add Annotation Layer. Within this
@@ -239,11 +239,11 @@ dialogue:
- Set the Annotation Source as Superset annotation
- Specify the Annotation Layer as Volcanic Eruptions
<img src={useBaseUrl("/img/tutorial/annotation_settings.png" )} />
<img src={useBaseUrl('/img/tutorial/annotation_settings.png')} />
Select **Apply** to see your annotation shown on the chart.
<img src={useBaseUrl("/img/tutorial/annotation.png" )} />
<img src={useBaseUrl('/img/tutorial/annotation.png')} />
If you wish, you can change how your annotation looks by changing the settings in the Display
configuration section. Otherwise, select **OK** and finally **Save** to save your chart. If you keep
@@ -265,7 +265,7 @@ datasource and the **Line Chart** visualization type. Within the Time section, s
Next, in the query section, change the Metrics to the sum of Cost. Select **Run Query** to show the
chart. You should see the total cost per day for each month in October 2011.
<img src={useBaseUrl("/img/tutorial/advanced_analytics_base.png" )} />
<img src={useBaseUrl('/img/tutorial/advanced_analytics_base.png')} />
Finally, save the visualization as Tutorial Advanced Analytics Base, adding it to the Tutorial
Dashboard.
@@ -284,7 +284,7 @@ on 7 days and we avoid any ramp up period.
After displaying the chart by selecting **Run Query** you will see that the data is less variable
and that the series starts later as the ramp up period is excluded.
<img src={useBaseUrl("/img/tutorial/rolling_mean.png" )} />
<img src={useBaseUrl('/img/tutorial/rolling_mean.png')} />
Save the chart as Tutorial Rolling Mean and add it to the Tutorial Dashboard.
@@ -299,13 +299,15 @@ Next, in the Time Comparison subsection of **Advanced Analytics**, enter the Tim
“minus 1 week” (note this box accepts input in natural language). Run Query to see the new chart,
which has an additional series with the same values, shifted a week back in time.
<img src={useBaseUrl("/img/tutorial/time_comparison_two_series.png" )} />
<img src={useBaseUrl('/img/tutorial/time_comparison_two_series.png')} />
Then, change the **Calculation type** to Absolute difference and select **Run Query**. We can now
see only one series again, this time showing the difference between the two series we saw
previously.
<img src={useBaseUrl("/img/tutorial/time_comparison_absolute_difference.png" )} />
<img
src={useBaseUrl('/img/tutorial/time_comparison_absolute_difference.png')}
/>
Save the chart as Tutorial Time Comparison and add it to the Tutorial Dashboard.
@@ -317,7 +319,7 @@ As in the previous section, reopen the Tutorial Advanced Analytics Base chart.
Next, in the Python Functions subsection of **Advanced Analytics**, enter 7D, corresponding to seven
days, in the Rule and median as the Method and show the chart by selecting **Run Query**.
<img src={useBaseUrl("/img/tutorial/resample.png" )} />
<img src={useBaseUrl('/img/tutorial/resample.png')} />
Note that now we have a single data point every 7 days. In our case, the value showed corresponds to
the median value within the seven daily data points. For more information on the meaning of the

1490
docs/user_docs_versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json
View File

File diff suppressed because it is too large Load Diff

14
docs/user_docs_versioned_docs/version-6.1.0/databases/index.mdx
View File

@@ -4,24 +4,24 @@ sidebar_label: Overview
sidebar_position: 1
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabaseIndex } from '@site/src/components/databases';
import databaseData from '../_versioned_data/src/data/databases.json';

107
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx
View File

@@ -1,31 +1,120 @@
---
title: Amazon Athena
sidebar_label: Amazon Athena
description: "Amazon Athena is an interactive query service for analyzing data in S3 using SQL."
description: 'Amazon Athena is an interactive query service for analyzing data in S3 using SQL.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"amazon_athena","engine_name":"Amazon Athena","module":"athena","documentation":{"description":"Amazon Athena is an interactive query service for analyzing data in S3 using SQL.","logo":"amazon-athena.jpg","homepage_url":"https://aws.amazon.com/athena/","categories":["CLOUD_AWS","QUERY_ENGINES","PROPRIETARY"],"pypi_packages":["pyathena[pandas]"],"connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","drivers":[{"name":"PyAthena (REST)","pypi_package":"pyathena[pandas]","connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":true,"notes":"No Java required. URL-encode special characters (e.g., s3:// -> s3%3A//)."},{"name":"PyAthenaJDBC","pypi_package":"PyAthenaJDBC","connection_string":"awsathena+jdbc://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":false,"notes":"Requires Amazon Athena JDBC driver."}],"engine_parameters":[{"name":"IAM Role Assumption","description":"Assume a specific IAM role for queries","json":{"connect_args":{"role_arn":"<role arn>"}}}],"notes":"URL-encode special characters in s3_staging_dir (e.g., s3:// becomes s3%3A//).","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":30,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'amazon_athena',
engine_name: 'Amazon Athena',
module: 'athena',
documentation: {
description:
'Amazon Athena is an interactive query service for analyzing data in S3 using SQL.',
logo: 'amazon-athena.jpg',
homepage_url: 'https://aws.amazon.com/athena/',
categories: ['CLOUD_AWS', 'QUERY_ENGINES', 'PROPRIETARY'],
pypi_packages: ['pyathena[pandas]'],
connection_string:
'awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}',
drivers: [
{
name: 'PyAthena (REST)',
pypi_package: 'pyathena[pandas]',
connection_string:
'awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}',
is_recommended: true,
notes:
'No Java required. URL-encode special characters (e.g., s3:// -> s3%3A//).',
},
{
name: 'PyAthenaJDBC',
pypi_package: 'PyAthenaJDBC',
connection_string:
'awsathena+jdbc://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}',
is_recommended: false,
notes: 'Requires Amazon Athena JDBC driver.',
},
],
engine_parameters: [
{
name: 'IAM Role Assumption',
description: 'Assume a specific IAM role for queries',
json: { connect_args: { role_arn: '<role arn>' } },
},
],
notes:
'URL-encode special characters in s3_staging_dir (e.g., s3:// becomes s3%3A//).',
custom_errors: [
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors at or near "%(syntax_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 30,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Amazon Athena" database={databaseInfo} />

76
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx
View File

@@ -1,31 +1,89 @@
---
title: Amazon DynamoDB
sidebar_label: Amazon DynamoDB
description: "Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL."
description: 'Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"amazon_dynamodb","engine_name":"Amazon DynamoDB","module":"dynamodb","documentation":{"description":"Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL.","logo":"aws.png","homepage_url":"https://aws.amazon.com/dynamodb/","categories":["CLOUD_AWS","SEARCH_NOSQL","PROPRIETARY"],"pypi_packages":["pydynamodb"],"connection_string":"dynamodb://{aws_access_key_id}:{aws_secret_access_key}@dynamodb.{region}.amazonaws.com:443?connector=superset","parameters":{"aws_access_key_id":"AWS access key ID","aws_secret_access_key":"AWS secret access key","region":"AWS region (e.g., us-east-1)"},"notes":"Uses PartiQL for SQL queries. Requires connector=superset parameter.","docs_url":"https://github.com/passren/PyDynamoDB"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":32,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'amazon_dynamodb',
engine_name: 'Amazon DynamoDB',
module: 'dynamodb',
documentation: {
description:
'Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL.',
logo: 'aws.png',
homepage_url: 'https://aws.amazon.com/dynamodb/',
categories: ['CLOUD_AWS', 'SEARCH_NOSQL', 'PROPRIETARY'],
pypi_packages: ['pydynamodb'],
connection_string:
'dynamodb://{aws_access_key_id}:{aws_secret_access_key}@dynamodb.{region}.amazonaws.com:443?connector=superset',
parameters: {
aws_access_key_id: 'AWS access key ID',
aws_secret_access_key: 'AWS secret access key',
region: 'AWS region (e.g., us-east-1)',
},
notes:
'Uses PartiQL for SQL queries. Requires connector=superset parameter.',
docs_url: 'https://github.com/passren/PyDynamoDB',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 32,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Amazon DynamoDB" database={databaseInfo} />

201
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx
View File

File diff suppressed because one or more lines are too long

150
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx
View File

@@ -1,31 +1,163 @@
---
title: Apache Doris
sidebar_label: Apache Doris
description: "Apache Doris is a high-performance real-time analytical database."
description: 'Apache Doris is a high-performance real-time analytical database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_doris","engine_name":"Apache Doris","module":"doris","documentation":{"description":"Apache Doris is a high-performance real-time analytical database.","logo":"doris.png","homepage_url":"https://doris.apache.org/","pypi_packages":["mysqlclient","pydoris"],"connection_string":"doris://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"User name","password":"Password","host":"Doris FE Host","database":"Database name","port":"Doris FE port","catalog":"Catalog name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"categories":["APACHE_PROJECTS","ANALYTICAL_DATABASES","OPEN_SOURCE"],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown Doris server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":79,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_doris',
engine_name: 'Apache Doris',
module: 'doris',
documentation: {
description:
'Apache Doris is a high-performance real-time analytical database.',
logo: 'doris.png',
homepage_url: 'https://doris.apache.org/',
pypi_packages: ['mysqlclient', 'pydoris'],
connection_string:
'doris://{username}:{password}@{host}:{port}/{catalog}.{database}',
default_port: 9030,
parameters: {
username: 'User name',
password: 'Password',
host: 'Doris FE Host',
database: 'Database name',
port: 'Doris FE port',
catalog: 'Catalog name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
],
categories: ['APACHE_PROJECTS', 'ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
custom_errors: [
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s" or the password is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
invalid_fields: ['username', 'password'],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'Unknown Doris server host "%(hostname)s".',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
invalid_fields: ['host'],
},
{
regex_name: 'CONNECTION_HOST_DOWN_REGEX',
message_template:
'The host "%(hostname)s" might be down and can\'t be reached.',
error_type: 'CONNECTION_HOST_DOWN_ERROR',
category: 'Connection',
description: 'Host unreachable',
issue_codes: [1009],
invalid_fields: ['host', 'port'],
},
{
regex_name: 'CONNECTION_UNKNOWN_DATABASE_REGEX',
message_template: 'Unable to connect to database "%(database)s".',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
invalid_fields: ['database'],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors near "%(server_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 79,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Doris" database={databaseInfo} />

100
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx
View File

@@ -1,31 +1,113 @@
---
title: Apache Drill
sidebar_label: Apache Drill
description: "Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL."
description: 'Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_drill","engine_name":"Apache Drill","module":"drill","documentation":{"description":"Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL.","logo":"apache-drill.png","homepage_url":"https://drill.apache.org/","categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-drill"],"connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","default_port":8047,"drivers":[{"name":"SQLAlchemy (REST)","pypi_package":"sqlalchemy-drill","connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","is_recommended":true},{"name":"JDBC","pypi_package":"sqlalchemy-drill","connection_string":"drill+jdbc://{username}:{password}@{host}:{port}","is_recommended":false,"notes":"Requires Drill JDBC Driver installation.","docs_url":"https://drill.apache.org/docs/using-the-jdbc-driver/"},{"name":"ODBC","pypi_package":"sqlalchemy-drill","is_recommended":false,"notes":"See Apache Drill documentation for ODBC setup.","docs_url":"https://drill.apache.org/docs/installing-the-driver-on-linux/"}],"connection_examples":[{"description":"Local embedded mode","connection_string":"drill+sadrill://localhost:8047/dfs?use_ssl=False"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":50,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'apache_drill',
engine_name: 'Apache Drill',
module: 'drill',
documentation: {
description:
'Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL.',
logo: 'apache-drill.png',
homepage_url: 'https://drill.apache.org/',
categories: ['APACHE_PROJECTS', 'QUERY_ENGINES', 'OPEN_SOURCE'],
pypi_packages: ['sqlalchemy-drill'],
connection_string:
'drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True',
default_port: 8047,
drivers: [
{
name: 'SQLAlchemy (REST)',
pypi_package: 'sqlalchemy-drill',
connection_string:
'drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True',
is_recommended: true,
},
{
name: 'JDBC',
pypi_package: 'sqlalchemy-drill',
connection_string: 'drill+jdbc://{username}:{password}@{host}:{port}',
is_recommended: false,
notes: 'Requires Drill JDBC Driver installation.',
docs_url: 'https://drill.apache.org/docs/using-the-jdbc-driver/',
},
{
name: 'ODBC',
pypi_package: 'sqlalchemy-drill',
is_recommended: false,
notes: 'See Apache Drill documentation for ODBC setup.',
docs_url:
'https://drill.apache.org/docs/installing-the-driver-on-linux/',
},
],
connection_examples: [
{
description: 'Local embedded mode',
connection_string: 'drill+sadrill://localhost:8047/dfs?use_ssl=False',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 50,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="Apache Drill" database={databaseInfo} />

109
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx
View File

@@ -1,31 +1,122 @@
---
title: Apache Druid
sidebar_label: Apache Druid
description: "Apache Druid is a high performance real-time analytics database."
description: 'Apache Druid is a high performance real-time analytics database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_druid","engine_name":"Apache Druid","module":"druid","documentation":{"description":"Apache Druid is a high performance real-time analytics database.","logo":"druid.png","homepage_url":"https://druid.apache.org/","categories":["APACHE_PROJECTS","TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}:{port}/druid/v2/sql","default_port":9088,"parameters":{"username":"Database username","password":"Database password","host":"IP address or URL of the host","port":"Default 9088"},"ssl_configuration":{"custom_certificate":"Add certificate in Root Certificate field. pydruid will automatically use https.","disable_ssl_verification":{"engine_params":{"connect_args":{"scheme":"https","ssl_verify_cert":false}}}},"advanced_features":{"aggregations":"Define common aggregations in datasource edit view under List Druid Column tab.","post_aggregations":"Create metrics with postagg as Metric Type and provide valid JSON post-aggregation definition."},"notes":"A native Druid connector ships with Superset (behind DRUID_IS_ACTIVE flag) but SQLAlchemy connector via pydruid is preferred.","compatible_databases":[{"name":"Imply","description":"Imply is a fully-managed cloud platform and enterprise distribution built on Apache Druid. It provides real-time analytics with enterprise security and support.","logo":"imply.png","homepage_url":"https://imply.io/","categories":["TIME_SERIES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}/druid/v2/sql","docs_url":"https://docs.imply.io/"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":47,"max_score":201,"joins":false,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_druid',
engine_name: 'Apache Druid',
module: 'druid',
documentation: {
description:
'Apache Druid is a high performance real-time analytics database.',
logo: 'druid.png',
homepage_url: 'https://druid.apache.org/',
categories: ['APACHE_PROJECTS', 'TIME_SERIES', 'OPEN_SOURCE'],
pypi_packages: ['pydruid'],
connection_string:
'druid://{username}:{password}@{host}:{port}/druid/v2/sql',
default_port: 9088,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'IP address or URL of the host',
port: 'Default 9088',
},
ssl_configuration: {
custom_certificate:
'Add certificate in Root Certificate field. pydruid will automatically use https.',
disable_ssl_verification: {
engine_params: {
connect_args: { scheme: 'https', ssl_verify_cert: false },
},
},
},
advanced_features: {
aggregations:
'Define common aggregations in datasource edit view under List Druid Column tab.',
post_aggregations:
'Create metrics with postagg as Metric Type and provide valid JSON post-aggregation definition.',
},
notes:
'A native Druid connector ships with Superset (behind DRUID_IS_ACTIVE flag) but SQLAlchemy connector via pydruid is preferred.',
compatible_databases: [
{
name: 'Imply',
description:
'Imply is a fully-managed cloud platform and enterprise distribution built on Apache Druid. It provides real-time analytics with enterprise security and support.',
logo: 'imply.png',
homepage_url: 'https://imply.io/',
categories: [
'TIME_SERIES',
'CLOUD_DATA_WAREHOUSES',
'HOSTED_OPEN_SOURCE',
],
pypi_packages: ['pydruid'],
connection_string: 'druid://{username}:{password}@{host}/druid/v2/sql',
docs_url: 'https://docs.imply.io/',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 47,
max_score: 201,
joins: false,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Druid" database={databaseInfo} />

82
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx
View File

@@ -1,31 +1,95 @@
---
title: Apache Hive
sidebar_label: Apache Hive
description: "Apache Hive is a data warehouse infrastructure built on Hadoop."
description: 'Apache Hive is a data warehouse infrastructure built on Hadoop.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_hive","engine_name":"Apache Hive","module":"hive","documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","pypi_packages":["pyhive","pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":140,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'apache_hive',
engine_name: 'Apache Hive',
module: 'hive',
documentation: {
description:
'Apache Hive is a data warehouse infrastructure built on Hadoop.',
logo: 'apache-hive.svg',
homepage_url: 'https://hive.apache.org/',
pypi_packages: ['pyhive', 'pyhive'],
install_instructions: 'pip install "apache-superset[presto]"',
connection_string: 'hive://hive@{hostname}:{port}/{database}',
default_port: 10000,
parameters: {
hostname: 'Presto coordinator hostname',
port: 'Presto coordinator port (default 8080)',
database: 'Catalog name',
},
drivers: [
{
name: 'PyHive',
pypi_package: 'pyhive',
connection_string: 'presto://{hostname}:{port}/{database}',
is_recommended: true,
},
],
categories: ['APACHE_PROJECTS', 'QUERY_ENGINES', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 140,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="Apache Hive" database={databaseInfo} />

68
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx
View File

@@ -1,31 +1,81 @@
---
title: Apache Impala
sidebar_label: Apache Impala
description: "Apache Impala is an open-source massively parallel processing SQL query engine."
description: 'Apache Impala is an open-source massively parallel processing SQL query engine.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_impala","engine_name":"Apache Impala","module":"impala","documentation":{"description":"Apache Impala is an open-source massively parallel processing SQL query engine.","logo":"apache-impala.png","homepage_url":"https://impala.apache.org/","categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["impyla"],"connection_string":"impala://{hostname}:{port}/{database}","default_port":21050},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":37,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_impala',
engine_name: 'Apache Impala',
module: 'impala',
documentation: {
description:
'Apache Impala is an open-source massively parallel processing SQL query engine.',
logo: 'apache-impala.png',
homepage_url: 'https://impala.apache.org/',
categories: ['APACHE_PROJECTS', 'QUERY_ENGINES', 'OPEN_SOURCE'],
pypi_packages: ['impyla'],
connection_string: 'impala://{hostname}:{port}/{database}',
default_port: 21050,
},
time_grains: {
SECOND: false,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 37,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Impala" database={databaseInfo} />

76
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx
View File

@@ -1,31 +1,89 @@
---
title: Apache IoTDB
sidebar_label: Apache IoTDB
description: "Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data."
description: 'Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_iotdb","engine_name":"Apache IoTDB","module":"iotdb","documentation":{"description":"Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data.","logo":"apache-iotdb.svg","homepage_url":"https://iotdb.apache.org/","categories":["APACHE_PROJECTS","TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["apache-iotdb"],"connection_string":"iotdb://{username}:{password}@{hostname}:{port}","default_port":6667,"parameters":{"username":"Database username (default: root)","password":"Database password (default: root)","hostname":"IP address or hostname","port":"Default 6667"},"notes":"The IoTDB SQLAlchemy dialect was written to integrate with Apache Superset. IoTDB uses a hierarchical data model, which is reorganized into a relational model for SQL queries."},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"score":20,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_iotdb',
engine_name: 'Apache IoTDB',
module: 'iotdb',
documentation: {
description:
'Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data.',
logo: 'apache-iotdb.svg',
homepage_url: 'https://iotdb.apache.org/',
categories: ['APACHE_PROJECTS', 'TIME_SERIES', 'OPEN_SOURCE'],
pypi_packages: ['apache-iotdb'],
connection_string: 'iotdb://{username}:{password}@{hostname}:{port}',
default_port: 6667,
parameters: {
username: 'Database username (default: root)',
password: 'Database password (default: root)',
hostname: 'IP address or hostname',
port: 'Default 6667',
},
notes:
'The IoTDB SQLAlchemy dialect was written to integrate with Apache Superset. IoTDB uses a hierarchical data model, which is reorganized into a relational model for SQL queries.',
},
time_grains: {
SECOND: false,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: false,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: false,
SIX_HOURS: false,
DAY: false,
WEEK: false,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: false,
QUARTER: false,
QUARTER_YEAR: false,
YEAR: false,
},
score: 20,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache IoTDB" database={databaseInfo} />

68
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx
View File

@@ -1,31 +1,81 @@
---
title: Apache Kylin
sidebar_label: Apache Kylin
description: "Apache Kylin is an open-source OLAP engine for big data."
description: 'Apache Kylin is an open-source OLAP engine for big data.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_kylin","engine_name":"Apache Kylin","module":"kylin","documentation":{"description":"Apache Kylin is an open-source OLAP engine for big data.","logo":"apache-kylin.png","homepage_url":"https://kylin.apache.org/","categories":["APACHE_PROJECTS","ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["kylinpy"],"connection_string":"kylin://{username}:{password}@{hostname}:{port}/{project}?{param1}={value1}&{param2}={value2}","default_port":7070},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_kylin',
engine_name: 'Apache Kylin',
module: 'kylin',
documentation: {
description: 'Apache Kylin is an open-source OLAP engine for big data.',
logo: 'apache-kylin.png',
homepage_url: 'https://kylin.apache.org/',
categories: ['APACHE_PROJECTS', 'ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
pypi_packages: ['kylinpy'],
connection_string:
'kylin://{username}:{password}@{hostname}:{port}/{project}?{param1}={value1}&{param2}={value2}',
default_port: 7070,
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Kylin" database={databaseInfo} />

70
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx
View File

@@ -1,31 +1,83 @@
---
title: Apache Phoenix
sidebar_label: Apache Phoenix
description: "Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data."
description: 'Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_phoenix","engine_name":"Apache Phoenix","module":"phoenix","documentation":{"description":"Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data.","logo":"apache-phoenix.png","homepage_url":"https://phoenix.apache.org/","categories":["APACHE_PROJECTS","ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["phoenixdb"],"connection_string":"phoenix://{hostname}:{port}/","default_port":8765,"notes":"Phoenix provides a SQL interface to Apache HBase. The phoenixdb driver connects via the Phoenix Query Server and supports a subset of SQLAlchemy."},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_phoenix',
engine_name: 'Apache Phoenix',
module: 'phoenix',
documentation: {
description:
'Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data.',
logo: 'apache-phoenix.png',
homepage_url: 'https://phoenix.apache.org/',
categories: ['APACHE_PROJECTS', 'ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
pypi_packages: ['phoenixdb'],
connection_string: 'phoenix://{hostname}:{port}/',
default_port: 8765,
notes:
'Phoenix provides a SQL interface to Apache HBase. The phoenixdb driver connects via the Phoenix Query Server and supports a subset of SQLAlchemy.',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Phoenix" database={databaseInfo} />

83
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx
View File

@@ -1,31 +1,96 @@
---
title: Apache Pinot
sidebar_label: Apache Pinot
description: "Apache Pinot is a real-time distributed OLAP datastore."
description: 'Apache Pinot is a real-time distributed OLAP datastore.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_pinot","engine_name":"Apache Pinot","module":"pinot","documentation":{"description":"Apache Pinot is a real-time distributed OLAP datastore.","logo":"apache-pinot.svg","homepage_url":"https://pinot.apache.org/","categories":["APACHE_PROJECTS","TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["pinotdb"],"connection_string":"pinot+http://{broker_host}:{broker_port}/query?controller=http://{controller_host}:{controller_port}/","default_port":8099,"connection_examples":[{"description":"With authentication","connection_string":"pinot://{username}:{password}@{broker_host}:{broker_port}/query/sql?controller=http://{controller_host}:{controller_port}/verify_ssl=true"}],"engine_parameters":[{"name":"Multi-stage Query Engine","description":"Enable for Explore view, joins, window functions","json":{"connect_args":{"use_multistage_engine":"true"}},"docs_url":"https://docs.pinot.apache.org/reference/multi-stage-engine"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":32,"max_score":201,"joins":false,"subqueries":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_pinot',
engine_name: 'Apache Pinot',
module: 'pinot',
documentation: {
description: 'Apache Pinot is a real-time distributed OLAP datastore.',
logo: 'apache-pinot.svg',
homepage_url: 'https://pinot.apache.org/',
categories: ['APACHE_PROJECTS', 'TIME_SERIES', 'OPEN_SOURCE'],
pypi_packages: ['pinotdb'],
connection_string:
'pinot+http://{broker_host}:{broker_port}/query?controller=http://{controller_host}:{controller_port}/',
default_port: 8099,
connection_examples: [
{
description: 'With authentication',
connection_string:
'pinot://{username}:{password}@{broker_host}:{broker_port}/query/sql?controller=http://{controller_host}:{controller_port}/verify_ssl=true',
},
],
engine_parameters: [
{
name: 'Multi-stage Query Engine',
description: 'Enable for Explore view, joins, window functions',
json: { connect_args: { use_multistage_engine: 'true' } },
docs_url: 'https://docs.pinot.apache.org/reference/multi-stage-engine',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 32,
max_score: 201,
joins: false,
subqueries: false,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Pinot" database={databaseInfo} />

68
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx
View File

@@ -1,31 +1,81 @@
---
title: Apache Solr
sidebar_label: Apache Solr
description: "Apache Solr is an open-source enterprise search platform."
description: 'Apache Solr is an open-source enterprise search platform.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_solr","engine_name":"Apache Solr","module":"solr","documentation":{"description":"Apache Solr is an open-source enterprise search platform.","logo":"apache-solr.png","homepage_url":"https://solr.apache.org/","categories":["APACHE_PROJECTS","SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-solr"],"connection_string":"solr://{username}:{password}@{host}:{port}/{server_path}/{collection}[/?use_ssl=true|false]","default_port":8983},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"score":20,"max_score":201,"joins":false,"subqueries":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'apache_solr',
engine_name: 'Apache Solr',
module: 'solr',
documentation: {
description: 'Apache Solr is an open-source enterprise search platform.',
logo: 'apache-solr.png',
homepage_url: 'https://solr.apache.org/',
categories: ['APACHE_PROJECTS', 'SEARCH_NOSQL', 'OPEN_SOURCE'],
pypi_packages: ['sqlalchemy-solr'],
connection_string:
'solr://{username}:{password}@{host}:{port}/{server_path}/{collection}[/?use_ssl=true|false]',
default_port: 8983,
},
time_grains: {
SECOND: false,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: false,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: false,
SIX_HOURS: false,
DAY: false,
WEEK: false,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: false,
QUARTER: false,
QUARTER_YEAR: false,
YEAR: false,
},
score: 20,
max_score: 201,
joins: false,
subqueries: false,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Apache Solr" database={databaseInfo} />

81
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx
View File

@@ -1,31 +1,94 @@
---
title: Apache Spark SQL
sidebar_label: Apache Spark SQL
description: "Apache Spark SQL is a module for structured data processing."
description: 'Apache Spark SQL is a module for structured data processing.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"apache_spark_sql","engine_name":"Apache Spark SQL","module":"spark","documentation":{"description":"Apache Spark SQL is a module for structured data processing.","logo":"apache-spark.png","homepage_url":"https://spark.apache.org/sql/","pypi_packages":["pyhive","pyhive","pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"spark://hive@{hostname}:{port}/{database}","default_port":10000,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":140,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'apache_spark_sql',
engine_name: 'Apache Spark SQL',
module: 'spark',
documentation: {
description: 'Apache Spark SQL is a module for structured data processing.',
logo: 'apache-spark.png',
homepage_url: 'https://spark.apache.org/sql/',
pypi_packages: ['pyhive', 'pyhive', 'pyhive'],
install_instructions: 'pip install "apache-superset[presto]"',
connection_string: 'spark://hive@{hostname}:{port}/{database}',
default_port: 10000,
parameters: {
hostname: 'Presto coordinator hostname',
port: 'Presto coordinator port (default 8080)',
database: 'Catalog name',
},
drivers: [
{
name: 'PyHive',
pypi_package: 'pyhive',
connection_string: 'presto://{hostname}:{port}/{database}',
is_recommended: true,
},
],
categories: ['APACHE_PROJECTS', 'QUERY_ENGINES', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 140,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="Apache Spark SQL" database={databaseInfo} />

88
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/arc.mdx
View File

@@ -1,31 +1,101 @@
---
title: Arc
sidebar_label: Arc
description: "Arc is a data platform with multiple connection options."
description: 'Arc is a data platform with multiple connection options.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"arc","engine_name":"Arc","module":"arc","documentation":{"description":"Arc is a data platform with multiple connection options.","categories":["OTHER","PROPRIETARY"],"pypi_packages":["arc-superset-arrow"],"connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","parameters":{"api_key":"Arc API key","hostname":"Arc hostname","port":"Arc port","database":"Database name"},"drivers":[{"name":"Apache Arrow (Recommended)","pypi_package":"arc-superset-arrow","connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","is_recommended":true,"notes":"Recommended for production. Provides 3-5x better performance using Apache Arrow IPC."},{"name":"JSON","pypi_package":"arc-superset-dialect","connection_string":"arc+json://{api_key}@{hostname}:{port}/{database}","is_recommended":false}],"notes":"Arc supports multiple databases (schemas) within a single instance. Each Arc database appears as a schema in SQL Lab."},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'arc',
engine_name: 'Arc',
module: 'arc',
documentation: {
description: 'Arc is a data platform with multiple connection options.',
categories: ['OTHER', 'PROPRIETARY'],
pypi_packages: ['arc-superset-arrow'],
connection_string: 'arc+arrow://{api_key}@{hostname}:{port}/{database}',
parameters: {
api_key: 'Arc API key',
hostname: 'Arc hostname',
port: 'Arc port',
database: 'Database name',
},
drivers: [
{
name: 'Apache Arrow (Recommended)',
pypi_package: 'arc-superset-arrow',
connection_string: 'arc+arrow://{api_key}@{hostname}:{port}/{database}',
is_recommended: true,
notes:
'Recommended for production. Provides 3-5x better performance using Apache Arrow IPC.',
},
{
name: 'JSON',
pypi_package: 'arc-superset-dialect',
connection_string: 'arc+json://{api_key}@{hostname}:{port}/{database}',
is_recommended: false,
},
],
notes:
'Arc supports multiple databases (schemas) within a single instance. Each Arc database appears as a schema in SQL Lab.',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Arc" database={databaseInfo} />

73
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/ascend.mdx
View File

@@ -1,31 +1,86 @@
---
title: Ascend
sidebar_label: Ascend
description: "Ascend.io is a data automation platform for building data pipelines."
description: 'Ascend.io is a data automation platform for building data pipelines.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"ascend","engine_name":"Ascend","module":"ascend","documentation":{"description":"Ascend.io is a data automation platform for building data pipelines.","logo":"ascend.webp","homepage_url":"https://www.ascend.io/","pypi_packages":["impyla","impyla"],"connection_string":"ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true","default_port":21050,"categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","HOSTED_OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'ascend',
engine_name: 'Ascend',
module: 'ascend',
documentation: {
description:
'Ascend.io is a data automation platform for building data pipelines.',
logo: 'ascend.webp',
homepage_url: 'https://www.ascend.io/',
pypi_packages: ['impyla', 'impyla'],
connection_string:
'ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true',
default_port: 21050,
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'HOSTED_OPEN_SOURCE',
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 38,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Ascend" database={databaseInfo} />

97
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx
View File

@@ -1,31 +1,110 @@
---
title: Aurora MySQL (Data API)
sidebar_label: Aurora MySQL (Data API)
description: "MySQL is a popular open-source relational database."
description: 'MySQL is a popular open-source relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"aurora_mysql_(data_api)","engine_name":"Aurora MySQL (Data API)","module":"aurora","documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'aurora_mysql_(data_api)',
engine_name: 'Aurora MySQL (Data API)',
module: 'aurora',
documentation: {
description: 'MySQL is a popular open-source relational database.',
logo: 'mysql.png',
homepage_url: 'https://www.mysql.com/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['mysqlclient'],
connection_string: 'mysql://{username}:{password}@{host}/{database}',
default_port: 3306,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'localhost, 127.0.0.1, IP address, or hostname',
database: 'Database name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 59,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Aurora MySQL (Data API)" database={databaseInfo} />

97
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx
View File

@@ -1,31 +1,110 @@
---
title: Aurora MySQL
sidebar_label: Aurora MySQL
description: "MySQL is a popular open-source relational database."
description: 'MySQL is a popular open-source relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"aurora_mysql","engine_name":"Aurora MySQL","module":"aurora","documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'aurora_mysql',
engine_name: 'Aurora MySQL',
module: 'aurora',
documentation: {
description: 'MySQL is a popular open-source relational database.',
logo: 'mysql.png',
homepage_url: 'https://www.mysql.com/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['mysqlclient'],
connection_string: 'mysql://{username}:{password}@{host}/{database}',
default_port: 3306,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'localhost, 127.0.0.1, IP address, or hostname',
database: 'Database name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 59,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Aurora MySQL" database={databaseInfo} />

91
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx
View File

@@ -1,31 +1,104 @@
---
title: Aurora PostgreSQL (Data API)
sidebar_label: Aurora PostgreSQL (Data API)
description: "PostgreSQL is an advanced open-source relational database."
description: 'PostgreSQL is an advanced open-source relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"aurora_postgresql_(data_api)","engine_name":"Aurora PostgreSQL (Data API)","module":"aurora","documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html"},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":104,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":true,"user_impersonation":false};
export const databaseInfo = {
engine: 'aurora_postgresql_(data_api)',
engine_name: 'Aurora PostgreSQL (Data API)',
module: 'aurora',
documentation: {
description: 'PostgreSQL is an advanced open-source relational database.',
logo: 'postgresql.svg',
homepage_url: 'https://www.postgresql.org/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['psycopg2'],
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
default_port: 5432,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'For localhost: localhost or 127.0.0.1. For AWS: endpoint URL',
port: 'Default 5432',
database: 'Database name',
},
notes: 'The psycopg2 library comes bundled with Superset Docker images.',
connection_examples: [
{
description: 'Basic connection',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
},
{
description: 'With SSL required',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require',
},
],
docs_url: 'https://www.postgresql.org/docs/',
sqlalchemy_docs_url:
'https://docs.sqlalchemy.org/en/13/dialects/postgresql.html',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 104,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: true,
user_impersonation: false,
};
<DatabasePage name="Aurora PostgreSQL (Data API)" database={databaseInfo} />

91
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx
View File

@@ -1,31 +1,104 @@
---
title: Aurora PostgreSQL
sidebar_label: Aurora PostgreSQL
description: "PostgreSQL is an advanced open-source relational database."
description: 'PostgreSQL is an advanced open-source relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"aurora_postgresql","engine_name":"Aurora PostgreSQL","module":"aurora","documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html"},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":104,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":true,"user_impersonation":false};
export const databaseInfo = {
engine: 'aurora_postgresql',
engine_name: 'Aurora PostgreSQL',
module: 'aurora',
documentation: {
description: 'PostgreSQL is an advanced open-source relational database.',
logo: 'postgresql.svg',
homepage_url: 'https://www.postgresql.org/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['psycopg2'],
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
default_port: 5432,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'For localhost: localhost or 127.0.0.1. For AWS: endpoint URL',
port: 'Default 5432',
database: 'Database name',
},
notes: 'The psycopg2 library comes bundled with Superset Docker images.',
connection_examples: [
{
description: 'Basic connection',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
},
{
description: 'With SSL required',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require',
},
],
docs_url: 'https://www.postgresql.org/docs/',
sqlalchemy_docs_url:
'https://docs.sqlalchemy.org/en/13/dialects/postgresql.html',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 104,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: true,
user_impersonation: false,
};
<DatabasePage name="Aurora PostgreSQL" database={databaseInfo} />

93
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx
View File

@@ -1,31 +1,106 @@
---
title: Azure Data Explorer
sidebar_label: Azure Data Explorer
description: "Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax."
description: 'Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"azure_data_explorer","engine_name":"Azure Data Explorer","module":"kusto","documentation":{"description":"Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax.","logo":"kusto.png","homepage_url":"https://azure.microsoft.com/en-us/products/data-explorer/","categories":["CLOUD_AZURE","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-kusto"],"connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","parameters":{"cluster":"Azure Data Explorer cluster name","database":"Database name","client_id":"Azure AD application (client) ID","client_secret":"Azure AD application secret","tenant_id":"Azure AD tenant ID"},"drivers":[{"name":"SQL Interface (Recommended)","pypi_package":"sqlalchemy-kusto","connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":true,"notes":"Use familiar SQL syntax to query Azure Data Explorer."},{"name":"KQL (Kusto Query Language)","pypi_package":"sqlalchemy-kusto","connection_string":"kustokql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":false,"notes":"Use native Kusto Query Language for advanced analytics."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":54,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'azure_data_explorer',
engine_name: 'Azure Data Explorer',
module: 'kusto',
documentation: {
description:
'Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax.',
logo: 'kusto.png',
homepage_url: 'https://azure.microsoft.com/en-us/products/data-explorer/',
categories: ['CLOUD_AZURE', 'ANALYTICAL_DATABASES', 'PROPRIETARY'],
pypi_packages: ['sqlalchemy-kusto'],
connection_string:
'kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}',
parameters: {
cluster: 'Azure Data Explorer cluster name',
database: 'Database name',
client_id: 'Azure AD application (client) ID',
client_secret: 'Azure AD application secret',
tenant_id: 'Azure AD tenant ID',
},
drivers: [
{
name: 'SQL Interface (Recommended)',
pypi_package: 'sqlalchemy-kusto',
connection_string:
'kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}',
is_recommended: true,
notes: 'Use familiar SQL syntax to query Azure Data Explorer.',
},
{
name: 'KQL (Kusto Query Language)',
pypi_package: 'sqlalchemy-kusto',
connection_string:
'kustokql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}',
is_recommended: false,
notes: 'Use native Kusto Query Language for advanced analytics.',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: false,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 54,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Azure Data Explorer" database={databaseInfo} />

131
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx
View File

@@ -1,31 +1,144 @@
---
title: Azure Synapse
sidebar_label: Azure Synapse
description: "Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing."
description: 'Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"azure_synapse","engine_name":"Azure Synapse","module":"mssql","documentation":{"description":"Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing.","logo":"azure.svg","homepage_url":"https://azure.microsoft.com/en-us/products/synapse-analytics/","pypi_packages":["pymssql","pymssql"],"connection_string":"mssql+pymssql://{username}@{server}:{password}@{server}.database.windows.net:1433/{database}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":44,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'azure_synapse',
engine_name: 'Azure Synapse',
module: 'mssql',
documentation: {
description:
'Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing.',
logo: 'azure.svg',
homepage_url:
'https://azure.microsoft.com/en-us/products/synapse-analytics/',
pypi_packages: ['pymssql', 'pymssql'],
connection_string:
'mssql+pymssql://{username}@{server}:{password}@{server}.database.windows.net:1433/{database}',
default_port: 1433,
drivers: [
{
name: 'pymssql',
pypi_package: 'pymssql',
connection_string:
'mssql+pymssql://{username}:{password}@{host}:{port}/{database}',
is_recommended: true,
},
{
name: 'pyodbc',
pypi_package: 'pyodbc',
connection_string:
'mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30',
is_recommended: false,
notes:
'Connection string must be URL-encoded. Special characters like @ need encoding.',
},
],
docs_url:
'https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords',
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'PROPRIETARY',
],
custom_errors: [
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s", password, or database name "%(database)s" is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'The hostname "%(hostname)s" cannot be resolved.',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
},
{
regex_name: 'CONNECTION_PORT_CLOSED_REGEX',
message_template:
'Port %(port)s on hostname "%(hostname)s" refused the connection.',
error_type: 'CONNECTION_PORT_CLOSED_ERROR',
category: 'Connection',
description: 'Port closed or refused',
issue_codes: [1008],
},
{
regex_name: 'CONNECTION_HOST_DOWN_REGEX',
message_template:
'The host "%(hostname)s" might be down, and can\'t be reached on port %(port)s.',
error_type: 'CONNECTION_HOST_DOWN_ERROR',
category: 'Connection',
description: 'Host unreachable',
issue_codes: [1009],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 44,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Azure Synapse" database={databaseInfo} />

140
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx
View File

@@ -5,27 +5,151 @@ description: "ClickHouse is an open-source column-oriented database for real-tim
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"clickhouse","engine_name":"ClickHouse","module":"clickhouse","documentation":{"description":"ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets.","logo":"clickhouse.png","homepage_url":"https://clickhouse.com/","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","default_port":8123,"drivers":[{"name":"clickhouse-connect (Recommended)","pypi_package":"clickhouse-connect>=0.13.0","connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Official ClickHouse Python driver with native protocol support."},{"name":"clickhouse-sqlalchemy (Legacy)","pypi_package":"clickhouse-sqlalchemy","connection_string":"clickhouse://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Older driver using HTTP interface. Use clickhouse-connect for new deployments."}],"connection_examples":[{"description":"Altinity Cloud","connection_string":"clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=true"},{"description":"Local (no auth, no SSL)","connection_string":"clickhousedb://localhost/default"}],"install_instructions":"echo \"clickhouse-connect>=0.13.0\" >> ./docker/requirements-local.txt","compatible_databases":[{"name":"ClickHouse Cloud","description":"ClickHouse Cloud is the official fully-managed cloud service for ClickHouse. It provides automatic scaling, built-in backups, and enterprise security features.","logo":"clickhouse.png","homepage_url":"https://clickhouse.cloud/","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true","parameters":{"username":"ClickHouse Cloud username","password":"ClickHouse Cloud password","host":"Your ClickHouse Cloud hostname","database":"Database name (default)"},"docs_url":"https://clickhouse.com/docs/en/cloud"},{"name":"Altinity.Cloud","description":"Altinity.Cloud is a managed ClickHouse service providing Kubernetes-native deployments with enterprise support.","logo":"altinity.png","homepage_url":"https://altinity.cloud/","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}/{database}?secure=true","docs_url":"https://docs.altinity.com/"}]},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":61,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":false,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'clickhouse',
engine_name: 'ClickHouse',
module: 'clickhouse',
documentation: {
description:
"ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets.",
logo: 'clickhouse.png',
homepage_url: 'https://clickhouse.com/',
categories: ['ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
pypi_packages: ['clickhouse-connect>=0.13.0'],
connection_string:
'clickhousedb://{username}:{password}@{host}:{port}/{database}',
default_port: 8123,
drivers: [
{
name: 'clickhouse-connect (Recommended)',
pypi_package: 'clickhouse-connect>=0.13.0',
connection_string:
'clickhousedb://{username}:{password}@{host}:{port}/{database}',
is_recommended: true,
notes:
'Official ClickHouse Python driver with native protocol support.',
},
{
name: 'clickhouse-sqlalchemy (Legacy)',
pypi_package: 'clickhouse-sqlalchemy',
connection_string:
'clickhouse://{username}:{password}@{host}:{port}/{database}',
is_recommended: false,
notes:
'Older driver using HTTP interface. Use clickhouse-connect for new deployments.',
},
],
connection_examples: [
{
description: 'Altinity Cloud',
connection_string:
'clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=true',
},
{
description: 'Local (no auth, no SSL)',
connection_string: 'clickhousedb://localhost/default',
},
],
install_instructions:
'echo "clickhouse-connect>=0.13.0" >> ./docker/requirements-local.txt',
compatible_databases: [
{
name: 'ClickHouse Cloud',
description:
'ClickHouse Cloud is the official fully-managed cloud service for ClickHouse. It provides automatic scaling, built-in backups, and enterprise security features.',
logo: 'clickhouse.png',
homepage_url: 'https://clickhouse.cloud/',
categories: [
'ANALYTICAL_DATABASES',
'CLOUD_DATA_WAREHOUSES',
'HOSTED_OPEN_SOURCE',
],
pypi_packages: ['clickhouse-connect>=0.13.0'],
connection_string:
'clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true',
parameters: {
username: 'ClickHouse Cloud username',
password: 'ClickHouse Cloud password',
host: 'Your ClickHouse Cloud hostname',
database: 'Database name (default)',
},
docs_url: 'https://clickhouse.com/docs/en/cloud',
},
{
name: 'Altinity.Cloud',
description:
'Altinity.Cloud is a managed ClickHouse service providing Kubernetes-native deployments with enterprise support.',
logo: 'altinity.png',
homepage_url: 'https://altinity.cloud/',
categories: [
'ANALYTICAL_DATABASES',
'CLOUD_DATA_WAREHOUSES',
'HOSTED_OPEN_SOURCE',
],
pypi_packages: ['clickhouse-connect>=0.13.0'],
connection_string:
'clickhousedb://{username}:{password}@{host}/{database}?secure=true',
docs_url: 'https://docs.altinity.com/',
},
],
},
time_grains: {
SECOND: false,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 61,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: false,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="ClickHouse" database={databaseInfo} />

78
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx
View File

@@ -1,31 +1,91 @@
---
title: Cloudflare D1
sidebar_label: Cloudflare D1
description: "Cloudflare D1 is a serverless SQLite database."
description: 'Cloudflare D1 is a serverless SQLite database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"cloudflare_d1","engine_name":"Cloudflare D1","module":"d1","documentation":{"description":"Cloudflare D1 is a serverless SQLite database.","logo":"cloudflare.png","homepage_url":"https://developers.cloudflare.com/d1/","pypi_packages":["superset-engine-d1"],"connection_string":"d1://{cloudflare_account_id}:{cloudflare_api_token}@{cloudflare_d1_database_id}","notes":"No additional library needed. SQLite is bundled with Python.","categories":["CLOUD_DATA_WAREHOUSES","TRADITIONAL_RDBMS","HOSTED_OPEN_SOURCE"],"parameters":{"cloudflare_account_id":"Cloudflare account ID","cloudflare_api_token":"Cloudflare API token","cloudflare_d1_database_id":"D1 database ID"},"install_instructions":"pip install superset-engine-d1"},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":41,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'cloudflare_d1',
engine_name: 'Cloudflare D1',
module: 'd1',
documentation: {
description: 'Cloudflare D1 is a serverless SQLite database.',
logo: 'cloudflare.png',
homepage_url: 'https://developers.cloudflare.com/d1/',
pypi_packages: ['superset-engine-d1'],
connection_string:
'd1://{cloudflare_account_id}:{cloudflare_api_token}@{cloudflare_d1_database_id}',
notes: 'No additional library needed. SQLite is bundled with Python.',
categories: [
'CLOUD_DATA_WAREHOUSES',
'TRADITIONAL_RDBMS',
'HOSTED_OPEN_SOURCE',
],
parameters: {
cloudflare_account_id: 'Cloudflare account ID',
cloudflare_api_token: 'Cloudflare API token',
cloudflare_d1_database_id: 'D1 database ID',
},
install_instructions: 'pip install superset-engine-d1',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: true,
YEAR: true,
},
score: 41,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Cloudflare D1" database={databaseInfo} />

92
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx
View File

@@ -1,31 +1,105 @@
---
title: CockroachDB
sidebar_label: CockroachDB
description: "CockroachDB is a distributed SQL database built for cloud applications."
description: 'CockroachDB is a distributed SQL database built for cloud applications.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"cockroachdb","engine_name":"CockroachDB","module":"cockroachdb","documentation":{"description":"CockroachDB is a distributed SQL database built for cloud applications.","logo":"cockroachdb.png","homepage_url":"https://www.cockroachlabs.com/","pypi_packages":["psycopg2","cockroachdb"],"connection_string":"cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable","default_port":26257,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://github.com/cockroachdb/sqlalchemy-cockroachdb","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":94,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'cockroachdb',
engine_name: 'CockroachDB',
module: 'cockroachdb',
documentation: {
description:
'CockroachDB is a distributed SQL database built for cloud applications.',
logo: 'cockroachdb.png',
homepage_url: 'https://www.cockroachlabs.com/',
pypi_packages: ['psycopg2', 'cockroachdb'],
connection_string:
'cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable',
default_port: 26257,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'For localhost: localhost or 127.0.0.1. For AWS: endpoint URL',
port: 'Default 5432',
database: 'Database name',
},
notes: 'The psycopg2 library comes bundled with Superset Docker images.',
connection_examples: [
{
description: 'Basic connection',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
},
{
description: 'With SSL required',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require',
},
],
docs_url: 'https://github.com/cockroachdb/sqlalchemy-cockroachdb',
sqlalchemy_docs_url:
'https://docs.sqlalchemy.org/en/13/dialects/postgresql.html',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 94,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="CockroachDB" database={databaseInfo} />

85
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/couchbase.mdx
View File

@@ -1,31 +1,98 @@
---
title: Couchbase
sidebar_label: Couchbase
description: "Couchbase is a distributed NoSQL document database with SQL++ support."
description: 'Couchbase is a distributed NoSQL document database with SQL++ support.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"couchbase","engine_name":"Couchbase","module":"couchbase","documentation":{"description":"Couchbase is a distributed NoSQL document database with SQL++ support.","logo":"couchbase.svg","homepage_url":"https://www.couchbase.com/","categories":["SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["couchbase-sqlalchemy"],"connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","default_port":8091,"parameters":{"username":"Couchbase username","password":"Couchbase password","host":"Couchbase host or connection string for cloud","port":"Couchbase port (default 8091)","database":"Couchbase database/bucket name"},"drivers":[{"name":"couchbase-sqlalchemy","pypi_package":"couchbase-sqlalchemy","connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":false,"subqueries":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'couchbase',
engine_name: 'Couchbase',
module: 'couchbase',
documentation: {
description:
'Couchbase is a distributed NoSQL document database with SQL++ support.',
logo: 'couchbase.svg',
homepage_url: 'https://www.couchbase.com/',
categories: ['SEARCH_NOSQL', 'OPEN_SOURCE'],
pypi_packages: ['couchbase-sqlalchemy'],
connection_string:
'couchbase://{username}:{password}@{host}:{port}?ssl=true',
default_port: 8091,
parameters: {
username: 'Couchbase username',
password: 'Couchbase password',
host: 'Couchbase host or connection string for cloud',
port: 'Couchbase port (default 8091)',
database: 'Couchbase database/bucket name',
},
drivers: [
{
name: 'couchbase-sqlalchemy',
pypi_package: 'couchbase-sqlalchemy',
connection_string:
'couchbase://{username}:{password}@{host}:{port}?ssl=true',
is_recommended: true,
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: false,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 27,
max_score: 201,
joins: false,
subqueries: false,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Couchbase" database={databaseInfo} />

80
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/cratedb.mdx
View File

@@ -1,31 +1,93 @@
---
title: CrateDB
sidebar_label: CrateDB
description: "CrateDB is a distributed SQL database for machine data and IoT workloads."
description: 'CrateDB is a distributed SQL database for machine data and IoT workloads.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"cratedb","engine_name":"CrateDB","module":"crate","documentation":{"description":"CrateDB is a distributed SQL database for machine data and IoT workloads.","logo":"cratedb.svg","homepage_url":"https://cratedb.com","categories":["TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["crate","sqlalchemy-cratedb"],"connection_string":"crate://{host}:{port}","default_port":4200,"parameters":{"host":"CrateDB host","port":"CrateDB HTTP port (default 4200)"},"drivers":[{"name":"crate","pypi_package":"crate[sqlalchemy]","connection_string":"crate://{host}:{port}","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'cratedb',
engine_name: 'CrateDB',
module: 'crate',
documentation: {
description:
'CrateDB is a distributed SQL database for machine data and IoT workloads.',
logo: 'cratedb.svg',
homepage_url: 'https://cratedb.com',
categories: ['TIME_SERIES', 'OPEN_SOURCE'],
pypi_packages: ['crate', 'sqlalchemy-cratedb'],
connection_string: 'crate://{host}:{port}',
default_port: 4200,
parameters: {
host: 'CrateDB host',
port: 'CrateDB HTTP port (default 4200)',
},
drivers: [
{
name: 'crate',
pypi_package: 'crate[sqlalchemy]',
connection_string: 'crate://{host}:{port}',
is_recommended: true,
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="CrateDB" database={databaseInfo} />

80
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/databend.mdx
View File

@@ -1,31 +1,93 @@
---
title: Databend
sidebar_label: Databend
description: "Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance."
description: 'Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"databend","engine_name":"Databend","module":"databend","documentation":{"description":"Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance.","logo":"databend.png","homepage_url":"https://www.databend.com/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["databend-sqlalchemy"],"connection_string":"databend://{username}:{password}@{host}:{port}/{database}?secure=true","default_port":443,"parameters":{"username":"Database username","password":"Database password","host":"Databend host","port":"Databend port (default 443 for HTTPS)","database":"Database name"}},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":51,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":false,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'databend',
engine_name: 'Databend',
module: 'databend',
documentation: {
description:
'Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance.',
logo: 'databend.png',
homepage_url: 'https://www.databend.com/',
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'PROPRIETARY',
],
pypi_packages: ['databend-sqlalchemy'],
connection_string:
'databend://{username}:{password}@{host}:{port}/{database}?secure=true',
default_port: 443,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'Databend host',
port: 'Databend port (default 443 for HTTPS)',
database: 'Database name',
},
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 51,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: false,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Databend" database={databaseInfo} />

82
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx
View File

@@ -1,31 +1,95 @@
---
title: Databricks Interactive Cluster
sidebar_label: Databricks Interactive Cluster
description: "Apache Hive is a data warehouse infrastructure built on Hadoop."
description: 'Apache Hive is a data warehouse infrastructure built on Hadoop.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"databricks_interactive_cluster","engine_name":"Databricks Interactive Cluster","module":"databricks","documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","pypi_packages":["pyhive","pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":140,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'databricks_interactive_cluster',
engine_name: 'Databricks Interactive Cluster',
module: 'databricks',
documentation: {
description:
'Apache Hive is a data warehouse infrastructure built on Hadoop.',
logo: 'apache-hive.svg',
homepage_url: 'https://hive.apache.org/',
pypi_packages: ['pyhive', 'pyhive'],
install_instructions: 'pip install "apache-superset[presto]"',
connection_string: 'hive://hive@{hostname}:{port}/{database}',
default_port: 10000,
parameters: {
hostname: 'Presto coordinator hostname',
port: 'Presto coordinator port (default 8080)',
database: 'Catalog name',
},
drivers: [
{
name: 'PyHive',
pypi_package: 'pyhive',
connection_string: 'presto://{hostname}:{port}/{database}',
is_recommended: true,
},
],
categories: ['APACHE_PROJECTS', 'QUERY_ENGINES', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 140,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="Databricks Interactive Cluster" database={databaseInfo} />

115
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/databricks.mdx
View File

@@ -1,31 +1,128 @@
---
title: Databricks
sidebar_label: Databricks
description: "Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use "
description: 'Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use '
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"databricks","engine_name":"Databricks","module":"databricks","documentation":{"description":"Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use the Python Connector for SQL warehouses and clusters.","logo":"databricks.png","homepage_url":"https://www.databricks.com/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","HOSTED_OPEN_SOURCE"],"pypi_packages":["apache-superset[databricks]"],"install_instructions":"pip install apache-superset[databricks]","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","parameters":{"access_token":"Personal access token from Settings > User Settings","host":"Server hostname from cluster JDBC/ODBC settings","port":"Port (default 443)","http_path":"HTTP path from cluster JDBC/ODBC settings"},"drivers":[{"name":"Databricks Python Connector (Recommended)","pypi_package":"databricks-sql-connector","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","is_recommended":true,"notes":"Official Databricks connector. Best for SQL warehouses and clusters."},{"name":"Hive Connector (Interactive Clusters)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+pyhive://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"For Interactive Clusters. Requires http_path in engine parameters."},{"name":"ODBC (SQL Endpoints)","pypi_package":"pyodbc","connection_string":"databricks+pyodbc://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Requires ODBC driver. For serverless SQL warehouses."},{"name":"databricks-dbapi (Legacy)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+connector://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Legacy connector. Use Python Connector for new deployments."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":70,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'databricks',
engine_name: 'Databricks',
module: 'databricks',
documentation: {
description:
'Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use the Python Connector for SQL warehouses and clusters.',
logo: 'databricks.png',
homepage_url: 'https://www.databricks.com/',
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'HOSTED_OPEN_SOURCE',
],
pypi_packages: ['apache-superset[databricks]'],
install_instructions: 'pip install apache-superset[databricks]',
connection_string:
'databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}',
parameters: {
access_token: 'Personal access token from Settings > User Settings',
host: 'Server hostname from cluster JDBC/ODBC settings',
port: 'Port (default 443)',
http_path: 'HTTP path from cluster JDBC/ODBC settings',
},
drivers: [
{
name: 'Databricks Python Connector (Recommended)',
pypi_package: 'databricks-sql-connector',
connection_string:
'databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}',
is_recommended: true,
notes:
'Official Databricks connector. Best for SQL warehouses and clusters.',
},
{
name: 'Hive Connector (Interactive Clusters)',
pypi_package: 'databricks-dbapi[sqlalchemy]',
connection_string:
'databricks+pyhive://token:{access_token}@{host}:{port}/{database}',
is_recommended: false,
notes:
'For Interactive Clusters. Requires http_path in engine parameters.',
},
{
name: 'ODBC (SQL Endpoints)',
pypi_package: 'pyodbc',
connection_string:
'databricks+pyodbc://token:{access_token}@{host}:{port}/{database}',
is_recommended: false,
notes: 'Requires ODBC driver. For serverless SQL warehouses.',
},
{
name: 'databricks-dbapi (Legacy)',
pypi_package: 'databricks-dbapi[sqlalchemy]',
connection_string:
'databricks+connector://token:{access_token}@{host}:{port}/{database}',
is_recommended: false,
notes: 'Legacy connector. Use Python Connector for new deployments.',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 70,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Databricks" database={databaseInfo} />

168
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/denodo.mdx
View File

@@ -1,31 +1,181 @@
---
title: Denodo
sidebar_label: Denodo
description: "Denodo is a data virtualization platform for logical data management."
description: 'Denodo is a data virtualization platform for logical data management.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"denodo","engine_name":"Denodo","module":"denodo","documentation":{"description":"Denodo is a data virtualization platform for logical data management.","logo":"denodo.png","homepage_url":"https://www.denodo.com/","categories":["QUERY_ENGINES","PROPRIETARY"],"pypi_packages":["psycopg2"],"connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","default_port":9996,"parameters":{"username":"Denodo username","password":"Denodo password","host":"Denodo VDP server hostname","port":"ODBC port (default 9996)","database":"Virtual database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Uses PostgreSQL wire protocol."}],"custom_errors":[{"message_template":"Incorrect username or password.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username","password"]},{"message_template":"Please enter a password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"message_template":"Hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"message_template":"Server refused the connection: check hostname and port.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"message_template":"Unable to connect to database \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"message_template":"Unable to connect to database \"%(database)s\": database does not exist or insufficient permissions","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017],"invalid_fields":["database"]},{"message_template":"Please check your query for syntax errors at or near \"%(err)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"Column \"%(column)s\" not found in \"%(view)s\".","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"message_template":"Invalid aggregation expression.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"\"%(exp)s\" is neither an aggregation function nor appears in the GROUP BY clause.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'denodo',
engine_name: 'Denodo',
module: 'denodo',
documentation: {
description:
'Denodo is a data virtualization platform for logical data management.',
logo: 'denodo.png',
homepage_url: 'https://www.denodo.com/',
categories: ['QUERY_ENGINES', 'PROPRIETARY'],
pypi_packages: ['psycopg2'],
connection_string:
'denodo://{username}:{password}@{host}:{port}/{database}',
default_port: 9996,
parameters: {
username: 'Denodo username',
password: 'Denodo password',
host: 'Denodo VDP server hostname',
port: 'ODBC port (default 9996)',
database: 'Virtual database name',
},
drivers: [
{
name: 'psycopg2',
pypi_package: 'psycopg2',
connection_string:
'denodo://{username}:{password}@{host}:{port}/{database}',
is_recommended: true,
notes: 'Uses PostgreSQL wire protocol.',
},
],
custom_errors: [
{
message_template: 'Incorrect username or password.',
error_type: 'CONNECTION_INVALID_USERNAME_ERROR',
category: 'Authentication',
description: 'Invalid username',
issue_codes: [1012],
invalid_fields: ['username', 'password'],
},
{
message_template: 'Please enter a password.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
invalid_fields: ['password'],
},
{
message_template: 'Hostname "%(hostname)s" cannot be resolved.',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
invalid_fields: ['host'],
},
{
message_template:
'Server refused the connection: check hostname and port.',
error_type: 'CONNECTION_PORT_CLOSED_ERROR',
category: 'Connection',
description: 'Port closed or refused',
issue_codes: [1008],
invalid_fields: ['host', 'port'],
},
{
message_template: 'Unable to connect to database "%(database)s"',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
invalid_fields: ['database'],
},
{
message_template:
'Unable to connect to database "%(database)s": database does not exist or insufficient permissions',
error_type: 'CONNECTION_DATABASE_PERMISSIONS_ERROR',
category: 'Permissions',
description: 'Insufficient permissions',
issue_codes: [1017],
invalid_fields: ['database'],
},
{
message_template:
'Please check your query for syntax errors at or near "%(err)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
{
message_template: 'Column "%(column)s" not found in "%(view)s".',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
{
message_template: 'Invalid aggregation expression.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
{
message_template:
'"%(exp)s" is neither an aggregation function nor appears in the GROUP BY clause.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: false,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 27,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Denodo" database={databaseInfo} />

85
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/dremio.mdx
View File

@@ -1,31 +1,98 @@
---
title: Dremio
sidebar_label: Dremio
description: "Dremio is a data lakehouse platform for fast, self-service analytics."
description: 'Dremio is a data lakehouse platform for fast, self-service analytics.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"dremio","engine_name":"Dremio","module":"dremio","documentation":{"description":"Dremio is a data lakehouse platform for fast, self-service analytics.","logo":"dremio.png","homepage_url":"https://www.dremio.com/","categories":["QUERY_ENGINES","PROPRIETARY"],"pypi_packages":["sqlalchemy_dremio"],"connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","parameters":{"token":"Personal Access Token (PAT) or API token"},"drivers":[{"name":"Arrow Flight (Recommended)","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","is_recommended":true},{"name":"ODBC","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+pyodbc://{token}@{host}:31010/dremio","is_recommended":false,"notes":"Requires Dremio ODBC drivers installed."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'dremio',
engine_name: 'Dremio',
module: 'dremio',
documentation: {
description:
'Dremio is a data lakehouse platform for fast, self-service analytics.',
logo: 'dremio.png',
homepage_url: 'https://www.dremio.com/',
categories: ['QUERY_ENGINES', 'PROPRIETARY'],
pypi_packages: ['sqlalchemy_dremio'],
connection_string:
'dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true',
parameters: { token: 'Personal Access Token (PAT) or API token' },
drivers: [
{
name: 'Arrow Flight (Recommended)',
pypi_package: 'sqlalchemy_dremio',
connection_string:
'dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true',
is_recommended: true,
},
{
name: 'ODBC',
pypi_package: 'sqlalchemy_dremio',
connection_string: 'dremio+pyodbc://{token}@{host}:31010/dremio',
is_recommended: false,
notes: 'Requires Dremio ODBC drivers installed.',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Dremio" database={databaseInfo} />

105
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/duckdb.mdx
View File

@@ -1,31 +1,118 @@
---
title: DuckDB
sidebar_label: DuckDB
description: "DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats."
description: 'DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"duckdb","engine_name":"DuckDB","module":"duckdb","documentation":{"description":"DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats.","logo":"duckdb.png","homepage_url":"https://duckdb.org/","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["duckdb-engine"],"connection_string":"duckdb:////path/to/duck.db","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:////path/to/duck.db","is_recommended":true}],"notes":"DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.","compatible_databases":[{"name":"MotherDuck","description":"MotherDuck is a serverless cloud analytics platform built on DuckDB, offering collaborative data sharing and cloud-native scalability.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","pypi_packages":["duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","parameters":{"database":"MotherDuck database name","motherduck_token":"Service token from MotherDuck dashboard"},"notes":"Cloud-hosted DuckDB with collaboration features.","categories":["HOSTED_OPEN_SOURCE"]}],"custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'duckdb',
engine_name: 'DuckDB',
module: 'duckdb',
documentation: {
description:
'DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats.',
logo: 'duckdb.png',
homepage_url: 'https://duckdb.org/',
categories: ['ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
pypi_packages: ['duckdb-engine'],
connection_string: 'duckdb:////path/to/duck.db',
drivers: [
{
name: 'duckdb-engine',
pypi_package: 'duckdb-engine',
connection_string: 'duckdb:////path/to/duck.db',
is_recommended: true,
},
],
notes:
'DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.',
compatible_databases: [
{
name: 'MotherDuck',
description:
'MotherDuck is a serverless cloud analytics platform built on DuckDB, offering collaborative data sharing and cloud-native scalability.',
logo: 'motherduck.png',
homepage_url: 'https://motherduck.com/',
pypi_packages: ['duckdb', 'duckdb-engine'],
connection_string: 'duckdb:///md:{database}?motherduck_token={token}',
parameters: {
database: 'MotherDuck database name',
motherduck_token: 'Service token from MotherDuck dashboard',
},
notes: 'Cloud-hosted DuckDB with collaboration features.',
categories: ['HOSTED_OPEN_SOURCE'],
},
],
custom_errors: [
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template:
'We can\'t seem to resolve the column "%(column_name)s"',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 38,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="DuckDB" database={databaseInfo} />

119
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx
View File

@@ -1,31 +1,132 @@
---
title: Elasticsearch
sidebar_label: Elasticsearch
description: "Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax."
description: 'Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"elasticsearch","engine_name":"Elasticsearch","module":"elasticsearch","documentation":{"description":"Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/elasticsearch/","categories":["SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","default_port":9243,"parameters":{"user":"Elasticsearch username","password":"Elasticsearch password","host":"Elasticsearch host"},"drivers":[{"name":"Elasticsearch SQL API (Recommended)","pypi_package":"elasticsearch-dbapi","connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","is_recommended":true,"notes":"For Elastic Cloud and self-hosted Elasticsearch with SQL enabled."},{"name":"OpenDistro / OpenSearch SQL","pypi_package":"elasticsearch-dbapi","connection_string":"odelasticsearch+https://{user}:{password}@{host}:9200/","is_recommended":false,"notes":"For OpenDistro Elasticsearch or Amazon OpenSearch Service."}],"compatible_databases":[{"name":"Elastic Cloud","description":"Elastic Cloud is the official managed Elasticsearch service from Elastic. It includes Elasticsearch, Kibana, and enterprise features with automatic scaling.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/cloud/","categories":["SEARCH_NOSQL","HOSTED_OPEN_SOURCE"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{deployment}.{region}.cloud.es.io:9243/","docs_url":"https://www.elastic.co/guide/en/cloud/current/"},{"name":"Amazon OpenSearch Service","description":"Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) is a managed search and analytics service on AWS.","logo":"elasticsearch.png","homepage_url":"https://aws.amazon.com/opensearch-service/","categories":["SEARCH_NOSQL","CLOUD_AWS","HOSTED_OPEN_SOURCE"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"odelasticsearch+https://{user}:{password}@{host}:443/","docs_url":"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"score":37,"max_score":201,"joins":false,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'elasticsearch',
engine_name: 'Elasticsearch',
module: 'elasticsearch',
documentation: {
description:
'Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax.',
logo: 'elasticsearch.png',
homepage_url: 'https://www.elastic.co/elasticsearch/',
categories: ['SEARCH_NOSQL', 'OPEN_SOURCE'],
pypi_packages: ['elasticsearch-dbapi'],
connection_string: 'elasticsearch+https://{user}:{password}@{host}:9243/',
default_port: 9243,
parameters: {
user: 'Elasticsearch username',
password: 'Elasticsearch password',
host: 'Elasticsearch host',
},
drivers: [
{
name: 'Elasticsearch SQL API (Recommended)',
pypi_package: 'elasticsearch-dbapi',
connection_string:
'elasticsearch+https://{user}:{password}@{host}:9243/',
is_recommended: true,
notes:
'For Elastic Cloud and self-hosted Elasticsearch with SQL enabled.',
},
{
name: 'OpenDistro / OpenSearch SQL',
pypi_package: 'elasticsearch-dbapi',
connection_string:
'odelasticsearch+https://{user}:{password}@{host}:9200/',
is_recommended: false,
notes: 'For OpenDistro Elasticsearch or Amazon OpenSearch Service.',
},
],
compatible_databases: [
{
name: 'Elastic Cloud',
description:
'Elastic Cloud is the official managed Elasticsearch service from Elastic. It includes Elasticsearch, Kibana, and enterprise features with automatic scaling.',
logo: 'elasticsearch.png',
homepage_url: 'https://www.elastic.co/cloud/',
categories: ['SEARCH_NOSQL', 'HOSTED_OPEN_SOURCE'],
pypi_packages: ['elasticsearch-dbapi'],
connection_string:
'elasticsearch+https://{user}:{password}@{deployment}.{region}.cloud.es.io:9243/',
docs_url: 'https://www.elastic.co/guide/en/cloud/current/',
},
{
name: 'Amazon OpenSearch Service',
description:
'Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) is a managed search and analytics service on AWS.',
logo: 'elasticsearch.png',
homepage_url: 'https://aws.amazon.com/opensearch-service/',
categories: ['SEARCH_NOSQL', 'CLOUD_AWS', 'HOSTED_OPEN_SOURCE'],
pypi_packages: ['elasticsearch-dbapi'],
connection_string:
'odelasticsearch+https://{user}:{password}@{host}:443/',
docs_url:
'https://docs.aws.amazon.com/opensearch-service/latest/developerguide/',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: false,
QUARTER_YEAR: false,
YEAR: true,
},
score: 37,
max_score: 201,
joins: false,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Elasticsearch" database={databaseInfo} />

97
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/exasol.mdx
View File

@@ -1,31 +1,110 @@
---
title: Exasol
sidebar_label: Exasol
description: "Exasol is a high-performance, in-memory, MPP analytical database."
description: 'Exasol is a high-performance, in-memory, MPP analytical database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"exasol","engine_name":"Exasol","module":"exasol","documentation":{"description":"Exasol is a high-performance, in-memory, MPP analytical database.","logo":"exasol.png","homepage_url":"https://www.exasol.com/","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-exasol"],"connection_string":"exa+pyodbc://{username}:{password}@{dsn}","default_port":8563,"parameters":{"username":"Database username","password":"Database password","dsn":"DSN name configured in odbc.ini"},"drivers":[{"name":"pyodbc","pypi_package":"sqlalchemy-exasol","connection_string":"exa+pyodbc://{username}:{password}@{dsn}","is_recommended":true,"notes":"Requires ODBC driver and DSN configuration."},{"name":"turbodbc","pypi_package":"sqlalchemy-exasol[turbodbc]","connection_string":"exa+turbodbc://{username}:{password}@{dsn}","is_recommended":false,"notes":"Faster but requires additional dependencies."},{"name":"websocket","pypi_package":"sqlalchemy-exasol[websocket]","connection_string":"exa+websocket://{username}:{password}@{host}:{port}/{schema}","is_recommended":false,"notes":"Pure Python, no ODBC required."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'exasol',
engine_name: 'Exasol',
module: 'exasol',
documentation: {
description:
'Exasol is a high-performance, in-memory, MPP analytical database.',
logo: 'exasol.png',
homepage_url: 'https://www.exasol.com/',
categories: ['ANALYTICAL_DATABASES', 'PROPRIETARY'],
pypi_packages: ['sqlalchemy-exasol'],
connection_string: 'exa+pyodbc://{username}:{password}@{dsn}',
default_port: 8563,
parameters: {
username: 'Database username',
password: 'Database password',
dsn: 'DSN name configured in odbc.ini',
},
drivers: [
{
name: 'pyodbc',
pypi_package: 'sqlalchemy-exasol',
connection_string: 'exa+pyodbc://{username}:{password}@{dsn}',
is_recommended: true,
notes: 'Requires ODBC driver and DSN configuration.',
},
{
name: 'turbodbc',
pypi_package: 'sqlalchemy-exasol[turbodbc]',
connection_string: 'exa+turbodbc://{username}:{password}@{dsn}',
is_recommended: false,
notes: 'Faster but requires additional dependencies.',
},
{
name: 'websocket',
pypi_package: 'sqlalchemy-exasol[websocket]',
connection_string:
'exa+websocket://{username}:{password}@{host}:{port}/{schema}',
is_recommended: false,
notes: 'Pure Python, no ODBC required.',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Exasol" database={databaseInfo} />

76
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/firebird.mdx
View File

@@ -1,31 +1,89 @@
---
title: Firebird
sidebar_label: Firebird
description: "Firebird is an open-source relational database."
description: 'Firebird is an open-source relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"firebird","engine_name":"Firebird","module":"firebird","documentation":{"description":"Firebird is an open-source relational database.","logo":"firebird.png","homepage_url":"https://firebirdsql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-firebird"],"version_requirements":"sqlalchemy-firebird>=0.7.0,<0.8","connection_string":"firebird+fdb://{username}:{password}@{host}:{port}//{path_to_db_file}","default_port":3050,"connection_examples":[{"description":"Local database","connection_string":"firebird+fdb://SYSDBA:masterkey@192.168.86.38:3050//Library/Frameworks/Firebird.framework/Versions/A/Resources/examples/empbuild/employee.fdb"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"score":26,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'firebird',
engine_name: 'Firebird',
module: 'firebird',
documentation: {
description: 'Firebird is an open-source relational database.',
logo: 'firebird.png',
homepage_url: 'https://firebirdsql.org/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['sqlalchemy-firebird'],
version_requirements: 'sqlalchemy-firebird>=0.7.0,<0.8',
connection_string:
'firebird+fdb://{username}:{password}@{host}:{port}//{path_to_db_file}',
default_port: 3050,
connection_examples: [
{
description: 'Local database',
connection_string:
'firebird+fdb://SYSDBA:masterkey@192.168.86.38:3050//Library/Frameworks/Firebird.framework/Versions/A/Resources/examples/empbuild/employee.fdb',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: false,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: false,
QUARTER_YEAR: false,
YEAR: true,
},
score: 26,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Firebird" database={databaseInfo} />

88
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/firebolt.mdx
View File

@@ -1,31 +1,101 @@
---
title: Firebolt
sidebar_label: Firebolt
description: "Firebolt is a cloud data warehouse designed for high-performance analytics."
description: 'Firebolt is a cloud data warehouse designed for high-performance analytics.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"firebolt","engine_name":"Firebolt","module":"firebolt","documentation":{"description":"Firebolt is a cloud data warehouse designed for high-performance analytics.","logo":"firebolt.png","homepage_url":"https://www.firebolt.io/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["firebolt-sqlalchemy"],"connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","parameters":{"client_id":"Service account client ID","client_secret":"Service account client secret","database":"Database name","engine_name":"Engine name","account_name":"Account name"},"drivers":[{"name":"firebolt-sqlalchemy","pypi_package":"firebolt-sqlalchemy","connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'firebolt',
engine_name: 'Firebolt',
module: 'firebolt',
documentation: {
description:
'Firebolt is a cloud data warehouse designed for high-performance analytics.',
logo: 'firebolt.png',
homepage_url: 'https://www.firebolt.io/',
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'PROPRIETARY',
],
pypi_packages: ['firebolt-sqlalchemy'],
connection_string:
'firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}',
parameters: {
client_id: 'Service account client ID',
client_secret: 'Service account client secret',
database: 'Database name',
engine_name: 'Engine name',
account_name: 'Account name',
},
drivers: [
{
name: 'firebolt-sqlalchemy',
pypi_package: 'firebolt-sqlalchemy',
connection_string:
'firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}',
is_recommended: true,
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Firebolt" database={databaseInfo} />

141
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx
View File

@@ -1,31 +1,154 @@
---
title: Google BigQuery
sidebar_label: Google BigQuery
description: "Google BigQuery is a serverless, highly scalable data warehouse."
description: 'Google BigQuery is a serverless, highly scalable data warehouse.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"google_bigquery","engine_name":"Google BigQuery","module":"bigquery","documentation":{"description":"Google BigQuery is a serverless, highly scalable data warehouse.","logo":"google-big-query.svg","homepage_url":"https://cloud.google.com/bigquery/","categories":["CLOUD_GCP","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-bigquery"],"connection_string":"bigquery://{project_id}","install_instructions":"echo \"sqlalchemy-bigquery\" >> ./docker/requirements-local.txt","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to BigQuery datasets. For CSV/Excel uploads, also install pandas_gbq.","warnings":["Google BigQuery Python SDK is not compatible with gevent. Use a worker type other than gevent when deploying with gunicorn."],"docs_url":"https://github.com/googleapis/python-bigquery-sqlalchemy","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"BigQuery Data Viewer\", \"BigQuery Metadata Viewer\", \"BigQuery Job User\" and the following permissions are set \"bigquery.readsessions.create\", \"bigquery.readsessions.getData\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":83,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'google_bigquery',
engine_name: 'Google BigQuery',
module: 'bigquery',
documentation: {
description:
'Google BigQuery is a serverless, highly scalable data warehouse.',
logo: 'google-big-query.svg',
homepage_url: 'https://cloud.google.com/bigquery/',
categories: ['CLOUD_GCP', 'ANALYTICAL_DATABASES', 'PROPRIETARY'],
pypi_packages: ['sqlalchemy-bigquery'],
connection_string: 'bigquery://{project_id}',
install_instructions:
'echo "sqlalchemy-bigquery" >> ./docker/requirements-local.txt',
authentication_methods: [
{
name: 'Service Account JSON',
description:
'Upload service account credentials JSON or paste in Secure Extra',
secure_extra: {
credentials_info: {
type: 'service_account',
project_id: '...',
private_key_id: '...',
private_key: '...',
client_email: '...',
client_id: '...',
auth_uri: '...',
token_uri: '...',
},
},
},
],
notes:
'Create a Service Account via GCP console with access to BigQuery datasets. For CSV/Excel uploads, also install pandas_gbq.',
warnings: [
'Google BigQuery Python SDK is not compatible with gevent. Use a worker type other than gevent when deploying with gunicorn.',
],
docs_url: 'https://github.com/googleapis/python-bigquery-sqlalchemy',
custom_errors: [
{
regex_name: 'CONNECTION_DATABASE_PERMISSIONS_REGEX',
message_template:
'Unable to connect. Verify that the following roles are set on the service account: "BigQuery Data Viewer", "BigQuery Metadata Viewer", "BigQuery Job User" and the following permissions are set "bigquery.readsessions.create", "bigquery.readsessions.getData"',
error_type: 'CONNECTION_DATABASE_PERMISSIONS_ERROR',
category: 'Permissions',
description: 'Insufficient permissions',
issue_codes: [1017],
},
{
regex_name: 'TABLE_DOES_NOT_EXIST_REGEX',
message_template:
'The table "%(table)s" does not exist. A valid table must be used to run this query.',
error_type: 'TABLE_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Table not found',
issue_codes: [1003, 1005],
},
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template:
'We can\'t seem to resolve column "%(column)s" at line %(location)s.',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
{
regex_name: 'SCHEMA_DOES_NOT_EXIST_REGEX',
message_template:
'The schema "%(schema)s" does not exist. A valid schema must be used to run this query.',
error_type: 'SCHEMA_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Schema not found',
issue_codes: [1003, 1016],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors at or near "%(syntax_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 83,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Google BigQuery" database={databaseInfo} />

136
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx
View File

@@ -1,31 +1,149 @@
---
title: Google Datastore
sidebar_label: Google Datastore
description: "Google Cloud Datastore is a highly scalable NoSQL database for your applications."
description: 'Google Cloud Datastore is a highly scalable NoSQL database for your applications.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"google_datastore","engine_name":"Google Datastore","module":"datastore","documentation":{"description":"Google Cloud Datastore is a highly scalable NoSQL database for your applications.","logo":"datastore.png","homepage_url":"https://cloud.google.com/datastore/","categories":["CLOUD_GCP","SEARCH_NOSQL","PROPRIETARY"],"pypi_packages":["python-datastore-sqlalchemy"],"connection_string":"datastore://{project_id}/?database={database_id}","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to datastore datasets.","docs_url":"https://github.com/splasky/Python-datastore-sqlalchemy","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"Cloud Datastore Viewer\", \"Cloud Datastore User\", \"Cloud Datastore Creator\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":73,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'google_datastore',
engine_name: 'Google Datastore',
module: 'datastore',
documentation: {
description:
'Google Cloud Datastore is a highly scalable NoSQL database for your applications.',
logo: 'datastore.png',
homepage_url: 'https://cloud.google.com/datastore/',
categories: ['CLOUD_GCP', 'SEARCH_NOSQL', 'PROPRIETARY'],
pypi_packages: ['python-datastore-sqlalchemy'],
connection_string: 'datastore://{project_id}/?database={database_id}',
authentication_methods: [
{
name: 'Service Account JSON',
description:
'Upload service account credentials JSON or paste in Secure Extra',
secure_extra: {
credentials_info: {
type: 'service_account',
project_id: '...',
private_key_id: '...',
private_key: '...',
client_email: '...',
client_id: '...',
auth_uri: '...',
token_uri: '...',
},
},
},
],
notes:
'Create a Service Account via GCP console with access to datastore datasets.',
docs_url: 'https://github.com/splasky/Python-datastore-sqlalchemy',
custom_errors: [
{
regex_name: 'CONNECTION_DATABASE_PERMISSIONS_REGEX',
message_template:
'Unable to connect. Verify that the following roles are set on the service account: "Cloud Datastore Viewer", "Cloud Datastore User", "Cloud Datastore Creator"',
error_type: 'CONNECTION_DATABASE_PERMISSIONS_ERROR',
category: 'Permissions',
description: 'Insufficient permissions',
issue_codes: [1017],
},
{
regex_name: 'TABLE_DOES_NOT_EXIST_REGEX',
message_template:
'The table "%(table)s" does not exist. A valid table must be used to run this query.',
error_type: 'TABLE_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Table not found',
issue_codes: [1003, 1005],
},
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template:
'We can\'t seem to resolve column "%(column)s" at line %(location)s.',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
{
regex_name: 'SCHEMA_DOES_NOT_EXIST_REGEX',
message_template:
'The schema "%(schema)s" does not exist. A valid schema must be used to run this query.',
error_type: 'SCHEMA_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Schema not found',
issue_codes: [1003, 1016],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors at or near "%(syntax_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 73,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Google Datastore" database={databaseInfo} />

81
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx
View File

@@ -1,31 +1,94 @@
---
title: Google Sheets
sidebar_label: Google Sheets
description: "Google Sheets allows querying spreadsheets as SQL tables via shillelagh."
description: 'Google Sheets allows querying spreadsheets as SQL tables via shillelagh.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"google_sheets","engine_name":"Google Sheets","module":"gsheets","documentation":{"description":"Google Sheets allows querying spreadsheets as SQL tables via shillelagh.","logo":"google-sheets.svg","homepage_url":"https://www.google.com/sheets/about/","pypi_packages":["shillelagh[gsheetsapi]","shillelagh[gsheetsapi]"],"connection_string":"gsheets://","notes":"Requires Google service account credentials or OAuth2 authentication. See docs for setup instructions.","categories":["CLOUD_GCP","HOSTED_OPEN_SOURCE"],"install_instructions":"pip install \"apache-superset[gsheets]\"","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":61,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'google_sheets',
engine_name: 'Google Sheets',
module: 'gsheets',
documentation: {
description:
'Google Sheets allows querying spreadsheets as SQL tables via shillelagh.',
logo: 'google-sheets.svg',
homepage_url: 'https://www.google.com/sheets/about/',
pypi_packages: ['shillelagh[gsheetsapi]', 'shillelagh[gsheetsapi]'],
connection_string: 'gsheets://',
notes:
'Requires Google service account credentials or OAuth2 authentication. See docs for setup instructions.',
categories: ['CLOUD_GCP', 'HOSTED_OPEN_SOURCE'],
install_instructions: 'pip install "apache-superset[gsheets]"',
custom_errors: [
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors near "%(server_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: true,
YEAR: true,
},
score: 61,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="Google Sheets" database={databaseInfo} />

92
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/greenplum.mdx
View File

@@ -1,31 +1,105 @@
---
title: Greenplum
sidebar_label: Greenplum
description: "VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL."
description: 'VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"greenplum","engine_name":"Greenplum","module":"greenplum","documentation":{"description":"VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL.","logo":"greenplum.png","homepage_url":"https://greenplum.org/","pypi_packages":["psycopg2","sqlalchemy-greenplum","psycopg2"],"connection_string":"greenplum://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"Greenplum coordinator host","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://docs.vmware.com/en/VMware-Greenplum/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":94,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'greenplum',
engine_name: 'Greenplum',
module: 'greenplum',
documentation: {
description:
'VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL.',
logo: 'greenplum.png',
homepage_url: 'https://greenplum.org/',
pypi_packages: ['psycopg2', 'sqlalchemy-greenplum', 'psycopg2'],
connection_string:
'greenplum://{username}:{password}@{host}:{port}/{database}',
default_port: 5432,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'Greenplum coordinator host',
port: 'Default 5432',
database: 'Database name',
},
notes: 'The psycopg2 library comes bundled with Superset Docker images.',
connection_examples: [
{
description: 'Basic connection',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
},
{
description: 'With SSL required',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require',
},
],
docs_url: 'https://docs.vmware.com/en/VMware-Greenplum/',
sqlalchemy_docs_url:
'https://docs.sqlalchemy.org/en/13/dialects/postgresql.html',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 94,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Greenplum" database={databaseInfo} />

81
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/hologres.mdx
View File

@@ -1,31 +1,94 @@
---
title: Hologres
sidebar_label: Hologres
description: "Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11."
description: 'Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"hologres","engine_name":"Hologres","module":"hologres","documentation":{"description":"Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"default_port":80,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset."},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":34,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'hologres',
engine_name: 'Hologres',
module: 'hologres',
documentation: {
description:
'Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11.',
logo: 'hologres.png',
homepage_url: 'https://www.alibabacloud.com/product/hologres',
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'PROPRIETARY',
],
pypi_packages: ['psycopg2'],
connection_string:
'postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}',
parameters: {
username: 'AccessKey ID of your Alibaba Cloud account',
password: 'AccessKey secret of your Alibaba Cloud account',
host: 'Public endpoint of the Hologres instance',
port: 'Port number of the Hologres instance',
database: 'Name of the Hologres database',
},
default_port: 80,
notes: 'Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 34,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Hologres" database={databaseInfo} />

86
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx
View File

@@ -1,31 +1,99 @@
---
title: IBM Db2 for i
sidebar_label: IBM Db2 for i
description: "IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms."
description: 'IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"ibm_db2_for_i","engine_name":"IBM Db2 for i","module":"ibmi","documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'ibm_db2_for_i',
engine_name: 'IBM Db2 for i',
module: 'ibmi',
documentation: {
description:
'IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.',
logo: 'ibm-db2.svg',
homepage_url: 'https://www.ibm.com/db2',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['ibm_db_sa'],
connection_string:
'db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}',
default_port: 50000,
drivers: [
{
name: 'ibm_db_sa (with LIMIT)',
connection_string:
'db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}',
is_recommended: true,
},
{
name: 'ibm_db_sa (without LIMIT syntax)',
connection_string:
'ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}',
is_recommended: false,
notes:
'Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab.',
},
],
docs_url: 'https://github.com/ibmdb/python-ibmdbsa',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 38,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="IBM Db2 for i" database={databaseInfo} />

105
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx
View File

@@ -1,31 +1,118 @@
---
title: IBM Db2
sidebar_label: IBM Db2
description: "IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms."
description: 'IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"ibm_db2","engine_name":"IBM Db2","module":"db2","documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"compatible_databases":[{"name":"IBM Db2 for i (AS/400)","description":"Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/products/db2-for-i","pypi_packages":["sqlalchemy-ibmi"],"connection_string":"ibmi://{username}:{password}@{host}/{database}","parameters":{"username":"IBM i username","password":"IBM i password","host":"IBM i system host","database":"Library/schema name"},"docs_url":"https://github.com/IBM/sqlalchemy-ibmi","categories":["PROPRIETARY"]}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'ibm_db2',
engine_name: 'IBM Db2',
module: 'db2',
documentation: {
description:
'IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.',
logo: 'ibm-db2.svg',
homepage_url: 'https://www.ibm.com/db2',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['ibm_db_sa'],
connection_string:
'db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}',
default_port: 50000,
drivers: [
{
name: 'ibm_db_sa (with LIMIT)',
connection_string:
'db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}',
is_recommended: true,
},
{
name: 'ibm_db_sa (without LIMIT syntax)',
connection_string:
'ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}',
is_recommended: false,
notes:
'Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab.',
},
],
compatible_databases: [
{
name: 'IBM Db2 for i (AS/400)',
description:
'Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.',
logo: 'ibm-db2.svg',
homepage_url: 'https://www.ibm.com/products/db2-for-i',
pypi_packages: ['sqlalchemy-ibmi'],
connection_string: 'ibmi://{username}:{password}@{host}/{database}',
parameters: {
username: 'IBM i username',
password: 'IBM i password',
host: 'IBM i system host',
database: 'Library/schema name',
},
docs_url: 'https://github.com/IBM/sqlalchemy-ibmi',
categories: ['PROPRIETARY'],
},
],
docs_url: 'https://github.com/ibmdb/python-ibmdbsa',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 38,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="IBM Db2" database={databaseInfo} />

69
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx
View File

@@ -1,31 +1,82 @@
---
title: IBM Netezza Performance Server
sidebar_label: IBM Netezza Performance Server
description: "IBM Netezza Performance Server is a data warehouse appliance."
description: 'IBM Netezza Performance Server is a data warehouse appliance.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"ibm_netezza_performance_server","engine_name":"IBM Netezza Performance Server","module":"netezza","documentation":{"description":"IBM Netezza Performance Server is a data warehouse appliance.","logo":"netezza.png","homepage_url":"https://www.ibm.com/products/netezza","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["nzalchemy"],"connection_string":"netezza+nzpy://{username}:{password}@{hostname}:{port}/{database}","default_port":5480},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'ibm_netezza_performance_server',
engine_name: 'IBM Netezza Performance Server',
module: 'netezza',
documentation: {
description:
'IBM Netezza Performance Server is a data warehouse appliance.',
logo: 'netezza.png',
homepage_url: 'https://www.ibm.com/products/netezza',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['nzalchemy'],
connection_string:
'netezza+nzpy://{username}:{password}@{hostname}:{port}/{database}',
default_port: 5480,
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="IBM Netezza Performance Server" database={databaseInfo} />

98
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/mariadb.mdx
View File

@@ -1,31 +1,111 @@
---
title: MariaDB
sidebar_label: MariaDB
description: "MariaDB is a community-developed fork of MySQL."
description: 'MariaDB is a community-developed fork of MySQL.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"mariadb","engine_name":"MariaDB","module":"mariadb","documentation":{"description":"MariaDB is a community-developed fork of MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient","mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"notes":"Uses the MySQL driver. Fully compatible with MySQL connector."},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'mariadb',
engine_name: 'MariaDB',
module: 'mariadb',
documentation: {
description: 'MariaDB is a community-developed fork of MySQL.',
logo: 'mariadb.png',
homepage_url: 'https://mariadb.org/',
pypi_packages: ['mysqlclient', 'mysqlclient'],
connection_string: 'mysql://{username}:{password}@{host}/{database}',
default_port: 3306,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'localhost, 127.0.0.1, IP address, or hostname',
database: 'Database name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
],
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
notes: 'Uses the MySQL driver. Fully compatible with MySQL connector.',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 59,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="MariaDB" database={databaseInfo} />

126
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx
View File

@@ -1,31 +1,139 @@
---
title: Microsoft SQL Server
sidebar_label: Microsoft SQL Server
description: "Microsoft SQL Server is a relational database management system."
description: 'Microsoft SQL Server is a relational database management system.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"microsoft_sql_server","engine_name":"Microsoft SQL Server","module":"mssql","documentation":{"description":"Microsoft SQL Server is a relational database management system.","logo":"msql.png","homepage_url":"https://www.microsoft.com/en-us/sql-server","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["pymssql"],"connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":44,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'microsoft_sql_server',
engine_name: 'Microsoft SQL Server',
module: 'mssql',
documentation: {
description:
'Microsoft SQL Server is a relational database management system.',
logo: 'msql.png',
homepage_url: 'https://www.microsoft.com/en-us/sql-server',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['pymssql'],
connection_string:
'mssql+pymssql://{username}:{password}@{host}:{port}/{database}',
default_port: 1433,
drivers: [
{
name: 'pymssql',
pypi_package: 'pymssql',
connection_string:
'mssql+pymssql://{username}:{password}@{host}:{port}/{database}',
is_recommended: true,
},
{
name: 'pyodbc',
pypi_package: 'pyodbc',
connection_string:
'mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30',
is_recommended: false,
notes:
'Connection string must be URL-encoded. Special characters like @ need encoding.',
},
],
docs_url:
'https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords',
custom_errors: [
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s", password, or database name "%(database)s" is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'The hostname "%(hostname)s" cannot be resolved.',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
},
{
regex_name: 'CONNECTION_PORT_CLOSED_REGEX',
message_template:
'Port %(port)s on hostname "%(hostname)s" refused the connection.',
error_type: 'CONNECTION_PORT_CLOSED_ERROR',
category: 'Connection',
description: 'Port closed or refused',
issue_codes: [1008],
},
{
regex_name: 'CONNECTION_HOST_DOWN_REGEX',
message_template:
'The host "%(hostname)s" might be down, and can\'t be reached on port %(port)s.',
error_type: 'CONNECTION_HOST_DOWN_ERROR',
category: 'Connection',
description: 'Host unreachable',
issue_codes: [1009],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 44,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Microsoft SQL Server" database={databaseInfo} />

77
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/monetdb.mdx
View File

@@ -1,31 +1,90 @@
---
title: MonetDB
sidebar_label: MonetDB
description: "MonetDB is an open-source column-oriented relational database for high-performance analytics."
description: 'MonetDB is an open-source column-oriented relational database for high-performance analytics.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"monetdb","engine_name":"MonetDB","module":"monetdb","documentation":{"description":"MonetDB is an open-source column-oriented relational database for high-performance analytics.","logo":"monet-db.png","homepage_url":"https://www.monetdb.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-monetdb","pymonetdb"],"connection_string":"monetdb://{username}:{password}@{host}:{port}/{database}","default_port":50000,"parameters":{"username":"Database username (default: monetdb)","password":"Database password (default: monetdb)","host":"MonetDB server host","port":"Default 50000","database":"Database name"},"docs_url":"https://www.monetdb.org/documentation/"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"score":26,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'monetdb',
engine_name: 'MonetDB',
module: 'monetdb',
documentation: {
description:
'MonetDB is an open-source column-oriented relational database for high-performance analytics.',
logo: 'monet-db.png',
homepage_url: 'https://www.monetdb.org/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['sqlalchemy-monetdb', 'pymonetdb'],
connection_string:
'monetdb://{username}:{password}@{host}:{port}/{database}',
default_port: 50000,
parameters: {
username: 'Database username (default: monetdb)',
password: 'Database password (default: monetdb)',
host: 'MonetDB server host',
port: 'Default 50000',
database: 'Database name',
},
docs_url: 'https://www.monetdb.org/documentation/',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: false,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: false,
QUARTER_YEAR: false,
YEAR: true,
},
score: 26,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="MonetDB" database={databaseInfo} />

94
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/mongodb.mdx
View File

@@ -1,31 +1,107 @@
---
title: MongoDB
sidebar_label: MongoDB
description: "MongoDB is a document-oriented, operational NoSQL database."
description: 'MongoDB is a document-oriented, operational NoSQL database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"mongodb","engine_name":"MongoDB","module":"mongodb","documentation":{"description":"MongoDB is a document-oriented, operational NoSQL database.","logo":"mongodb.png","homepage_url":"https://www.mongodb.com/","categories":["SEARCH_NOSQL","PROPRIETARY"],"pypi_packages":["pymongosql"],"connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","parameters":{"username":"Username for MongoDB","password":"Password for MongoDB","host":"MongoDB host","port":"MongoDB port","database":"Database name"},"drivers":[{"name":"MongoDB Atlas Cloud","pypi_package":"pymongosql","connection_string":"mongodb+srv://{username}:{password}@{host}/{database}?mode=superset","notes":"For MongoDB Atlas cloud service.","is_recommended":true},{"name":"MongoDB Cluster","pypi_package":"pymongosql","connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","is_recommended":false,"notes":"For self-hosted MongoDB instances."}],"notes":"Uses PartiQL for SQL queries. Requires mode=superset parameter.","docs_url":"https://github.com/passren/PyMongoSQL"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":32,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'mongodb',
engine_name: 'MongoDB',
module: 'mongodb',
documentation: {
description: 'MongoDB is a document-oriented, operational NoSQL database.',
logo: 'mongodb.png',
homepage_url: 'https://www.mongodb.com/',
categories: ['SEARCH_NOSQL', 'PROPRIETARY'],
pypi_packages: ['pymongosql'],
connection_string:
'mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset',
parameters: {
username: 'Username for MongoDB',
password: 'Password for MongoDB',
host: 'MongoDB host',
port: 'MongoDB port',
database: 'Database name',
},
drivers: [
{
name: 'MongoDB Atlas Cloud',
pypi_package: 'pymongosql',
connection_string:
'mongodb+srv://{username}:{password}@{host}/{database}?mode=superset',
notes: 'For MongoDB Atlas cloud service.',
is_recommended: true,
},
{
name: 'MongoDB Cluster',
pypi_package: 'pymongosql',
connection_string:
'mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset',
is_recommended: false,
notes: 'For self-hosted MongoDB instances.',
},
],
notes: 'Uses PartiQL for SQL queries. Requires mode=superset parameter.',
docs_url: 'https://github.com/passren/PyMongoSQL',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 32,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="MongoDB" database={databaseInfo} />

103
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/motherduck.mdx
View File

@@ -1,31 +1,116 @@
---
title: MotherDuck
sidebar_label: MotherDuck
description: "MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration."
description: 'MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"motherduck","engine_name":"MotherDuck","module":"duckdb","documentation":{"description":"MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","pypi_packages":["duckdb-engine","duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:////path/to/duck.db","is_recommended":true},{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:///md:{database}?motherduck_token={token}","is_recommended":true}],"notes":"DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"parameters":{"database":"MotherDuck database name","token":"Service token from MotherDuck dashboard"},"docs_url":"https://motherduck.com/docs/getting-started/","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":58,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'motherduck',
engine_name: 'MotherDuck',
module: 'duckdb',
documentation: {
description:
'MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration.',
logo: 'motherduck.png',
homepage_url: 'https://motherduck.com/',
pypi_packages: ['duckdb-engine', 'duckdb', 'duckdb-engine'],
connection_string: 'duckdb:///md:{database}?motherduck_token={token}',
drivers: [
{
name: 'duckdb-engine',
pypi_package: 'duckdb-engine',
connection_string: 'duckdb:////path/to/duck.db',
is_recommended: true,
},
{
name: 'duckdb-engine',
pypi_package: 'duckdb-engine',
connection_string: 'duckdb:///md:{database}?motherduck_token={token}',
is_recommended: true,
},
],
notes:
'DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.',
categories: [
'ANALYTICAL_DATABASES',
'CLOUD_DATA_WAREHOUSES',
'HOSTED_OPEN_SOURCE',
],
parameters: {
database: 'MotherDuck database name',
token: 'Service token from MotherDuck dashboard',
},
docs_url: 'https://motherduck.com/docs/getting-started/',
custom_errors: [
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template:
'We can\'t seem to resolve the column "%(column_name)s"',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 58,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="MotherDuck" database={databaseInfo} />

180
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/mysql.mdx
View File

@@ -1,31 +1,193 @@
---
title: MySQL
sidebar_label: MySQL
description: "MySQL is a popular open-source relational database."
description: 'MySQL is a popular open-source relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"mysql","engine_name":"MySQL","module":"mysql","documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["OPEN_SOURCE"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}&region_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["CLOUD_AWS","HOSTED_OPEN_SOURCE"]}],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown MySQL server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'mysql',
engine_name: 'MySQL',
module: 'mysql',
documentation: {
description: 'MySQL is a popular open-source relational database.',
logo: 'mysql.png',
homepage_url: 'https://www.mysql.com/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['mysqlclient'],
connection_string: 'mysql://{username}:{password}@{host}/{database}',
default_port: 3306,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'localhost, 127.0.0.1, IP address, or hostname',
database: 'Database name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
],
compatible_databases: [
{
name: 'MariaDB',
description:
'MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.',
logo: 'mariadb.png',
homepage_url: 'https://mariadb.org/',
pypi_packages: ['mysqlclient'],
connection_string:
'mysql://{username}:{password}@{host}:{port}/{database}',
categories: ['OPEN_SOURCE'],
},
{
name: 'Amazon Aurora MySQL',
description:
'Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.',
logo: 'aws-aurora.jpg',
homepage_url: 'https://aws.amazon.com/rds/aurora/',
pypi_packages: ['sqlalchemy-aurora-data-api'],
connection_string:
'mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}&region_name={region_name}',
parameters: {
aws_access_id: 'AWS Access Key ID',
aws_secret_access_key: 'AWS Secret Access Key',
database_name: 'Database name',
aurora_cluster_arn: 'Aurora cluster ARN',
secret_arn: 'Secrets Manager ARN for credentials',
region_name: 'AWS region (e.g., us-east-1)',
},
notes:
'Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.',
categories: ['CLOUD_AWS', 'HOSTED_OPEN_SOURCE'],
},
],
custom_errors: [
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s" or the password is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
invalid_fields: ['username', 'password'],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'Unknown MySQL server host "%(hostname)s".',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
invalid_fields: ['host'],
},
{
regex_name: 'CONNECTION_HOST_DOWN_REGEX',
message_template:
'The host "%(hostname)s" might be down and can\'t be reached.',
error_type: 'CONNECTION_HOST_DOWN_ERROR',
category: 'Connection',
description: 'Host unreachable',
issue_codes: [1009],
invalid_fields: ['host', 'port'],
},
{
regex_name: 'CONNECTION_UNKNOWN_DATABASE_REGEX',
message_template: 'Unable to connect to database "%(database)s".',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
invalid_fields: ['database'],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors near "%(server_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 59,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="MySQL" database={databaseInfo} />

147
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx
View File

@@ -1,31 +1,160 @@
---
title: OceanBase
sidebar_label: OceanBase
description: "OceanBase is a distributed relational database."
description: 'OceanBase is a distributed relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"oceanbase","engine_name":"OceanBase","module":"oceanbase","documentation":{"description":"OceanBase is a distributed relational database.","logo":"oceanbase.svg","homepage_url":"https://www.oceanbase.com/","pypi_packages":["mysqlclient","oceanbase_py"],"connection_string":"oceanbase://{username}:{password}@{host}:{port}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown OceanBase server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'oceanbase',
engine_name: 'OceanBase',
module: 'oceanbase',
documentation: {
description: 'OceanBase is a distributed relational database.',
logo: 'oceanbase.svg',
homepage_url: 'https://www.oceanbase.com/',
pypi_packages: ['mysqlclient', 'oceanbase_py'],
connection_string:
'oceanbase://{username}:{password}@{host}:{port}/{database}',
default_port: 3306,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'localhost, 127.0.0.1, IP address, or hostname',
database: 'Database name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
],
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
custom_errors: [
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s" or the password is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
invalid_fields: ['username', 'password'],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'Unknown OceanBase server host "%(hostname)s".',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
invalid_fields: ['host'],
},
{
regex_name: 'CONNECTION_HOST_DOWN_REGEX',
message_template:
'The host "%(hostname)s" might be down and can\'t be reached.',
error_type: 'CONNECTION_HOST_DOWN_ERROR',
category: 'Connection',
description: 'Host unreachable',
issue_codes: [1009],
invalid_fields: ['host', 'port'],
},
{
regex_name: 'CONNECTION_UNKNOWN_DATABASE_REGEX',
message_template: 'Unable to connect to database "%(database)s".',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
invalid_fields: ['database'],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors near "%(server_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 59,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="OceanBase" database={databaseInfo} />

140
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/ocient.mdx
View File

@@ -1,31 +1,153 @@
---
title: Ocient
sidebar_label: Ocient
description: "Ocient is a hyperscale data analytics database."
description: 'Ocient is a hyperscale data analytics database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"ocient","engine_name":"Ocient","module":"ocient","documentation":{"description":"Ocient is a hyperscale data analytics database.","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-ocient"],"connection_string":"ocient://{username}:{password}@{host}:{port}/{database}","install_instructions":"pip install sqlalchemy-ocient","custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The user/password combination is not valid (Incorrect password for user).","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Could not connect to database: \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Could not resolve hostname: \"%(host)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_INVALID_PORT_ERROR","message_template":"Port out of range 0-65535","error_type":"CONNECTION_INVALID_PORT_ERROR"},{"regex_name":"INVALID_CONNECTION_STRING_REGEX","message_template":"Invalid Connection String: Expecting String of the form 'ocient://user:pass@host:port/database'.","error_type":"GENERIC_DB_ENGINE_ERROR","category":"General","description":"Database engine error","issue_codes":[1002]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Syntax Error: %(qualifier)s input \"%(input)s\" expecting \"%(expected)s","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"Table or View \"%(table)s\" does not exist.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"Invalid reference to column: \"%(column)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":true,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'ocient',
engine_name: 'Ocient',
module: 'ocient',
documentation: {
description: 'Ocient is a hyperscale data analytics database.',
categories: ['ANALYTICAL_DATABASES', 'PROPRIETARY'],
pypi_packages: ['sqlalchemy-ocient'],
connection_string:
'ocient://{username}:{password}@{host}:{port}/{database}',
install_instructions: 'pip install sqlalchemy-ocient',
custom_errors: [
{
regex_name: 'CONNECTION_INVALID_USERNAME_REGEX',
message_template: 'The username "%(username)s" does not exist.',
error_type: 'CONNECTION_INVALID_USERNAME_ERROR',
category: 'Authentication',
description: 'Invalid username',
issue_codes: [1012],
},
{
regex_name: 'CONNECTION_INVALID_PASSWORD_REGEX',
message_template:
'The user/password combination is not valid (Incorrect password for user).',
error_type: 'CONNECTION_INVALID_PASSWORD_ERROR',
category: 'Authentication',
description: 'Invalid password',
issue_codes: [1013],
},
{
regex_name: 'CONNECTION_UNKNOWN_DATABASE_REGEX',
message_template: 'Could not connect to database: "%(database)s"',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'Could not resolve hostname: "%(host)s".',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
},
{
regex_name: 'CONNECTION_INVALID_PORT_ERROR',
message_template: 'Port out of range 0-65535',
error_type: 'CONNECTION_INVALID_PORT_ERROR',
},
{
regex_name: 'INVALID_CONNECTION_STRING_REGEX',
message_template:
"Invalid Connection String: Expecting String of the form 'ocient://user:pass@host:port/database'.",
error_type: 'GENERIC_DB_ENGINE_ERROR',
category: 'General',
description: 'Database engine error',
issue_codes: [1002],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Syntax Error: %(qualifier)s input "%(input)s" expecting "%(expected)s',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
{
regex_name: 'TABLE_DOES_NOT_EXIST_REGEX',
message_template: 'Table or View "%(table)s" does not exist.',
error_type: 'TABLE_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Table not found',
issue_codes: [1003, 1005],
},
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template: 'Invalid reference to column: "%(column)s"',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: false,
QUARTER_YEAR: true,
YEAR: true,
},
score: 38,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Ocient" database={databaseInfo} />

70
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/oracle.mdx
View File

@@ -1,31 +1,83 @@
---
title: Oracle
sidebar_label: Oracle
description: "Oracle Database is a multi-model database management system."
description: 'Oracle Database is a multi-model database management system.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"oracle","engine_name":"Oracle","module":"oracle","documentation":{"description":"Oracle Database is a multi-model database management system.","logo":"oraclelogo.png","homepage_url":"https://www.oracle.com/database/","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["oracledb"],"connection_string":"oracle://{username}:{password}@{hostname}:{port}","default_port":1521,"notes":"Previously used cx_Oracle, now uses oracledb.","docs_url":"https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'oracle',
engine_name: 'Oracle',
module: 'oracle',
documentation: {
description: 'Oracle Database is a multi-model database management system.',
logo: 'oraclelogo.png',
homepage_url: 'https://www.oracle.com/database/',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['oracledb'],
connection_string: 'oracle://{username}:{password}@{hostname}:{port}',
default_port: 1521,
notes: 'Previously used cx_Oracle, now uses oracledb.',
docs_url:
'https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Oracle" database={databaseInfo} />

76
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/parseable.mdx
View File

@@ -1,31 +1,89 @@
---
title: Parseable
sidebar_label: Parseable
description: "Parseable is a distributed log analytics database with SQL-like query interface."
description: 'Parseable is a distributed log analytics database with SQL-like query interface.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"parseable","engine_name":"Parseable","module":"parseable","documentation":{"description":"Parseable is a distributed log analytics database with SQL-like query interface.","categories":["SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-parseable"],"connection_string":"parseable://{username}:{password}@{hostname}:{port}/{stream_name}","connection_examples":[{"description":"Example connection","connection_string":"parseable://admin:admin@demo.parseable.com:443/ingress-nginx"}],"notes":"Stream name in URI represents the Parseable logstream to query. Supports HTTP (80) and HTTPS (443).","docs_url":"https://www.parseable.io"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'parseable',
engine_name: 'Parseable',
module: 'parseable',
documentation: {
description:
'Parseable is a distributed log analytics database with SQL-like query interface.',
categories: ['SEARCH_NOSQL', 'OPEN_SOURCE'],
pypi_packages: ['sqlalchemy-parseable'],
connection_string:
'parseable://{username}:{password}@{hostname}:{port}/{stream_name}',
connection_examples: [
{
description: 'Example connection',
connection_string:
'parseable://admin:admin@demo.parseable.com:443/ingress-nginx',
},
],
notes:
'Stream name in URI represents the Parseable logstream to query. Supports HTTP (80) and HTTPS (443).',
docs_url: 'https://www.parseable.io',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 28,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Parseable" database={databaseInfo} />

322
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/postgresql.mdx
View File

File diff suppressed because one or more lines are too long

154
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/presto.mdx
View File

@@ -1,31 +1,167 @@
---
title: Presto
sidebar_label: Presto
description: "Presto is a distributed SQL query engine for big data."
description: 'Presto is a distributed SQL query engine for big data.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"presto","engine_name":"Presto","module":"presto","documentation":{"description":"Presto is a distributed SQL query engine for big data.","logo":"presto-og.png","homepage_url":"https://prestodb.io/","categories":["QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"presto://{hostname}:{port}/{database}","default_port":8080,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table_name)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema_name)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_ERROR","message_template":"Unable to connect to catalog named \"%(catalog_name)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":159,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":true,"user_impersonation":true};
export const databaseInfo = {
engine: 'presto',
engine_name: 'Presto',
module: 'presto',
documentation: {
description: 'Presto is a distributed SQL query engine for big data.',
logo: 'presto-og.png',
homepage_url: 'https://prestodb.io/',
categories: ['QUERY_ENGINES', 'OPEN_SOURCE'],
pypi_packages: ['pyhive'],
install_instructions: 'pip install "apache-superset[presto]"',
connection_string: 'presto://{hostname}:{port}/{database}',
default_port: 8080,
parameters: {
hostname: 'Presto coordinator hostname',
port: 'Presto coordinator port (default 8080)',
database: 'Catalog name',
},
drivers: [
{
name: 'PyHive',
pypi_package: 'pyhive',
connection_string: 'presto://{hostname}:{port}/{database}',
is_recommended: true,
},
],
custom_errors: [
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template:
'We can\'t seem to resolve the column "%(column_name)s" at line %(location)s.',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
{
regex_name: 'TABLE_DOES_NOT_EXIST_REGEX',
message_template:
'The table "%(table_name)s" does not exist. A valid table must be used to run this query.',
error_type: 'TABLE_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Table not found',
issue_codes: [1003, 1005],
},
{
regex_name: 'SCHEMA_DOES_NOT_EXIST_REGEX',
message_template:
'The schema "%(schema_name)s" does not exist. A valid schema must be used to run this query.',
error_type: 'SCHEMA_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Schema not found',
issue_codes: [1003, 1016],
},
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s" or the password is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
},
{
regex_name: 'CONNECTION_INVALID_HOSTNAME_REGEX',
message_template: 'The hostname "%(hostname)s" cannot be resolved.',
error_type: 'CONNECTION_INVALID_HOSTNAME_ERROR',
category: 'Connection',
description: 'Invalid hostname',
issue_codes: [1007],
},
{
regex_name: 'CONNECTION_HOST_DOWN_REGEX',
message_template:
'The host "%(hostname)s" might be down, and can\'t be reached on port %(port)s.',
error_type: 'CONNECTION_HOST_DOWN_ERROR',
category: 'Connection',
description: 'Host unreachable',
issue_codes: [1009],
},
{
regex_name: 'CONNECTION_PORT_CLOSED_REGEX',
message_template:
'Port %(port)s on hostname "%(hostname)s" refused the connection.',
error_type: 'CONNECTION_PORT_CLOSED_ERROR',
category: 'Connection',
description: 'Port closed or refused',
issue_codes: [1008],
},
{
regex_name: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
message_template:
'Unable to connect to catalog named "%(catalog_name)s".',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: false,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 159,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: true,
user_impersonation: true,
};
<DatabasePage name="Presto" database={databaseInfo} />

91
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/risingwave.mdx
View File

@@ -1,31 +1,104 @@
---
title: RisingWave
sidebar_label: RisingWave
description: "RisingWave is a distributed streaming database."
description: 'RisingWave is a distributed streaming database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"risingwave","engine_name":"RisingWave","module":"risingwave","documentation":{"description":"RisingWave is a distributed streaming database.","logo":"risingwave.svg","homepage_url":"https://risingwave.com/","pypi_packages":["psycopg2","sqlalchemy-risingwave"],"connection_string":"risingwave://root@{hostname}:{port}/{database}?sslmode=disable","default_port":4566,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://github.com/risingwavelabs/sqlalchemy-risingwave","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":94,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'risingwave',
engine_name: 'RisingWave',
module: 'risingwave',
documentation: {
description: 'RisingWave is a distributed streaming database.',
logo: 'risingwave.svg',
homepage_url: 'https://risingwave.com/',
pypi_packages: ['psycopg2', 'sqlalchemy-risingwave'],
connection_string:
'risingwave://root@{hostname}:{port}/{database}?sslmode=disable',
default_port: 4566,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'For localhost: localhost or 127.0.0.1. For AWS: endpoint URL',
port: 'Default 5432',
database: 'Database name',
},
notes: 'The psycopg2 library comes bundled with Superset Docker images.',
connection_examples: [
{
description: 'Basic connection',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
},
{
description: 'With SSL required',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require',
},
],
docs_url: 'https://github.com/risingwavelabs/sqlalchemy-risingwave',
sqlalchemy_docs_url:
'https://docs.sqlalchemy.org/en/13/dialects/postgresql.html',
categories: ['ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 94,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="RisingWave" database={databaseInfo} />

70
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx
View File

@@ -1,31 +1,83 @@
---
title: SAP HANA
sidebar_label: SAP HANA
description: "SAP HANA is an in-memory relational database and application platform."
description: 'SAP HANA is an in-memory relational database and application platform.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"sap_hana","engine_name":"SAP HANA","module":"hana","documentation":{"description":"SAP HANA is an in-memory relational database and application platform.","logo":"sap-hana.png","homepage_url":"https://www.sap.com/products/technology-platform/hana.html","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["hdbcli","sqlalchemy-hana"],"install_instructions":"pip install apache_superset[hana]","connection_string":"hana://{username}:{password}@{host}:{port}","default_port":30015,"docs_url":"https://github.com/SAP/sqlalchemy-hana"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'sap_hana',
engine_name: 'SAP HANA',
module: 'hana',
documentation: {
description:
'SAP HANA is an in-memory relational database and application platform.',
logo: 'sap-hana.png',
homepage_url: 'https://www.sap.com/products/technology-platform/hana.html',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['hdbcli', 'sqlalchemy-hana'],
install_instructions: 'pip install apache_superset[hana]',
connection_string: 'hana://{username}:{password}@{host}:{port}',
default_port: 30015,
docs_url: 'https://github.com/SAP/sqlalchemy-hana',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: false,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 27,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="SAP HANA" database={databaseInfo} />

94
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx
View File

@@ -1,31 +1,107 @@
---
title: SAP Sybase
sidebar_label: SAP Sybase
description: "SAP ASE (formerly Sybase) is an enterprise relational database."
description: 'SAP ASE (formerly Sybase) is an enterprise relational database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"sap_sybase","engine_name":"SAP Sybase","module":"sybase","documentation":{"description":"SAP ASE (formerly Sybase) is an enterprise relational database.","logo":"sybase.png","homepage_url":"https://www.sap.com/products/technology-platform/sybase-ase.html","pypi_packages":["pymssql","sqlalchemy-sybase","pyodbc"],"connection_string":"sybase+pyodbc://{username}:{password}@{dsn}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://help.sap.com/docs/SAP_ASE","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"parameters":{"username":"Database username","password":"Database password","dsn":"ODBC Data Source Name configured for SAP ASE"},"notes":"Requires SAP ASE ODBC driver installed and configured as a DSN."},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":44,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'sap_sybase',
engine_name: 'SAP Sybase',
module: 'sybase',
documentation: {
description:
'SAP ASE (formerly Sybase) is an enterprise relational database.',
logo: 'sybase.png',
homepage_url:
'https://www.sap.com/products/technology-platform/sybase-ase.html',
pypi_packages: ['pymssql', 'sqlalchemy-sybase', 'pyodbc'],
connection_string: 'sybase+pyodbc://{username}:{password}@{dsn}',
default_port: 1433,
drivers: [
{
name: 'pymssql',
pypi_package: 'pymssql',
connection_string:
'mssql+pymssql://{username}:{password}@{host}:{port}/{database}',
is_recommended: true,
},
{
name: 'pyodbc',
pypi_package: 'pyodbc',
connection_string:
'mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30',
is_recommended: false,
notes:
'Connection string must be URL-encoded. Special characters like @ need encoding.',
},
],
docs_url: 'https://help.sap.com/docs/SAP_ASE',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
parameters: {
username: 'Database username',
password: 'Database password',
dsn: 'ODBC Data Source Name configured for SAP ASE',
},
notes: 'Requires SAP ASE ODBC driver installed and configured as a DSN.',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 44,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="SAP Sybase" database={databaseInfo} />

69
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx
View File

@@ -1,31 +1,82 @@
---
title: Shillelagh
sidebar_label: Shillelagh
description: "Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs."
description: 'Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"shillelagh","engine_name":"Shillelagh","module":"shillelagh","documentation":{"description":"Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs.","logo":"shillelagh.png","homepage_url":"https://shillelagh.readthedocs.io/","pypi_packages":["shillelagh[gsheetsapi]"],"connection_string":"shillelagh://","notes":"Shillelagh uses virtual tables to query external data sources. Google Sheets requires OAuth credentials configured.","categories":["OTHER","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":41,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'shillelagh',
engine_name: 'Shillelagh',
module: 'shillelagh',
documentation: {
description:
'Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs.',
logo: 'shillelagh.png',
homepage_url: 'https://shillelagh.readthedocs.io/',
pypi_packages: ['shillelagh[gsheetsapi]'],
connection_string: 'shillelagh://',
notes:
'Shillelagh uses virtual tables to query external data sources. Google Sheets requires OAuth credentials configured.',
categories: ['OTHER', 'OPEN_SOURCE'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: true,
YEAR: true,
},
score: 41,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Shillelagh" database={databaseInfo} />

85
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/singlestore.mdx
View File

@@ -1,31 +1,98 @@
---
title: SingleStore
sidebar_label: SingleStore
description: "SingleStore is a distributed SQL database for real-time analytics and transactions."
description: 'SingleStore is a distributed SQL database for real-time analytics and transactions.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"singlestore","engine_name":"SingleStore","module":"singlestore","documentation":{"description":"SingleStore is a distributed SQL database for real-time analytics and transactions.","logo":"singlestore.png","homepage_url":"https://www.singlestore.com/","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["singlestoredb"],"connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"SingleStore host","port":"SingleStore port (default 3306)","database":"Database name"},"drivers":[{"name":"singlestoredb","pypi_package":"singlestoredb","connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":68,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'singlestore',
engine_name: 'SingleStore',
module: 'singlestore',
documentation: {
description:
'SingleStore is a distributed SQL database for real-time analytics and transactions.',
logo: 'singlestore.png',
homepage_url: 'https://www.singlestore.com/',
categories: ['ANALYTICAL_DATABASES', 'PROPRIETARY'],
pypi_packages: ['singlestoredb'],
connection_string:
'singlestoredb://{username}:{password}@{host}:{port}/{database}',
default_port: 3306,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'SingleStore host',
port: 'SingleStore port (default 3306)',
database: 'Database name',
},
drivers: [
{
name: 'singlestoredb',
pypi_package: 'singlestoredb',
connection_string:
'singlestoredb://{username}:{password}@{host}:{port}/{database}',
is_recommended: true,
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 68,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="SingleStore" database={databaseInfo} />

117
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/snowflake.mdx
View File

@@ -1,31 +1,130 @@
---
title: Snowflake
sidebar_label: Snowflake
description: "Snowflake is a cloud-native data warehouse."
description: 'Snowflake is a cloud-native data warehouse.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"snowflake","engine_name":"Snowflake","module":"snowflake","documentation":{"description":"Snowflake is a cloud-native data warehouse.","logo":"snowflake.svg","homepage_url":"https://www.snowflake.com/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["snowflake-sqlalchemy"],"connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}","install_instructions":"echo \"snowflake-sqlalchemy\" >> ./docker/requirements-local.txt","connection_examples":[{"description":"With role and warehouse","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}"},{"description":"With defaults (role/warehouse optional)","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}"}],"authentication_methods":[{"name":"Key Pair Authentication","description":"Use RSA key pair instead of password","requirements":"Key pair must be generated and public key registered in Snowflake","notes":"Merge multi-line private key to one line with \\n between lines."}],"notes":"Schema is not required in connection string. Ensure user has privileges for all databases/schemas/tables/views/warehouses.","docs_url":"https://docs.snowflake.com/en/user-guide/key-pair-auth.html","custom_errors":[{"regex_name":"OBJECT_DOES_NOT_EXIST_REGEX","message_template":"%(object)s does not exist in this database.","error_type":"OBJECT_DOES_NOT_EXIST_ERROR","category":"Query","description":"Object not found","issue_codes":[1029]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":72,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'snowflake',
engine_name: 'Snowflake',
module: 'snowflake',
documentation: {
description: 'Snowflake is a cloud-native data warehouse.',
logo: 'snowflake.svg',
homepage_url: 'https://www.snowflake.com/',
categories: [
'CLOUD_DATA_WAREHOUSES',
'ANALYTICAL_DATABASES',
'PROPRIETARY',
],
pypi_packages: ['snowflake-sqlalchemy'],
connection_string:
'snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}',
install_instructions:
'echo "snowflake-sqlalchemy" >> ./docker/requirements-local.txt',
connection_examples: [
{
description: 'With role and warehouse',
connection_string:
'snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}',
},
{
description: 'With defaults (role/warehouse optional)',
connection_string:
'snowflake://{user}:{password}@{account}.{region}/{database}',
},
],
authentication_methods: [
{
name: 'Key Pair Authentication',
description: 'Use RSA key pair instead of password',
requirements:
'Key pair must be generated and public key registered in Snowflake',
notes:
'Merge multi-line private key to one line with \\n between lines.',
},
],
notes:
'Schema is not required in connection string. Ensure user has privileges for all databases/schemas/tables/views/warehouses.',
docs_url: 'https://docs.snowflake.com/en/user-guide/key-pair-auth.html',
custom_errors: [
{
regex_name: 'OBJECT_DOES_NOT_EXIST_REGEX',
message_template: '%(object)s does not exist in this database.',
error_type: 'OBJECT_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Object not found',
issue_codes: [1029],
},
{
regex_name: 'SYNTAX_ERROR_REGEX',
message_template:
'Please check your query for syntax errors at or near "%(syntax_error)s". Then, try running your query again.',
error_type: 'SYNTAX_ERROR',
category: 'Query',
description: 'SQL syntax error',
issue_codes: [1030],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 72,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Snowflake" database={databaseInfo} />

78
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/sqlite.mdx
View File

@@ -1,31 +1,91 @@
---
title: SQLite
sidebar_label: SQLite
description: "SQLite is a self-contained, serverless SQL database engine."
description: 'SQLite is a self-contained, serverless SQL database engine.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"sqlite","engine_name":"SQLite","module":"sqlite","documentation":{"description":"SQLite is a self-contained, serverless SQL database engine.","logo":"sqlite.png","homepage_url":"https://www.sqlite.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":[],"connection_string":"sqlite:///path/to/file.db?check_same_thread=false","notes":"No additional library needed. SQLite is bundled with Python.","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":41,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'sqlite',
engine_name: 'SQLite',
module: 'sqlite',
documentation: {
description: 'SQLite is a self-contained, serverless SQL database engine.',
logo: 'sqlite.png',
homepage_url: 'https://www.sqlite.org/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: [],
connection_string: 'sqlite:///path/to/file.db?check_same_thread=false',
notes: 'No additional library needed. SQLite is bundled with Python.',
custom_errors: [
{
regex_name: 'COLUMN_DOES_NOT_EXIST_REGEX',
message_template:
'We can\'t seem to resolve the column "%(column_name)s"',
error_type: 'COLUMN_DOES_NOT_EXIST_ERROR',
category: 'Query',
description: 'Column not found',
issue_codes: [1003, 1004],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: true,
YEAR: true,
},
score: 41,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: false,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="SQLite" database={databaseInfo} />

171
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/starrocks.mdx
View File

@@ -1,31 +1,184 @@
---
title: StarRocks
sidebar_label: StarRocks
description: "StarRocks is a high-performance analytical database for real-time analytics."
description: 'StarRocks is a high-performance analytical database for real-time analytics.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"starrocks","engine_name":"StarRocks","module":"starrocks","documentation":{"description":"StarRocks is a high-performance analytical database for real-time analytics.","logo":"starrocks.png","homepage_url":"https://www.starrocks.io/","pypi_packages":["mysqlclient","starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"Database username","password":"Database password","host":"StarRocks FE host","database":"Database name","port":"Query port (default 9030)","catalog":"Catalog name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."},{"name":"starrocks","pypi_package":"starrocks","connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","is_recommended":true},{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"MySQL-compatible driver for StarRocks."},{"name":"PyMySQL","pypi_package":"pymysql","connection_string":"mysql+pymysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Pure Python MySQL driver, no compilation required."}],"categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"compatible_databases":[{"name":"CelerData","description":"CelerData is a fully-managed cloud analytics service built on StarRocks. It provides instant elasticity, automatic scaling, and enterprise features.","logo":"celerdata.png","homepage_url":"https://celerdata.com/","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","parameters":{"username":"CelerData username","password":"CelerData password","host":"CelerData cluster endpoint","port":"Query port (default 9030)","catalog":"Catalog name","database":"Database name"},"docs_url":"https://docs.celerdata.com/"}],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":89,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'starrocks',
engine_name: 'StarRocks',
module: 'starrocks',
documentation: {
description:
'StarRocks is a high-performance analytical database for real-time analytics.',
logo: 'starrocks.png',
homepage_url: 'https://www.starrocks.io/',
pypi_packages: ['mysqlclient', 'starrocks'],
connection_string:
'starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}',
default_port: 9030,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'StarRocks FE host',
database: 'Database name',
port: 'Query port (default 9030)',
catalog: 'Catalog name',
},
host_examples: [
{ platform: 'Localhost', host: 'localhost or 127.0.0.1' },
{ platform: 'Docker on Linux', host: '172.18.0.1' },
{ platform: 'Docker on macOS', host: 'docker.for.mac.host.internal' },
{ platform: 'On-premise', host: 'IP address or hostname' },
],
drivers: [
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string: 'mysql://{username}:{password}@{host}/{database}',
is_recommended: true,
notes: 'Recommended driver. May fail with caching_sha2_password auth.',
},
{
name: 'mysql-connector-python',
pypi_package: 'mysql-connector-python',
connection_string:
'mysql+mysqlconnector://{username}:{password}@{host}/{database}',
is_recommended: false,
notes:
'Required for newer MySQL databases using caching_sha2_password authentication.',
},
{
name: 'starrocks',
pypi_package: 'starrocks',
connection_string:
'starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}',
is_recommended: true,
},
{
name: 'mysqlclient',
pypi_package: 'mysqlclient',
connection_string:
'mysql://{username}:{password}@{host}:{port}/{database}',
is_recommended: false,
notes: 'MySQL-compatible driver for StarRocks.',
},
{
name: 'PyMySQL',
pypi_package: 'pymysql',
connection_string:
'mysql+pymysql://{username}:{password}@{host}:{port}/{database}',
is_recommended: false,
notes: 'Pure Python MySQL driver, no compilation required.',
},
],
categories: ['ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
compatible_databases: [
{
name: 'CelerData',
description:
'CelerData is a fully-managed cloud analytics service built on StarRocks. It provides instant elasticity, automatic scaling, and enterprise features.',
logo: 'celerdata.png',
homepage_url: 'https://celerdata.com/',
categories: [
'ANALYTICAL_DATABASES',
'CLOUD_DATA_WAREHOUSES',
'HOSTED_OPEN_SOURCE',
],
pypi_packages: ['starrocks'],
connection_string:
'starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}',
parameters: {
username: 'CelerData username',
password: 'CelerData password',
host: 'CelerData cluster endpoint',
port: 'Query port (default 9030)',
catalog: 'Catalog name',
database: 'Database name',
},
docs_url: 'https://docs.celerdata.com/',
},
],
custom_errors: [
{
regex_name: 'CONNECTION_ACCESS_DENIED_REGEX',
message_template:
'Either the username "%(username)s" or the password is incorrect.',
error_type: 'CONNECTION_ACCESS_DENIED_ERROR',
category: 'Authentication',
description: 'Access denied',
issue_codes: [1014, 1015],
invalid_fields: ['username', 'password'],
},
{
regex_name: 'CONNECTION_UNKNOWN_DATABASE_REGEX',
message_template: 'Unable to connect to database "%(database)s".',
error_type: 'CONNECTION_UNKNOWN_DATABASE_ERROR',
category: 'Connection',
description: 'Unknown database',
issue_codes: [1015],
invalid_fields: ['database'],
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 89,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="StarRocks" database={databaseInfo} />

69
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx
View File

@@ -1,31 +1,82 @@
---
title: Superset meta database
sidebar_label: Superset meta database
description: "Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection."
description: 'Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"superset_meta_database","engine_name":"Superset meta database","module":"superset","documentation":{"description":"Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection.","logo":"superset.svg","homepage_url":"https://superset.apache.org/","pypi_packages":["shillelagh[gsheetsapi]"],"connection_string":"superset://","notes":"This is an internal Superset feature. Enable with ENABLE_SUPERSET_META_DB feature flag. Allows cross-database queries using virtual tables.","categories":["OTHER"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":31,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"supports_file_upload":false,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'superset_meta_database',
engine_name: 'Superset meta database',
module: 'superset',
documentation: {
description:
'Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection.',
logo: 'superset.svg',
homepage_url: 'https://superset.apache.org/',
pypi_packages: ['shillelagh[gsheetsapi]'],
connection_string: 'superset://',
notes:
'This is an internal Superset feature. Enable with ENABLE_SUPERSET_META_DB feature flag. Allows cross-database queries using virtual tables.',
categories: ['OTHER'],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: true,
YEAR: true,
},
score: 31,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: false,
supports_file_upload: false,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Superset meta database" database={databaseInfo} />

74
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/tdengine.mdx
View File

@@ -1,31 +1,87 @@
---
title: TDengine
sidebar_label: TDengine
description: "TDengine is a high-performance time-series database for IoT."
description: 'TDengine is a high-performance time-series database for IoT.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"tdengine","engine_name":"TDengine","module":"tdengine","documentation":{"description":"TDengine is a high-performance time-series database for IoT.","logo":"tdengine.png","homepage_url":"https://tdengine.com/","categories":["TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["taospy","taos-ws-py"],"connection_string":"taosws://{user}:{password}@{host}:{port}","default_port":6041,"connection_examples":[{"description":"Local connection","connection_string":"taosws://root:taosdata@127.0.0.1:6041"}],"docs_url":"https://www.tdengine.com"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"score":25,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'tdengine',
engine_name: 'TDengine',
module: 'tdengine',
documentation: {
description: 'TDengine is a high-performance time-series database for IoT.',
logo: 'tdengine.png',
homepage_url: 'https://tdengine.com/',
categories: ['TIME_SERIES', 'OPEN_SOURCE'],
pypi_packages: ['taospy', 'taos-ws-py'],
connection_string: 'taosws://{user}:{password}@{host}:{port}',
default_port: 6041,
connection_examples: [
{
description: 'Local connection',
connection_string: 'taosws://root:taosdata@127.0.0.1:6041',
},
],
docs_url: 'https://www.tdengine.com',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: false,
QUARTER: false,
QUARTER_YEAR: false,
YEAR: false,
},
score: 25,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="TDengine" database={databaseInfo} />

84
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/teradata.mdx
View File

@@ -1,31 +1,97 @@
---
title: Teradata
sidebar_label: Teradata
description: "Teradata is an enterprise data warehouse platform."
description: 'Teradata is an enterprise data warehouse platform.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"teradata","engine_name":"Teradata","module":"teradata","documentation":{"description":"Teradata is an enterprise data warehouse platform.","logo":"teradata.png","homepage_url":"https://www.teradata.com/","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["teradatasqlalchemy"],"connection_string":"teradatasql://{user}:{password}@{host}","default_port":1025,"drivers":[{"name":"teradatasqlalchemy (Recommended)","pypi_package":"teradatasqlalchemy","connection_string":"teradatasql://{user}:{password}@{host}","is_recommended":true,"notes":"No ODBC drivers required."},{"name":"sqlalchemy-teradata (ODBC)","pypi_package":"sqlalchemy-teradata","is_recommended":false,"notes":"Requires ODBC driver installation.","docs_url":"https://downloads.teradata.com/download/connectivity/odbc-driver/linux"}]},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'teradata',
engine_name: 'Teradata',
module: 'teradata',
documentation: {
description: 'Teradata is an enterprise data warehouse platform.',
logo: 'teradata.png',
homepage_url: 'https://www.teradata.com/',
categories: ['TRADITIONAL_RDBMS', 'PROPRIETARY'],
pypi_packages: ['teradatasqlalchemy'],
connection_string: 'teradatasql://{user}:{password}@{host}',
default_port: 1025,
drivers: [
{
name: 'teradatasqlalchemy (Recommended)',
pypi_package: 'teradatasqlalchemy',
connection_string: 'teradatasql://{user}:{password}@{host}',
is_recommended: true,
notes: 'No ODBC drivers required.',
},
{
name: 'sqlalchemy-teradata (ODBC)',
pypi_package: 'sqlalchemy-teradata',
is_recommended: false,
notes: 'Requires ODBC driver installation.',
docs_url:
'https://downloads.teradata.com/download/connectivity/odbc-driver/linux',
},
],
},
time_grains: {
SECOND: false,
FIVE_SECONDS: false,
THIRTY_SECONDS: false,
MINUTE: true,
FIVE_MINUTES: false,
TEN_MINUTES: false,
FIFTEEN_MINUTES: false,
THIRTY_MINUTES: false,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 27,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Teradata" database={databaseInfo} />

78
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx
View File

@@ -1,31 +1,91 @@
---
title: TimescaleDB
sidebar_label: TimescaleDB
description: "TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL."
description: 'TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"timescaledb","engine_name":"TimescaleDB","module":"timescaledb","documentation":{"description":"TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.timescale.com/"},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":34,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'timescaledb',
engine_name: 'TimescaleDB',
module: 'timescaledb',
documentation: {
description:
'TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL.',
logo: 'timescale.png',
homepage_url: 'https://www.timescale.com/',
categories: ['ANALYTICAL_DATABASES', 'OPEN_SOURCE'],
pypi_packages: ['psycopg2'],
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
default_port: 5432,
connection_examples: [
{
description: 'Timescale Cloud (SSL required)',
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require',
},
],
notes: 'Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.',
docs_url: 'https://docs.timescale.com/',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 34,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="TimescaleDB" database={databaseInfo} />

123
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/trino.mdx
View File

@@ -1,31 +1,136 @@
---
title: Trino
sidebar_label: Trino
description: "Trino is a distributed SQL query engine for big data analytics."
description: 'Trino is a distributed SQL query engine for big data analytics.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"trino","engine_name":"Trino","module":"trino","documentation":{"description":"Trino is a distributed SQL query engine for big data analytics.","logo":"trino.png","homepage_url":"https://trino.io/","categories":["QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["trino"],"install_instructions":"pip install \"apache-superset[trino]\"","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","default_port":8080,"parameters":{"username":"Trino username","password":"Trino password (if authentication is enabled)","hostname":"Trino coordinator hostname","port":"Trino coordinator port (default 8080)","catalog":"Catalog name"},"drivers":[{"name":"trino","pypi_package":"trino","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","is_recommended":true}],"compatible_databases":[{"name":"Starburst Galaxy","description":"Starburst Galaxy is a fully-managed cloud analytics platform built on Trino. It provides data lake analytics with enterprise security and governance.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-galaxy/","categories":["QUERY_ENGINES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{host}:{port}/{catalog}","parameters":{"username":"Starburst Galaxy username (email/role)","password":"Starburst Galaxy password or token","host":"Your Galaxy cluster hostname","port":"Port (default 443)","catalog":"Catalog name"},"docs_url":"https://docs.starburst.io/starburst-galaxy/"},{"name":"Starburst Enterprise","description":"Starburst Enterprise is a self-managed Trino distribution with enterprise features, security, and support.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-enterprise/","categories":["QUERY_ENGINES","HOSTED_OPEN_SOURCE"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","docs_url":"https://docs.starburst.io/"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":149,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":true,"query_cost_estimation":true,"sql_validation":false,"user_impersonation":true};
export const databaseInfo = {
engine: 'trino',
engine_name: 'Trino',
module: 'trino',
documentation: {
description:
'Trino is a distributed SQL query engine for big data analytics.',
logo: 'trino.png',
homepage_url: 'https://trino.io/',
categories: ['QUERY_ENGINES', 'OPEN_SOURCE'],
pypi_packages: ['trino'],
install_instructions: 'pip install "apache-superset[trino]"',
connection_string:
'trino://{username}:{password}@{hostname}:{port}/{catalog}',
default_port: 8080,
parameters: {
username: 'Trino username',
password: 'Trino password (if authentication is enabled)',
hostname: 'Trino coordinator hostname',
port: 'Trino coordinator port (default 8080)',
catalog: 'Catalog name',
},
drivers: [
{
name: 'trino',
pypi_package: 'trino',
connection_string:
'trino://{username}:{password}@{hostname}:{port}/{catalog}',
is_recommended: true,
},
],
compatible_databases: [
{
name: 'Starburst Galaxy',
description:
'Starburst Galaxy is a fully-managed cloud analytics platform built on Trino. It provides data lake analytics with enterprise security and governance.',
logo: 'starburst.png',
homepage_url: 'https://www.starburst.io/platform/starburst-galaxy/',
categories: [
'QUERY_ENGINES',
'CLOUD_DATA_WAREHOUSES',
'HOSTED_OPEN_SOURCE',
],
pypi_packages: ['trino'],
connection_string:
'trino://{username}:{password}@{host}:{port}/{catalog}',
parameters: {
username: 'Starburst Galaxy username (email/role)',
password: 'Starburst Galaxy password or token',
host: 'Your Galaxy cluster hostname',
port: 'Port (default 443)',
catalog: 'Catalog name',
},
docs_url: 'https://docs.starburst.io/starburst-galaxy/',
},
{
name: 'Starburst Enterprise',
description:
'Starburst Enterprise is a self-managed Trino distribution with enterprise features, security, and support.',
logo: 'starburst.png',
homepage_url: 'https://www.starburst.io/platform/starburst-enterprise/',
categories: ['QUERY_ENGINES', 'HOSTED_OPEN_SOURCE'],
pypi_packages: ['trino'],
connection_string:
'trino://{username}:{password}@{hostname}:{port}/{catalog}',
docs_url: 'https://docs.starburst.io/',
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: false,
HALF_HOUR: true,
HOUR: true,
SIX_HOURS: true,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: true,
WEEK_STARTING_MONDAY: true,
WEEK_ENDING_SATURDAY: true,
WEEK_ENDING_SUNDAY: true,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 149,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: true,
supports_catalog: true,
supports_dynamic_catalog: true,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: true,
query_cost_estimation: true,
sql_validation: false,
user_impersonation: true,
};
<DatabasePage name="Trino" database={databaseInfo} />

77
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/vertica.mdx
View File

@@ -1,31 +1,90 @@
---
title: Vertica
sidebar_label: Vertica
description: "Vertica is a column-oriented analytics database."
description: 'Vertica is a column-oriented analytics database.'
hide_title: true
---
{/*
{/\*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/}
\*/}
import { DatabasePage } from '@site/src/components/databases';
export const databaseInfo = {"engine":"vertica","engine_name":"Vertica","module":"vertica","documentation":{"description":"Vertica is a column-oriented analytics database.","logo":"vertica.png","homepage_url":"https://www.vertica.com/","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-vertica-python"],"connection_string":"vertica+vertica_python://{username}:{password}@{host}/{database}","default_port":5433,"parameters":{"username":"Database username","password":"Database password","host":"localhost, IP address, or hostname (cloud or on-prem)","database":"Database name","port":"Default 5433"},"notes":"Supports load balancer backup host configuration.","docs_url":"http://www.vertica.com/"},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":34,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"supports_file_upload":true,"query_cancelation":false,"query_cost_estimation":false,"sql_validation":false,"user_impersonation":false};
export const databaseInfo = {
engine: 'vertica',
engine_name: 'Vertica',
module: 'vertica',
documentation: {
description: 'Vertica is a column-oriented analytics database.',
logo: 'vertica.png',
homepage_url: 'https://www.vertica.com/',
categories: ['ANALYTICAL_DATABASES', 'PROPRIETARY'],
pypi_packages: ['sqlalchemy-vertica-python'],
connection_string:
'vertica+vertica_python://{username}:{password}@{host}/{database}',
default_port: 5433,
parameters: {
username: 'Database username',
password: 'Database password',
host: 'localhost, IP address, or hostname (cloud or on-prem)',
database: 'Database name',
port: 'Default 5433',
},
notes: 'Supports load balancer backup host configuration.',
docs_url: 'http://www.vertica.com/',
},
time_grains: {
SECOND: true,
FIVE_SECONDS: true,
THIRTY_SECONDS: true,
MINUTE: true,
FIVE_MINUTES: true,
TEN_MINUTES: true,
FIFTEEN_MINUTES: true,
THIRTY_MINUTES: true,
HALF_HOUR: false,
HOUR: true,
SIX_HOURS: false,
DAY: true,
WEEK: true,
WEEK_STARTING_SUNDAY: false,
WEEK_STARTING_MONDAY: false,
WEEK_ENDING_SATURDAY: false,
WEEK_ENDING_SUNDAY: false,
MONTH: true,
QUARTER: true,
QUARTER_YEAR: false,
YEAR: true,
},
score: 34,
max_score: 201,
joins: true,
subqueries: true,
supports_dynamic_schema: false,
supports_catalog: false,
supports_dynamic_catalog: false,
ssh_tunneling: true,
supports_file_upload: true,
query_cancelation: false,
query_cost_estimation: false,
sql_validation: false,
user_impersonation: false,
};
<DatabasePage name="Vertica" database={databaseInfo} />

Some files were not shown because too many files have changed in this diff Show More