Create SQL Server Data Sources

NineData supports adding various types and environments of data sources to the console for unified management. You can use database DevOps, backup and recovery, data replication, and database comparison features for data sources that have been added. This article introduces how to add SQL Server data sources to NineData.

Prerequisites

• The server IP address of NineData has been added to the data source allowlist. Please refer to the image below for instructions on how to obtain the server IP address.

  

• Make sure you have available data source quota; otherwise, the data source cannot be added. You can quickly check your remaining quota at the top-right corner of the NineData console.

Operation Steps

1. Log in to the NineData Console.

2. On the left navigation pane, click > .

3. Click  tab, and click  on the page. In the popup window for selecting the data source type, choose > (the type of data source to be added), and configure the parameters based on the table below on the page.
   tip

   If you make a mistake during the operation, you can click the icon at the top of the page to make a new selection.

4. Configure the parameters of the data source:

   Parameter	Description
   	Enter the name of the data source. To facilitate subsequent search and management, please use meaningful names.
   	Choose the access method of the data source. Supports access through , , SSH Tunnel three methods. : Access the data source through the public network address. : A secure and fast intranet access method provided by NineData. The host where the data source is located needs to be connected first. Please refer to Add Gateway for the connection method. SSH Tunnel: Access the data source through an SSH tunnel.
   selection of	: The public network connection address and port of the data source.
   selection of	: Select the NineData gateway installed on the host where the data source is located. : Can be written as localhost (data source is on the local machine) or the intranet IP of the host where the data source is located.
   selection of SSH Tunnel	: Enter the public IP or domain name of the server where the target data source is located, and the corresponding port number (the default port number for SSH service is 22). : Choose the SSH authentication method. : Connect through (i.e., the server's login name) and (i.e., the server's login password). : Enter the login username of the server where the target data source is located. : Enter the login password of the server where the target data source is located. (recommended): Connect through and . : Enter the login username of the server where the target data source is located. : Click to upload the private key file, which is a key file without a suffix. If you have not created one yet, please refer to Generate SSH Tunnel Key File. : Enter the password set when generating the key file. If you did not set a password during the key generation process, leave this field blank. Note: After the SSH configuration is completed, you need to click the on the right, and there may be the following two results: Prompt : Indicates that the SSH Tunnel has been established. Prompt error message: Indicates a connection failure, you need to troubleshoot the cause of the error and retry. : Can be written as localhost (data source is on the local machine) or the intranet IP of the host where the data source is located.
   	The username of the data source.
   	The password of the data source.
   	Select the region closest to your data source location to effectively reduce network latency.
   	Choose according to the actual business purpose of the data source, as an environmental identifier of the data source. Default provides and environments, and supports you to create a custom environment. Note: Under the organization mode, the database environment can also be applied to permission policy management, for example, the default role only supports access to data sources in the environment and cannot access data sources in other environments. For more information, please refer to Manage Roles.
   	Whether to use SSL encryption to access the data source (default on). If the data source enforces SSL encrypted connections, this switch must be turned on, otherwise the connection will fail. Click the switch on the right to turn on or off encrypted transmission. Click the > to the left of to expand detailed configuration. (default selected): Select this option, the client will always trust the server certificate, regardless of whether the certificate is issued by a trusted certificate authority. This will make the connection easier, but also increase the risk of malicious attacks. : If the SQL Server server uses a certificate issued by a self-signed CA, this option needs to be selected, and the root certificate of that CA needs to be uploaded. NineData will verify the uploaded certificate, if the certificate cannot pass the verification, the connection will be rejected. : Enter the hostname or domain name associated with the certificate issued by the CA, used to verify whether the hostname of the current connection matches the hostname in the certificate. If they do not match, the connection will be rejected to avoid man-in-the-middle attacks. Note: Under normal circumstances, all items can be kept at their default settings. For more information on SSL configuration, please refer to the official documentation: Configure SQL Server encrypted connections.

5. After all configurations are completed, click the next to to test whether the data source can be accessed normally. If prompted with , you can click to complete the addition of the data source. Otherwise, please recheck the connection settings until the connection test is successful.

Appendix: Add NineData's IP address to the SQL Server database whitelist

When adding data sources located in , you need to add the IP address of the NineData service to the SQL Server database whitelist to allow NineData to provide services.

This section takes SQL Server 2022 version as an example to introduce how to add an IP whitelist.

1. Log in to the host where the SQL Server service is located and open SQL Server Configuration Manager.

2. In the left navigation bar, select SQL Server Network Configuration and choose the SQL Server instance you want to modify.

3. In the right window, double-click the TCP/IP protocol.

   tip

   Please ensure that the TCP/IP protocol is enabled.

4. Click the IP Addresses tab and add the IP addresses allowed to access SQL Server. For example, if you want to allow a host with IP address 192.168.1.2 to access SQL Server, simply enter 192.168.1.2 in the text box to the right of IP Addresses.

5. Click OK and restart the SQL Server instance.