Skip to content

Register TiDB Cloud and Get the Lake DSN

The Lake DSN is the complete connection string required by Guance to connect to TiDB Cloud Lake. Whether you are integrating an external data source or creating a data forwarding rule, you must first copy the Lake DSN from the TiDB Cloud Lake Connect page.

What the Lake DSN Contains

The Lake DSN format is similar to:

lake://user:password@host:443/database?warehouse=warehouse_name
Content Purpose
SQL User Identifies the SQL user used for the connection
Password Authenticates the SQL user identity
Endpoint & Port Connects to the TiDB Cloud Lake service
Database Specifies the default database
Warehouse Specifies the Warehouse used for query execution or load tasks
Security Notice

The Lake DSN contains a password. Do not display the full DSN in screenshots, group chats, ticket bodies, or logs. When troubleshooting, provide only the masked Endpoint, Database, Warehouse, and error information.

New Users: Register and Get the Lake DSN

  1. Click Register for TiDB Cloud. The link opens in a new tab;
  2. Complete registration, verification, and first login using email or SSO;
  3. The system enters TiDB Cloud Lake and automatically opens Connect;
  4. In Connection information, confirm the SQL User, Password, Database, and Warehouse;
  5. In the example area, select LakeSQL and copy the full DSN;
  6. Keep the TiDB Cloud Lake tab open and return to the original Guance tab to continue configuration.

Select LakeSQL and copy the Lake DSN on the TiDB Cloud Lake Connect page

When a new user enters for the first time, the Warehouse is automatically created by the TiDB Cloud Lake onboarding. Guance does not create or manage Warehouses.

Existing Users: Get the Lake DSN

  1. Click Open TiDB Cloud Lake Connect;
  2. If not already logged in, complete the login. After a successful login, you will return to Lake and see Connect;
  3. In Connection information, select the SQL User, Database, and Warehouse to use for this session, and obtain or fill in the Password;
  4. In the example area, select LakeSQL;
  5. Copy the full DSN;
  6. Return to the original Guance page and paste the DSN.

Connection information and LakeSQL DSN on the TiDB Cloud Lake Connect page

Return to Guance to Complete Configuration

  1. Return to the Integrations > External Data Sources > Add Data Source page;
  2. Select TiDB Cloud Lake Direct Connect;
  3. Paste the DSN into Lake DSN;
  4. Test the connection and save.

For complete steps, see Integrate and Query TiDB Cloud Lake.

  1. Return to the Data Forwarding > Forwarding Rules > Create Rule page;
  2. Set the forwarding target to TiDB Cloud Lake;
  3. Paste the DSN into Lake DSN;
  4. Confirm the automatically parsed Database and Warehouse, then fill in the Target Table;
  5. Test the connection and complete the rule creation. If the target table does not exist, the system will execute a table creation operation when the rule is completed.

For complete steps, see Forward Data to TiDB Cloud Lake.

DSN Storage and Replacement

  • Guance encrypts the stored DSN. Subsequent pages will not display the password or the full connection string.
  • After changing the TiDB Cloud Lake SQL user password, the original DSN becomes invalid. Re-copy the DSN and update all external data sources and data forwarding rules that reference those credentials.
  • It is recommended to use dedicated SQL users for queries and data forwarding respectively, to avoid a single account having both read/write and table creation permissions.

If you still cannot connect after obtaining or filling in the DSN, refer to the FAQ.

Feedback

Is this page helpful?