Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 6f57461583
Fetching contributors…

Cannot retrieve contributors at this time

file 533 lines (476 sloc) 16.692 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
// Copyright 2010 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package sqlite provides access to the SQLite library, version 3.
package sqlite

/*
#cgo LDFLAGS: -lsqlite3

#include <sqlite3.h>
#include <stdlib.h>

// cgo doesn't support varargs
static int my_db_config(sqlite3 *db, int op, int v, int *ok) {
return sqlite3_db_config(db, op, v, ok);
}
*/
import "C"

import (
"errors"
"fmt"
"io"
"unsafe"
)

type ConnError struct {
c *Conn
code Errno
msg string
details string
}

func (e *ConnError) Code() Errno {
return e.code
}

// FIXME it might be the case that a second error occurs on a separate thread in between the time of the first error and the call to this method.
func (e *ConnError) ExtendedCode() int {
return int(C.sqlite3_extended_errcode(e.c.db))
}

// Return Database file name from which the error comes from.
func (e *ConnError) Filename() string {
return e.c.Filename("main")
}

func (e *ConnError) Error() string { // FIXME code.Error() & e.msg are often redundant...
if len(e.details) > 0 {
return fmt.Sprintf("%s; %s (%s)", e.code.Error(), e.msg, e.details)
} else if len(e.msg) > 0 {
return fmt.Sprintf("%s; %s", e.code.Error(), e.msg)
}
return e.code.Error()
}

// Result codes
type Errno int

func (e Errno) Error() string {
s := errText[e]
if s == "" {
return fmt.Sprintf("errno %d", int(e))
}
return s
}

var (
ErrError error = Errno(C.SQLITE_ERROR) /* SQL error or missing database */
ErrInternal error = Errno(C.SQLITE_INTERNAL) /* Internal logic error in SQLite */
ErrPerm error = Errno(C.SQLITE_PERM) /* Access permission denied */
ErrAbort error = Errno(C.SQLITE_ABORT) /* Callback routine requested an abort */
ErrBusy error = Errno(C.SQLITE_BUSY) /* The database file is locked */
ErrLocked error = Errno(C.SQLITE_LOCKED) /* A table in the database is locked */
ErrNoMem error = Errno(C.SQLITE_NOMEM) /* A malloc() failed */
ErrReadOnly error = Errno(C.SQLITE_READONLY) /* Attempt to write a readonly database */
ErrInterrupt error = Errno(C.SQLITE_INTERRUPT) /* Operation terminated by sqlite3_interrupt()*/
ErrIOErr error = Errno(C.SQLITE_IOERR) /* Some kind of disk I/O error occurred */
ErrCorrupt error = Errno(C.SQLITE_CORRUPT) /* The database disk image is malformed */
ErrNotFound error = Errno(C.SQLITE_NOTFOUND) /* Unknown opcode in sqlite3_file_control() */
ErrFull error = Errno(C.SQLITE_FULL) /* Insertion failed because database is full */
ErrCantOpen error = Errno(C.SQLITE_CANTOPEN) /* Unable to open the database file */
ErrProtocol error = Errno(C.SQLITE_PROTOCOL) /* Database lock protocol error */
ErrEmpty error = Errno(C.SQLITE_EMPTY) /* Database is empty */
ErrSchema error = Errno(C.SQLITE_SCHEMA) /* The database schema changed */
ErrTooBig error = Errno(C.SQLITE_TOOBIG) /* String or BLOB exceeds size limit */
ErrConstraint error = Errno(C.SQLITE_CONSTRAINT) /* Abort due to constraint violation */
ErrMismatch error = Errno(C.SQLITE_MISMATCH) /* Data type mismatch */
ErrMisuse error = Errno(C.SQLITE_MISUSE) /* Library used incorrectly */
ErrNolfs error = Errno(C.SQLITE_NOLFS) /* Uses OS features not supported on host */
ErrAuth error = Errno(C.SQLITE_AUTH) /* Authorization denied */
ErrFormat error = Errno(C.SQLITE_FORMAT) /* Auxiliary database format error */
ErrRange error = Errno(C.SQLITE_RANGE) /* 2nd parameter to sqlite3_bind out of range */
ErrNotDB error = Errno(C.SQLITE_NOTADB) /* File opened that is not a database file */
Row = Errno(C.SQLITE_ROW) /* sqlite3_step() has another row ready */
Done = Errno(C.SQLITE_DONE) /* sqlite3_step() has finished executing */
ErrSpecific = Errno(-1) /* Wrapper specific error */
)

