Support matrix (original) (raw)

Tested configurations

The following configurations are tested in CI.

Other configurations

The following configurations are not tested but are expected to work.

GOOS and GOARCH

You need a working Go toolchain.

Build tags

These customize the Go SQLite VFS.

Compiler

We automatically use wazero's:

• 🟢 compiler: on an SSE4.1 or ARMv8 processor, on supported OSes
• 🔴 interpreter

The interpreter is significantly slower (but the compiler introduces startup latency).
Use wazero.NewRuntimeConfigInterpreter() to always use the interpreter.

File locking

Use vfs.SupportsFileLockingto check if your build supports file locking:

• 🟢 full support
• 🟡 reduced concurrency:BEGIN IMMEDIATE behaves like BEGIN EXCLUSIVE(docs)
• 🟠 incompatible locking: accessing databases concurrently with other SQLite libraries risks data corruption
• 🔴 no support: can only open databases withnolock=1(or immutable=1); WAL mode not supported

Shared memory WAL

Use vfs.SupportsSharedMemoryto check if your build supports shared memory:

• 🟢 full support
• 🟡 reduced performance: memory sharing through copying, which reduces performance under write-heavy workloads
• 🟠 in-process: WAL databases can only be accessed by a single proccess; other processes fail with SQLITE_PROTOCOL, SQLITE_IOERR, or SQLITE_CANTOPEN
• 🔴 no support: can only open WAL databases with EXCLUSIVE locking mode