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

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

List the Defined Data Source(s)


odbcinst -q -s
CData Bitbucket Source
...

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

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

For most queries, you must set the Workspace. The only exception to this is the Workspaces table, which does not require this property to be set, as querying it provides a list of workspace slugs that can be used to set Workspace. To query this table, you must set Schema to 'Information' and execute the query SELECT * FROM Workspaces>.

Setting Schema to 'Information' displays general information. To connect to Bitbucket, set these parameters:

Schema: To show general information about a workspace, such as its users, repositories, and projects, set this to Information. Otherwise, set this to the schema of the repository or project you are querying. To get a full set of available schemas, query the sys_schemas table.
Workspace: Required if you are not querying the Workspaces table. This property is not required for querying the Workspaces table, as that query only returns a list of workspace slugs that can be used to set Workspace.

Authenticating to Bitbucket

Bitbucket supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

Creating a custom OAuth application

From your Bitbucket account:

Go to Settings (the gear icon) and select Workspace Settings.
In the Apps and Features section, select OAuth Consumers.
Click Add Consumer.
Enter a name and description for your custom application.
Set the callback URL:
- For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
- For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
If you plan to use client credentials to authenticate, you must select This is a private consumer. In the driver, you must set AuthScheme to client.
Select which permissions to give your OAuth application. These determine what data you can read and write with it.
To save the new custom application, click Save.
After the application has been saved, you can select it to view its settings. The application's Key and Secret are displayed. Record these for future use. You will use the Key to set the OAuthClientId and the Secret to set the OAuthClientSecret.

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


[CData Bitbucket Source]
Driver = /opt/cdata/cdata-odbc-driver-for-bitbucket/lib/libbitbucketodbc.x64.so
Description = My Description
Workspace = myworkspaceslug
Schema = Information

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

Creating a Simple Go App for Bitbucket Data

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

cdata-odbc-bitbucket.go


package main

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

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

  var (
    title string
    contentraw string
  )

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


./cdata-odbc-bitbucket

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

Ready to get started?

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

Download Now

Learn more:

Bitbucket ODBC Driver

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

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

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