Golang SQLCipher driver conforming to the built-in database/sql interface and using the latest sqlite3 code.
Go to file
Kirill Smelkov 00a23ba538 Don't spawn interrupt goroutine if we know that context cannot be canceled
For a Go-only project the following code pattern

	go func() {
		select {
		case <-ctx.Done():
			// call some cancel

		case <-done:
			// work finished ok
		}
	}()

	// do some work
	close(done)

works good and fast - without high scheduling overhead because scheduler
usually puts spawned goroutine into run queue on the same OS thread and so
after done is closed control is passed to spawned goroutine without OS context
switch.

However in the presence of Cgo calls in "do some work" the situation can
become different - Cgo calls are treated by go runtime similarly to
system calls with the effect that goroutines spawned on original OS
thread tend to be migrated by scheduler to be executed on another OS
thread.

This in turn can bring high overhead for communicating on "done", which
ultimately can result in full context switch: if the spawned goroutine
had chance to run, already checked done and ctx to be not ready, and went
into sleep via wait on futex - showing as something like below in strace for
one read query (note futex calls):

	27867 00:38:39.782146 stat(".../neo.sqlite-journal", 0x7f83809c4a20) = -1 ENOENT (No such file or directory)
	27867 00:38:39.782165 pread64(3, "\0\0\0\33\0\0\10\235\0\0\10]\0\0\0\27", 16, 24) = 16
	27871 00:38:39.782179 <... pselect6 resumed> ) = 0 (Timeout)
	27868 00:38:39.782187 <... pselect6 resumed> ) = 0 (Timeout)
	27871 00:38:39.782193 futex(0xc4200f8538, FUTEX_WAIT, 0, NULL <unfinished ...>
	27868 00:38:39.782199 futex(0xc420013138, FUTEX_WAIT, 0, NULL <unfinished ...>
	27867 00:38:39.782205 stat(".../neo.sqlite-wal", 0x7f83809c4a20) = -1 ENOENT (No such file or directory)
	27867 00:38:39.782224 fstat(3, {st_mode=S_IFREG|0644, st_size=9031680, ...}) = 0
	27867 00:38:39.782247 futex(0xc420013138, FUTEX_WAKE, 1 <unfinished ...>
	27868 00:38:39.782259 <... futex resumed> ) = 0
	27867 00:38:39.782265 <... futex resumed> ) = 1
	27868 00:38:39.782270 pselect6(0, NULL, NULL, NULL, {tv_sec=0, tv_nsec=3000}, NULL <unfinished ...>
	27867 00:38:39.782279 fcntl(3, F_SETLK, {l_type=F_UNLCK, l_whence=SEEK_SET, l_start=0, l_len=0}) = 0
	27867 00:38:39.782315 fcntl(3, F_SETLK, {l_type=F_RDLCK, l_whence=SEEK_SET, l_start=1073741824, l_len=1}) = 0
	27868 00:38:39.782336 <... pselect6 resumed> ) = 0 (Timeout)
	27867 00:38:39.782342 fcntl(3, F_SETLK, {l_type=F_RDLCK, l_whence=SEEK_SET, l_start=1073741826, l_len=510} <unfinished ...>
	27868 00:38:39.782348 futex(0xc4200f8538, FUTEX_WAKE, 1 <unfinished ...>
	27867 00:38:39.782355 <... fcntl resumed> ) = 0
	27871 00:38:39.782360 <... futex resumed> ) = 0
	27868 00:38:39.782367 <... futex resumed> ) = 1
	27871 00:38:39.782372 futex(0xc4200f8138, FUTEX_WAKE, 1 <unfinished ...>
	27868 00:38:39.782377 pselect6(0, NULL, NULL, NULL, {tv_sec=0, tv_nsec=3000}, NULL <unfinished ...>
	27871 00:38:39.782384 <... futex resumed> ) = 1
	27870 00:38:39.782389 <... futex resumed> ) = 0
	27867 00:38:39.782394 fcntl(3, F_SETLK, {l_type=F_UNLCK, l_whence=SEEK_SET, l_start=1073741824, l_len=1} <unfinished ...>
	27870 00:38:39.782400 pselect6(0, NULL, NULL, NULL, {tv_sec=0, tv_nsec=3000}, NULL <unfinished ...>
	27867 00:38:39.782408 <... fcntl resumed> ) = 0

Below link shows that go scheduler itself might be significantly improved for
cases when there are several Cgo calls made for a request in a server:

https://github.com/golang/go/issues/21827#issuecomment-329092317

in particular CGo-4 case should be closely related to this sqlite3 go package,
because for one query many CGo calls are made to SQLite.

However until there are proper scheduler fixes, let's make what could
be made to improve time to do queries:

If we know that the context under which a query is executed will never
be canceled - we know we can safely skip spawning the interrupt
goroutine and this was avoid ping-pong on done in between different OS
threads.

This brings the following speedup on my notebook with go1.10:

name               old req/s    new req/s    delta
Exec                 254k ± 1%    379k ± 1%  +48.89%  (p=0.000 n=10+10)
Query               90.6k ± 2%   96.4k ± 1%   +6.37%  (p=0.000 n=10+10)
Params              81.5k ± 1%   87.0k ± 1%   +6.83%  (p=0.000 n=10+10)
Stmt                 122k ± 2%    129k ± 1%   +6.07%  (p=0.000 n=10+9)
Rows                2.98k ± 1%   3.06k ± 1%   +2.77%  (p=0.000 n=9+10)
StmtRows            3.10k ± 1%   3.13k ± 1%   +1.12%  (p=0.000 n=9+10)

name               old time/op  new time/op  delta
CustomFunctions-4  10.6µs ± 1%  10.1µs ± 1%   -5.01%  (p=0.000 n=10+10)
2018-02-17 21:09:05 +03:00
_example fix type of event code 2018-01-29 11:15:57 +09:00
tool bump sqlite 3.22.0 2018-02-07 19:47:10 +09:00
.gitignore add *.o 2016-08-11 18:43:49 +09:00
.travis.yml Updated travis.yml 2017-10-22 14:57:02 +03:00
LICENSE Add LICENSE file 2014-08-18 16:52:12 +09:00
README.md Update README.md 2017-11-30 20:35:32 +00:00
backup.go fix breaking compatibility. 2017-03-21 09:14:48 +09:00
backup_test.go Test the error reporting when preparing to perform a backup. 2016-09-23 08:41:32 -04:00
callback.go Merge branch 'master' into master 2017-08-30 19:57:18 +09:00
callback_test.go Move argument converters to callback.go, and optimize return value handling. 2015-08-21 16:37:45 -07:00
doc.go Removing an unused C import to allow for "buildable" go files. Fixes https://github.com/mattn/go-sqlite3/issues/374 2017-01-18 17:14:12 +01:00
error.go fix breaking compatibility. 2017-03-21 09:14:48 +09:00
error_test.go fix error message 2017-11-19 00:09:25 +09:00
sqlite3-binding.c bump sqlite 3.22.0 2018-02-07 19:47:10 +09:00
sqlite3-binding.h bump sqlite 3.22.0 2018-02-07 19:47:10 +09:00
sqlite3.go Don't spawn interrupt goroutine if we know that context cannot be canceled 2018-02-17 21:09:05 +03:00
sqlite3_context.go rename 2017-03-05 21:40:25 +09:00
sqlite3_fts3_test.go FTS4 is not available on Trusty 2016-04-23 00:00:49 +08:00
sqlite3_fts5.go Conditional build for the FTS5 Extension 2016-03-07 16:20:02 +09:00
sqlite3_go18.go Add static_mock.go to allow building with CGO_ENABLED=0 2018-01-31 22:24:37 -06:00
sqlite3_go18_test.go Fix race in ExecContext 2017-11-21 13:40:00 +01:00
sqlite3_icu.go remove trailing space 2016-11-05 00:28:43 +09:00
sqlite3_json1.go Conditional build for the JSON1 Extension 2016-02-28 09:53:54 +01:00
sqlite3_libsqlite3.go support Solaris 2017-08-30 13:19:01 +09:00
sqlite3_load_extension.go disable extension when loading failed 2017-03-21 00:47:07 +09:00
sqlite3_omit_load_extension.go Disable LoadExtension when omit_load_extension is specified 2016-04-18 19:58:56 +08:00
sqlite3_other.go support Solaris 2017-08-30 13:19:01 +09:00
sqlite3_solaris.go add build constraint for solaris 2018-01-22 10:29:16 +09:00
sqlite3_test.go Move RegisterAggregator implementation 2017-11-05 09:18:06 +07:00
sqlite3_trace.go fix type of event code 2018-01-29 11:15:57 +09:00
sqlite3_type.go go vet && golint 2016-11-06 13:16:38 +09:00
sqlite3_vtable.go Adding unit test for VTable Insert/Update/Delete 2017-04-07 14:23:08 +07:00
sqlite3_vtable_test.go Adding unit test for VTable Insert/Update/Delete 2017-04-07 14:23:08 +07:00
sqlite3_windows.go Fix compile for old mingw32 2015-12-30 00:19:24 +02:00
sqlite3ext.h bump sqlite 3.22.0 2018-02-07 19:47:10 +09:00
static_mock.go Add static_mock.go to allow building with CGO_ENABLED=0 2018-01-31 22:24:37 -06:00

README.md

go-sqlite3

GoDoc Reference Build Status Coverage Status Go Report Card

Description

sqlite3 driver conforming to the built-in database/sql interface

Installation

This package can be installed with the go get command:

go get github.com/mattn/go-sqlite3

go-sqlite3 is cgo package. If you want to build your app using go-sqlite3, you need gcc. However, after you have built and installed go-sqlite3 with go install github.com/mattn/go-sqlite3 (which requires gcc), you can build your app without relying on gcc in future.

Documentation

API documentation can be found here: http://godoc.org/github.com/mattn/go-sqlite3

Examples can be found under the ./_example directory

FAQ

  • Want to build go-sqlite3 with libsqlite3 on my linux.

    Use go build --tags "libsqlite3 linux"

  • Want to build go-sqlite3 with libsqlite3 on OS X.

    Install sqlite3 from homebrew: brew install sqlite3

    Use go build --tags "libsqlite3 darwin"

  • Want to build go-sqlite3 with icu extension.

    Use go build --tags "icu"

    Available extensions: json1, fts5, icu

  • Can't build go-sqlite3 on windows 64bit.

    Probably, you are using go 1.0, go1.0 has a problem when it comes to compiling/linking on windows 64bit. See: #27

  • Getting insert error while query is opened.

    You can pass some arguments into the connection string, for example, a URI. See: #39

  • Do you want to cross compile? mingw on Linux or Mac?

    See: #106 See also: http://www.limitlessfx.com/cross-compile-golang-app-for-windows-from-linux.html

  • Want to get time.Time with current locale

    Use _loc=auto in SQLite3 filename schema like file:foo.db?_loc=auto.

  • Can I use this in multiple routines concurrently?

    Yes for readonly. But, No for writable. See #50, #51, #209.

  • Why is it racy if I use a sql.Open("sqlite3", ":memory:") database?

    Each connection to :memory: opens a brand new in-memory sql database, so if the stdlib's sql engine happens to open another connection and you've only specified ":memory:", that connection will see a brand new database. A workaround is to use "file::memory:?mode=memory&cache=shared". Every connection to this string will point to the same in-memory database. See #204 for more info.

License

MIT: http://mattn.mit-license.org/2012

sqlite3-binding.c, sqlite3-binding.h, sqlite3ext.h

The -binding suffix was added to avoid build failures under gccgo.

In this repository, those files are an amalgamation of code that was copied from SQLite3. The license of that code is the same as the license of SQLite3.

Author

Yasuhiro Matsumoto (a.k.a mattn)