Access WooCommerce Data as a Remote Oracle Database
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 WooCommerce to create a database link from WooCommerce to Oracle and to query WooCommerce data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.
Connect to WooCommerce as an ODBC Data Source
Information for connecting to WooCommerce follows, along with different instructions for configuring a DSN in Windows and Linux environments.
WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.
Connecting using one-legged OAuth 1.0 Authentication
Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):
- ConsumerKey
- ConsumerSecret
Connecting using WordPress OAuth 2.0 Authentication
After having configured the [ plugin, you may connect to WooCommerce by providing the following connection properties:
]
- OAuthClientId
- OAuthClientSecret
- CallbackURL
- InitiateOAuth - Set this to either GETANDREFRESH or REFRESH
In either case, you will need to set the Url property to the URL of the WooCommerce instance.
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 WooCommerce 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 WooCommerce 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 WooCommerce Source]
Driver = CData ODBC Driver for WooCommerce
Description = My Description
Url = https://example.com/
ConsumerKey = ck_ec52c76185c088ecaa3145287c8acba55a6f59ad
ConsumerSecret = cs_9fde14bf57126156701a7563fc87575713c355e5
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 WooCommerce data just as you would an Oracle database. Set the following properties when working with WooCommerce 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-woocommerce/lib/cdata.odbc.woocommerce.ini in a text editor and set the encoding.
cdata.odbc.woocommerce.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 WooCommerce data that enables you to query live WooCommerce data as an Oracle database.
-
Create the file initmywoocommercedb.ora in the folder oracle-home-directory/hs/admin and add the following setting:
initmywoocommercedb.ora
HS_FDS_CONNECT_INFO = "CData WooCommerce 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 = mywoocommercedb)
(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 = mywoocommercedb)
(ORACLE_HOME = your-oracle-home)
(PROGRAM = hsodbc)
)
)
-
Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:
tnsnames.ora
mywoocommercedb =
(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))
(CONNECT_DATA=(SID=mywoocommercedb))
(HS=OK)
)
-
Restart the listener.
Test the configuration with the following command:
tnsping mywoocommercedb
-
Open SQL*Plus and create the database link with the command below:
CREATE DATABASE LINK mywoocommercedb CONNECT TO "user" IDENTIFIED BY "password" USING 'mywoocommercedb';
You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):
SELECT * from "Orders"@mywoocommercedb WHERE ParentId = '3';