Read-only storage diagnostics toolkit for CSharpDB database and WAL files.
Get Started
$ dotnet add package CSharpDB.Storage.DiagnosticsReadme
CSharpDB.Storage.Diagnostics
Read-only storage diagnostics and integrity checking toolkit for CSharpDB database files.
Overview
CSharpDB.Storage.Diagnostics provides read-only inspection and integrity verification for CSharpDB database files, WAL files, and indexes. Use it to validate database health, diagnose corruption, inspect page layouts, and verify index consistency. All operations are non-destructive and safe to run on production databases.
Key Types
| Type | Description |
|---|---|
DatabaseInspector | Inspects database files: validates headers, walks B+trees, produces page-type histograms, and reports issues |
WalInspector | Validates WAL files: header checks, frame-by-frame validation (salt, checksums), commit marker detection |
IndexInspector | Verifies index integrity: root page validity, table/column existence, B+tree reachability |
DatabaseInspectReport | Report model with header info, page histogram, scanned pages, and issue list |
Usage
Database Inspection
using CSharpDB.Storage.Diagnostics;
// Full database inspection
var report = await DatabaseInspector.InspectAsync("mydb.db");
Console.WriteLine($"Pages scanned: {report.PageCountScanned}");
Console.WriteLine($"Issues found: {report.Issues.Count}");
foreach (var issue in report.Issues)
{
Console.WriteLine($" [{issue.Severity}] {issue.Message}");
}
// Inspect a specific page
var page = await DatabaseInspector.InspectPageAsync("mydb.db", pageId: 3, includeHex: true);
WAL Inspection
// Validate WAL integrity
var walReport = await WalInspector.InspectAsync("mydb.db");
// Check for frame validation errors, salt mismatches, checksum failures
Index Verification
// Verify an index is consistent with its table
var indexReport = await IndexInspector.CheckAsync("mydb.db", "idx_users_email", sampleSize: 100);
Installation
dotnet add package CSharpDB.Storage.Diagnostics
Dependencies
CSharpDB.Core- shared type systemCSharpDB.Storage- storage engine types and page format definitions
Related Packages
| Package | Description |
|---|---|
| CSharpDB.Storage | The storage engine this package inspects |
| CSharpDB.Service | Service layer that exposes diagnostics via API |
License
MIT - see LICENSE for details.