feat(db_engine_specs): complete metadata definitions and add missing unit test suites

superset/db_engine_specs/arc.py

@@ -45,6 +45,7 @@ class ArcEngineSpec(BaseEngineSpec):
         "categories": [DatabaseCategory.OTHER, DatabaseCategory.PROPRIETARY],
         "pypi_packages": ["arc-superset-arrow"],
         "connection_string": ("arc+arrow://{api_key}@{hostname}:{port}/{database}"),
+        "default_port": 8000,
         "parameters": {
             "api_key": "Arc API key",
             "hostname": "Arc hostname",

superset/db_engine_specs/aurora.py

@@ -14,17 +14,16 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-from superset.db_engine_specs.base import DatabaseCategory
+from superset.db_engine_specs.base import (
+    AURORA_DATA_API_KNOWN_INCOMPATIBILITIES,
+    DatabaseCategory,
+)
 from superset.db_engine_specs.mysql import MySQLEngineSpec
 from superset.db_engine_specs.postgres import PostgresEngineSpec
 
 
 class AuroraMySQLDataAPI(MySQLEngineSpec):
-    """Amazon Aurora MySQL via the Data API.
-
-    Note: Documentation is in MySQLEngineSpec's compatible_databases section.
-    This spec exists for runtime support of the auroradataapi driver.
-    """
+    """Amazon Aurora MySQL via the Data API."""
 
     engine = "mysql"
     default_driver = "auroradataapi"
@@ -56,15 +55,21 @@ class AuroraMySQLDataAPI(MySQLEngineSpec):
             "secret_arn={secret_arn}&region_name={region_name}"
         ),
         "default_port": 3306,
+        "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)",
+        },
+        "docs_url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/",
+        "known_incompatibilities": AURORA_DATA_API_KNOWN_INCOMPATIBILITIES,
     }
 
 
 class AuroraPostgresDataAPI(PostgresEngineSpec):
-    """Amazon Aurora PostgreSQL via the Data API.
-
-    Note: Documentation is in PostgresEngineSpec's compatible_databases section.
-    This spec exists for runtime support of the auroradataapi driver.
-    """
+    """Amazon Aurora PostgreSQL via the Data API."""
 
     engine = "postgresql"
     default_driver = "auroradataapi"
@@ -96,6 +101,16 @@ class AuroraPostgresDataAPI(PostgresEngineSpec):
             "secret_arn={secret_arn}&region_name={region_name}"
         ),
         "default_port": 5432,
+        "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)",
+        },
+        "docs_url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/",
+        "known_incompatibilities": AURORA_DATA_API_KNOWN_INCOMPATIBILITIES,
     }
 
 
@@ -125,8 +140,16 @@ class AuroraMySQLEngineSpec(MySQLEngineSpec):
             DatabaseCategory.HOSTED_OPEN_SOURCE,
         ],
         "pypi_packages": ["mysqlclient"],
-        "connection_string": "mysql://{user}:{password}@{host}:{port}/{database}",
+        "connection_string": "mysql://{username}:{password}@{host}:{port}/{database}",
         "default_port": 3306,
+        "parameters": {
+            "username": "Database username",
+            "password": "Database password",
+            "host": "Aurora cluster endpoint",
+            "port": "Default 3306",
+            "database": "Database name",
+        },
+        "docs_url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/",
     }
 
 
@@ -156,6 +179,14 @@ class AuroraPostgresEngineSpec(PostgresEngineSpec):
             DatabaseCategory.HOSTED_OPEN_SOURCE,
         ],
         "pypi_packages": ["psycopg2"],
-        "connection_string": "postgresql://{user}:{password}@{host}:{port}/{database}",
+        "connection_string": "postgresql://{username}:{password}@{host}:{port}/{database}",
         "default_port": 5432,
+        "parameters": {
+            "username": "Database username",
+            "password": "Database password",
+            "host": "Aurora cluster endpoint",
+            "port": "Default 5432",
+            "database": "Database name",
+        },
+        "docs_url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/",
     }

superset/db_engine_specs/clickhouse.py

@@ -336,6 +336,8 @@ class ClickHouseEngineSpec(ClickHouseBaseEngineSpec):
         "pypi_packages": ["clickhouse-sqlalchemy"],
         "connection_string": "clickhouse://{username}:{password}@{host}:{port}/{database}",
         "default_port": 8123,
+        "docs_url": "https://clickhouse.com/docs/",
+        "sqlalchemy_docs_url": "https://github.com/xzkostyan/clickhouse-sqlalchemy",
     }
 
     @classmethod
@@ -480,6 +482,10 @@ class ClickHouseConnectEngineSpec(BasicParametersMixin, ClickHouseEngineSpec):
         "logo": "clickhouse.svg",
         "logo_dark": "clickhouse-dark.svg",
         "homepage_url": "https://clickhouse.com/",
+        "sqlalchemy_docs_url": (
+            "https://clickhouse.com/docs/integrations/connectors/"
+            "data-visualization/superset-and-clickhouse"
+        ),
         "categories": [
             DatabaseCategory.ANALYTICAL_DATABASES,
             DatabaseCategory.OPEN_SOURCE,
@@ -549,7 +555,10 @@ class ClickHouseConnectEngineSpec(BasicParametersMixin, ClickHouseEngineSpec):
             'echo "clickhouse-connect>=1.8.0,<2.0" >> ./docker/requirements-local.txt\n'
             "# Restart the containers after adding the driver."
         ),
-        "docs_url": "https://clickhouse.com/docs/integrations/superset",
+        "docs_url": (
+            "https://clickhouse.com/docs/integrations/connectors/"
+            "data-visualization/superset-and-clickhouse"
+        ),
         "notes": (
             "The SQL playground at sql.clickhouse.com uses the database endpoint "
             "sql-clickhouse.clickhouse.com; the example connects to its uk sample "