bigquery

README

BigQuery SQL Driver for Golang

This is an implementation of the BigQuery Client as a database/sql/driver for easy integration and usage.

Goals of project

This project is meant to be a basic database/sql driver implementation for Golang so that developers can easily use tools like Gorm, and *sql.DB functions, with Google's BigQuery database.

Usage

Check out the example application in the examples directory, for a few examples.

As this is using the Google Cloud Go SDK, you will need to have your credentials available via the GOOGLE_APPLICATION_CREDENTIALS environment variable point to your credential JSON file.

Vanilla *sql.DB usage

Just like any other database/sql driver you'll need to import it

package main

import (
    "database/sql"
    _ "github.com/solcates/go-sql-bigquery"
    "log"
)

func main() {
    db, err := sql.Open("bigquery", 
        "bigquery://projectid/dataset")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close() 
    // Do Something with the DB

}

Gorm Usage

For gorm

package main

import (
    "github.com/jinzhu/gorm"
    _ "github.com/solcates/go-sql-bigquery/dialects/bigquery"
    "log"
)

func main() {
    db, err := gorm.Open("bigquery", 
        "bigquery://projectid/dataset")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close() 
    // Do Something with the DB

}

Contribution

Pull Requests are welcome!

Current Support

• driver.Conn implemented
• driver.Querier implemented
• driver.Pinger implemented
• gorm Dialect - have only tested basic use cases
• Prepared Statements - supported via a quick hack
• Parametiterized Queries

Documentation

Index

• Constants
• func NewStmt(query string, c *conn) *stmt
• type Config
  • func ConfigFromConnString(in string) (cfg *Config, err error)
• type Connector
  • func NewConnector(connectionString string) *Connector
  • func (c *Connector) Connect(ctx context.Context) (driver.Conn, error)
  • func (c *Connector) Driver() driver.Driver
• type Driver
  • func (d *Driver) Open(connectionString string) (c driver.Conn, err error)

Constants

const (
	ConnectionStringEnvKey = "BIGQUERY_CONNECTION_STRING"
)

Functions

func NewStmt

func NewStmt(query string, c *conn) *stmt

Types

type Config

type Config struct {
	ProjectID string
	Location  string
	DataSet   string
}

func ConfigFromConnString

func ConfigFromConnString(in string) (cfg *Config, err error)

ConfigFromConnString will return the Config structures

type Connector

type Connector struct {
	Info   map[string]string
	Client *bigquery.Client
	// contains filtered or unexported fields
}

func NewConnector

func NewConnector(connectionString string) *Connector

func (*Connector) Connect

func (c *Connector) Connect(ctx context.Context) (driver.Conn, error)

func (*Connector) Driver

func (c *Connector) Driver() driver.Driver

type Driver

type Driver struct {
	Config *Config
	// contains filtered or unexported fields
}

func (*Driver) Open

func (d *Driver) Open(connectionString string) (c driver.Conn, err error)