Skip to content

Commit

Permalink
Docs: Add "External resources" section to TiDB source connector doc (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
zhangyangyu authored Aug 3, 2022
1 parent 3b85a74 commit c05b3f0
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/integrations/sources/tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ GRANT SELECT ON <database name>.* TO 'airbyte'@'%';

Your database user should now be ready for use with Airbyte.

## Connection via SSH Tunnel
### Connection via SSH Tunnel

Airbyte has the ability to connect to a TiDB instance via an SSH Tunnel. The reason you might want to do this because it is not possible \(or against security policy\) to connect to the database directly \(e.g. it does not have a public IP address\).

Expand All @@ -73,7 +73,7 @@ Using this feature requires additional configuration, when creating the source.
6. If you are using `Password Authentication`, then `SSH Login Username` should be set to the password of the User from the previous step. If you are using `SSH Key Authentication` TiDB password, but the password for the OS-user that Airbyte is using to perform commands on the bastion.
7. If you are using `SSH Key Authentication`, then `SSH Private Key` should be set to the RSA Private Key that you are using to create the SSH connection. This should be the full contents of the key file starting with `-----BEGIN RSA PRIVATE KEY-----` and ending with `-----END RSA PRIVATE KEY-----`.

### Data type mapping
## Data type mapping

[TiDB data types](https://docs.pingcap.com/tidb/stable/data-type-overview) are mapped to the following data types when synchronizing data:

Expand Down Expand Up @@ -116,6 +116,12 @@ Using this feature requires additional configuration, when creating the source.

**Note:** arrays for all the above types as well as custom types are supported, although they may be de-nested depending on the destination.

## External resources

Now that you have set up the TiDB source connector, check out the following TiDB tutorial:

- [Using Airbyte to Migrate Data from TiDB Cloud to Snowflake](https://en.pingcap.com/blog/using-airbyte-to-migrate-data-from-tidb-cloud-to-snowflake/)

## Changelog

| Version | Date | Pull Request | Subject |
Expand Down

0 comments on commit c05b3f0

Please sign in to comment.