mirror of
https://github.com/docker/docker-agent.git
synced 2026-11-06 15:07:58 +00:00
David Gageot
c37dfa34d6
Adds a Ping() call to sqliteutil.OpenDB to ensure the database connection is valid and the file can be opened. This ensures that file permission or missing directory errors are caught and diagnosed immediately. Assisted-By: cagent
77 lines
2.3 KiB
Go
77 lines
2.3 KiB
Go
package sqliteutil
|
|
|
|
import (
|
|
"database/sql"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"modernc.org/sqlite"
|
|
sqlite3 "modernc.org/sqlite/lib"
|
|
)
|
|
|
|
// OpenDB opens a SQLite database with recommended pragmas for concurrency and foreign key support.
|
|
// It configures the connection pool for serialized writes (MaxOpenConns=1).
|
|
func OpenDB(path string) (*sql.DB, error) {
|
|
// Add query parameters for better concurrency handling and data integrity
|
|
// _pragma=busy_timeout(5000): Wait up to 5 seconds if database is locked
|
|
// _pragma=journal_mode(WAL): Enable Write-Ahead Logging for better concurrent access
|
|
// _pragma=foreign_keys(1): Enable foreign key constraints (critical for ON DELETE CASCADE)
|
|
dsn := fmt.Sprintf("%s?_pragma=busy_timeout(5000)&_pragma=journal_mode(WAL)&_pragma=foreign_keys(1)", path)
|
|
|
|
db, err := sql.Open("sqlite", dsn)
|
|
if err != nil {
|
|
if IsCantOpenError(err) {
|
|
return nil, DiagnoseDBOpenError(path, err)
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
// Configure connection pool to serialize writes (SQLite limitation)
|
|
// This prevents "database is locked" errors from concurrent writes
|
|
db.SetMaxOpenConns(1)
|
|
db.SetMaxIdleConns(1)
|
|
db.SetConnMaxLifetime(0)
|
|
|
|
// Verify connection works (this will trigger file creation/open)
|
|
if err := db.Ping(); err != nil {
|
|
db.Close()
|
|
if IsCantOpenError(err) {
|
|
return nil, DiagnoseDBOpenError(path, err)
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
return db, nil
|
|
}
|
|
|
|
// IsCantOpenError checks if the error is a SQLite CANTOPEN error (code 14).
|
|
func IsCantOpenError(err error) bool {
|
|
var sqliteErr *sqlite.Error
|
|
if errors.As(err, &sqliteErr) {
|
|
return sqliteErr.Code() == sqlite3.SQLITE_CANTOPEN
|
|
}
|
|
return false
|
|
}
|
|
|
|
// DiagnoseDBOpenError provides a more helpful error message when SQLite
|
|
// fails to open/create a database file.
|
|
func DiagnoseDBOpenError(path string, originalErr error) error {
|
|
dir := filepath.Dir(path)
|
|
|
|
info, err := os.Stat(dir)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
return fmt.Errorf("cannot create database at %q: directory %q does not exist", path, dir)
|
|
}
|
|
return fmt.Errorf("cannot create database at %q: %w", path, err)
|
|
}
|
|
|
|
if !info.IsDir() {
|
|
return fmt.Errorf("cannot create database at %q: %q is not a directory", path, dir)
|
|
}
|
|
|
|
return fmt.Errorf("cannot create database at %q: permission denied or file cannot be created in %q (original error: %v)", path, dir, originalErr)
|
|
}
|