Database

SwiftlyS2's database service lets plugins fetch named connections from one global configuration, through APIISwiftlyCore.Database (APIIDatabaseService).

Global Database Configuration

Connections are defined in configs/database.jsonc and referenced by name from plugins:

{
    "default_connection": "host",
    "connections": {
        "host": "mysql://username:password@localhost:3306/database",
        "analytics": "postgresql://username:password@localhost:5432/database",
        "local": "sqlite://data/local.db"
    }
}

Supported URI formats: mysql://user:pass@host:3306/database, postgresql://user:pass@host:5432/database, sqlite://path/to/database.db.

Getting a Connection

APIIDatabaseService.GetConnection returns an IDbConnection for the named connection, falling back to the default connection if the name isn't found. APIIDatabaseService.GetConnectionString and APIIDatabaseService.GetConnectionInfo share the same fallback and expose the raw string / parsed metadata instead (see APIDatabaseConnectionInfo for the full field list - driver, host, database, user, pass, timeout, port, raw URI):

using var connection = Core.Database.GetConnection("host");
connection.Open();
 
string connectionString = Core.Database.GetConnectionString("host");
DatabaseConnectionInfo info = Core.Database.GetConnectionInfo("host");
Console.WriteLine($"{info.Driver} -> {info.Host}:{info.Port}/{info.Database}");

Using ADO.NET or an ORM

GetConnection returns IDbConnection, so plain ADO.NET or any compatible ORM works - Dapper, Dommel, FreeSql, Entity Framework Core:

using var connection = Core.Database.GetConnection("host");
 
var players = await connection.QueryAsync<PlayerRow>(
    "SELECT steam_id, name FROM players WHERE is_active = @IsActive",
    new { IsActive = true }
);