dburl's Introduction

About dburl

Package dburl provides a standardized way of processing database connection strings for PostgreSQL, MySQL, SQLite, Oracle, and Microsoft SQL Server databases in the form of a URL.

Standard URLs are of the form protocol+transport://user:pass@host/dbname?opt1=a&opt2=b.

For example, the following are URLs that can be processed using Parse or Open:

    postgres://user:pass@localhost/mydb
    pgsql://user:[email protected]/anotherdb?sslmode=disable
    mysql://user:pass@localhost:8899/mydb
    oracle://user:[email protected]/someOtherDatabase
    mssql://localhost/databaseName
    sqlserver://localhost/databaseName
    sqlite://path/to/mydatabase.sqlite3
    file://mydb.sqlite3

Additional protocol aliases are provided for all of the databases in order to facilitate better handling of URLs from various sources.

Please note that you still need to import the related database driver package into your code.

Installation

Install in the usual Go fashion:

go install -u github.com/knq/dburl

Usage

Please see the GoDoc API page for a full API listing.

The dburl package can be used similarly to the following:

// example/example.go
package main

import (
	"fmt"
	"log"

	_ "github.com/denisenkom/go-mssqldb"
	"github.com/knq/dburl"
)

func main() {
	db, err := dburl.Open("sqlserver://user:pass@localhost/dbname")
	if err != nil {
		log.Fatal(err)
	}

	var name string
	err = db.QueryRow(`SELECT name FROM mytable WHERE id=10`).Scan(&name)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(">> got: %s\n", name)
}