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

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

NOTE: You may need to install odbcinst. Use the following command in a terminal:


apt install odbcinst

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 API Driver for ODBC
...

List the Defined Data Source(s)


odbcinst -q -s
CData API Source
...

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

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

Start by setting the Profile connection property to the location of the TypeForm Profile on disk (e.g. C:\profiles\TypeForm.apip). Next, set the ProfileSettings connection property to the connection string for TypeForm (see below).

TypeForm API Profile Settings

Authentication to TypeForm uses the OAuth standard.

To authenticate to TypeForm, you must first register and configure an OAuth application with TypeForm here: https://admin.typeform.com/account#/section/tokens. Your app will be assigned a client ID and a client secret which can be set in the connection string. More information on setting up an OAuth application can be found at https://developer.typeform.com/get-started/.

Note that there are several different use scenarios which all require different redirect URIs:

CData Desktop Applications: CData desktop applications (Sync, API Server, ArcESB) accept OAuth tokens at /src/oauthCallback.rst. The host and port is the same as the default port used by the application. For example, if you use http://localhost:8019/ to access CData Sync then the redirect URI will be http://localhost:8019/src/oauthCallback.rst.
CData Cloud Applications: CData cloud applications are similar to their desktop counterparts. If you access Connect Cloud at https://1.2.3.4/ then you should use the redirect https://1.2.3.4/src/oauthCallback.rst.
Desktop Application: When using a desktop application, the URI https://localhost:33333 is recommended.
Web Application: When developing a web application using the driver, use your own URI here such as https://my-website.com/oauth.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to OAuth.
InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
OAuthClientId: Set this to the Client Id that is specified in your app settings.
OAuthClientSecret: Set this to Client Secret that is specified in your app settings.
CallbackURL: Set this to the Redirect URI you specified in your app settings.

/etc/odbc.ini or $HOME/.odbc.ini


[CData API Source]
Driver = /opt/cdata/cdata-api-driver-for-api/lib/libapiodbc.x64.so
Description = My Description
Profile = C:\profiles\TypeForm.apip
Authscheme = OAuth
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
CallbackUrl = your_callback_url

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

Creating a Simple Go App for Typeform Data

With the Driver Manager installed and the DSN configured, you are ready to create a simple Go application to work with your Typeform 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

There are a series of steps required to install the ODBC driver for Go.

Create the $HOME/golang/go path (if it does not exist) by entering the following commands in a terminal: mkdir /root/golang mkdir /root/golang/go
Define the GOPATH environment variable: export GOPATH=$HOME/golang/go
Create a module inside the new Go directory: cd $GOPATH go mod init myproject
Install the Go driver for ODBC databases:
go get http://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 Typeform data and displays the results. Create the directory $GOPATH/src/cdata-odbc-typeform and create a new Go source file, copying the source code from below.

cdata-odbc-typeform.go


package main

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

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

  var (
    id string
    title string
  )

  rows, err := db.Query("SELECT Id, Title FROM Tags WHERE SettingsIsPublic = ?", "true")
  if err != nil {
    log.Fatal(err)
  }
  defer rows.Close()
  for rows.Next() {
    err := rows.Scan(&id, &title)
    if err != nil {
      log.Fatal(err)
    }
    fmt.Println(id, title)
  }
  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 Typeform data:


./cdata-odbc-typeform

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

Ready to get started?

Connect to live data from Typeform with the API Driver

Connect to Typeform

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