Access and Query TiDB Cloud Lake¶

After adding TiDB Cloud Lake in Integrations > External Data Sources, you can select this data source in query entry points that already support external data sources, such as Metrics Analysis and Dashboards, and execute native read-only SQL on TiDB Cloud Lake. This integration is carried out by the Guance server side via the TiDB Cloud Lake Driver and does not depend on DataFlux Func.

Prerequisites¶

• Already obtained the Lake DSN;
• The Lake DSN contains a valid Database and Warehouse;
• The SQL user has read-only query permissions on the target data;
• The current account has permission to configure external data sources.

Add a Data Source¶

1. Go to Integrations > External Data Sources;
2. Click Add Data Source;
3. In Select Connection Method, choose TiDB Cloud Lake Direct Connection;
4. Confirm the data source type is read-only TiDB Cloud Lake;
5. Fill in the connection properties:

TiDB Cloud Lake Direct Connection does not require a data source ID. When connecting other external data sources via DataFlux Func, the existing ID field and configuration requirements remain unchanged.

After completing the above fields:

1. Click Test Connection. The system will verify the DSN, Warehouse, network connectivity, and query permissions of the SQL user;
2. In Set Permissions, enable custom operation permissions as needed:
   • Disabled: Follows the default permissions of "External Data Sources";
   • Enabled: Only the creator, administrators, and specified members can operate or use this data source;
3. Save the data source.

Use in Queries¶

The following steps use Metrics > Metrics Analysis as an example; the operation is the same in other query entry points that support external data sources, such as Dashboards.

1. Go to Metrics > Metrics Analysis;
2. Add a Data Source Query;
3. Open the data source selector and select the TiDB Cloud Lake data source you just created;
4. Hover over the data source name to confirm the data source type, Database, and Warehouse;
5. Enter a native read-only SQL statement;
6. Click Run Query to view the results;
7. Optionally, save the query results to a dashboard or other supported display scenarios.

For example:

SELECT
  service,
  COUNT(*) AS log_count
FROM observability.application
WHERE event_time BETWEEN #{startTime} AND #{endTime}
GROUP BY service
ORDER BY log_count DESC
LIMIT 100;

Adjust the example according to your actual table structure, field names, and TiDB Cloud Lake SQL syntax.

SQL Usage Scope¶

If the query times out or exceeds the return limit, narrow the query time range, add more filter conditions, or use LIMIT.

Manage Data Sources¶

On the Integrations > External Data Sources page, you can filter by data source type TiDB Cloud Lake or search by name.

• Edit: Modify the name, description, Lake DSN, or operation permissions;
• Delete: After deletion, existing queries that reference this data source will no longer be able to execute;
• Change Password: After changing the password in TiDB Cloud Lake, re-obtain the DSN and edit the data source.

Verification Results¶

After configuration, the following should all be true:

• The external data source is saved successfully;
• Authorized members can see the data source in the query data source selector;
• Executing a read-only SQL statement returns results;
• Unauthorized members cannot select or execute the data source.

If the connection test or query fails, refer to the FAQ.