Kontainers Common/io.microkt.kontainers.domain/R2dbcKontainer

R2dbcKontainer

interface R2dbcKontainer : DatabaseKontainer

Functions

Returns the platform assigned address at which this Kontainer can be reached the application that started this Kontainer. The returned address may be an IP address or hostname depending on the platform on which it's running.

getDatabaseName

abstract fun getDatabaseName(): String

Returns the name of this Kontainer's default database.

getDirectAddress

abstract fun getDirectAddress(): String?

Returns the platform assigned address at which this Kontainer can be directly reached by other Kontainers running on the platform.

getPassword

abstract fun getPassword(): String

Returns this Kontainer's default database password.

getPort

abstract fun getPort(): Int?

Returns the platform assigned default port for this Kontainer. The default port is the first port specified by this Kontainer's KontainerSpec.

abstract fun getPort(containerPort: Int): Int?

Returns the platform assigned port mapped to the given exposed containerPort defined by this Kontainer's KontainerSpec.

getUsername

abstract fun getUsername(): String

Returns this Kontainer's default database username.

remove

abstract suspend fun remove()

Removes this Kontainer for the running platform. Once a Kontainer is removed, it cannot be restarted.

removeSync

open fun removeSync()

Removes this Kontainer synchronously from the running platform.

start

abstract suspend fun start(timeout: Long)

Starts this Kontainer asynchronously with the given timeout.

startSync

open fun startSync(timeout: Long)

Starts this Kontainer synchronously with the given timeout, blocking the current thread until this Kontainer starts or the timeout is reached.

Properties

abstract val id: String

The platform assigned identifier for this Kontainer.

kontainerSpec

abstract val kontainerSpec: KontainerSpec

The Kontainer specification for this Kontainer.