Skip to content

Reference

Reference is the map: factual, complete, and consistent. Use it to look things up — the application DSL, the discovery interfaces, configuration keys, and every subsystem. For learning or task-oriented help, see the tutorial and how-to guides.

Foundations

Configuration

  • Configuration — ConfigProvider, the typed configuration binding patterns (ConfigBinder, @ConfigPrefix, ConfigBinding), and every recognized key.

Data

  • Persistence — Table, mapping, CrudRepository, SqlExecutor, DatabaseConfig.
  • Transactions — transactionManager, TransactionConfig, retry, and isolation.
  • Migrations — KatalystMigration, MigrationRunner, MigrationOptions.

Application features

  • Scheduler — requireScheduler, the jobs DSL, ScheduleConfig, CronExpression.
  • Events — DomainEvent, EventHandler, EventBus, side effects, deduplication.
  • Ktor integration — katalystRouting, katalystMiddleware, katalystWebSockets, katalystExceptionHandler, ktInject.

Testing

  • Testing — katalystTestEnvironment, katalystTestApplication, inMemoryDatabaseConfig, FakeConfigProvider.