client-scanner/io.github.octaviusframework.client.scanner/ScanReport

ScanReport

data class ScanReport(val enums: List<RegisteredType>, val composites: List<RegisteredType>, val dynamicTypes: List<RegisteredType>, val unresolved: List<RegisteredType> = emptyList())

What a scan found and registered.

Worth logging or asserting on at startup. A scan that finds nothing is the failure this exists to make visible: a package name with a typo in it registers nothing and raises nothing, and the first sign of it is a query months later coming back with an unmapped column.

Constructors

ScanReport

constructor(enums: List<RegisteredType>, composites: List<RegisteredType>, dynamicTypes: List<RegisteredType>, unresolved: List<RegisteredType> = emptyList())

Properties

composites

val composites: List<RegisteredType>

Data classes registered as PostgreSQL COMPOSITE types.

dynamicTypes

val dynamicTypes: List<RegisteredType>

Classes registered as dynamic_dto discriminators.

enums

val enums: List<RegisteredType>

Enums registered as PostgreSQL ENUM types.

total

val total: Int

How many classes were registered in total.

unresolved

val unresolved: List<RegisteredType>

The enums and composites whose type the database does not have. They are registered all the same and appear in enums or composites as well - registering a name the catalogue does not carry yet is allowed, and works once the type exists and reloadTypes() has run. It is reported because the other way to get here is a name with a typo in it, and that one is otherwise silent until a query cannot map a column.

Functions

isEmpty

fun isEmpty(): Boolean

Whether the scan registered nothing at all.

toString

open override fun toString(): String