Create an Oracle Data Source

Add an Oracle data source to NineData. You can then use it for Database DevOps, backup and restore, data replication, database comparison, and other supported features. This guide covers connection mode, credentials, Oracle login role, environment 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.

  

• 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.

Procedure

1. Log in to the NineData Console.

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

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

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

4. Configure the data source parameters:

   Parameter	Description
   Name	Enter a data source name. Use a meaningful name so you can find and manage it later.
   Connection	Select how NineData connects to the data source. Supported methods are IP Address, Gateway, and SSH Tunnel. IP Address: Connect through the 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 the public network address. SSH Tunnel: Connect through an SSH tunnel.
   Configuration items when Connection is IP Address	Host: The public network connection address, port, SIDUsed to uniquely identify a specific Oracle database instance. (Service NameA logical identifier used to recognize and access an Oracle database instance, associated with a specific SID. By configuring different Service Names, multiple logical identifiers can be associated with the same database instance.).
   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. Also provide the SID or Service Name.
   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 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. Also provide the SID or Service Name.
   DB Account	Enter the login username for Oracle.
   DB Password	Enter the login password for Oracle.
   Role	Select the role to use after logging in to Oracle. Default (default): Includes basic permissions, can perform general database operations. SYSDBA: The role with the highest permissions, has full control over the database. SYSOPER: Includes specific database operation permissions, such as starting and shutting down database instances, backing up and restoring databases, etc.
   Access Region	Select the region closest to the location of your Oracle host to effectively reduce network latency.
   Environment	Choose an environment based on the business purpose of the data source. This serves as an environment identifier of the data source. The default environments are PROD and DEV. You can also 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.

5. 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 you create the data source, it appears in the data source list. You can use it in NineData features that support Oracle.

Appendix: Add NineData IP addresses to the Oracle database whitelist

When you add a data source located in On-Premise/Other Cloud, add the NineData service IP address to the Oracle database whitelist so NineData can access the database.

The following example uses Oracle 12. The same method applies to Oracle 9i and later.

1. Open the Oracle configuration file sqlnet.ora with a text editor. This file is usually located in the /network/admin/ directory of the Oracle installation directory. Example: /opt/oracle/product/OraHome/network/admin/sqlnet.ora. If you cannot find this file, you can search for it by executing the command find / -name sqlnet.ora 2>/dev/null in the terminal.

2. Modify the tcp.validnode_checking, tcp.invited_nodes, tcp.excluded_nodes parameters in the sqlnet.ora file as follows:

   tcp.validnode_checking = yes
   tcp.invited_nodes = (127.0.0.1, <allowed IP address or address segment>)
   tcp.excluded_nodes = (<denied IP address or address segment>)
   tip

   • If the above parameters are not found, add them directly.
   • The value of tcp.validnode_checking can be yes|no. Use it to enable or disable the whitelist. If it is set to no, the tcp.invited_nodes and tcp.excluded_nodes settings do not take effect.
   • Keep 127.0.0.1 in tcp.invited_nodes; otherwise, local connections to the database fail.
   • If the same IP address is included in both tcp.invited_nodes and tcp.excluded_nodes, Oracle still allows that IP address.
   • Separate multiple addresses or address ranges with commas (,).

3. Run lsnrctl reload to reload the sqlnet.ora file.

   tip

   • If you created the sqlnet.ora file manually, run lsnrctl stop, and then run lsnrctl start to restart the Oracle database.
   • If the lsnrctl command is not found, switch to the Oracle account by running su - oracle, and then try again.