Ready to get started?

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

Learn more:

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

Access SingleStore data like you would a database - read, write, and update SingleStore. through a standard ODBC Driver interface.

Write a Simple Go Application to work with SingleStore Data on Linux

Use CData ODBC drivers and unixODBC to create a simple Go app with live connectivity to SingleStore 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 SingleStore and unixODBC you are able write applications with connectivity to live SingleStore data. This article will walk you through the process of installing the ODBC Driver for SingleStore, configuring a connection using the unixODBC Driver Manager, and creating a simple Go application to work with SingleStore 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 SingleStore
...

List the Defined Data Source(s)


$ odbcinst -q -s
CData SingleStore Source
...

To use the CData ODBC Driver for SingleStore 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.singlestore.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-singlestore), as follows:

cdata.odbc.singlestore.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.

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.

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

Creating a Simple Go App for SingleStore Data

With the Driver Manager installed and the DSN configured, you are ready to create a simple Go application to work with your SingleStore 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 SingleStore data and displays the results. Create the directory $GOPATH/src/cdata-odbc-singlestore and create a new Go source file, copying the source code from below.

cdata-odbc-singlestore.go


package main

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

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

  var (
    shipname string
    shipcity string
  )

  rows, err := db.Query("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = ?", "USA")
  if err != nil {
    log.Fatal(err)
  }
  defer rows.Close()
  for rows.Next() {
    err := rows.Scan(&shipname, &shipcity)
    if err != nil {
      log.Fatal(err)
    }
    fmt.Println(shipname, shipcity)
  }
  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 SingleStore data:


$ ./cdata-odbc-singlestore

At this point, you have a simple Go application for working with SingleStore 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