cat.nyaa.nyaacore.orm.backends.IConnectedDatabase Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rpgitems Show documentation

The legacy RPGItems continues. (fork)

There is a newer version: 3.12.2

package cat.nyaa.nyaacore.orm.backends;

import org.bukkit.plugin.Plugin;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
import java.util.Map;

/**
 * IDatabase contains an internal JDBC connection. see {@link cat.nyaa.nyaacore.orm.DatabaseUtils#connect(Plugin, BackendConfig)}
 * So the user *MUST* disconnect this
 * 
 * This interface is *NOT* thread safe.
 * If you what multiple connections, call {@link cat.nyaa.nyaacore.orm.DatabaseUtils#connect(Plugin, BackendConfig)} to create more connections.
 * AND **NEVER** FORGET TO {@link IConnectedDatabase#close()}
 * 

 * All ITable returned by {@link IConnectedDatabase#getTable(Class)} share this same connection.
 * NEVER operate on different tables simultaneously.
 * 
 * General rule:
 * when in double, use {@link cat.nyaa.nyaacore.orm.DatabaseUtils#connect(Plugin, BackendConfig)} to get a new connection
 */
public interface IConnectedDatabase extends AutoCloseable {
    /**
     * Get underlying JDBC connection. Easily gets messed up. Avoid if you can.
     *
     * @return
     */
    Connection getConnection();

     ITypedTable getTable(Class recordClass);

    /**
     * @param recordClass
     * @param 
     * @return
     */
     ITypedTable getUnverifiedTable(Class recordClass);

    @Override
    void close() throws SQLException;

    boolean verifySchema(String tableName, Class recordClass);

    /**
     * Execute a SQL file bundled with some plugin, using the default Connection.
     *
     * @param filename       full file name, including extension, in resources/sql folder
     * @param replacementMap {{key}} in the file will be replaced by value. Ignored if null. NOTE: sql injection will happen
     * @param cls            class of desired object
     * @param parameters     JDBC's positional parametrized query. Java Type
     * @return the result set, null if cls is null.
     */
     List queryBundledAs(Plugin plugin, String filename, Map replacementMap, Class cls, Object... parameters);
}