var errText = map[Errno]string{
C.SQLITE_ERROR: "SQL error or missing database",
C.SQLITE_INTERNAL: "Internal logic error in SQLite",
C.SQLITE_PERM: "Access permission denied",
C.SQLITE_ABORT: "Callback routine requested an abort",
C.SQLITE_BUSY: "The database file is locked",
C.SQLITE_LOCKED: "A table in the database is locked",
C.SQLITE_NOMEM: "A malloc() failed",
C.SQLITE_READONLY: "Attempt to write a readonly database",
C.SQLITE_INTERRUPT: "Operation terminated by sqlite3_interrupt()",
C.SQLITE_IOERR: "Some kind of disk I/O error occurred",
C.SQLITE_CORRUPT: "The database disk image is malformed",
C.SQLITE_NOTFOUND: "Unknown opcode in sqlite3_file_control()",
C.SQLITE_FULL: "Insertion failed because database is full",
C.SQLITE_CANTOPEN: "Unable to open the database file",
C.SQLITE_PROTOCOL: "Database lock protocol error",
C.SQLITE_EMPTY: "Database is empty",
C.SQLITE_SCHEMA: "The database schema changed",
C.SQLITE_TOOBIG: "String or BLOB exceeds size limit",
C.SQLITE_CONSTRAINT: "Abort due to constraint violation",
C.SQLITE_MISMATCH: "Data type mismatch",
C.SQLITE_MISUSE: "Library used incorrectly",
C.SQLITE_NOLFS: "Uses OS features not supported on host",
C.SQLITE_AUTH: "Authorization denied",
C.SQLITE_FORMAT: "Auxiliary database format error",
C.SQLITE_RANGE: "2nd parameter to sqlite3_bind out of range",
C.SQLITE_NOTADB: "File opened that is not a database file",
Row: "sqlite3_step() has another row ready",
Done: "sqlite3_step() has finished executing",
ErrSpecific: "Wrapper specific error",
}

func (c *Conn) error(rv C.int, details ...string) error {
if c == nil {
return errors.New("nil sqlite database")
}
if rv == C.SQLITE_OK {
return nil
}
err := &ConnError{c: c, code: Errno(rv), msg: C.GoString(C.sqlite3_errmsg(c.db))}
if len(details) > 0 {
err.details = details[0]
}
return err
}

func (c *Conn) specificError(msg string, a ...interface{}) error {
return &ConnError{c: c, code: ErrSpecific, msg: fmt.Sprintf(msg, a...)}
}

func (c *Conn) LastError() error {
if c == nil {
return errors.New("nil sqlite database")
}
return &ConnError{c: c, code: Errno(C.sqlite3_errcode(c.db)), msg: C.GoString(C.sqlite3_errmsg(c.db))}
}

// Database connection handle
type Conn struct {
db *C.sqlite3
stmtCache *cache
authorizer *sqliteAuthorizer
busyHandler *sqliteBusyHandler
profile *sqliteProfile
progressHandler *sqliteProgressHandler
trace *sqliteTrace
commitHook *sqliteCommitHook
rollbackHook *sqliteRollbackHook
updateHook *sqliteUpdateHook
udfs map[string]*sqliteFunction
}

// Run-time library version number
// (See http://sqlite.org/c3ref/libversion.html)
func Version() string {
p := C.sqlite3_libversion()
return C.GoString(p)
}

