Learn more
 

Ready to get started?

Download a free trial of the Adobe Commerce ODBC Driver to get started:

 Download Now

Learn more:

Adobe Commerce Icon Adobe Commerce ODBC Driver

The Adobe Commerce ODBC Driver is a powerful tool that allows you to connect with live Adobe Commerce data, directly from any applications that support ODBC connectivity.

Access Adobe Commerce like you would a database - read, write, and update Customers, Inventory, Products, Orders, etc. through a standard ODBC Driver interface.

In this article

Related articles

Analyze Adobe Commerce Data in R


Create data visualizations and use high-performance statistical functions to analyze Adobe Commerce data in Microsoft R Open.

Access Adobe Commerce data with pure R script and standard SQL. You can use the CData ODBC Driver for Adobe Commerce and the RODBC package to work with remote Adobe Commerce data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Adobe Commerce data and visualize Adobe Commerce data in R.

Install R

You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).

Connect to Adobe Commerce as an ODBC Data Source

Information for connecting to Adobe Commerce follows, along with different instructions for configuring a DSN in Windows and Linux environments.

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

  • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

  • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

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.

Linux

If you are installing the CData ODBC Driver for Adobe Commerce 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 Adobe Commerce Source] Driver = CData ODBC Driver for Adobe Commerce Description = My Description OAuthClientId = MyConsumerKey OAuthClientSecret = MyConsumerSecret CallbackURL = http://127.0.0.1:33333 Url = https://myAdobe Commercehost.com

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Load the RODBC Package

To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.

After installing the RODBC package, the following line loads the package:

library(RODBC)

Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.

library(checkpoint) checkpoint("2016-01-01")

Connect to Adobe Commerce Data as an ODBC Data Source

You can connect to a DSN in R with the following line:

conn <- odbcConnect("CData Adobe Commerce Source")

Schema Discovery

The driver models Adobe Commerce APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

sqlTables(conn)

Execute SQL Queries

Use the sqlQuery function to execute any SQL query supported by the Adobe Commerce API.

products <- sqlQuery(conn, "SELECT Name, Price FROM Products", believeNRows=FALSE, rows_at_time=1)

You can view the results in a data viewer window with the following command:

View(products)

Plot Adobe Commerce Data

You can now analyze Adobe Commerce data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(products$Price, main="Adobe Commerce Products", names.arg = products$Name, horiz=TRUE)