feat: zig-sqlite.

zig-vendor/zig-sqlite/errors.zig

@@ -0,0 +1,311 @@
+const std = @import("std");
+const mem = std.mem;
+
+const c = @import("c.zig").c;
+const versionGreaterThanOrEqualTo = @import("c.zig").versionGreaterThanOrEqualTo;
+
+pub const SQLiteExtendedIOError = error{
+    SQLiteIOErrRead,
+    SQLiteIOErrShortRead,
+    SQLiteIOErrWrite,
+    SQLiteIOErrFsync,
+    SQLiteIOErrDirFsync,
+    SQLiteIOErrTruncate,
+    SQLiteIOErrFstat,
+    SQLiteIOErrUnlock,
+    SQLiteIOErrRDLock,
+    SQLiteIOErrDelete,
+    SQLiteIOErrBlocked,
+    SQLiteIOErrNoMem,
+    SQLiteIOErrAccess,
+    SQLiteIOErrCheckReservedLock,
+    SQLiteIOErrLock,
+    SQLiteIOErrClose,
+    SQLiteIOErrDirClose,
+    SQLiteIOErrSHMOpen,
+    SQLiteIOErrSHMSize,
+    SQLiteIOErrSHMLock,
+    SQLiteIOErrSHMMap,
+    SQLiteIOErrSeek,
+    SQLiteIOErrDeleteNoEnt,
+    SQLiteIOErrMmap,
+    SQLiteIOErrGetTempPath,
+    SQLiteIOErrConvPath,
+    SQLiteIOErrVnode,
+    SQLiteIOErrAuth,
+    SQLiteIOErrBeginAtomic,
+    SQLiteIOErrCommitAtomic,
+    SQLiteIOErrRollbackAtomic,
+    SQLiteIOErrData,
+    SQLiteIOErrCorruptFS,
+};
+
+pub const SQLiteExtendedCantOpenError = error{
+    SQLiteCantOpenNoTempDir,
+    SQLiteCantOpenIsDir,
+    SQLiteCantOpenFullPath,
+    SQLiteCantOpenConvPath,
+    SQLiteCantOpenDirtyWAL,
+    SQLiteCantOpenSymlink,
+};
+
+pub const SQLiteExtendedReadOnlyError = error{
+    SQLiteReadOnlyRecovery,
+    SQLiteReadOnlyCantLock,
+    SQLiteReadOnlyRollback,
+    SQLiteReadOnlyDBMoved,
+    SQLiteReadOnlyCantInit,
+    SQLiteReadOnlyDirectory,
+};
+
+pub const SQLiteExtendedConstraintError = error{
+    SQLiteConstraintCheck,
+    SQLiteConstraintCommitHook,
+    SQLiteConstraintForeignKey,
+    SQLiteConstraintFunction,
+    SQLiteConstraintNotNull,
+    SQLiteConstraintPrimaryKey,
+    SQLiteConstraintTrigger,
+    SQLiteConstraintUnique,
+    SQLiteConstraintVTab,
+    SQLiteConstraintRowID,
+    SQLiteConstraintPinned,
+};
+
+pub const SQLiteExtendedError = error{
+    SQLiteErrorMissingCollSeq,
+    SQLiteErrorRetry,
+    SQLiteErrorSnapshot,
+
+    SQLiteLockedSharedCache,
+    SQLiteLockedVTab,
+
+    SQLiteBusyRecovery,
+    SQLiteBusySnapshot,
+    SQLiteBusyTimeout,
+
+    SQLiteCorruptVTab,
+    SQLiteCorruptSequence,
+    SQLiteCorruptIndex,
+
+    SQLiteAbortRollback,
+};
+
+pub const SQLiteError = error{
+    SQLiteError,
+    SQLiteInternal,
+    SQLitePerm,
+    SQLiteAbort,
+    SQLiteBusy,
+    SQLiteLocked,
+    SQLiteNoMem,
+    SQLiteReadOnly,
+    SQLiteInterrupt,
+    SQLiteIOErr,
+    SQLiteCorrupt,
+    SQLiteNotFound,
+    SQLiteFull,
+    SQLiteCantOpen,
+    SQLiteProtocol,
+    SQLiteEmpty,
+    SQLiteSchema,
+    SQLiteTooBig,
+    SQLiteConstraint,
+    SQLiteMismatch,
+    SQLiteMisuse,
+    SQLiteNoLFS,
+    SQLiteAuth,
+    SQLiteRange,
+    SQLiteNotADatabase,
+    SQLiteNotice,
+    SQLiteWarning,
+};
+
+pub const Error = SQLiteError ||
+    SQLiteExtendedError ||
+    SQLiteExtendedIOError ||
+    SQLiteExtendedCantOpenError ||
+    SQLiteExtendedReadOnlyError ||
+    SQLiteExtendedConstraintError;
+
+pub fn errorFromResultCode(code: c_int) Error {
+    // These errors are only available since 3.22.0.
+    if (comptime versionGreaterThanOrEqualTo(3, 22, 0)) {
+        switch (code) {
+            c.SQLITE_ERROR_MISSING_COLLSEQ => return error.SQLiteErrorMissingCollSeq,
+            c.SQLITE_ERROR_RETRY => return error.SQLiteErrorRetry,
+            c.SQLITE_READONLY_CANTINIT => return error.SQLiteReadOnlyCantInit,
+            c.SQLITE_READONLY_DIRECTORY => return error.SQLiteReadOnlyDirectory,
+            else => {},
+        }
+    }
+
+    // These errors are only available since 3.25.0.
+    if (comptime versionGreaterThanOrEqualTo(3, 25, 0)) {
+        switch (code) {
+            c.SQLITE_ERROR_SNAPSHOT => return error.SQLiteErrorSnapshot,
+            c.SQLITE_LOCKED_VTAB => return error.SQLiteLockedVTab,
+            c.SQLITE_CANTOPEN_DIRTYWAL => return error.SQLiteCantOpenDirtyWAL,
+            c.SQLITE_CORRUPT_SEQUENCE => return error.SQLiteCorruptSequence,
+            else => {},
+        }
+    }
+    // These errors are only available since 3.31.0.
+    if (comptime versionGreaterThanOrEqualTo(3, 31, 0)) {
+        switch (code) {
+            c.SQLITE_CANTOPEN_SYMLINK => return error.SQLiteCantOpenSymlink,
+            c.SQLITE_CONSTRAINT_PINNED => return error.SQLiteConstraintPinned,
+            else => {},
+        }
+    }
+    // These errors are only available since 3.32.0.
+    if (comptime versionGreaterThanOrEqualTo(3, 32, 0)) {
+        switch (code) {
+            c.SQLITE_IOERR_DATA => return error.SQLiteIOErrData, // See https://sqlite.org/cksumvfs.html
+            c.SQLITE_BUSY_TIMEOUT => return error.SQLiteBusyTimeout,
+            c.SQLITE_CORRUPT_INDEX => return error.SQLiteCorruptIndex,
+            else => {},
+        }
+    }
+    // These errors are only available since 3.34.0.
+    if (comptime versionGreaterThanOrEqualTo(3, 34, 0)) {
+        switch (code) {
+            c.SQLITE_IOERR_CORRUPTFS => return error.SQLiteIOErrCorruptFS,
+            else => {},
+        }
+    }
+
+    switch (code) {
+        c.SQLITE_ERROR => return error.SQLiteError,
+        c.SQLITE_INTERNAL => return error.SQLiteInternal,
+        c.SQLITE_PERM => return error.SQLitePerm,
+        c.SQLITE_ABORT => return error.SQLiteAbort,
+        c.SQLITE_BUSY => return error.SQLiteBusy,
+        c.SQLITE_LOCKED => return error.SQLiteLocked,
+        c.SQLITE_NOMEM => return error.SQLiteNoMem,
+        c.SQLITE_READONLY => return error.SQLiteReadOnly,
+        c.SQLITE_INTERRUPT => return error.SQLiteInterrupt,
+        c.SQLITE_IOERR => return error.SQLiteIOErr,
+        c.SQLITE_CORRUPT => return error.SQLiteCorrupt,
+        c.SQLITE_NOTFOUND => return error.SQLiteNotFound,
+        c.SQLITE_FULL => return error.SQLiteFull,
+        c.SQLITE_CANTOPEN => return error.SQLiteCantOpen,
+        c.SQLITE_PROTOCOL => return error.SQLiteProtocol,
+        c.SQLITE_EMPTY => return error.SQLiteEmpty,
+        c.SQLITE_SCHEMA => return error.SQLiteSchema,
+        c.SQLITE_TOOBIG => return error.SQLiteTooBig,
+        c.SQLITE_CONSTRAINT => return error.SQLiteConstraint,
+        c.SQLITE_MISMATCH => return error.SQLiteMismatch,
+        c.SQLITE_MISUSE => return error.SQLiteMisuse,
+        c.SQLITE_NOLFS => return error.SQLiteNoLFS,
+        c.SQLITE_AUTH => return error.SQLiteAuth,
+        c.SQLITE_RANGE => return error.SQLiteRange,
+        c.SQLITE_NOTADB => return error.SQLiteNotADatabase,
+        c.SQLITE_NOTICE => return error.SQLiteNotice,
+        c.SQLITE_WARNING => return error.SQLiteWarning,
+
+        c.SQLITE_IOERR_READ => return error.SQLiteIOErrRead,
+        c.SQLITE_IOERR_SHORT_READ => return error.SQLiteIOErrShortRead,
+        c.SQLITE_IOERR_WRITE => return error.SQLiteIOErrWrite,
+        c.SQLITE_IOERR_FSYNC => return error.SQLiteIOErrFsync,
+        c.SQLITE_IOERR_DIR_FSYNC => return error.SQLiteIOErrDirFsync,
+        c.SQLITE_IOERR_TRUNCATE => return error.SQLiteIOErrTruncate,
+        c.SQLITE_IOERR_FSTAT => return error.SQLiteIOErrFstat,
+        c.SQLITE_IOERR_UNLOCK => return error.SQLiteIOErrUnlock,
+        c.SQLITE_IOERR_RDLOCK => return error.SQLiteIOErrRDLock,
+        c.SQLITE_IOERR_DELETE => return error.SQLiteIOErrDelete,
+        c.SQLITE_IOERR_BLOCKED => return error.SQLiteIOErrBlocked,
+        c.SQLITE_IOERR_NOMEM => return error.SQLiteIOErrNoMem,
+        c.SQLITE_IOERR_ACCESS => return error.SQLiteIOErrAccess,
+        c.SQLITE_IOERR_CHECKRESERVEDLOCK => return error.SQLiteIOErrCheckReservedLock,
+        c.SQLITE_IOERR_LOCK => return error.SQLiteIOErrLock,
+        c.SQLITE_IOERR_CLOSE => return error.SQLiteIOErrClose,
+        c.SQLITE_IOERR_DIR_CLOSE => return error.SQLiteIOErrDirClose,
+        c.SQLITE_IOERR_SHMOPEN => return error.SQLiteIOErrSHMOpen,
+        c.SQLITE_IOERR_SHMSIZE => return error.SQLiteIOErrSHMSize,
+        c.SQLITE_IOERR_SHMLOCK => return error.SQLiteIOErrSHMLock,
+        c.SQLITE_IOERR_SHMMAP => return error.SQLiteIOErrSHMMap,
+        c.SQLITE_IOERR_SEEK => return error.SQLiteIOErrSeek,
+        c.SQLITE_IOERR_DELETE_NOENT => return error.SQLiteIOErrDeleteNoEnt,
+        c.SQLITE_IOERR_MMAP => return error.SQLiteIOErrMmap,
+        c.SQLITE_IOERR_GETTEMPPATH => return error.SQLiteIOErrGetTempPath,
+        c.SQLITE_IOERR_CONVPATH => return error.SQLiteIOErrConvPath,
+        c.SQLITE_IOERR_VNODE => return error.SQLiteIOErrVnode,
+        c.SQLITE_IOERR_AUTH => return error.SQLiteIOErrAuth,
+        c.SQLITE_IOERR_BEGIN_ATOMIC => return error.SQLiteIOErrBeginAtomic,
+        c.SQLITE_IOERR_COMMIT_ATOMIC => return error.SQLiteIOErrCommitAtomic,
+        c.SQLITE_IOERR_ROLLBACK_ATOMIC => return error.SQLiteIOErrRollbackAtomic,
+
+        c.SQLITE_LOCKED_SHAREDCACHE => return error.SQLiteLockedSharedCache,
+
+        c.SQLITE_BUSY_RECOVERY => return error.SQLiteBusyRecovery,
+        c.SQLITE_BUSY_SNAPSHOT => return error.SQLiteBusySnapshot,
+
+        c.SQLITE_CANTOPEN_NOTEMPDIR => return error.SQLiteCantOpenNoTempDir,
+        c.SQLITE_CANTOPEN_ISDIR => return error.SQLiteCantOpenIsDir,
+        c.SQLITE_CANTOPEN_FULLPATH => return error.SQLiteCantOpenFullPath,
+        c.SQLITE_CANTOPEN_CONVPATH => return error.SQLiteCantOpenConvPath,
+
+        c.SQLITE_CORRUPT_VTAB => return error.SQLiteCorruptVTab,
+
+        c.SQLITE_READONLY_RECOVERY => return error.SQLiteReadOnlyRecovery,
+        c.SQLITE_READONLY_CANTLOCK => return error.SQLiteReadOnlyCantLock,
+        c.SQLITE_READONLY_ROLLBACK => return error.SQLiteReadOnlyRollback,
+        c.SQLITE_READONLY_DBMOVED => return error.SQLiteReadOnlyDBMoved,
+
+        c.SQLITE_ABORT_ROLLBACK => return error.SQLiteAbortRollback,
+
+        c.SQLITE_CONSTRAINT_CHECK => return error.SQLiteConstraintCheck,
+        c.SQLITE_CONSTRAINT_COMMITHOOK => return error.SQLiteConstraintCommitHook,
+        c.SQLITE_CONSTRAINT_FOREIGNKEY => return error.SQLiteConstraintForeignKey,
+        c.SQLITE_CONSTRAINT_FUNCTION => return error.SQLiteConstraintFunction,
+        c.SQLITE_CONSTRAINT_NOTNULL => return error.SQLiteConstraintNotNull,
+        c.SQLITE_CONSTRAINT_PRIMARYKEY => return error.SQLiteConstraintPrimaryKey,
+        c.SQLITE_CONSTRAINT_TRIGGER => return error.SQLiteConstraintTrigger,
+        c.SQLITE_CONSTRAINT_UNIQUE => return error.SQLiteConstraintUnique,
+        c.SQLITE_CONSTRAINT_VTAB => return error.SQLiteConstraintVTab,
+        c.SQLITE_CONSTRAINT_ROWID => return error.SQLiteConstraintRowID,
+
+        else => std.debug.panic("invalid result code {}", .{code}),
+    }
+}
+
+/// DetailedError contains a SQLite error code and error message.
+pub const DetailedError = struct {
+    code: usize,
+    near: i32,
+    message: []const u8,
+
+    pub fn format(self: @This(), writer: anytype) !void {
+        _ = try writer.print("{{code: {}, near: {d}, message: {s}}}", .{ self.code, self.near, self.message });
+    }
+};
+
+pub fn getDetailedErrorFromResultCode(code: c_int) DetailedError {
+    return .{
+        .code = @intCast(code),
+        .near = -1,
+        .message = blk: {
+            const msg = c.sqlite3_errstr(code);
+            break :blk mem.sliceTo(msg, 0);
+        },
+    };
+}
+
+pub fn getErrorOffset(db: *c.sqlite3) i32 {
+    if (comptime versionGreaterThanOrEqualTo(3, 38, 0)) {
+        return c.sqlite3_error_offset(db);
+    }
+    return -1;
+}
+
+pub fn getLastDetailedErrorFromDb(db: *c.sqlite3) DetailedError {
+    return .{
+        .code = @intCast(c.sqlite3_extended_errcode(db)),
+        .near = getErrorOffset(db),
+        .message = blk: {
+            const msg = c.sqlite3_errmsg(db);
+            break :blk mem.sliceTo(msg, 0);
+        },
+    };
+}