Package Usage: go: zombiezen.com/go/sqlite
Package sqlite provides a Go interface to SQLite 3.
The semantics of this package are deliberately close to the SQLite3 C API.
See the official C API introduction for an overview of the basics.
An SQLite connection is represented by a *Conn.
Connections cannot be used concurrently.
A typical Go program will create a pool of connections
(e.g. by using zombiezen.com/go/sqlite/sqlitex.NewPool
to create a *zombiezen.com/go/sqlite/sqlitex.Pool)
so goroutines can borrow a connection
while they need to talk to the database.
This package assumes SQLite will be used concurrently by the
process through several connections, so the build options for
SQLite enable multi-threading and the shared cache.
The implementation automatically handles shared cache locking,
see the documentation on Stmt.Step for details.
The optional SQLite 3 extensions compiled in are:
session, FTS5, RTree, JSON1, and GeoPoly.
This is not a database/sql driver.
For helper functions to make it easier to execute statements,
see the zombiezen.com/go/sqlite/sqlitex package.
Statements are prepared with the Conn.Prepare and Conn.PrepareTransient methods.
When using Conn.Prepare, statements are keyed inside a connection by the
original query string used to create them. This means long-running
high-performance code paths can write:
After all the connections in a pool have been warmed up by passing
through one of these Prepare calls, subsequent calls are simply a
map lookup that returns an existing statement.
SQLite transactions can be managed manually with this package
by directly executing BEGIN / COMMIT / ROLLBACK or
SAVEPOINT / RELEASE / ROLLBACK statements,
but there are also helper functions available in zombiezen.com/go/sqlite/sqlitex:
For simple schema migration needs, see the zombiezen.com/go/sqlite/sqlitemigration package.
Use Conn.CreateFunction to register Go functions for use as SQL functions.
The sqlite package supports the SQLite incremental I/O interface
for streaming blob data into and out of the the database
without loading the entire blob into a single []byte.
(This is important when working either with very large blobs,
or more commonly, a large number of moderate-sized blobs concurrently.)
See Conn.OpenBlob for more details.
Every connection can have a done channel associated with it
using the Conn.SetInterrupt method.
This is typically the channel returned by a context.Context.Done method.
As database connections are long-lived,
the Conn.SetInterrupt method can be called multiple times
to reset the associated lifetime.
Using a Pool to execute SQL in a concurrent HTTP handler.
This is the same as the main package example, but uses the SQLite
statement API instead of sqlitex.
34 versions
Latest release: plus d'un an ago
81 dependent packages
View more package details: https://packages.ecosystem.code.gouv.fr/registries/proxy.golang.org/packages/zombiezen.com/go/sqlite