exposed-vertx-sql-client-core/com.huanshankeji.exposedvertxsqlclient/ConnectionConfig

ConnectionConfig

sealed interface ConnectionConfig(source)

Common configuration for database connections to both Vert.x SqlClient and Exposed Database, currently supporting both TCP socket and Unix domain socket connections.

Use ConnectionConfig.Socket for standard TCP/IP connections, or ConnectionConfig.UnixDomainSocketWithPeerAuthentication for Unix domain socket connections with peer authentication (experimental, primarily tested with PostgreSQL on Linux).

See also

ConnectionConfig.Socket

ConnectionConfig.UnixDomainSocketWithPeerAuthentication

Inheritors

UnixDomainSocketWithPeerAuthentication

Types

class Socket(val host: String, val port: Int? = null, val user: String, val password: String, val database: String) : ConnectionConfig

Standard TCP/IP socket connection configuration.

UnixDomainSocketWithPeerAuthentication

class UnixDomainSocketWithPeerAuthentication(val path: String, val role: String, val database: String) : ConnectionConfig

Unix domain socket connection configuration with peer authentication.

Properties

abstract val database: String

The name of the database to connect to.

abstract val userAndRole: String

The user and role name used for authentication.

Functions

getCoConnectHandler

fun ConnectionConfig.getCoConnectHandler(extra: CoConnectHandler?): CoConnectHandler?

suspend fun ConnectionConfig.initConnection(sqlConnection: SqlConnection, extra: CoConnectHandler?)