go-sqlite3/sqlite3.go

1115 lines
27 KiB
Go
Raw Normal View History

2014-08-18 11:56:31 +04:00
// Copyright (C) 2014 Yasuhiro Matsumoto <mattn.jp@gmail.com>.
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file.
2014-08-18 12:00:59 +04:00
2013-08-13 17:10:30 +04:00
package sqlite3
2011-11-11 16:36:22 +04:00
/*
#cgo CFLAGS: -std=gnu99
2017-07-05 11:25:03 +03:00
#cgo CFLAGS: -DSQLITE_ENABLE_RTREE -DSQLITE_THREADSAFE=1
2015-09-20 19:07:23 +03:00
#cgo CFLAGS: -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS -DSQLITE_ENABLE_FTS4_UNICODE61
2016-09-05 21:58:10 +03:00
#cgo CFLAGS: -DSQLITE_TRACE_SIZE_LIMIT=15
#cgo CFLAGS: -DSQLITE_DISABLE_INTRINSIC
2016-10-28 17:22:18 +03:00
#cgo CFLAGS: -Wno-deprecated-declarations
#ifndef USE_LIBSQLITE3
#include <sqlite3-binding.h>
#else
#include <sqlite3.h>
#endif
2011-11-11 16:36:22 +04:00
#include <stdlib.h>
#include <string.h>
#ifdef __CYGWIN__
# include <errno.h>
#endif
2013-04-06 18:06:48 +04:00
#ifndef SQLITE_OPEN_READWRITE
# define SQLITE_OPEN_READWRITE 0
#endif
#ifndef SQLITE_OPEN_FULLMUTEX
# define SQLITE_OPEN_FULLMUTEX 0
#endif
2016-04-22 11:20:04 +03:00
#ifndef SQLITE_DETERMINISTIC
# define SQLITE_DETERMINISTIC 0
#endif
static int
_sqlite3_open_v2(const char *filename, sqlite3 **ppDb, int flags, const char *zVfs) {
#ifdef SQLITE_OPEN_URI
return sqlite3_open_v2(filename, ppDb, flags | SQLITE_OPEN_URI, zVfs);
#else
return sqlite3_open_v2(filename, ppDb, flags, zVfs);
#endif
}
2011-11-11 16:36:22 +04:00
static int
_sqlite3_bind_text(sqlite3_stmt *stmt, int n, char *p, int np) {
return sqlite3_bind_text(stmt, n, p, np, SQLITE_TRANSIENT);
}
static int
_sqlite3_bind_blob(sqlite3_stmt *stmt, int n, void *p, int np) {
return sqlite3_bind_blob(stmt, n, p, np, SQLITE_TRANSIENT);
}
#include <stdio.h>
#include <stdint.h>
static int
_sqlite3_exec(sqlite3* db, const char* pcmd, long long* rowid, long long* changes)
{
int rv = sqlite3_exec(db, pcmd, 0, 0, 0);
*rowid = (long long) sqlite3_last_insert_rowid(db);
*changes = (long long) sqlite3_changes(db);
return rv;
}
static int
_sqlite3_step(sqlite3_stmt* stmt, long long* rowid, long long* changes)
{
int rv = sqlite3_step(stmt);
sqlite3* db = sqlite3_db_handle(stmt);
*rowid = (long long) sqlite3_last_insert_rowid(db);
*changes = (long long) sqlite3_changes(db);
return rv;
}
void _sqlite3_result_text(sqlite3_context* ctx, const char* s) {
sqlite3_result_text(ctx, s, -1, &free);
}
void _sqlite3_result_blob(sqlite3_context* ctx, const void* b, int l) {
sqlite3_result_blob(ctx, b, l, SQLITE_TRANSIENT);
}
int _sqlite3_create_function(
sqlite3 *db,
const char *zFunctionName,
int nArg,
int eTextRep,
uintptr_t pApp,
void (*xFunc)(sqlite3_context*,int,sqlite3_value**),
void (*xStep)(sqlite3_context*,int,sqlite3_value**),
void (*xFinal)(sqlite3_context*)
) {
return sqlite3_create_function(db, zFunctionName, nArg, eTextRep, (void*) pApp, xFunc, xStep, xFinal);
}
void callbackTrampoline(sqlite3_context*, int, sqlite3_value**);
int commitHookTrampoline(void*);
void rollbackHookTrampoline(void*);
void updateHookTrampoline(void*, int, char*, char*, sqlite3_int64);
2011-11-11 16:36:22 +04:00
*/
import "C"
import (
2012-01-20 20:44:24 +04:00
"database/sql"
"database/sql/driver"
"errors"
"fmt"
"io"
"net/url"
"reflect"
"runtime"
2015-01-02 09:31:46 +03:00
"strconv"
"strings"
"sync"
"time"
2011-11-11 16:36:22 +04:00
"unsafe"
2016-11-04 08:24:22 +03:00
"golang.org/x/net/context"
2011-11-11 16:36:22 +04:00
)
2016-11-04 18:40:06 +03:00
// SQLiteTimestampFormats is timestamp formats understood by both this module
// and SQLite. The first format in the slice will be used when saving time
// values into the database. When parsing a string from a timestamp or datetime
// column, the formats are tried in order.
var SQLiteTimestampFormats = []string{
// By default, store timestamps with whatever timezone they come with.
// When parsed, they will be returned with the same timezone.
"2006-01-02 15:04:05.999999999-07:00",
"2006-01-02T15:04:05.999999999-07:00",
"2006-01-02 15:04:05.999999999",
"2006-01-02T15:04:05.999999999",
"2006-01-02 15:04:05",
"2006-01-02T15:04:05",
"2006-01-02 15:04",
"2006-01-02T15:04",
"2006-01-02",
}
2011-11-11 16:36:22 +04:00
func init() {
sql.Register("sqlite3", &SQLiteDriver{})
2011-11-11 16:36:22 +04:00
}
2016-02-23 09:20:57 +03:00
// Version returns SQLite library version information.
2016-11-04 18:40:06 +03:00
func Version() (libVersion string, libVersionNumber int, sourceID string) {
libVersion = C.GoString(C.sqlite3_libversion())
libVersionNumber = int(C.sqlite3_libversion_number())
2016-11-04 18:40:06 +03:00
sourceID = C.GoString(C.sqlite3_sourceid())
return libVersion, libVersionNumber, sourceID
}
const (
SQLITE_DELETE = C.SQLITE_DELETE
SQLITE_INSERT = C.SQLITE_INSERT
SQLITE_UPDATE = C.SQLITE_UPDATE
)
2016-11-04 18:40:06 +03:00
// SQLiteDriver implement sql.Driver.
2011-11-11 16:36:22 +04:00
type SQLiteDriver struct {
Extensions []string
ConnectHook func(*SQLiteConn) error
2011-11-11 16:36:22 +04:00
}
2016-11-04 18:40:06 +03:00
// SQLiteConn implement sql.Conn.
2011-11-11 16:36:22 +04:00
type SQLiteConn struct {
2017-08-01 18:06:18 +03:00
mu sync.Mutex
db *C.sqlite3
loc *time.Location
txlock string
funcs []*functionInfo
aggregators []*aggInfo
2011-11-11 16:36:22 +04:00
}
2016-11-04 18:40:06 +03:00
// SQLiteTx implemen sql.Tx.
2011-11-11 16:36:22 +04:00
type SQLiteTx struct {
c *SQLiteConn
}
2016-11-04 18:40:06 +03:00
// SQLiteStmt implement sql.Stmt.
2013-01-31 11:48:30 +04:00
type SQLiteStmt struct {
c *SQLiteConn
s *C.sqlite3_stmt
t string
closed bool
cls bool
2013-01-31 11:48:30 +04:00
}
2016-11-04 18:40:06 +03:00
// SQLiteResult implement sql.Result.
2013-01-31 11:48:30 +04:00
type SQLiteResult struct {
2013-05-11 16:45:48 +04:00
id int64
changes int64
2013-01-31 11:48:30 +04:00
}
2016-11-04 18:40:06 +03:00
// SQLiteRows implement sql.Rows.
2013-01-31 11:48:30 +04:00
type SQLiteRows struct {
s *SQLiteStmt
nc int
cols []string
decltype []string
cls bool
2017-08-01 19:43:14 +03:00
closed bool
2016-11-06 14:43:53 +03:00
done chan struct{}
2013-01-31 11:48:30 +04:00
}
type functionInfo struct {
f reflect.Value
argConverters []callbackArgConverter
variadicConverter callbackArgConverter
retConverter callbackRetConverter
}
func (fi *functionInfo) Call(ctx *C.sqlite3_context, argv []*C.sqlite3_value) {
args, err := callbackConvertArgs(argv, fi.argConverters, fi.variadicConverter)
if err != nil {
callbackError(ctx, err)
return
}
ret := fi.f.Call(args)
if len(ret) == 2 && ret[1].Interface() != nil {
callbackError(ctx, ret[1].Interface().(error))
return
}
err = fi.retConverter(ctx, ret[0])
if err != nil {
callbackError(ctx, err)
return
}
}
type aggInfo struct {
constructor reflect.Value
// Active aggregator objects for aggregations in flight. The
// aggregators are indexed by a counter stored in the aggregation
// user data space provided by sqlite.
active map[int64]reflect.Value
next int64
stepArgConverters []callbackArgConverter
stepVariadicConverter callbackArgConverter
doneRetConverter callbackRetConverter
}
func (ai *aggInfo) agg(ctx *C.sqlite3_context) (int64, reflect.Value, error) {
aggIdx := (*int64)(C.sqlite3_aggregate_context(ctx, C.int(8)))
if *aggIdx == 0 {
*aggIdx = ai.next
ret := ai.constructor.Call(nil)
if len(ret) == 2 && ret[1].Interface() != nil {
return 0, reflect.Value{}, ret[1].Interface().(error)
}
if ret[0].IsNil() {
return 0, reflect.Value{}, errors.New("aggregator constructor returned nil state")
}
ai.next++
ai.active[*aggIdx] = ret[0]
}
return *aggIdx, ai.active[*aggIdx], nil
}
func (ai *aggInfo) Step(ctx *C.sqlite3_context, argv []*C.sqlite3_value) {
_, agg, err := ai.agg(ctx)
if err != nil {
callbackError(ctx, err)
return
}
args, err := callbackConvertArgs(argv, ai.stepArgConverters, ai.stepVariadicConverter)
if err != nil {
callbackError(ctx, err)
return
}
ret := agg.MethodByName("Step").Call(args)
if len(ret) == 1 && ret[0].Interface() != nil {
callbackError(ctx, ret[0].Interface().(error))
return
}
}
func (ai *aggInfo) Done(ctx *C.sqlite3_context) {
idx, agg, err := ai.agg(ctx)
if err != nil {
callbackError(ctx, err)
return
}
defer func() { delete(ai.active, idx) }()
ret := agg.MethodByName("Done").Call(nil)
if len(ret) == 2 && ret[1].Interface() != nil {
callbackError(ctx, ret[1].Interface().(error))
return
}
err = ai.doneRetConverter(ctx, ret[0])
if err != nil {
callbackError(ctx, err)
return
}
}
2013-01-31 11:48:30 +04:00
// Commit transaction.
2011-11-11 16:36:22 +04:00
func (tx *SQLiteTx) Commit() error {
2016-11-08 06:19:13 +03:00
_, err := tx.c.exec(context.Background(), "COMMIT", nil)
if err != nil && err.(Error).Code == C.SQLITE_BUSY {
// sqlite3 will leave the transaction open in this scenario.
// However, database/sql considers the transaction complete once we
// return from Commit() - we must clean up to honour its semantics.
2016-11-08 06:19:13 +03:00
tx.c.exec(context.Background(), "ROLLBACK", nil)
}
return err
2011-11-11 16:36:22 +04:00
}
2013-01-31 11:48:30 +04:00
// Rollback transaction.
2011-11-11 16:36:22 +04:00
func (tx *SQLiteTx) Rollback() error {
2016-11-08 06:19:13 +03:00
_, err := tx.c.exec(context.Background(), "ROLLBACK", nil)
return err
2011-11-11 16:36:22 +04:00
}
// RegisterCommitHook sets the commit hook for a connection.
//
// If the callback returns non-zero the transaction will become a rollback.
//
// If there is an existing commit hook for this connection, it will be
// removed. If callback is nil the existing hook (if any) will be removed
// without creating a new one.
func (c *SQLiteConn) RegisterCommitHook(callback func() int) {
if callback == nil {
C.sqlite3_commit_hook(c.db, nil, nil)
} else {
C.sqlite3_commit_hook(c.db, (*[0]byte)(unsafe.Pointer(C.commitHookTrampoline)), unsafe.Pointer(newHandle(c, callback)))
}
}
// RegisterRollbackHook sets the rollback hook for a connection.
//
// If there is an existing rollback hook for this connection, it will be
// removed. If callback is nil the existing hook (if any) will be removed
// without creating a new one.
func (c *SQLiteConn) RegisterRollbackHook(callback func()) {
if callback == nil {
C.sqlite3_rollback_hook(c.db, nil, nil)
} else {
C.sqlite3_rollback_hook(c.db, (*[0]byte)(unsafe.Pointer(C.rollbackHookTrampoline)), unsafe.Pointer(newHandle(c, callback)))
}
}
// RegisterUpdateHook sets the update hook for a connection.
//
// The parameters to the callback are the operation (one of the constants
// SQLITE_INSERT, SQLITE_DELETE, or SQLITE_UPDATE), the database name, the
// table name, and the rowid.
//
// If there is an existing update hook for this connection, it will be
// removed. If callback is nil the existing hook (if any) will be removed
// without creating a new one.
func (c *SQLiteConn) RegisterUpdateHook(callback func(int, string, string, int64)) {
if callback == nil {
C.sqlite3_update_hook(c.db, nil, nil)
} else {
C.sqlite3_update_hook(c.db, (*[0]byte)(unsafe.Pointer(C.updateHookTrampoline)), unsafe.Pointer(newHandle(c, callback)))
}
}
// RegisterFunc makes a Go function available as a SQLite function.
//
// The Go function can have arguments of the following types: any
// numeric type except complex, bool, []byte, string and
// interface{}. interface{} arguments are given the direct translation
// of the SQLite data type: int64 for INTEGER, float64 for FLOAT,
// []byte for BLOB, string for TEXT.
//
// The function can additionally be variadic, as long as the type of
// the variadic argument is one of the above.
//
// If pure is true. SQLite will assume that the function's return
// value depends only on its inputs, and make more aggressive
// optimizations in its queries.
//
// See _example/go_custom_funcs for a detailed example.
func (c *SQLiteConn) RegisterFunc(name string, impl interface{}, pure bool) error {
var fi functionInfo
fi.f = reflect.ValueOf(impl)
t := fi.f.Type()
if t.Kind() != reflect.Func {
return errors.New("Non-function passed to RegisterFunc")
}
if t.NumOut() != 1 && t.NumOut() != 2 {
return errors.New("SQLite functions must return 1 or 2 values")
}
if t.NumOut() == 2 && !t.Out(1).Implements(reflect.TypeOf((*error)(nil)).Elem()) {
return errors.New("Second return value of SQLite function must be error")
}
numArgs := t.NumIn()
if t.IsVariadic() {
numArgs--
}
for i := 0; i < numArgs; i++ {
conv, err := callbackArg(t.In(i))
if err != nil {
return err
}
fi.argConverters = append(fi.argConverters, conv)
}
if t.IsVariadic() {
conv, err := callbackArg(t.In(numArgs).Elem())
if err != nil {
return err
}
fi.variadicConverter = conv
// Pass -1 to sqlite so that it allows any number of
// arguments. The call helper verifies that the minimum number
// of arguments is present for variadic functions.
numArgs = -1
}
conv, err := callbackRet(t.Out(0))
if err != nil {
return err
}
fi.retConverter = conv
// fi must outlast the database connection, or we'll have dangling pointers.
c.funcs = append(c.funcs, &fi)
cname := C.CString(name)
defer C.free(unsafe.Pointer(cname))
opts := C.SQLITE_UTF8
if pure {
opts |= C.SQLITE_DETERMINISTIC
}
2017-03-04 18:45:41 +03:00
rv := sqlite3CreateFunction(c.db, cname, C.int(numArgs), C.int(opts), newHandle(c, &fi), C.callbackTrampoline, nil, nil)
if rv != C.SQLITE_OK {
return c.lastError()
}
return nil
}
2017-03-04 18:45:41 +03:00
func sqlite3CreateFunction(db *C.sqlite3, zFunctionName *C.char, nArg C.int, eTextRep C.int, pApp uintptr, xFunc unsafe.Pointer, xStep unsafe.Pointer, xFinal unsafe.Pointer) C.int {
2016-11-08 11:07:32 +03:00
return C._sqlite3_create_function(db, zFunctionName, nArg, eTextRep, C.uintptr_t(pApp), (*[0]byte)(unsafe.Pointer(xFunc)), (*[0]byte)(unsafe.Pointer(xStep)), (*[0]byte)(unsafe.Pointer(xFinal)))
2016-11-08 06:19:13 +03:00
}
2013-09-09 05:44:44 +04:00
// AutoCommit return which currently auto commit or not.
2013-08-23 09:11:15 +04:00
func (c *SQLiteConn) AutoCommit() bool {
2013-08-23 09:26:33 +04:00
return int(C.sqlite3_get_autocommit(c.db)) != 0
2013-08-23 09:11:15 +04:00
}
func (c *SQLiteConn) lastError() error {
return lastError(c.db)
}
func lastError(db *C.sqlite3) error {
rv := C.sqlite3_errcode(db)
if rv == C.SQLITE_OK {
return nil
}
return Error{
Code: ErrNo(rv),
ExtendedCode: ErrNoExtended(C.sqlite3_extended_errcode(db)),
err: C.GoString(C.sqlite3_errmsg(db)),
}
}
2016-11-04 18:40:06 +03:00
// Exec implements Execer.
func (c *SQLiteConn) Exec(query string, args []driver.Value) (driver.Result, error) {
2016-11-04 08:24:22 +03:00
list := make([]namedValue, len(args))
for i, v := range args {
list[i] = namedValue{
Ordinal: i + 1,
Value: v,
}
}
return c.exec(context.Background(), query, list)
}
func (c *SQLiteConn) exec(ctx context.Context, query string, args []namedValue) (driver.Result, error) {
2016-11-04 09:00:29 +03:00
start := 0
2014-06-25 22:54:09 +04:00
for {
2016-11-08 19:13:34 +03:00
s, err := c.prepare(ctx, query)
2014-06-25 22:54:09 +04:00
if err != nil {
return nil, err
}
var res driver.Result
if s.(*SQLiteStmt).s != nil {
na := s.NumInput()
2014-08-18 13:48:48 +04:00
if len(args) < na {
2017-01-07 16:22:02 +03:00
s.Close()
2017-03-05 16:16:51 +03:00
return nil, fmt.Errorf("not enough args to execute query: want %d got %d", na, len(args))
2014-08-18 13:23:58 +04:00
}
2016-11-04 09:00:29 +03:00
for i := 0; i < na; i++ {
args[i].Ordinal -= start
}
2016-11-04 08:24:22 +03:00
res, err = s.(*SQLiteStmt).exec(ctx, args[:na])
2014-06-25 22:54:09 +04:00
if err != nil && err != driver.ErrSkip {
s.Close()
return nil, err
}
args = args[na:]
2016-11-04 09:00:29 +03:00
start += na
2014-06-25 22:54:09 +04:00
}
tail := s.(*SQLiteStmt).t
s.Close()
2014-06-25 22:54:09 +04:00
if tail == "" {
return res, nil
}
query = tail
}
}
2016-11-04 08:24:22 +03:00
type namedValue struct {
Name string
Ordinal int
Value driver.Value
}
2016-11-04 18:40:06 +03:00
// Query implements Queryer.
func (c *SQLiteConn) Query(query string, args []driver.Value) (driver.Rows, error) {
2016-11-04 08:24:22 +03:00
list := make([]namedValue, len(args))
for i, v := range args {
list[i] = namedValue{
Ordinal: i + 1,
Value: v,
}
}
return c.query(context.Background(), query, list)
}
func (c *SQLiteConn) query(ctx context.Context, query string, args []namedValue) (driver.Rows, error) {
2016-11-04 09:00:29 +03:00
start := 0
2014-06-25 22:54:09 +04:00
for {
2016-11-08 19:13:34 +03:00
s, err := c.prepare(ctx, query)
2014-06-25 22:54:09 +04:00
if err != nil {
return nil, err
}
s.(*SQLiteStmt).cls = true
2014-06-25 22:54:09 +04:00
na := s.NumInput()
if len(args) < na {
2017-03-05 16:16:51 +03:00
return nil, fmt.Errorf("not enough args to execute query: want %d got %d", na, len(args))
}
2016-11-04 09:00:29 +03:00
for i := 0; i < na; i++ {
args[i].Ordinal -= start
}
2016-11-04 08:24:22 +03:00
rows, err := s.(*SQLiteStmt).query(ctx, args[:na])
2014-06-25 22:54:09 +04:00
if err != nil && err != driver.ErrSkip {
s.Close()
2016-11-08 07:22:46 +03:00
return rows, err
2014-06-25 22:54:09 +04:00
}
args = args[na:]
2016-11-04 09:00:29 +03:00
start += na
2014-06-25 22:54:09 +04:00
tail := s.(*SQLiteStmt).t
if tail == "" {
return rows, nil
}
2014-11-13 20:21:49 +03:00
rows.Close()
2014-06-25 22:54:09 +04:00
s.Close()
query = tail
}
}
2013-01-31 11:48:30 +04:00
// Begin transaction.
2011-11-11 16:36:22 +04:00
func (c *SQLiteConn) Begin() (driver.Tx, error) {
2016-11-04 09:15:16 +03:00
return c.begin(context.Background())
}
func (c *SQLiteConn) begin(ctx context.Context) (driver.Tx, error) {
2016-11-08 06:19:13 +03:00
if _, err := c.exec(ctx, c.txlock, nil); err != nil {
2011-11-11 16:36:22 +04:00
return nil, err
}
return &SQLiteTx{c}, nil
}
func errorString(err Error) string {
return C.GoString(C.sqlite3_errstr(C.int(err.Code)))
}
2013-01-31 11:48:30 +04:00
// Open database and return a new connection.
2016-02-23 09:20:57 +03:00
// You can specify a DSN string using a URI as the filename.
2013-01-31 11:48:30 +04:00
// test.db
// file:test.db?cache=shared&mode=memory
// :memory:
// file::memory:
2015-06-05 17:03:38 +03:00
// go-sqlite3 adds the following query parameters to those used by SQLite:
// _loc=XXX
// Specify location of time format. It's possible to specify "auto".
// _busy_timeout=XXX
// Specify value for sqlite3_busy_timeout.
// _txlock=XXX
// Specify locking behavior for transactions. XXX can be "immediate",
// "deferred", "exclusive".
// _foreign_keys=X
// Enable or disable enforcement of foreign keys. X can be 1 or 0.
// _recursive_triggers=X
// Enable or disable recursive triggers. X can be 1 or 0.
2011-11-11 16:36:22 +04:00
func (d *SQLiteDriver) Open(dsn string) (driver.Conn, error) {
if C.sqlite3_threadsafe() == 0 {
return nil, errors.New("sqlite library was not compiled for thread-safe operation")
}
var loc *time.Location
txlock := "BEGIN"
2016-11-04 18:40:06 +03:00
busyTimeout := 5000
foreignKeys := -1
recursiveTriggers := -1
2015-03-05 05:05:58 +03:00
pos := strings.IndexRune(dsn, '?')
if pos >= 1 {
params, err := url.ParseQuery(dsn[pos+1:])
if err != nil {
return nil, err
}
// _loc
if val := params.Get("_loc"); val != "" {
2015-03-05 05:05:58 +03:00
if val == "auto" {
loc = time.Local
} else {
loc, err = time.LoadLocation(val)
if err != nil {
return nil, fmt.Errorf("Invalid _loc: %v: %v", val, err)
}
}
}
2015-03-05 05:05:58 +03:00
// _busy_timeout
if val := params.Get("_busy_timeout"); val != "" {
2015-03-21 21:16:35 +03:00
iv, err := strconv.ParseInt(val, 10, 64)
if err != nil {
return nil, fmt.Errorf("Invalid _busy_timeout: %v: %v", val, err)
}
2016-11-04 18:40:06 +03:00
busyTimeout = int(iv)
}
// _txlock
if val := params.Get("_txlock"); val != "" {
switch val {
case "immediate":
txlock = "BEGIN IMMEDIATE"
case "exclusive":
txlock = "BEGIN EXCLUSIVE"
case "deferred":
txlock = "BEGIN"
default:
return nil, fmt.Errorf("Invalid _txlock: %v", val)
}
}
// _foreign_keys
if val := params.Get("_foreign_keys"); val != "" {
switch val {
case "1":
foreignKeys = 1
case "0":
foreignKeys = 0
default:
return nil, fmt.Errorf("Invalid _foreign_keys: %v", val)
}
}
// _recursive_triggers
if val := params.Get("_recursive_triggers"); val != "" {
switch val {
case "1":
recursiveTriggers = 1
case "0":
recursiveTriggers = 0
default:
return nil, fmt.Errorf("Invalid _recursive_triggers: %v", val)
}
}
2015-03-05 20:23:57 +03:00
if !strings.HasPrefix(dsn, "file:") {
2015-03-05 20:00:09 +03:00
dsn = dsn[:pos]
}
}
2011-11-11 16:36:22 +04:00
var db *C.sqlite3
name := C.CString(dsn)
defer C.free(unsafe.Pointer(name))
rv := C._sqlite3_open_v2(name, &db,
2011-11-11 16:36:22 +04:00
C.SQLITE_OPEN_FULLMUTEX|
C.SQLITE_OPEN_READWRITE|
C.SQLITE_OPEN_CREATE,
2011-11-11 16:36:22 +04:00
nil)
if rv != 0 {
return nil, Error{Code: ErrNo(rv)}
2011-11-11 16:36:22 +04:00
}
if db == nil {
return nil, errors.New("sqlite succeeded without returning a database")
}
2012-03-12 09:20:55 +04:00
2016-11-04 18:40:06 +03:00
rv = C.sqlite3_busy_timeout(db, C.int(busyTimeout))
2012-03-12 09:20:55 +04:00
if rv != C.SQLITE_OK {
C.sqlite3_close_v2(db)
return nil, Error{Code: ErrNo(rv)}
2012-03-12 09:20:55 +04:00
}
exec := func(s string) error {
cs := C.CString(s)
rv := C.sqlite3_exec(db, cs, nil, nil, nil)
C.free(unsafe.Pointer(cs))
if rv != C.SQLITE_OK {
return lastError(db)
}
return nil
}
if foreignKeys == 0 {
if err := exec("PRAGMA foreign_keys = OFF;"); err != nil {
C.sqlite3_close_v2(db)
return nil, err
}
} else if foreignKeys == 1 {
if err := exec("PRAGMA foreign_keys = ON;"); err != nil {
C.sqlite3_close_v2(db)
return nil, err
}
}
if recursiveTriggers == 0 {
if err := exec("PRAGMA recursive_triggers = OFF;"); err != nil {
C.sqlite3_close_v2(db)
return nil, err
}
} else if recursiveTriggers == 1 {
if err := exec("PRAGMA recursive_triggers = ON;"); err != nil {
C.sqlite3_close_v2(db)
return nil, err
}
}
conn := &SQLiteConn{db: db, loc: loc, txlock: txlock}
2013-08-23 08:58:54 +04:00
if len(d.Extensions) > 0 {
if err := conn.loadExtensions(d.Extensions); err != nil {
conn.Close()
return nil, err
}
}
2013-08-23 08:58:54 +04:00
if d.ConnectHook != nil {
if err := d.ConnectHook(conn); err != nil {
conn.Close()
return nil, err
}
2013-08-23 08:58:54 +04:00
}
runtime.SetFinalizer(conn, (*SQLiteConn).Close)
2013-08-23 08:58:54 +04:00
return conn, nil
2011-11-11 16:36:22 +04:00
}
2013-01-31 11:48:30 +04:00
// Close the connection.
2011-11-11 16:36:22 +04:00
func (c *SQLiteConn) Close() error {
2013-10-24 17:21:37 +04:00
rv := C.sqlite3_close_v2(c.db)
2011-11-11 16:36:22 +04:00
if rv != C.SQLITE_OK {
return c.lastError()
2011-11-11 16:36:22 +04:00
}
deleteHandles(c)
2017-08-01 18:06:18 +03:00
c.mu.Lock()
2011-11-11 16:36:22 +04:00
c.db = nil
2017-08-01 18:06:18 +03:00
c.mu.Unlock()
runtime.SetFinalizer(c, nil)
2011-11-11 16:36:22 +04:00
return nil
}
func (c *SQLiteConn) dbConnOpen() bool {
if c == nil {
return false
}
2017-08-01 18:06:18 +03:00
c.mu.Lock()
defer c.mu.Unlock()
return c.db != nil
}
2016-02-23 09:20:57 +03:00
// Prepare the query string. Return a new statement.
2011-11-11 16:36:22 +04:00
func (c *SQLiteConn) Prepare(query string) (driver.Stmt, error) {
2016-11-04 09:11:24 +03:00
return c.prepare(context.Background(), query)
}
func (c *SQLiteConn) prepare(ctx context.Context, query string) (driver.Stmt, error) {
2011-11-11 16:36:22 +04:00
pquery := C.CString(query)
defer C.free(unsafe.Pointer(pquery))
var s *C.sqlite3_stmt
2013-09-09 05:44:44 +04:00
var tail *C.char
rv := C.sqlite3_prepare_v2(c.db, pquery, -1, &s, &tail)
2011-11-11 16:36:22 +04:00
if rv != C.SQLITE_OK {
return nil, c.lastError()
2011-11-11 16:36:22 +04:00
}
var t string
2015-03-24 00:18:23 +03:00
if tail != nil && *tail != '\000' {
2013-09-09 05:44:44 +04:00
t = strings.TrimSpace(C.GoString(tail))
2011-11-11 16:36:22 +04:00
}
2016-11-04 09:00:29 +03:00
ss := &SQLiteStmt{c: c, s: s, t: t}
runtime.SetFinalizer(ss, (*SQLiteStmt).Close)
return ss, nil
2011-11-11 16:36:22 +04:00
}
2013-01-31 11:48:30 +04:00
// Close the statement.
2011-11-11 16:36:22 +04:00
func (s *SQLiteStmt) Close() error {
2012-02-20 11:14:49 +04:00
if s.closed {
return nil
}
s.closed = true
if !s.c.dbConnOpen() {
2013-02-13 05:32:40 +04:00
return errors.New("sqlite statement with already closed database connection")
}
2011-11-11 16:38:53 +04:00
rv := C.sqlite3_finalize(s.s)
2017-08-28 12:58:02 +03:00
s.s = nil
2011-11-11 16:36:22 +04:00
if rv != C.SQLITE_OK {
return s.c.lastError()
2011-11-11 16:36:22 +04:00
}
runtime.SetFinalizer(s, nil)
2011-11-11 16:36:22 +04:00
return nil
}
2016-11-04 18:40:06 +03:00
// NumInput return a number of parameters.
2011-11-11 16:36:22 +04:00
func (s *SQLiteStmt) NumInput() int {
2016-11-04 09:00:29 +03:00
return int(C.sqlite3_bind_parameter_count(s.s))
}
type bindArg struct {
n int
v driver.Value
2011-11-11 16:36:22 +04:00
}
var placeHolder = []byte{0}
2016-11-04 08:24:22 +03:00
func (s *SQLiteStmt) bind(args []namedValue) error {
2011-11-11 16:36:22 +04:00
rv := C.sqlite3_reset(s.s)
2011-11-11 16:38:53 +04:00
if rv != C.SQLITE_ROW && rv != C.SQLITE_OK && rv != C.SQLITE_DONE {
return s.c.lastError()
2011-11-11 16:36:22 +04:00
}
2016-11-04 09:00:29 +03:00
for i, v := range args {
if v.Name != "" {
2016-12-09 07:12:14 +03:00
cname := C.CString(":" + v.Name)
2016-11-04 09:00:29 +03:00
args[i].Ordinal = int(C.sqlite3_bind_parameter_index(s.s, cname))
C.free(unsafe.Pointer(cname))
}
}
2016-11-04 09:00:29 +03:00
for _, arg := range args {
n := C.int(arg.Ordinal)
switch v := arg.Value.(type) {
2011-11-11 16:36:22 +04:00
case nil:
rv = C.sqlite3_bind_null(s.s, n)
case string:
if len(v) == 0 {
rv = C._sqlite3_bind_text(s.s, n, (*C.char)(unsafe.Pointer(&placeHolder[0])), C.int(0))
} else {
b := []byte(v)
rv = C._sqlite3_bind_text(s.s, n, (*C.char)(unsafe.Pointer(&b[0])), C.int(len(b)))
}
2011-11-11 16:36:22 +04:00
case int64:
rv = C.sqlite3_bind_int64(s.s, n, C.sqlite3_int64(v))
case bool:
if bool(v) {
2012-03-12 09:20:55 +04:00
rv = C.sqlite3_bind_int(s.s, n, 1)
2011-11-11 16:36:22 +04:00
} else {
rv = C.sqlite3_bind_int(s.s, n, 0)
}
case float64:
rv = C.sqlite3_bind_double(s.s, n, C.double(v))
case []byte:
2017-08-21 23:30:07 +03:00
ln := len(v)
if ln == 0 {
v = placeHolder
2011-11-11 16:36:22 +04:00
}
2017-08-21 23:30:07 +03:00
rv = C._sqlite3_bind_blob(s.s, n, unsafe.Pointer(&v[0]), C.int(ln))
case time.Time:
b := []byte(v.Format(SQLiteTimestampFormats[0]))
2015-03-04 19:17:38 +03:00
rv = C._sqlite3_bind_text(s.s, n, (*C.char)(unsafe.Pointer(&b[0])), C.int(len(b)))
2011-11-11 16:36:22 +04:00
}
if rv != C.SQLITE_OK {
return s.c.lastError()
2011-11-11 16:36:22 +04:00
}
}
return nil
}
2014-02-18 04:06:30 +04:00
// Query the statement with arguments. Return records.
2012-02-20 11:14:49 +04:00
func (s *SQLiteStmt) Query(args []driver.Value) (driver.Rows, error) {
2016-11-04 08:24:22 +03:00
list := make([]namedValue, len(args))
for i, v := range args {
list[i] = namedValue{
Ordinal: i + 1,
Value: v,
}
}
return s.query(context.Background(), list)
}
func (s *SQLiteStmt) query(ctx context.Context, args []namedValue) (driver.Rows, error) {
2011-11-11 16:36:22 +04:00
if err := s.bind(args); err != nil {
return nil, err
}
2016-11-06 14:43:53 +03:00
rows := &SQLiteRows{
s: s,
nc: int(C.sqlite3_column_count(s.s)),
cols: nil,
decltype: nil,
cls: s.cls,
2017-08-01 19:43:14 +03:00
closed: false,
2016-11-06 14:43:53 +03:00
done: make(chan struct{}),
}
2017-02-11 15:47:11 +03:00
go func(db *C.sqlite3) {
2016-11-06 14:43:53 +03:00
select {
case <-ctx.Done():
2017-02-11 15:47:11 +03:00
select {
case <-rows.done:
default:
2017-02-16 09:57:29 +03:00
C.sqlite3_interrupt(db)
2017-02-11 15:47:11 +03:00
rows.Close()
}
2016-11-06 14:43:53 +03:00
case <-rows.done:
}
2017-02-11 15:47:11 +03:00
}(s.c.db)
2016-11-06 14:43:53 +03:00
return rows, nil
2011-11-11 16:36:22 +04:00
}
2016-11-04 18:40:06 +03:00
// LastInsertId teturn last inserted ID.
2011-11-14 17:10:13 +04:00
func (r *SQLiteResult) LastInsertId() (int64, error) {
return r.id, nil
2011-11-14 17:10:13 +04:00
}
2016-11-04 18:40:06 +03:00
// RowsAffected return how many rows affected.
2011-11-14 17:10:13 +04:00
func (r *SQLiteResult) RowsAffected() (int64, error) {
return r.changes, nil
2011-11-14 17:10:13 +04:00
}
2016-11-04 18:40:06 +03:00
// Exec execute the statement with arguments. Return result object.
2012-02-20 11:14:49 +04:00
func (s *SQLiteStmt) Exec(args []driver.Value) (driver.Result, error) {
2016-11-04 08:24:22 +03:00
list := make([]namedValue, len(args))
for i, v := range args {
list[i] = namedValue{
Ordinal: i + 1,
Value: v,
}
}
return s.exec(context.Background(), list)
}
func (s *SQLiteStmt) exec(ctx context.Context, args []namedValue) (driver.Result, error) {
2011-11-11 16:36:22 +04:00
if err := s.bind(args); err != nil {
2014-11-16 17:51:46 +03:00
C.sqlite3_reset(s.s)
C.sqlite3_clear_bindings(s.s)
2011-11-11 16:36:22 +04:00
return nil, err
}
2016-11-06 14:46:27 +03:00
done := make(chan struct{})
defer close(done)
2017-01-03 16:25:02 +03:00
go func(db *C.sqlite3) {
2016-11-06 14:46:27 +03:00
select {
case <-ctx.Done():
2017-01-03 16:25:02 +03:00
C.sqlite3_interrupt(db)
2016-11-06 14:46:27 +03:00
case <-done:
}
2017-01-03 16:25:02 +03:00
}(s.c.db)
2016-11-06 14:46:27 +03:00
var rowid, changes C.longlong
rv := C._sqlite3_step(s.s, &rowid, &changes)
2011-11-11 16:38:53 +04:00
if rv != C.SQLITE_ROW && rv != C.SQLITE_OK && rv != C.SQLITE_DONE {
err := s.c.lastError()
2014-11-16 17:51:46 +03:00
C.sqlite3_reset(s.s)
C.sqlite3_clear_bindings(s.s)
return nil, err
2011-11-11 16:36:22 +04:00
}
2016-11-06 14:46:27 +03:00
2016-11-08 06:19:13 +03:00
return &SQLiteResult{id: int64(rowid), changes: int64(changes)}, nil
2011-11-11 16:36:22 +04:00
}
2013-01-31 11:48:30 +04:00
// Close the rows.
2011-11-11 16:36:22 +04:00
func (rc *SQLiteRows) Close() error {
2017-08-01 19:43:14 +03:00
if rc.s.closed || rc.closed {
2013-09-09 07:28:34 +04:00
return nil
}
2017-08-01 19:43:14 +03:00
rc.closed = true
2016-11-06 14:43:53 +03:00
if rc.done != nil {
close(rc.done)
}
if rc.cls {
return rc.s.Close()
}
2012-03-12 09:20:55 +04:00
rv := C.sqlite3_reset(rc.s.s)
if rv != C.SQLITE_OK {
return rc.s.c.lastError()
2012-03-12 09:20:55 +04:00
}
return nil
2011-11-11 16:36:22 +04:00
}
2016-11-04 18:40:06 +03:00
// Columns return column names.
2011-11-11 16:36:22 +04:00
func (rc *SQLiteRows) Columns() []string {
if rc.nc != len(rc.cols) {
rc.cols = make([]string, rc.nc)
for i := 0; i < rc.nc; i++ {
rc.cols[i] = C.GoString(C.sqlite3_column_name(rc.s.s, C.int(i)))
}
}
return rc.cols
}
2016-11-04 18:40:06 +03:00
// DeclTypes return column types.
2016-03-06 23:27:17 +03:00
func (rc *SQLiteRows) DeclTypes() []string {
if rc.decltype == nil {
rc.decltype = make([]string, rc.nc)
for i := 0; i < rc.nc; i++ {
rc.decltype[i] = strings.ToLower(C.GoString(C.sqlite3_column_decltype(rc.s.s, C.int(i))))
}
}
return rc.decltype
}
2016-11-04 18:40:06 +03:00
// Next move cursor to next.
2012-02-20 11:14:49 +04:00
func (rc *SQLiteRows) Next(dest []driver.Value) error {
rv := C.sqlite3_step(rc.s.s)
if rv == C.SQLITE_DONE {
return io.EOF
}
if rv != C.SQLITE_ROW {
rv = C.sqlite3_reset(rc.s.s)
if rv != C.SQLITE_OK {
return rc.s.c.lastError()
2013-09-09 08:44:24 +04:00
}
return nil
2011-11-11 16:36:22 +04:00
}
2016-03-06 23:27:17 +03:00
rc.DeclTypes()
2011-11-11 16:36:22 +04:00
for i := range dest {
2011-11-11 16:38:53 +04:00
switch C.sqlite3_column_type(rc.s.s, C.int(i)) {
case C.SQLITE_INTEGER:
val := int64(C.sqlite3_column_int64(rc.s.s, C.int(i)))
switch rc.decltype[i] {
case "timestamp", "datetime", "date":
2015-03-05 05:05:58 +03:00
var t time.Time
// Assume a millisecond unix timestamp if it's 13 digits -- too
// large to be a reasonable timestamp in seconds.
if val > 1e12 || val < -1e12 {
val *= int64(time.Millisecond) // convert ms to nsec
t = time.Unix(0, val)
2015-01-02 09:31:46 +03:00
} else {
t = time.Unix(val, 0)
2015-03-05 05:05:58 +03:00
}
t = t.UTC()
2015-03-05 05:05:58 +03:00
if rc.s.c.loc != nil {
t = t.In(rc.s.c.loc)
2015-01-02 09:31:46 +03:00
}
2015-03-05 05:05:58 +03:00
dest[i] = t
case "boolean":
dest[i] = val > 0
default:
dest[i] = val
}
2011-11-11 16:38:53 +04:00
case C.SQLITE_FLOAT:
dest[i] = float64(C.sqlite3_column_double(rc.s.s, C.int(i)))
case C.SQLITE_BLOB:
p := C.sqlite3_column_blob(rc.s.s, C.int(i))
if p == nil {
dest[i] = nil
continue
}
n := int(C.sqlite3_column_bytes(rc.s.s, C.int(i)))
switch dest[i].(type) {
case sql.RawBytes:
dest[i] = (*[1 << 30]byte)(unsafe.Pointer(p))[0:n]
default:
slice := make([]byte, n)
copy(slice[:], (*[1 << 30]byte)(unsafe.Pointer(p))[0:n])
dest[i] = slice
}
2011-11-11 16:38:53 +04:00
case C.SQLITE_NULL:
dest[i] = nil
case C.SQLITE_TEXT:
var err error
var timeVal time.Time
n := int(C.sqlite3_column_bytes(rc.s.s, C.int(i)))
s := C.GoStringN((*C.char)(unsafe.Pointer(C.sqlite3_column_text(rc.s.s, C.int(i)))), C.int(n))
2012-12-30 02:20:27 +04:00
switch rc.decltype[i] {
case "timestamp", "datetime", "date":
2015-03-05 05:05:58 +03:00
var t time.Time
2015-04-15 10:26:27 +03:00
s = strings.TrimSuffix(s, "Z")
2015-03-04 16:58:32 +03:00
for _, format := range SQLiteTimestampFormats {
2015-03-04 19:17:38 +03:00
if timeVal, err = time.ParseInLocation(format, s, time.UTC); err == nil {
2015-03-05 05:05:58 +03:00
t = timeVal
2015-03-04 16:58:32 +03:00
break
}
}
if err != nil {
2012-12-30 02:20:27 +04:00
// The column is a time value, so return the zero time on parse failure.
2015-03-05 05:05:58 +03:00
t = time.Time{}
}
if rc.s.c.loc != nil {
t = t.In(rc.s.c.loc)
}
2015-03-05 05:05:58 +03:00
dest[i] = t
default:
dest[i] = []byte(s)
}
2011-11-11 16:36:22 +04:00
}
}
return nil
}