// Flags for file open operations
type OpenFlag int

const (
OPEN_READONLY OpenFlag = C.SQLITE_OPEN_READONLY
OPEN_READWRITE OpenFlag = C.SQLITE_OPEN_READWRITE
OPEN_CREATE OpenFlag = C.SQLITE_OPEN_CREATE
OPEN_URI OpenFlag = C.SQLITE_OPEN_URI
OPEN_NOMUTEX OpenFlag = C.SQLITE_OPEN_NOMUTEX
OPEN_FULLMUTEX OpenFlag = C.SQLITE_OPEN_FULLMUTEX
OPEN_SHAREDCACHE OpenFlag = C.SQLITE_OPEN_SHAREDCACHE
OPEN_PRIVATECACHE OpenFlag = C.SQLITE_OPEN_PRIVATECACHE
)

// Open a new database connection.
// ":memory:" for memory db
// "" for temp file db
//
// (See sqlite3_open_v2: http://sqlite.org/c3ref/open.html)
func Open(filename string, flags ...OpenFlag) (*Conn, error) {
return OpenVfs(filename, "", flags...)
}

// Open a new database with a specified virtual file system.
func OpenVfs(filename string, vfsname string, flags ...OpenFlag) (*Conn, error) {
if C.sqlite3_threadsafe() == 0 {
return nil, errors.New("sqlite library was not compiled for thread-safe operation")
}
var openFlags int
if len(flags) > 0 {
for _, flag := range flags {
openFlags |= int(flag)
}
} else {
openFlags = C.SQLITE_OPEN_FULLMUTEX | C.SQLITE_OPEN_READWRITE | C.SQLITE_OPEN_CREATE
}

var db *C.sqlite3
name := C.CString(filename)
defer C.free(unsafe.Pointer(name))
var vfs *C.char
if len(vfsname) > 0 {
vfs = C.CString(vfsname)
defer C.free(unsafe.Pointer(vfs))
}
rv := C.sqlite3_open_v2(name, &db, C.int(openFlags), vfs)
if rv != C.SQLITE_OK {
if db != nil {
C.sqlite3_close(db)
}
return nil, Errno(rv)
}
if db == nil {
return nil, errors.New("sqlite succeeded without returning a database")
}
return &Conn{db: db, stmtCache: newCache()}, nil
}

// Set a busy timeout
// (See http://sqlite.org/c3ref/busy_timeout.html)
func (c *Conn) BusyTimeout(ms int) error { // TODO time.Duration ?
return c.error(C.sqlite3_busy_timeout(c.db, C.int(ms)))
}

// Enable or disable the enforcement of foreign key constraints
// Calls sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_FKEY, b)
// Another way is PRAGMA foreign_keys = boolean;
//
// (See http://sqlite.org/c3ref/c_dbconfig_enable_fkey.html)
func (c *Conn) EnableFKey(b bool) (bool, error) {
return c.queryOrSetEnableFKey(btocint(b))
}

// Calls sqlite3_db_config(db, SQLITE_DBCONFIG_ENABLE_FKEY, -1)
// Another way is PRAGMA foreign_keys;
//
// (See http://sqlite.org/c3ref/c_dbconfig_enable_fkey.html)
func (c *Conn) IsFKeyEnabled() (bool, error) {
return c.queryOrSetEnableFKey(-1)
}
func (c *Conn) queryOrSetEnableFKey(i C.int) (bool, error) {
var ok C.int
rv := C.my_db_config(c.db, C.SQLITE_DBCONFIG_ENABLE_FKEY, i, &ok)
if rv == C.SQLITE_OK {
return (ok == 1), nil
}
return false, c.error(rv)
}

// Enable or disable the extended result codes feature of SQLite.
// (See http://sqlite.org/c3ref/extended_result_codes.html)
func (c *Conn) EnableExtendedResultCodes(b bool) error {
return c.error(C.sqlite3_extended_result_codes(c.db, btocint(b)))
}

