Database Connections

On the initial configuration screen, as well as any configuration page which requires a connection to be set, the tool exposes a panel for connection string editing.

Connection strings are named settings which provide SanteDB with the necessary information to contact a particular database server using a specified provider.

Editing Connection Strings

When editing a connection string in an existing configuration file, you will be presented with a list of connection strings which have already been configured:

In the example above, a user could select a an existing Read/Write connection string which has already been configured or they can create a NEW connection string to, for example, bind the read/write connection string to a read/write primary node.

Connection Types

PostgreSQL Configuration

When PostgreSQL is selected as the database software, you should enter the connection details to the PostgreSQL server and database you'd like to configure.



The location of the PostgreSQL server on your network.



The port number (if using a different port than 5432)


user id

The user identifier which SanteDB should use to connect to the database server.


The password for the user to be used to connect to the server.


The name of the database to connect to (or a new database)


True if the SanteDB should use connection pooling (true recommended for production environments)


The minimum number of pooled connections to keep open to the database.



The maximum number of pooled connections to allow to the database (before a wait is induced)



When Firebird is selected as the database software, SanteDB will assume you're using an embedded IBSQL (Firebird) database.


user id

The user identifier to connect to the database provider (should be SYSDBA)



If password protecting the database, the password of SYSDBA

initial catalog

The name of the FDB file to connect to or a new database.

SQLite / SQLCipher

SanteDB iCDR version 3.0 and higher supports the configuration of the SQLite and SQLCipher persistence layer. This is ideal for test environments and lightweight deployments.


data source

The name of the SQLite database file which should be used for connection



If using SQLCipher the password indicates the passkey for the encrypted database.

foreign keys

True when the SQLite engine should enforce foreign keys.

Creating a new Database

You can create a new database from the configuration tool on the database software of your choice by selecting New Database as the database option. You will be prompted to enter the details of the database you're creating:

You will need to provide the superuser account of a user which has CREATE DATABASE permission on the selected provider. Upon pressing OK the database will be created and initialized, and you will be returned to the initial configuration screen.

Last updated