Skip to main content

Create a TiDB Data Source

Add a TiDB data source to NineData for Database DevOps, backup and restore, data replication, database comparison, and other supported features. This guide covers connection mode, credentials, environment settings, SSL settings, and the connection test.

Before you begin​

  • The server IP address of NineData has been added to the data source allowlist. The server IP address can be viewed by selecting the target region in Access Region on the Create Datasource page.

    server_ip_address

  • Make sure data source quota is available; otherwise, the data source cannot be added. Check the remaining quota in the NineData Console header.check_quota

Procedure​

  1. Sign in to the NineData Console.

  2. On the left navigation pane, click Datasource > Datasource.

  3. Select the Datasource tab, and then select Create Datasource. In the data source type selector, choose Database > (the type of data source to be added). On the Create Datasource page, configure the parameters based on the table below.
    tip

    If you make a mistake during the operation, select the arrow_down icon at the top of the Create Datasource page and choose again.

  1. Configure the data source parameters:

    Parameter
    		Description
    NameEnter a data source name. Use a meaningful name to find and manage it later.
    ConnectionSelect how NineData connects to the data source. Supported methods are IP Address, Gateway, and SSH Tunnel.
    • IP Address: Connect through a public network address.
    • Gateway: Use a NineData gateway for private-network access. Connect the host that runs the data source first. For instructions, see Add Gateway.
    • SSH Tunnel: Connect through an SSH tunnel.
    Select how NineData connects to the data source. Supported methods are IP Address and SSH Tunnel.
    • IP Address: Connect through a public network address.
    • SSH Tunnel: Connect through an SSH tunnel.
    Configuration items when Connection is IP AddressHost: The public network connection address and port of the data source.
    Configuration items when Connection is Gateway
    • Gateway: Select the NineData gateway installed on the host where the data source is located.
    • Host: Enter localhost if the data source is on the same host as the gateway, or enter the internal IP address of the host where the data source is located.
    Configuration items when Connection is SSH Tunnel
    • SSH Host: Enter the public IP address or domain name and SSH port of the server where the target data source is located. The default SSH port is 22.
    • SSH Authentication Method: Select the SSH authentication method.
      • Password: Connect with SSH Username and Password.
        • SSH Username: Enter the login username of the server where the target data source is located.
        • Password: Enter the login password of the server where the target data source is located.
      • Key (recommended): Connect with SSH Username and Key File.
        • SSH Username: Enter the login username of the server where the target data source is located.
        • Key File: Click Upload to upload the private key file, which is a key file without a suffix. If you have not created one yet, see Generate SSH Tunnel Key File.
        • Password: Enter the password set when the key file was generated. If no password was set during key generation, leave this field blank.
      • Note: After configuring SSH, click Connection Test to test the tunnel. Possible results:
      • Connection Successfully: The SSH tunnel is established.
      • Error message: The connection failed. Troubleshoot the cause based on the error message and try again.
    • Host: Enter localhost if the data source is on the same host as the SSH server, or enter the internal IP address of the host where the data source is located.
    DB AccountEnter the login username of the database.
    DB PasswordEnter the login password of the database.
    Access RegionSelect the region closest to your database host to effectively reduce network latency.
    EnvironmentChoose an environment based on the business purpose of the data source. This environment identifies the data source. The default environments are PROD and DEV. Custom environments are supported. For details, see create a custom environment.
    Note: Under organization mode, the database environment can also be applied to permission policy management. For example, the default Prod Admin role can access only data sources in the PROD environment and cannot access data sources in other environments. For more information, see Manage Roles.
    EncryptionConfigure SSL encryption for access to the data source (default: on). If the data source requires SSL-encrypted connections, enable this option; otherwise, the connection fails.
    Use the switch to enable or disable encrypted transmission. Click the > to the left of Encryption to expand detailed configuration.
    • SSL Options: Supports the following two methods.
      • If Available: NineData checks the server SSL status. If SSL is enabled, NineData connects through SSL first. If SSL is not enabled, NineData uses a non-SSL connection.
      • Require: Always use SSL to connect to the data source. If the server does not support this method or cannot establish an SSL connection for other reasons, the connection fails.
    • SSL Cipher: Specify the SSL-Cipher encryption algorithm.
    • Verify Server Certificate (SSL CA): If the MySQL server uses a certificate issued by a self-signed CA, upload the root certificate of this CA.
    • Verify Server Identity (SSL Identify): Verify the server name and IP address to make sure the connection reaches the intended MySQL server and to help prevent man-in-the-middle attacks.
    • Authenticate Client: If the server requires a client certificate, upload the client certificate and key. The server verifies the uploaded information to secure the connection.
    Note: In most cases, if the server supports SSL-encrypted connections, select Require. No other options are required; NineData generates the key used for the connection.

  2. After you configure all parameters, click Connection Test next to Create Datasource to test connectivity. When Connection Successfully is displayed, click Create Datasource to create the data source. Otherwise, review the connection settings and run the test again.

Result​

After the connection test succeeds and the data source is created, it appears in the data source list and is available to NineData features that support TiDB.