Register for TiDB Cloud and Get the Lake DSN¶
Lake DSN is the complete connection string required for Guance to connect to TiDB Cloud Lake. Whether you need to connect an external data source or create a data forwarding rule, you must first copy the Lake DSN from the TiDB Cloud Lake Connect page.
What Does the Lake DSN Contain¶
The Lake DSN format is similar to:
| Content | Purpose |
|---|---|
| SQL User | Identifies the SQL user used for the connection |
| Password | Authenticates the SQL user identity |
| Endpoint and Port | Connects to the TiDB Cloud Lake service |
| Database | Determines the default database |
| Warehouse | Determines the Warehouse used for queries or load tasks |
Security warning
The Lake DSN contains a password. Do not display the full DSN in screenshots, group chats, ticket content, or logs. When troubleshooting, provide only masked Endpoint, Database, Warehouse, and error information.
New users: Sign up and get the Lake DSN¶
- Click Sign up for TiDB Cloud. The link opens in a new tab.
- Use your email or SSO to complete registration, verification, and first login.
- The system navigates to TiDB Cloud Lake and automatically opens Connect.
- In Connection information, confirm the SQL User, Password, Database, and Warehouse.
- In the sample area, select LakeSQL and copy the complete DSN.
- Keep the TiDB Cloud Lake tab open, then return to the original Guance tab to continue configuration.
For new users entering for the first time, the Warehouse is automatically created by TiDB Cloud Lake onboarding. Guance does not create or manage Warehouses.
Existing users: Get the Lake DSN¶
- Click Open TiDB Cloud Lake Connect.
- Log in if you have not already done so. After successful login, you will return to Lake and Connect will open.
- In Connection information, select the SQL User, Database, and Warehouse to use for this connection, and obtain or enter the Password.
- In the sample area, select LakeSQL.
- Copy the complete DSN.
- Return to the original Guance page and paste the DSN.
Return to Guance to complete the configuration¶
- Return to Integrations > External Data Sources > Add Data Source.
- Select TiDB Cloud Lake Direct Connection.
- Paste the DSN into Lake DSN.
- Test the connection and save.
See Connect to and Query TiDB Cloud Lake for complete steps.
- Return to Data Forwarding > Forwarding Rules > Create Rule.
- Set the forwarding target to TiDB Cloud Lake.
- Paste the DSN into Lake DSN.
- Confirm the automatically parsed Database and Warehouse, then fill in the Target Table.
- Test the connection and complete rule creation. If the target table does not exist, the system creates the table when completing the rule.
See Data Forwarding to TiDB Cloud Lake for complete steps.
DSN Storage and Replacement¶
- Guance stores the DSN in encrypted form. Subsequent pages do not display the password or the full connection string.
- After you change the TiDB Cloud Lake SQL user password, the original DSN becomes invalid. Copy the DSN again and update all external data sources and data forwarding rules that reference this credential.
- We recommend using dedicated SQL users for queries and data forwarding separately, so that one account does not have both read/write and table creation permissions.
If you still cannot connect after obtaining or filling in the DSN, see FAQ.