me.lucko.helper.sql.HelperDataSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helper-sql Show documentation

Provides SQL datasources using HikariCP.

There is a newer version: 1.3.0

/*
 * This file is part of helper, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) 
 *  Copyright (c) contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package me.lucko.helper.sql;

import com.zaxxer.hikari.HikariDataSource;

import me.lucko.helper.sql.plugin.HikariWrapper;
import me.lucko.helper.terminable.Terminable;

import java.sql.Connection;
import java.sql.SQLException;

import javax.annotation.Nonnull;

/**
 * Represents an individual datasource, created by the library.
 */
public interface HelperDataSource extends Terminable {

    @Nonnull
    static HelperDataSource usingHikari(@Nonnull DatabaseCredentials credentials) {
        return new HikariWrapper(credentials);
    }

    /**
     * Gets the Hikari instance backing the datasource
     *
     * @return the hikari instance
     */
    @Nonnull
    HikariDataSource getHikari();

    /**
     * Gets a connection from the datasource.
     *
     * The connection should be returned once it has been used.
     *
     * @return a connection
     */
    @Nonnull
    Connection getConnection() throws SQLException;

}