org.spongepowered.api.service.sql

Interface SqlService

@ThreadSafe
public interface SqlService

This service provides the basics for an abstraction over SQL connections.

Implementations of this service are expected to be thread-safe.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getConnectionUrlFromAlias(String alias) Returns a possible connection URL for a given alias.
DataSource	getDataSource(Object plugin, String jdbcConnection) Returns a data source for the provided JDBC connection string or an alias.
DataSource	getDataSource(String jdbcConnection) Returns a data source for the provided JDBC connection string or an alias.

Method Detail

getDataSource

DataSource getDataSource(String jdbcConnection)
                  throws SQLException

Returns a data source for the provided JDBC connection string or an alias.

A jdbc connection url is expected to be of the form: jdbc:<engine>://[<username>[:<password>]@]<host >/<database> or an alias (available aliases are known only by the service provider)

Parameters:

jdbcConnection - The jdbc url or connection alias

Returns:

A data source providing connections to the given URL.

Throws:

SQLException - if a connection to the given database could not be established

getDataSource

DataSource getDataSource(Object plugin,
                         String jdbcConnection)
                  throws SQLException

Returns a data source for the provided JDBC connection string or an alias.

A jdbc connection url is expected to be of the form: jdbc:<engine>://[<username>[:<password>]@] <host>/<database> or an alias (available aliases are known only by the service provider)

Parameters:

plugin - The plugin to lookup databases relative to (primarily applying to file-backed databases)

jdbcConnection - The jdbc url or connection alias

Returns:

A data source providing connections to the given URL.

Throws:

SQLException - if a connection to the given database could not be established

getConnectionUrlFromAlias

Optional<String> getConnectionUrlFromAlias(String alias)

Returns a possible connection URL for a given alias.

Parameters:

alias - The alias to check

Returns:

The connection url as a String if it exists, or Optional.empty()