me.lucko.helper.sql

Interface HelperDataSource

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

HikariWrapper

public interface HelperDataSource
extends Terminable

Represents an individual datasource, created by the library.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
Connection	getConnection() Gets a connection from the datasource.
com.zaxxer.hikari.HikariDataSource	getHikari() Gets the Hikari instance backing the datasource
static HelperDataSource	usingHikari(DatabaseCredentials credentials)

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, close, closeAndReportException, closeSilently, isClosed

Method Detail

usingHikari

@Nonnull
static HelperDataSource usingHikari(@Nonnull
                                              DatabaseCredentials credentials)

getHikari

@Nonnull
com.zaxxer.hikari.HikariDataSource getHikari()

Gets the Hikari instance backing the datasource

Returns:

the hikari instance

getConnection

@Nonnull
Connection getConnection()
                            throws SQLException

Gets a connection from the datasource.

The connection should be returned once it has been used.

Returns:

a connection

Throws:

SQLException