MSSQL Index plugin

This plugins allows you to store the Orthanc index database in an MSSQL server (including Azure SQL).


Unlike the postgresql plugin, the MSSQL plugin is only able to store the Orthanc Index (the DICOM files can not be stored in MSSQL and must be stored in a file system or in a Blob storage)


Linux systems

This plugin is part of the osimis/orthanc-pro Docker images.  Note that you'll also need a valid license string to enable the plugin.

Windows systems

For Windows system, the MSSQL plugin DLL is available for download from here. As a prerequisite, you'll have to install the MSSQL ODCB drivers.


In your Orthanc configuration file, add a section like this one:

  "MSSQL" : {
    "EnableIndex" : true,
    "ConnectionString" : "Driver={ODBC Driver 13 for SQL Server};,1433;Database=yyyyyyyyyyyy;Uid=zzzzzzz;Pwd=ppppppppppp;Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;",
    "LicenseString" : "xxxxx___me%example.com___xxxx",
	"Lock" : false,
	"MaximumConnectionRetries": 10,  // Number of retries when connecting to the DB at startup
	"ConnectionRetryInterval": 5     // Interval between retries when connecting to the DB at startup

or use the environment variables as described in How to use osimis/orthanc Docker images ?.

Sample Docker setup

You'll find a sample Docker setup to demonstrate how you can configure the plugin here.