Skip to main content

Database providers

Hyppot uses an SQL database to store the data. We provide three different database providers compatible with different RDBMS. Each providers comes in separate NuGet package.

Hyppot will automatically initialize database and apply migrations on startup.

Note: In load-balanced environments with multiple instances, the automatic migration process may cause issues if multiple instances start simultaneously. In such scenarios, it's recommended to start instances sequentially.

MS Sql Server​

To use Microsoft SQL Server as the DB provider, install Hyppot.Sqlserver and configure:

using Hyppot.Sqlserver;

builder.Services.AddHyppot(config =>
{
    config.DbSetup = new SqlserverDbDetup(connectionString);
});

All the tables will be created in Hyppot schema to avoid conflicts with existing tables in the database.

PostgreSQL​

To use PostgreSQL, install package Hyppot.Postgresql. Then configure storage as following:

using Hyppot.Postgresql;

builder.Services.AddHyppot(config =>
{
    config.DbSetup = new PostgresqlDbSetup(connectionString);
});

All the tables will be created in Hyppot schema to avoid conflicts with existing tables in the database.

SQLite​

To use SQLite, install package Hyppot.Sqlite. Then configure storage as following:

using Hyppot.Sqlite;

// ... 

builder.Services.AddHyppot(config =>
{
    config.DbSetup = new SqliteDbSetup("Data Source=/path/to/db/hyppot.db");
});

As SQLite does not support schemas, we suggest to use separate db file for Hyppot to avoid potential table conflict issues.