github.com/cznic/ql@v1.2.1-0.20181122101857-b60735abf8a0/driver/driver.go (about)

     1  // Copyright 2014 The ql Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  /*
     6  Package driver registers QL sql/drivers named "ql", "ql2" and a memory driver named "ql-mem".
     7  
     8  See also [0], [1] and [3].
     9  
    10  Usage
    11  
    12  A skeleton program using ql/driver.
    13  
    14  	package main
    15  
    16  	import (
    17  		"database/sql"
    18  
    19  		_ "github.com/cznic/ql/driver"
    20  	)
    21  
    22  	func main() {
    23  		...
    24  		// Disk file DB
    25  		db, err := sql.Open("ql", "ql.db")  // [2]
    26  		// alternatively
    27  		db, err := sql.Open("ql", "file://ql.db")
    28  
    29  		// and/or
    30  
    31  		// Disk file DB using V2 format
    32  		db, err := sql.Open("ql2", "ql.db")
    33  		// alternatively
    34  		db, err := sql.Open("ql2", "file://ql.db")
    35  
    36  		// and/or
    37  
    38  		// RAM DB
    39  		mdb, err := sql.Open("ql-mem", "mem.db")
    40  		// alternatively
    41  		mdb, err := sql.Open("ql", "memory://mem.db")
    42  		if err != nil {
    43  			log.Fatal(err)
    44  		}
    45  
    46  		// Use db/mdb here
    47  		...
    48  	}
    49  
    50  This package exports nothing.
    51  
    52  Links
    53  
    54  Referenced from above:
    55  
    56    [0]: http://godoc.org/github.com/cznic/ql
    57    [1]: http://golang.org/pkg/database/sql/
    58    [2]: http://golang.org/pkg/database/sql/#Open
    59    [3]: http://golang.org/pkg/database/sql/driver
    60  */
    61  package driver
    62  
    63  import "github.com/cznic/ql"
    64  
    65  func init() {
    66  	ql.RegisterDriver()
    67  	ql.RegisterDriver2()
    68  	ql.RegisterMemDriver()
    69  }