Vuresoft.Dicom.Sqlite 0.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Vuresoft.Dicom.Sqlite --version 0.1.0
                    
NuGet\Install-Package Vuresoft.Dicom.Sqlite -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Vuresoft.Dicom.Sqlite" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Vuresoft.Dicom.Sqlite" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="Vuresoft.Dicom.Sqlite" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Vuresoft.Dicom.Sqlite --version 0.1.0
                    
#r "nuget: Vuresoft.Dicom.Sqlite, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Vuresoft.Dicom.Sqlite@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Vuresoft.Dicom.Sqlite&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Vuresoft.Dicom.Sqlite&version=0.1.0
                    
Install as a Cake Tool

Vuresoft.Dicom.Sqlite

** BETA VERSION **

A .NET library for storing DICOM medical images in SQLite databases. Each DICOM study is stored in its own SQLite database file, containing all instances with their complete image data.

Features

  • Store complete DICOM studies in single SQLite database files
  • One database per study for easy management and portability
  • Retrieve DICOM data by Study, Series, and Instance UIDs
  • Bulk import from directories or file lists
  • Thread-safe concurrent access with built-in locking

Installation

Add reference to Vuresoft.Dicom.Sqlite project or NuGet package (when available).

Basic Usage

Create a database from a directory of DICOM files

using Vuresoft.Dicom.Sqlite;

// Create a new database from a folder containing DICOM files
var db = await SqliteDicomStudyDb.CreateFromDirectoryAsync(
    sourceDirectory: @"C:\DicomFiles\Study123",
    databasePath: @"C:\Studies\study123.db"
);

Add DICOM files to an existing database

using var db = new SqliteDicomStudyDb(@"C:\Studies\study123.db");

// Add a single file
await db.AddInstanceFromFileAsync(@"C:\DicomFiles\image.dcm");

// Import multiple files
var files = new[] { "file1.dcm", "file2.dcm", "file3.dcm" };
await db.ImportFilesAsync(files);

// Import entire directory
await db.ImportDirectoryAsync(@"C:\DicomFiles\Study123");

Retrieve DICOM data

using var db = new SqliteDicomStudyDb(@"C:\Studies\study123.db");

// Get a single instance as DicomDataset
var dataset = await db.GetInstanceAsync(studyUid, seriesUid, sopUid);

// Get raw DICOM bytes
var bytes = await db.GetInstanceBytesAsync(studyUid, seriesUid, sopUid);

// Get all instances in a series
var seriesDatasets = await db.GetSeriesAsync(studyUid, seriesUid);

// Get all instances in a study
var studyBytes = await db.GetStudyBytesAsync(studyUid);

Database Structure

Each SQLite database contains:

  • Study table - Study Instance UID
  • Series table - Series Instance UIDs linked to studies
  • Instance table - SOP Instance UIDs with complete DICOM file data stored as BLOB

Dependencies

  • fo-dicom - DICOM file parsing
  • Microsoft.EntityFrameworkCore.Sqlite - Database access
  • .NET 10.0 or later

Thread Safety

The library includes built-in thread safety with per-study locking mechanisms to handle concurrent read/write operations safely.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.2.5 272 9/18/2025
0.2.4 225 9/15/2025
0.2.3 188 9/15/2025
0.2.2 54 9/13/2025
0.2.1 127 9/11/2025
0.2.0 136 9/9/2025
0.1.0 183 8/28/2025