Ready to get started?

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

Learn more:

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.

Write a Simple Go Application to work with Adobe Commerce Data on Linux

Use CData ODBC drivers and unixODBC to create a simple Go app with live connectivity to Adobe Commerce data.

Go is an open source programming language that enables you to easily build software on Linux/UNIX machines. When Go is paired with the ODBC Driver for Adobe Commerce and unixODBC you are able write applications with connectivity to live Adobe Commerce data. This article will walk you through the process of installing the ODBC Driver for Adobe Commerce, configuring a connection using the unixODBC Driver Manager, and creating a simple Go application to work with Adobe Commerce data.

Using the CData ODBC Drivers on a Unix/Linux Machine

The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in help documentation (installed and found online).

Installing the Driver Manager

Before installing the driver, you need to be sure that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC driver manager that is widely supported.

For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:


$ apt-get install unixodbc unixodbc-dev

For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:


$ yum install unixODBC unixODBC-devel

The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal:


$ odbcinst -j

The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command:


DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......: 8
SQLLEN Size........: 8
SQLSETPOSIROW Size.: 8

Installing the Driver

You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.

The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.

For Debian-based systems like Ubuntu, run the following command with sudo or as root: $ dpkg -i /path/to/package.deb

For systems that support .rpms, run the following command with sudo or as root: $ rpm -i /path/to/package.rpm

Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:

List the Registered Driver(s)


$ odbcinst -q -d
CData ODBC Driver for Adobe Commerce
...

List the Defined Data Source(s)


$ odbcinst -q -s
CData Adobe Commerce Source
...

To use the CData ODBC Driver for Adobe Commerce with unixODBC, you need to ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.adobe commerce.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-adobe commerce), as follows:

cdata.odbc.adobe commerce.ini


...

[Driver]
DriverManagerEncoding = UTF-16

Modifying the DSN

When the driver is installed, a system DSN should be predefined. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.

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

/etc/odbc.ini or $HOME/.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).

Creating a Simple Go App for Adobe Commerce Data

With the Driver Manager installed and the DSN configured, you are ready to create a simple Go application to work with your Adobe Commerce data. To start, install a Go driver for ODBC databases. While there are several options available, this article will use the odbc driver found at https://github.com/alexbrainman/odbc.

Installing odbc on Linux

To install the odbc driver for Go, you will need to first ensure that you define the GOPATH environment variable:


export GOPATH=$HOME/golang/go

Once GOPATH is defined, you are ready to install the Go driver for ODBC databases:


$ go get github.com/alexbrainman/odbc

Now you are ready to create and execute a simple Go application.

Sample Go Application

The sample application issues a simple SQL SELECT query for Adobe Commerce data and displays the results. Create the directory $GOPATH/src/cdata-odbc-adobecommerce and create a new Go source file, copying the source code from below.

cdata-odbc-adobecommerce.go


package main

import (
  _ "github.com/alexbrainman/odbc"
  "database/sql"
  "log"
  "fmt"
)

func main() {
  db, err := sql.Open("odbc",
    "DSN=CData Adobe Commerce Source")
  if err != nil {
    log.Fatal(err)
  }

  var (
    name string
    price string
  )

  rows, err := db.Query("SELECT Name, Price FROM Products WHERE Style = ?", "High Tech")
  if err != nil {
    log.Fatal(err)
  }
  defer rows.Close()
  for rows.Next() {
    err := rows.Scan(&name, &price)
    if err != nil {
      log.Fatal(err)
    }
    fmt.Println(name, price)
  }
  err = rows.Err()
  if err != nil {
    log.Fatal(err)
  }

  defer db.Close()
}

In the terminal, navigate to the Go application directory and build the application:


$ go build

After the application builds, you will be able to execute the application, displaying your Adobe Commerce data:


$ ./cdata-odbc-adobecommerce

At this point, you have a simple Go application for working with Adobe Commerce data. From here, you can easily expand the application, adding deeper read/write functionality through familiar SQL queries.

CData Software is a leading provider of data access and connectivity solutions. Our standards-based connectors streamline data access and insulate customers from the complexities of integrating with on-premise or cloud databases, SaaS, APIs, NoSQL, and Big Data.

Connect With Us

Get Started

Data Connectors

ETL/ ELT Solutions

Cloud & API Connectivity

OEM & Custom Drivers