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 performant code formatting (#42434)

Browse Source
This commit is contained in:
Đỗ Trọng Hải
2026-08-04 00:27:05 +07:00
committed by GitHub
parent 10f7927603
commit e4ef84ca72
2328 changed files with 90728 additions and 32682 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

@@ -6,19 +6,19 @@ 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.
*/}

103
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} />

72
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} />

197
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

146
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} />

96
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} />

105
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} />

78
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} />

64
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} />

72
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} />

64
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} />

66
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} />

79
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} />

64
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} />

77
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} />

84
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} />

69
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} />

93
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} />

93
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} />

87
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} />

87
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} />

89
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} />

127
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} />

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

@@ -7,25 +7,149 @@ 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} />

74
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} />

88
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} />

81
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} />

76
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} />

76
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} />

78
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} />

111
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} />

164
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} />

81
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} />

101
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} />

115
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} />

93
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} />

72
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} />

84
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} />

137
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} />

132
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} />

77
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} />

88
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} />

77
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} />

82
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} />

101
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} />

65
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} />

94
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} />

122
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} />

73
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} />

90
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} />

99
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} />

176
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} />

143
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} />

136
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} />

66
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} />

72
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} />

318
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

150
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} />

87
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} />

66
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} />

90
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} />

65
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} />

81
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} />

113
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} />

74
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} />

167
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} />

65
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} />

70
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} />

80
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} />

74
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} />

119
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} />

73
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} />

95
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/ydb.mdx
View File