// (See http://sqlite.org/c3ref/db_readonly.html)
func (c *Conn) Readonly(dbName string) (bool, error) {
cname := C.CString(dbName)
defer C.free(unsafe.Pointer(cname))
rv := C.sqlite3_db_readonly(c.db, cname)
if rv == -1 {
return false, c.error(C.SQLITE_ERROR, fmt.Sprintf("%q is not the name of a database", dbName))
}
return rv == 1, nil
}

// (See http://sqlite.org/c3ref/db_filename.html)
func (c *Conn) Filename(dbName string) string {
cname := C.CString(dbName)
defer C.free(unsafe.Pointer(cname))
return C.GoString(C.sqlite3_db_filename(c.db, cname))
}

// Prepare and execute one parameterized statement or many statements (separated by semi-colon).
// Don't use it with SELECT or anything that returns data.
func (c *Conn) Exec(cmd string, args ...interface{}) error {
for len(cmd) > 0 {
s, err := c.prepare(cmd)
if err != nil {
return err
} else if s.stmt == nil {
// this happens for a comment or white-space
cmd = s.tail
continue
}
err = s.Exec(args...)
if err != nil {
s.finalize()
return err
}
if len(s.tail) > 0 {
if len(args) > 0 {
s.finalize()
return c.specificError("Cannot execute multiple statements when args are specified")
}
}
cmd = s.tail
if err = s.finalize(); err != nil {
return err
}
}
return nil
}

// Return true if the specified query returns at least one row.
func (c *Conn) Exists(query string, args ...interface{}) (bool, error) {
s, err := c.Prepare(query, args...)
if err != nil {
return false, err
}
defer func() {
s.Reset()
s.Finalize()
}()
return s.Next()
}

// Use it with SELECT that returns only one row with only one column.
// Returns io.EOF when there is no row.
func (c *Conn) OneValue(query string, value interface{}, args ...interface{}) error {
s, err := c.Prepare(query, args...)
if err != nil {
return err
}
defer func() {
s.Reset()
s.Finalize()
}()
b, err := s.Next()
if err != nil {
return err
} else if !b {
return io.EOF
}
return s.Scan(value)
}

// Count the number of rows modified.
// If a separate thread makes changes on the same database connection while Changes() is running then the value returned is unpredictable and not meaningful.
// (See http://sqlite.org/c3ref/changes.html)
func (c *Conn) Changes() int {
return int(C.sqlite3_changes(c.db))
}

// Total number of rows Modified
// (See http://sqlite.org/c3ref/total_changes.html)
func (c *Conn) TotalChanges() int {
return int(C.sqlite3_total_changes(c.db))
}

// Return the rowid of the most recent successful INSERT into the database.
// If a separate thread performs a new INSERT on the same database connection while the LastInsertRowid() function is running and thus changes the last insert rowid, then the value returned by LastInsertRowid() is unpredictable and might not equal either the old or the new last insert rowid.
// (See http://sqlite.org/c3ref/last_insert_rowid.html)
func (c *Conn) LastInsertRowid() int64 {
return int64(C.sqlite3_last_insert_rowid(c.db))
}

// Interrupt a long-running query
// (See http://sqlite.org/c3ref/interrupt.html)
func (c *Conn) Interrupt() {
C.sqlite3_interrupt(c.db)
}

// Test for auto-commit mode
// (See http://sqlite.org/c3ref/get_autocommit.html)
func (c *Conn) GetAutocommit() bool {
return C.sqlite3_get_autocommit(c.db) != 0
}

// See Conn.BeginTransaction
type TransactionType int

const (
DEFERRED TransactionType = 0
IMMEDIATE TransactionType = 1
EXCLUSIVE TransactionType = 2
)

// Begin transaction in deferred mode
func (c *Conn) Begin() error {
return c.BeginTransaction(DEFERRED)
}

