api/org.octavius.data.annotation

Package-level declarations

Types

object DefaultPgCompositeMapper : PgCompositeMapper<Any>

Internal marker to indicate that no explicit mapper is provided.

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DynamicallyMappable(val typeName: String)

Marks a data class, enum class, or value class as a target for dynamic mapping from dynamic_dto type in PostgreSQL.

PgComposite

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PgComposite(val name: String = "", val schema: String = "", val mapper: KClass<out PgCompositeMapper<*>> = DefaultPgCompositeMapper::class)

Marks a data class as a data type that can be mapped to a composite type in PostgreSQL database.

PgCompositeMapper

interface PgCompositeMapper<T : Any>

Interface for manual (non-reflective) mapping of a data class to/from a Map. Used by PgComposite to bypass reflection-based mapping and improve performance.

PgEnum

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class PgEnum(val name: String = "", val schema: String = "", val pgConvention: CaseConvention = CaseConvention.SNAKE_CASE_UPPER, val kotlinConvention: CaseConvention = CaseConvention.PASCAL_CASE)

Marks an enum class as a data type that can be mapped to an ENUM type in PostgreSQL database.