@@ -1,31 +1,112 @@
---
title: YDB
sidebar_label: YDB
description: "YDB is a distributed SQL database by Yandex."
description: 'YDB is a distributed SQL database by Yandex.'
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":"ydb","engine_name":"YDB","module":"ydb","documentation":{"description":"YDB is a distributed SQL database by Yandex.","logo":"ydb.svg","homepage_url":"https://ydb.tech/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["ydb-sqlalchemy"],"connection_string":"ydb://{host}:{port}/{database_name}","default_port":2135,"engine_parameters":[{"name":"Protocol","description":"Specify connection protocol (default: grpc)","secure_extra":{"protocol":"grpcs"}}],"authentication_methods":[{"name":"Static Credentials","description":"Username/password authentication","secure_extra":{"credentials":{"username":"...","password":"..."}}},{"name":"Access Token","description":"Token-based authentication","secure_extra":{"credentials":{"token":"..."}}},{"name":"Service Account","description":"Service account JSON credentials","secure_extra":{"credentials":{"service_account_json":{"id":"...","service_account_id":"...","private_key":"..."}}}}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"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":23,"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: 'ydb',
engine_name: 'YDB',
module: 'ydb',
documentation: {
description: 'YDB is a distributed SQL database by Yandex.',
logo: 'ydb.svg',
homepage_url: 'https://ydb.tech/',
categories: ['TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['ydb-sqlalchemy'],
connection_string: 'ydb://{host}:{port}/{database_name}',
default_port: 2135,
engine_parameters: [
{
name: 'Protocol',
description: 'Specify connection protocol (default: grpc)',
secure_extra: { protocol: 'grpcs' },
},
],
authentication_methods: [
{
name: 'Static Credentials',
description: 'Username/password authentication',
secure_extra: { credentials: { username: '...', password: '...' } },
},
{
name: 'Access Token',
description: 'Token-based authentication',
secure_extra: { credentials: { token: '...' } },
},
{
name: 'Service Account',
description: 'Service account JSON credentials',
secure_extra: {
credentials: {
service_account_json: {
id: '...',
service_account_id: '...',
private_key: '...',
},
},
},
},
],
},
time_grains: {
SECOND: true,
FIVE_SECONDS: false,
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: 23,
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="YDB" database={databaseInfo} />

67
docs/user_docs_versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx
View File

@@ -1,31 +1,84 @@
---
title: YugabyteDB
sidebar_label: YugabyteDB
description: "YugabyteDB is a distributed SQL database built on top of PostgreSQL."
description: 'YugabyteDB is a distributed SQL database built on top of 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":"yugabytedb","engine_name":"YugabyteDB","module":"yugabytedb","documentation":{"description":"YugabyteDB is a distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","categories":["CLOUD_DATA_WAREHOUSES","TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5433,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.yugabyte.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: 'yugabytedb',
engine_name: 'YugabyteDB',
module: 'yugabytedb',
documentation: {
description:
'YugabyteDB is a distributed SQL database built on top of PostgreSQL.',
logo: 'yugabyte.png',
homepage_url: 'https://www.yugabyte.com/',
categories: ['CLOUD_DATA_WAREHOUSES', 'TRADITIONAL_RDBMS', 'OPEN_SOURCE'],
pypi_packages: ['psycopg2'],
connection_string:
'postgresql://{username}:{password}@{host}:{port}/{database}',
default_port: 5433,
notes: 'Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.',
docs_url: 'https://docs.yugabyte.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="YugabyteDB" database={databaseInfo} />

152
docs/user_docs_versioned_docs/version-6.1.0/faq.mdx
View File

@@ -2,68 +2,84 @@
sidebar_position: 9
title: Frequently Asked Questions
description: Common questions about Apache Superset including performance, database support, visualizations, and configuration.
keywords: [superset faq, superset questions, superset help, data visualization faq]
keywords:
[superset faq, superset questions, superset help, data visualization faq]
---
import FAQSchema from '@site/src/components/FAQSchema';
<FAQSchema faqs={[
{
question: "How big of a dataset can Superset handle?",
answer: "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 the query. The key to achieving acceptable performance is whether your database can execute queries and return results at acceptable speed."
},
{
question: "What are the computing specifications required to run Superset?",
answer: "The specs depend on how many users you have and their activity, not on the size of your data. Community members have reported 8GB RAM, 2vCPUs as adequate for a moderately-sized instance. Monitor your resource usage and adjust as needed."
},
{
question: "Can I join or query multiple tables at one time?",
answer: "Not in the Explore or Visualization UI directly. A Superset SQLAlchemy datasource can only be a single table or a view. You can create a view that joins tables, or use SQL Lab where you can write SQL queries to join multiple tables."
},
{
question: "How do I create my own visualization?",
answer: "Read the instructions in the Creating Visualization Plugins documentation to learn how to build custom visualizations for Superset."
},
{
question: "Can I upload and visualize CSV data?",
answer: "Yes! Superset supports CSV upload functionality. Read the Exploring Data documentation to learn how to enable and use CSV upload."
},
{
question: "Why are my queries timing out?",
answer: "There are many possible causes. For SQL Lab, Superset allows queries to run up to 6 hours by default (configurable via SQLLAB_ASYNC_TIME_LIMIT_SEC). For dashboard timeouts, check your gateway/proxy timeout settings and adjust SUPERSET_WEBSERVER_TIMEOUT in superset_config.py."
},
{
question: "Why is the map not visible in the geospatial visualization?",
answer: "You need to register a free account at Mapbox.com, obtain an API key, and add it to your .env file at the key MAPBOX_API_KEY."
},
{
question: "What database engine can I use as a backend for Superset?",
answer: "Superset is tested using MySQL, PostgreSQL, and SQLite backends for storing its internal metadata. While Superset supports many databases as data sources, only these are recommended for the metadata store in production."
},
{
question: "Does Superset work with my database?",
answer: "Superset supports any database with a Python SQLAlchemy dialect and DBAPI driver. Check the Connecting to Databases documentation for the full list of supported databases."
},
{
question: "Does Superset offer a public API?",
answer: "Yes, Superset has a public REST API documented using Swagger. Enable FAB_API_SWAGGER_UI in superset_config.py to access interactive API documentation at /swagger/v1."
},
{
question: "Does Superset collect any telemetry data?",
answer: "Superset uses Scarf by default to collect basic telemetry data to help maintainers understand version usage. Users can opt out by setting the SCARF_ANALYTICS environment variable to false."
},
{
question: "Does Superset have a trash bin to recover deleted assets?",
answer: "No, there is no built-in way to recover deleted dashboards, charts, or datasets. It is recommended to take periodic backups of the metadata database and use export functionality for recovery."
}
]} />
<FAQSchema
faqs={[
{
question: 'How big of a dataset can Superset handle?',
answer:
'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 the query. The key to achieving acceptable performance is whether your database can execute queries and return results at acceptable speed.',
},
{
question:
'What are the computing specifications required to run Superset?',
answer:
'The specs depend on how many users you have and their activity, not on the size of your data. Community members have reported 8GB RAM, 2vCPUs as adequate for a moderately-sized instance. Monitor your resource usage and adjust as needed.',
},
{
question: 'Can I join or query multiple tables at one time?',
answer:
'Not in the Explore or Visualization UI directly. A Superset SQLAlchemy datasource can only be a single table or a view. You can create a view that joins tables, or use SQL Lab where you can write SQL queries to join multiple tables.',
},
{
question: 'How do I create my own visualization?',
answer:
'Read the instructions in the Creating Visualization Plugins documentation to learn how to build custom visualizations for Superset.',
},
{
question: 'Can I upload and visualize CSV data?',
answer:
'Yes! Superset supports CSV upload functionality. Read the Exploring Data documentation to learn how to enable and use CSV upload.',
},
{
question: 'Why are my queries timing out?',
answer:
'There are many possible causes. For SQL Lab, Superset allows queries to run up to 6 hours by default (configurable via SQLLAB_ASYNC_TIME_LIMIT_SEC). For dashboard timeouts, check your gateway/proxy timeout settings and adjust SUPERSET_WEBSERVER_TIMEOUT in superset_config.py.',
},
{
question: 'Why is the map not visible in the geospatial visualization?',
answer:
'You need to register a free account at Mapbox.com, obtain an API key, and add it to your .env file at the key MAPBOX_API_KEY.',
},
{
question: 'What database engine can I use as a backend for Superset?',
answer:
'Superset is tested using MySQL, PostgreSQL, and SQLite backends for storing its internal metadata. While Superset supports many databases as data sources, only these are recommended for the metadata store in production.',
},
{
question: 'Does Superset work with my database?',
answer:
'Superset supports any database with a Python SQLAlchemy dialect and DBAPI driver. Check the Connecting to Databases documentation for the full list of supported databases.',
},
{
question: 'Does Superset offer a public API?',
answer:
'Yes, Superset has a public REST API documented using Swagger. Enable FAB_API_SWAGGER_UI in superset_config.py to access interactive API documentation at /swagger/v1.',
},
{
question: 'Does Superset collect any telemetry data?',
answer:
'Superset uses Scarf by default to collect basic telemetry data to help maintainers understand version usage. Users can opt out by setting the SCARF_ANALYTICS environment variable to false.',
},
{
question: 'Does Superset have a trash bin to recover deleted assets?',
answer:
'No, there is no built-in way to recover deleted dashboards, charts, or datasets. It is recommended to take periodic backups of the metadata database and use export functionality for recovery.',
},
]}
/>
# FAQ
## 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
@@ -73,7 +89,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.
@@ -157,10 +173,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]
}
```
@@ -173,8 +189,8 @@ value in milliseconds in the JSON Metadata field:
```json
{
"stagger_refresh": false,
"stagger_time": 2500
"stagger_refresh": false,
"stagger_time": 2500
}
```
@@ -217,8 +233,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.
@@ -236,11 +252,11 @@ second etc). Example:
```json
{
"label_colors": {
"foo": "#FF69B4",
"bar": "lightblue",
"baz": 0
}
"label_colors": {
"foo": "#FF69B4",
"bar": "lightblue",
"baz": 0
}
}
```
@@ -306,8 +322,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?

40
docs/user_docs_versioned_docs/version-6.1.0/index.mdx
View File

@@ -88,23 +88,47 @@ Superset provides:
[superset-video-1080p.webm](https://github.com/user-attachments/assets/b37388f7-a971-409c-96a7-90c4e31322e6)
<br/>
<br />
**Large Gallery of Visualizations**
<kbd><img title="Gallery" src="https://superset.apache.org/img/screenshots/gallery.jpg"/></kbd><br/>
<kbd>
<img
title="Gallery"
src="https://superset.apache.org/img/screenshots/gallery.jpg"
/>
</kbd>
<br />
**Craft Beautiful, Dynamic Dashboards**
<kbd><img title="View Dashboards" src="https://superset.apache.org/img/screenshots/dashboard.jpg"/></kbd><br/>
<kbd>
<img
title="View Dashboards"
src="https://superset.apache.org/img/screenshots/dashboard.jpg"
/>
</kbd>
<br />
**No-Code Chart Builder**
<kbd><img title="Slice & dice your data" src="https://superset.apache.org/img/screenshots/explore.jpg"/></kbd><br/>
<kbd>
<img
title="Slice & dice your data"
src="https://superset.apache.org/img/screenshots/explore.jpg"
/>
</kbd>
<br />
**Powerful SQL Editor**
<kbd><img title="SQL Lab" src="https://superset.apache.org/img/screenshots/sql_lab.jpg"/></kbd><br/>
<kbd>
<img
title="SQL Lab"
src="https://superset.apache.org/img/screenshots/sql_lab.jpg"
/>
</kbd>
<br />
## Supported Databases
@@ -263,4 +287,8 @@ Understanding the Superset Points of View
-->
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=bc1c90cd-bc04-4e11-8c7b-289fb2839492" />
<img
referrerpolicy="no-referrer-when-downgrade"
src="https://static.scarf.sh/a.png?x-pxid=bc1c90cd-bc04-4e11-8c7b-289fb2839492"
/>

1
docs/user_docs_versioned_docs/version-6.1.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

3
docs/user_docs_versioned_docs/version-6.1.0/quickstart.mdx
View File

@@ -82,7 +82,8 @@ From this point on, you can head on to:
Or just explore our [Documentation](https://superset.apache.org/docs/intro)!
:::resources
- [Video: Superset in 2 Minutes](https://www.youtube.com/watch?v=AqousXQ7YHw)
- [Video: Superset 101](https://www.youtube.com/watch?v=mAIH3hUoxEE)
- [Tutorial: Creating Your First Dashboard](/user-docs/using-superset/creating-your-first-dashboard)
:::
:::

120
docs/user_docs_versioned_docs/version-6.1.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)
@@ -76,13 +98,13 @@ 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.
@@ -105,15 +127,15 @@ To install Superset as a PWA, look for the install icon in your browser's addres
### 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
@@ -121,59 +143,62 @@ 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')} />
:::resources
- [Using Metrics and Calculated Columns](https://docs.preset.io/docs/using-metrics-and-calculated-columns) - In-depth guide to the semantic layer
- [Blog: Understanding the Superset Semantic Layer](https://preset.io/blog/understanding-superset-semantic-layer/)
- [Blog: Unlocking the Power of Virtual Datasets](https://preset.io/blog/unlocking-the-power-of-virtual-datasets-in-apache-superset/)
:::
:::
### 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
@@ -184,26 +209,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
@@ -218,14 +249,14 @@ For detailed information on configuring dashboard access, see the
[Dashboard Access Control](/admin-docs/security/#dashboard-access-control) section in the
Security documentation.
<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.
@@ -263,6 +294,7 @@ The **Table** chart type has several advanced capabilities worth knowing:
#### Conditional Formatting
Conditional formatting rules highlight cells based on their values. Rules can be applied to:
- **Numeric columns** — color cells above/below a threshold, or use a gradient across a range
- **String columns** — highlight cells matching specific text values or patterns
- **Boolean columns** — color cells that are `true` or `false`, or `null`/`not null`
@@ -284,6 +316,7 @@ Column headers display a tooltip with the column's **Description** from the data
#### Display Controls
In dashboard view mode (without entering Edit mode), charts with configurable display options expose a **Display Controls** panel accessible from the chart's context menu. This surfaces controls such as Time Grain, Time Column, and layer visibility for applicable chart types — making it easy to adjust a chart's view without going to Explore.
### AG Grid Interactive Table
The **AG Grid Interactive Table** chart type is Superset's fully-featured data grid, suitable for large paginated datasets where the standard Table chart is not enough.
@@ -294,12 +327,12 @@ AG Grid supports server-side column filters that query the full dataset — not
**Available filter types:**
| Column type | Filter options |
|---|---|
| Text | Contains, equals, starts with, ends with |
| Number | Equals, not equal, less than, greater than, between |
| Date | Before, after, between, blank |
| Set | Select from a list of distinct values |
| Column type | Filter options |
| ----------- | --------------------------------------------------- |
| Text | Contains, equals, starts with, ends with |
| Number | Equals, not equal, less than, greater than, between |
| Date | Before, after, between, blank |
| Set | Select from a list of distinct values |
**AND / OR logic:** Each column supports combining multiple conditions with AND or OR. Filters from different columns are always combined with AND.
@@ -363,6 +396,7 @@ Charts can display a "Last queried at" timestamp showing when the chart data was
When saving or adding a chart to a dashboard from Explore, you can select which tab it should land on using the tab tree-select dropdown in the "Add to dashboard" modal.
:::resources
- [Dashboard Customization](https://docs.preset.io/docs/dashboard-customization) - Advanced dashboard styling and layout options
- [Blog: BI Dashboard Best Practices](https://preset.io/blog/bi-dashboard-best-practices/)
:::
:::

28
docs/user_docs_versioned_docs/version-6.1.0/using-superset/embedding.mdx
View File

@@ -5,32 +5,32 @@ sidebar_position: 6
{/*
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.
*/}
# Embedding Superset
Superset dashboards can be embedded directly in host applications using the `@superset-ui/embedded-sdk` package.
:::info Prerequisites
- The `EMBEDDED_SUPERSET` feature flag must be enabled.
- The embedding domain and allowed origins must be configured by an admin.
:::
:::
## Quick Start
@@ -46,7 +46,7 @@ Embed a dashboard:
import { embedDashboard } from '@superset-ui/embedded-sdk';
embedDashboard({
id: 'dashboard-uuid-here', // from Dashboard → Embed
id: 'dashboard-uuid-here', // from Dashboard → Embed
supersetDomain: 'https://superset.example.com',
mountPoint: document.getElementById('superset-container'),
fetchGuestToken: () => fetchTokenFromYourBackend(),
@@ -116,11 +116,11 @@ Must be `True` to enable the embedded SDK and the guest token endpoint. Without
The following URL parameters can be passed through the `urlParams` option in `dashboardUiConfig` or appended to the embedded iframe URL:
| Parameter | Values | Effect |
|-----------|--------|--------|
| `standalone` | `0`, `1`, `2`, `3` | `0`: normal; `1`: hide nav; `2`: hide nav + title; `3`: hide nav + title + tabs |
| `show_filters` | `0`, `1` | Show or hide the native filter bar |
| `expand_filters` | `0`, `1` | Start with filter bar expanded or collapsed |
| Parameter | Values | Effect |
| ---------------- | ------------------ | ------------------------------------------------------------------------------- |
| `standalone` | `0`, `1`, `2`, `3` | `0`: normal; `1`: hide nav; `2`: hide nav + title; `3`: hide nav + title + tabs |
| `show_filters` | `0`, `1` | Show or hide the native filter bar |
| `expand_filters` | `0`, `1` | Start with filter bar expanded or collapsed |
---
@@ -128,4 +128,4 @@ The following URL parameters can be passed through the `urlParams` option in `da
- **Guest tokens expire** — their lifetime is controlled by the `GUEST_TOKEN_JWT_EXP_SECONDS` config (default: 5 minutes). Refresh tokens before they expire using a token refresh mechanism in your host app.
- **Row-level security** — pass `rls` rules in the guest token request to restrict which rows are visible to the embedded user.
- **Allowed domains** — restrict which host origins can embed a dashboard by setting **Allowed Domains** per-dashboard in the *Embed* settings modal. Superset checks the request's `Referer` header against this list before serving the embedded view; an empty list allows any origin, so configure this explicitly for production.
- **Allowed domains** — restrict which host origins can embed a dashboard by setting **Allowed Domains** per-dashboard in the _Embed_ settings modal. Superset checks the request's `Referer` header against this list before serving the embedded view; an empty list allows any origin, so configure this explicitly for production.

67
docs/user_docs_versioned_docs/version-6.1.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
@@ -32,12 +32,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
@@ -45,16 +45,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.
@@ -70,7 +70,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.
@@ -80,24 +80,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
@@ -109,7 +109,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.
@@ -124,7 +124,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
@@ -134,7 +134,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
@@ -146,7 +146,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.
@@ -161,7 +161,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.
@@ -178,7 +178,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.
@@ -191,14 +191,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**.
@@ -213,7 +213,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
@@ -230,7 +230,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
@@ -241,11 +241,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
@@ -267,7 +267,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.
@@ -286,7 +286,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.
@@ -301,13 +301,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.
@@ -319,7 +321,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
@@ -351,10 +353,11 @@ The **Custom** time range picker accepts natural language expressions alongside
These expressions are evaluated at query time, so saved charts always display data relative to the current date.
:::resources
- [Chart Walkthroughs](https://docs.preset.io/docs/chart-walkthroughs) - Detailed guides for most chart types
- [Blog: Why Apache ECharts is the Future of Apache Superset](https://preset.io/blog/2021-4-1-why-echarts/)
- [Blog: ECharts Time-Series Visualizations in Superset](https://preset.io/blog/echarts-time-series-visualizations-in-superset/)
- [Blog: Finding New Insights with Drill By](https://preset.io/blog/drill-by/)
- [Blog: From Drill Down to Drill By](https://preset.io/blog/drill-down-and-drill-by/)
- [Blog: Cross-Filtering in Apache Superset](https://preset.io/blog/cross-filtering-in-Superset-and-Preset/)
:::
:::

74
docs/user_docs_versioned_docs/version-6.1.0/using-superset/handlebars-chart.mdx
View File

@@ -28,11 +28,11 @@ Superset registers several custom helpers on top of the standard Handlebars buil
Formats a date value using [Day.js](https://day.js.org/) format strings.
```handlebars
{{dateFormat my_date format="MMMM YYYY"}}
{{dateFormat my_date format='MMMM YYYY'}}
```
| Option | Default | Description |
|--------|---------|-------------|
| Option | Default | Description |
| -------- | ------------ | --------------------------------- |
| `format` | `YYYY-MM-DD` | A Day.js-compatible format string |
---
@@ -52,11 +52,11 @@ Converts an object to a JSON string, or any other value to its string representa
Formats a number using locale-aware formatting.
```handlebars
{{formatNumber myNumber "en-US"}}
{{formatNumber myNumber 'en-US'}}
```
| Option | Default | Description |
|--------|---------|-------------|
| Option | Default | Description |
| -------- | ------- | --------------------- |
| `locale` | `en-US` | A BCP 47 language tag |
---
@@ -76,7 +76,7 @@ Parses a JSON string into an object that can be used in your template.
Groups an array of objects by a key, powered by [handlebars-group-by](https://github.com/nicktindall/handlebars-group-by).
```handlebars
{{#groupBy data "department"}}
{{#groupBy data 'department'}}
<h3>{{value}}</h3>
{{#each items}}
<p>{{this.name}}</p>
@@ -92,47 +92,47 @@ Superset also registers all helpers from the [just-handlebars-helpers](https://g
#### Comparison
| Helper | Description | Example |
|--------|-------------|---------|
| `eq` | Strict equality | `{{#if (eq status "active")}}` |
| `eqw` | Weak equality | `{{#if (eqw count "5")}}` |
| `neq` | Strict inequality | `{{#if (neq role "admin")}}` |
| `lt` | Less than | `{{#if (lt score 50)}}` |
| `lte` | Less than or equal | `{{#if (lte score 100)}}` |
| `gt` | Greater than | `{{#if (gt price 0)}}` |
| `gte` | Greater than or equal | `{{#if (gte age 18)}}` |
| Helper | Description | Example |
| ------ | --------------------- | ------------------------------ |
| `eq` | Strict equality | `{{#if (eq status "active")}}` |
| `eqw` | Weak equality | `{{#if (eqw count "5")}}` |
| `neq` | Strict inequality | `{{#if (neq role "admin")}}` |
| `lt` | Less than | `{{#if (lt score 50)}}` |
| `lte` | Less than or equal | `{{#if (lte score 100)}}` |
| `gt` | Greater than | `{{#if (gt price 0)}}` |
| `gte` | Greater than or equal | `{{#if (gte age 18)}}` |
#### Logical
| Helper | Description | Example |
|--------|-------------|---------|
| `and` | Logical AND | `{{#if (and isActive isVerified)}}` |
| `or` | Logical OR | `{{#if (or isAdmin isMod)}}` |
| `not` | Logical NOT | `{{#if (not isDisabled)}}` |
| `ifx` | Inline conditional | `{{ifx isActive "Yes" "No"}}` |
| Helper | Description | Example |
| ---------- | ----------------------------- | ---------------------------------------- |
| `and` | Logical AND | `{{#if (and isActive isVerified)}}` |
| `or` | Logical OR | `{{#if (or isAdmin isMod)}}` |
| `not` | Logical NOT | `{{#if (not isDisabled)}}` |
| `ifx` | Inline conditional | `{{ifx isActive "Yes" "No"}}` |
| `coalesce` | Returns first non-falsy value | `{{coalesce nickname name "Anonymous"}}` |
#### String
| Helper | Description | Example |
|--------|-------------|---------|
| `capitalize` | Capitalizes first letter | `{{capitalize name}}` |
| `uppercase` | Converts to uppercase | `{{uppercase status}}` |
| `lowercase` | Converts to lowercase | `{{lowercase email}}` |
| `truncate` | Truncates a string | `{{truncate description 100}}` |
| `contains` | Checks if string contains substring | `{{#if (contains tag "urgent")}}` |
| Helper | Description | Example |
| ------------ | ----------------------------------- | --------------------------------- |
| `capitalize` | Capitalizes first letter | `{{capitalize name}}` |
| `uppercase` | Converts to uppercase | `{{uppercase status}}` |
| `lowercase` | Converts to lowercase | `{{lowercase email}}` |
| `truncate` | Truncates a string | `{{truncate description 100}}` |
| `contains` | Checks if string contains substring | `{{#if (contains tag "urgent")}}` |
#### Math
| Helper | Description | Example |
|--------|-------------|---------|
| `add` | Addition | `{{add a b}}` |
| `subtract` | Subtraction | `{{subtract total discount}}` |
| Helper | Description | Example |
| ---------- | -------------- | ----------------------------- |
| `add` | Addition | `{{add a b}}` |
| `subtract` | Subtraction | `{{subtract total discount}}` |
| `multiply` | Multiplication | `{{multiply price quantity}}` |
| `divide` | Division | `{{divide total count}}` |
| `ceil` | Ceiling | `{{ceil value}}` |
| `floor` | Floor | `{{floor value}}` |
| `round` | Round | `{{round value}}` |
| `divide` | Division | `{{divide total count}}` |
| `ceil` | Ceiling | `{{ceil value}}` |
| `floor` | Floor | `{{floor value}}` |
| `round` | Round | `{{round value}}` |
For the full list of available helpers, see the [just-handlebars-helpers documentation](https://github.com/leapfrogtechnology/just-handlebars-helpers).

39
docs/user_docs_versioned_docs/version-6.1.0/using-superset/sql-templating.mdx
View File

@@ -7,19 +7,19 @@ keywords: [sql templating, jinja, sql lab, virtual datasets, dynamic queries]
{/*
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.
*/}
@@ -101,12 +101,12 @@ Superset provides built-in macros for common use cases.
### User Context
| Macro | Description |
|-------|-------------|
| `{{ current_username() }}` | Returns the logged-in user's username |
| `{{ current_user_id() }}` | Returns the logged-in user's account ID |
| `{{ current_user_email() }}` | Returns the logged-in user's email |
| `{{ current_user_roles() }}` | Returns an array of the user's roles |
| Macro | Description |
| ---------------------------- | --------------------------------------- |
| `{{ current_username() }}` | Returns the logged-in user's username |
| `{{ current_user_id() }}` | Returns the logged-in user's account ID |
| `{{ current_user_email() }}` | Returns the logged-in user's email |
| `{{ current_user_roles() }}` | Returns an array of the user's roles |
**Example: Row-level filtering by user**
@@ -128,10 +128,10 @@ WHERE role IN {{ current_user_roles()|where_in }}
Access dashboard and chart filter values in your queries:
| Macro | Description |
|-------|-------------|
| Macro | Description |
| ------------------------------- | ------------------------------- |
| `{{ filter_values('column') }}` | Returns filter values as a list |
| `{{ get_filters('column') }}` | Returns filters with operators |
| `{{ get_filters('column') }}` | Returns filters with operators |
**Example: Using filter values**
@@ -148,8 +148,8 @@ The `where_in` filter converts the list to SQL format: `('value1', 'value2', 'va
For charts with time range filters:
| Macro | Description |
|-------|-------------|
| Macro | Description |
| --------------------------------- | -------------------------------------------------- |
| `{{ get_time_filter('column') }}` | Returns time filter with `from_expr` and `to_expr` |
**Example: Time-filtered virtual dataset**
@@ -214,9 +214,7 @@ Add to the Parameters menu:
```json
{
"_filters": [
{"col": "region", "op": "IN", "val": ["US", "EU"]}
]
"_filters": [{ "col": "region", "op": "IN", "val": ["US", "EU"] }]
}
```
@@ -269,6 +267,7 @@ Using `remove_filter=True` applies the filter in the inner query for better perf
- **Format SQL is Jinja-aware**: The "Format SQL" button in SQL Lab correctly preserves `{{ }}` and `{% %}` template syntax and applies your selected database's SQL dialect when formatting.
:::resources
- [Admin Guide: SQL Templating Configuration](/admin-docs/configuration/sql-templating)
- [Blog: Intro to Jinja Templating in Apache Superset](https://preset.io/blog/intro-jinja-templating-apache-superset/)
:::
:::

78
docs/user_docs_versioned_docs/version-6.1.0/using-superset/using-ai-with-superset.mdx
View File

@@ -47,6 +47,7 @@ Ask your AI assistant to browse what's available in your Superset instance:
- **Get chart and dashboard details** -- understand what a chart shows, its query, and configuration
**Example prompts:**
> "What datasets are available?"
> "Show me the columns in the sales_orders dataset"
> "Find dashboards related to revenue"
@@ -62,6 +63,7 @@ Describe the visualization you want and AI creates it for you:
- **Get Explore links** -- open any chart in Superset's Explore view for further refinement
**Example prompts:**
> "Create a bar chart showing monthly revenue by region from the sales dataset"
> "Update chart 42 to use a line chart instead"
> "Give me a link to explore this chart further"
@@ -84,6 +86,7 @@ Build dashboards from a collection of charts:
- **Add charts to existing dashboards** -- place a chart on an existing dashboard with automatic positioning
**Example prompts:**
> "Create a dashboard called 'Q4 Sales Overview' with charts 10, 15, and 22"
> "Add the revenue trend chart to the executive dashboard"
@@ -95,6 +98,7 @@ Discover what database connections are configured in your Superset instance:
- **Get database details** -- name, backend type (PostgreSQL, Snowflake, etc.), and connection status
**Example prompts:**
> "What databases are connected to Superset?"
> "Show me details about the data warehouse connection"
@@ -106,6 +110,7 @@ Build ad-hoc SQL datasets that can be used as the basis for charts:
- **Use immediately in charts** -- the returned dataset ID can be passed directly to chart creation
**Example prompts:**
> "Create a dataset from: SELECT region, SUM(revenue) as total_revenue FROM orders GROUP BY region"
> "Make a virtual dataset called 'monthly_signups' from the users table filtered to last 12 months"
@@ -118,6 +123,7 @@ Execute SQL directly through your AI assistant:
- **Save queries** -- save a SQL query to SQL Lab's Saved Queries for later reuse
**Example prompts:**
> "Run this query: SELECT region, SUM(revenue) FROM sales GROUP BY region"
> "Open SQL Lab with a query to show the top 10 customers by order count"
> "Save this query as 'Weekly Revenue Report'"
@@ -130,6 +136,7 @@ Pull the raw data behind any chart:
- **Inspect results** -- useful for verifying what a visualization shows or feeding data into other tools
**Example prompts:**
> "Get the data behind chart 42"
> "Export chart 15 data as CSV"
@@ -139,6 +146,7 @@ Pull the raw data behind any chart:
- **Instance info** -- get high-level statistics about your Superset instance (number of datasets, charts, dashboards)
**Example prompts:**
> "Is Superset healthy?"
> "How many dashboards are in this instance?"
@@ -232,56 +240,56 @@ Ask your admin for the MCP server URL and any authentication tokens you need.
### Exploration & Discovery
| Tool | Description |
|------|-------------|
| `health_check` | Verify the MCP server is running and connected |
| `get_instance_info` | Get instance statistics (dataset, chart, dashboard counts) |
| `get_schema` | Discover available charts, datasets, and dashboards with schema info |
| Tool | Description |
| ------------------- | -------------------------------------------------------------------- |
| `health_check` | Verify the MCP server is running and connected |
| `get_instance_info` | Get instance statistics (dataset, chart, dashboard counts) |
| `get_schema` | Discover available charts, datasets, and dashboards with schema info |
### Datasets
| Tool | Description |
|------|-------------|
| `list_datasets` | List datasets with filtering and search |
| `get_dataset_info` | Get dataset metadata (columns, metrics, filters) |
| `create_virtual_dataset` | Create a virtual dataset from a SQL query |
| Tool | Description |
| ------------------------ | ------------------------------------------------ |
| `list_datasets` | List datasets with filtering and search |
| `get_dataset_info` | Get dataset metadata (columns, metrics, filters) |
| `create_virtual_dataset` | Create a virtual dataset from a SQL query |
### Charts
| Tool | Description |
|------|-------------|
| `list_charts` | List charts with filtering and search |
| `get_chart_info` | Get chart metadata and configuration |
| `get_chart_data` | Retrieve chart data (JSON, CSV, or Excel) |
| `get_chart_preview` | Generate a chart preview (URL, ASCII, table, or Vega-Lite) |
| `get_chart_type_schema` | Get the configuration schema for a chart type |
| `generate_chart` | Create a new chart from a specification (defaults to preview mode — review before saving) |
| `update_chart` | Modify an existing chart's configuration (pass `generate_preview=False` to persist immediately instead of returning a preview URL) |
| `update_chart_preview` | Update a cached chart preview without saving |
| `generate_explore_link` | Generate an Explore URL for interactive visualization |
| Tool | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `list_charts` | List charts with filtering and search |
| `get_chart_info` | Get chart metadata and configuration |
| `get_chart_data` | Retrieve chart data (JSON, CSV, or Excel) |
| `get_chart_preview` | Generate a chart preview (URL, ASCII, table, or Vega-Lite) |
| `get_chart_type_schema` | Get the configuration schema for a chart type |
| `generate_chart` | Create a new chart from a specification (defaults to preview mode — review before saving) |
| `update_chart` | Modify an existing chart's configuration (pass `generate_preview=False` to persist immediately instead of returning a preview URL) |
| `update_chart_preview` | Update a cached chart preview without saving |
| `generate_explore_link` | Generate an Explore URL for interactive visualization |
### Dashboards
| Tool | Description |
|------|-------------|
| `list_dashboards` | List dashboards with filtering and search |
| `get_dashboard_info` | Get dashboard metadata and layout |
| `generate_dashboard` | Create a new dashboard with specified charts |
| `add_chart_to_existing_dashboard` | Add a chart to an existing dashboard |
| Tool | Description |
| --------------------------------- | -------------------------------------------- |
| `list_dashboards` | List dashboards with filtering and search |
| `get_dashboard_info` | Get dashboard metadata and layout |
| `generate_dashboard` | Create a new dashboard with specified charts |
| `add_chart_to_existing_dashboard` | Add a chart to an existing dashboard |
### SQL
| Tool | Description |
|------|-------------|
| `execute_sql` | Run a SQL query with RBAC enforcement |
| `save_sql_query` | Persist a SQL query to SQL Lab's saved queries |
| `open_sql_lab_with_context` | Open SQL Lab with a pre-populated query |
| Tool | Description |
| --------------------------- | ---------------------------------------------- |
| `execute_sql` | Run a SQL query with RBAC enforcement |
| `save_sql_query` | Persist a SQL query to SQL Lab's saved queries |
| `open_sql_lab_with_context` | Open SQL Lab with a pre-populated query |
### Databases
| Tool | Description |
|------|-------------|
| `list_databases` | List configured database connections |
| Tool | Description |
| ------------------- | ------------------------------------------------ |
| `list_databases` | List configured database connections |
| `get_database_info` | Get details about a specific database connection |
---