me.lucko.helper.sql

Interface SqlProvider

All Known Implementing Classes:

SqlPlugin

public interface SqlProvider

Provides HelperDataSource instances.

Method Summary

Modifier and Type	Method and Description
HelperDataSource	getDataSource() Gets the global datasource.
HelperDataSource	getDataSource(DatabaseCredentials credentials) Constructs a new datasource using the given credentials.
DatabaseCredentials	getGlobalCredentials() Gets the global database credentials being used for the global datasource.

Method Detail

getDataSource

@Nonnull
HelperDataSource getDataSource()

Gets the global datasource.

Returns:

the global datasource.

getDataSource

@Nonnull
HelperDataSource getDataSource(@Nonnull
                                         DatabaseCredentials credentials)

Constructs a new datasource using the given credentials.

These instances are not cached, and a new datasource is created each time this method is called.

Parameters:

credentials - the credentials for the database

Returns:

a new datasource

getGlobalCredentials

@Nonnull
DatabaseCredentials getGlobalCredentials()

Gets the global database credentials being used for the global datasource.

Returns:

the global credentials