func (c *Conn) BeginTransaction(t TransactionType) error {
if t == DEFERRED {
return c.exec("BEGIN")
} else if t == IMMEDIATE {
return c.exec("BEGIN IMMEDIATE")
} else if t == EXCLUSIVE {
return c.exec("BEGIN EXCLUSIVE")
}
panic(fmt.Sprintf("Unsupported transaction type: '%#v'", t))
return nil
}

// Commit transaction
func (c *Conn) Commit() error {
// TODO Check autocommit?
return c.exec("COMMIT")
}

// Rollback transaction
func (c *Conn) Rollback() error {
// TODO Check autocommit?
return c.exec("ROLLBACK")
}

// (See http://sqlite.org/lang_savepoint.html)
func (c *Conn) Savepoint(name string) error {
return c.exec(Mprintf("SAVEPOINT %Q", name))
}

// (See http://sqlite.org/lang_savepoint.html)
func (c *Conn) ReleaseSavepoint(name string) error {
return c.exec(Mprintf("RELEASE %Q", name))
}

// (See http://sqlite.org/lang_savepoint.html)
func (c *Conn) RollbackSavepoint(name string) error {
return c.exec(Mprintf("ROLLBACK TO SAVEPOINT %Q", name))
}

func (c *Conn) exec(cmd string) error {
s, err := c.prepare(cmd)
if err != nil {
return err
}
defer s.finalize()
rv := C.sqlite3_step(s.stmt)
if Errno(rv) != Done {
return s.error(rv)
}
return nil
}

// Close a database connection and any dangling statements.
// (See http://sqlite.org/c3ref/close.html)
func (c *Conn) Close() error {
if c == nil {
return errors.New("nil sqlite database")
}
if c.db == nil {
return nil
}

c.stmtCache.flush()

// Dangling statements
stmt := C.sqlite3_next_stmt(c.db, nil)
for stmt != nil {
if C.sqlite3_stmt_busy(stmt) != 0 {
Log(C.SQLITE_MISUSE, "Dangling statement (not reset): \""+C.GoString(C.sqlite3_sql(stmt))+"\"")
} else {
Log(C.SQLITE_MISUSE, "Dangling statement (not finalize): \""+C.GoString(C.sqlite3_sql(stmt))+"\"")
}
C.sqlite3_finalize(stmt)
stmt = C.sqlite3_next_stmt(c.db, stmt)
}

rv := C.sqlite3_close(c.db)
if rv != C.SQLITE_OK {
Log(int(rv), "error while closing Conn")
return c.error(rv)
}
c.db = nil
return nil
}

// Enable or disable extension loading
// (See http://sqlite.org/c3ref/enable_load_extension.html)
func (c *Conn) EnableLoadExtension(b bool) {
C.sqlite3_enable_load_extension(c.db, btocint(b))
}

// Load an extension
// (See http://sqlite.org/c3ref/load_extension.html)
func (c *Conn) LoadExtension(file string, proc ...string) error {
cfile := C.CString(file)
defer C.free(unsafe.Pointer(cfile))
var cproc *C.char
if len(proc) > 0 {
cproc = C.CString(proc[0])
defer C.free(unsafe.Pointer(cproc))
}
var errMsg *C.char
rv := C.sqlite3_load_extension(c.db, cfile, cproc, &errMsg)
if rv != C.SQLITE_OK {
defer C.sqlite3_free(unsafe.Pointer(errMsg))
return c.error(rv, C.GoString(errMsg))
}
return nil
}

// Enable or disable shared pager cache
// (See http://sqlite.org/c3ref/enable_shared_cache.html)
func EnableSharedCache(b bool) {
C.sqlite3_enable_shared_cache(btocint(b))
}

// Must is a helper that wraps a call to a function returning (bool, os.Error)
// and panics if the error is non-nil.
func Must(b bool, err error) bool {
if err != nil {
panic(err)
}
return b
}

func btocint(b bool) C.int {
if b {
return 1
}
return 0
}
Something went wrong with that request. Please try again.