Skip to content

Database settings

Database settings are used to configure the database used by Open Banking Connector to read and write data.

In non-development environments (the default), you will at least need to at least provide a connection string setting for the configured database provider.

Settings

Name Valid Values Default Value(s) Description
OpenBankingConnector:Database:Provider {"Sqlite", "PostgreSql"} "PostgreSql" Determines which database provider Open Banking Connector uses.
OpenBankingConnector:Database:ConnectionStrings:{Provider}

where Provider ∈ {Sqlite, PostgreSql}

string "Data Source=./sqliteTestDb.db" (development environment and Provider = "Sqlite")

"Host=localhost;Database=test;Username=postgres" (development environment and Provider = "PostgreSql")

- (otherwise)

Connection strings for each database provider. Open Banking Connector only reads the one for the provider specified by OpenBankingConnector:Database:Provider. The BankTests project, however, may use multiple connection strings to test with multiple databases. A list of connection string parameters for provider PostgreSql is given here.
OpenBankingConnector:Database:EnsureDatabaseCreated {"true", "false"} "false" At application start-up, ensure database is created if does not exist.
OpenBankingConnector:Database:EnsureDatabaseMigrated {"true", "false"} "true" At application start-up, apply pending migrations. Only supported for database providers with migration support (i.e. only PostgreSql at this time).