AnalyticDB:Redash

Gather connection details

Before opening Redash, collect the following values from the AnalyticDB for MySQL console:

Add AnalyticDB for MySQL as a data source

1. Open Redash in your browser at http://<IP address>:<Port number>.

   • <IP address>: the IP address of the server where Redash is running.

   • <Port number>: the default port is 5000. If port 5000 is already in use, specify a different port when you start Redash.

2. In the navigation pane on the left, click Settings. On the Data Sources tab, click + New Data Source.

   

3. In the Create a New Data Source dialog box, set Type Selection to mysql — AnalyticDB for MySQL is MySQL-compatible, so the MySQL driver works directly. Enter the connection details you gathered, then click Create.

   Parameter	Description
   Type Selection	Select mysql from the drop-down list.
   Name	A custom name for this data source.
   Host	The endpoint of the AnalyticDB for MySQL cluster (internal or public — see Gather connection details).
   Port	Fixed at 3306.
   User	The database account of the cluster.
   Password	The password of the database account.
   Database Name	The database in the cluster.

   

4. In the navigation pane, choose Create > Query. Enter a SQL statement in the editor and click Execute.

   

5. After the query runs, click + New Visualization to create a chart from the results. See the Redash official documentation for visualization options.

   

Gather connection details

Before configuring Redash, collect the following values:

Prepare the environment

Complete the following steps before adding the data source in Redash. The destination paths differ depending on whether you deployed Redash from source code or from a Docker image.

For Docker deployments, </app folder> refers to the /app folder inside the redash_server, redash_scheduler, redash_adhoc_worker, and redash_scheduled_worker containers.

1. (Optional) Copy the adb_spark.png icon file to the following path:

   Deployment type	Destination path
   Source code	<root directory of the source code>/client/app/assets/images/db-logos/
   Docker image	</app folder>/client/dist/images/db-logos/

2. Copy the adb_spark_ds.py query runner file to the following path:

   Deployment type	Destination path
   Source code	<root directory of the source code>/redash/query_runner/
   Docker image	</app folder>/redash/query_runner/

3. Add 'redash.query_runner.adb_spark_ds' to the default_query_runners list in __init__.py: Append the entry at the end of the list:

   Deployment type	File path
   Source code	<root directory of the source code>/redash/settings/__init__.py
   Docker image	</app folder>/redash/settings/__init__.py

   default_query_runners = [
       'redash.query_runner.athena',
       'redash.query_runner.big_query',
       ........
       'redash.query_runner.uptycs',
       'redash.query_runner.adb_spark_ds'
   ]

Add AnalyticDB for MySQL as a data source

1. Open Redash. In the navigation pane on the left, click Settings. On the Data Sources tab, click + New Data Source.

   

2. In the Create a New Data Source dialog box, set Type Selection to ADB Spark. Enter the connection details you gathered, then click Create.

   Parameter	Description
   Type Selection	Select ADB Spark from the drop-down list.
   Name	A custom name for this data source.
   Host	The endpoint of the Spark Interactive resource group.
   Port	Fixed at 10000.
   Database	The database in the AnalyticDB for MySQL cluster.
   Username	The database account of the cluster.
   Password	The password of the database account.
   Resource Group	The name of the Spark Interactive resource group.

   

3. In the navigation pane, choose Create > Query. Enter a SQL statement in the editor and click Execute.

   

4. After the query runs, click + New Visualization to create a chart from the results. See the Redash official documentation for visualization options.