We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Access SingleStore Data as a Remote Oracle Database
Use the Oracle ODBC Gateway and Heterogeneous Services technology to access SingleStore data from your Oracle system.
The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for SingleStore to create a database link from SingleStore to Oracle and to query SingleStore data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.
Connect to SingleStore as an ODBC Data Source
Information for connecting to SingleStore follows, along with different instructions for configuring a DSN in Windows and Linux environments.
The following connection properties are required in order to connect to data.
- Server: The host name or IP of the server hosting the SingleStore database.
- Port: The port of the server hosting the SingleStore database.
- Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.
Connect Using Standard Authentication
To authenticate using standard authentication, set the following:
- User: The user which will be used to authenticate with the SingleStore server.
- Password: The password which will be used to authenticate with the SingleStore server.
Connect Using Integrated Security
As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.
Connect Using SSL Authentication
You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:
- SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
- SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
- SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
- SSLClientCertType: The certificate type of the client store.
- SSLServerCert: The certificate to be accepted from the server.
Connect Using SSH Authentication
Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:
- SSHClientCert: Set this to the name of the certificate store for the client certificate.
- SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
- SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
- SSHClientCertType: The certificate type of the client store.
- SSHPassword: The password that you use to authenticate with the SSH server.
- SSHPort: The port used for SSH operations.
- SSHServer: The SSH authentication server you are trying to authenticate against.
- SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
- SSHUser: Set this to the username that you use to authenticate with the SSH server.
Windows
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
Note: If you need to modify the DSN or create other SingleStore DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.
Linux
If you are installing the CData ODBC Driver for SingleStore in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.
/etc/odbc.ini
[CData SingleStore Source]
Driver = CData ODBC Driver for SingleStore
Description = My Description
User = myUser
Password = myPassword
Database = NorthWind
Server = myServer
Port = 3306
For specific information on using these configuration files, please refer to the help documentation (installed and found online).
Set Connection Properties for Compatibility with Oracle
The driver provides several connection properties that streamline accessing SingleStore data just as you would an Oracle database. Set the following properties when working with SingleStore data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.
MapToWVarchar=False
Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.
MaximumColumnSize=4000
Set this property to restrict the maximum column size to 4000 characters.
IncludeDualTable=True
Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.
Linux Configuration
In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-singlestore/lib/cdata.odbc.singlestore.ini in a text editor and set the encoding.
cdata.odbc.singlestore.ini
[Driver]
DriverManagerEncoding = UTF-8
Configure the ODBC Gateway, Oracle Net, and Oracle Database
Follow the procedure below to set up an ODBC gateway to SingleStore data that enables you to query live SingleStore data as an Oracle database.
-
Create the file initmysinglestoredb.ora in the folder oracle-home-directory/hs/admin and add the following setting:
initmysinglestoredb.ora
HS_FDS_CONNECT_INFO = "CData SingleStore Sys"
-
Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.
If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:
listener.ora
SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = mysinglestoredb) (ORACLE_HOME = your-oracle-home) (PROGRAM = dg4odbc) ) )
If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:
listener.ora
SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = mysinglestoredb) (ORACLE_HOME = your-oracle-home) (PROGRAM = hsodbc) ) )
-
Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:
tnsnames.ora
mysinglestoredb = (DESCRIPTION= (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521)) (CONNECT_DATA=(SID=mysinglestoredb)) (HS=OK) )
- Restart the listener.
Test the configuration with the following command:
tnsping mysinglestoredb
-
Open SQL*Plus and create the database link with the command below:
CREATE DATABASE LINK mysinglestoredb CONNECT TO "user" IDENTIFIED BY "password" USING 'mysinglestoredb';
You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):
SELECT * from "Orders"@mysinglestoredb WHERE ShipCountry = 'USA';