main.java.com.djrapitops.plan.database.databases

Class SQLDB

java.lang.Object

main.java.com.djrapitops.plan.database.Database

main.java.com.djrapitops.plan.database.databases.SQLDB

Direct Known Subclasses:

MySQLDB, SQLiteDB

public abstract class SQLDB
extends Database

Class containing main logic for different data related save and load functionality.

Since:

2.0.0

Author:

Rsl1122

Field Summary

Fields inherited from class main.java.com.djrapitops.plan.database.Database

actionsTable, commandUseTable, dataSource, ipsTable, killsTable, nicknamesTable, plugin, securityTable, serverTable, sessionsTable, tpsTable, userInfoTable, usersTable, versionTable, worldTable, worldTimesTable

Constructor Summary

Constructors

Constructor and Description
SQLDB(IPlan plugin)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the SQLDB
void	commit(Connection connection) Commits changes to the .db file when using SQLite Database.
Table[]	getAllTables() Get all tables in a good order.
Table[]	getAllTablesInRemoveOrder() Get all tables for removal of data.
Connection	getConnection()
int	getVersion() Used to get the database schema version.
void	init() Initializes the Database.
boolean	isNewDatabase()
boolean	isOpen()
void	removeAccount(UUID uuid) Removes all data related to an account from the database.
void	removeAllData() Used to clear all data from the database.
void	rollback(Connection connection) Reverts transaction when using SQLite Database.
void	scheduleClean(long secondsDelay)
void	setAvailable()
void	setupDatabase() Ensures connection functions correctly and all tables exist.
abstract void	setupDataSource() Setups the BasicDataSource
void	setVersion(int version) Used to set the database schema version.
boolean	wasSeenBefore(UUID uuid) Check if the user is saved in the database.

Methods inherited from class main.java.com.djrapitops.plan.database.Database

getActionsTable, getCommandUse, getCommandUseTable, getConfigName, getDataSource, getIpsTable, getKillsTable, getName, getNicknamesTable, getSavedUUIDs, getSecurityTable, getServerTable, getSessionsTable, getTpsTable, getUserInfoTable, getUsersTable, getWorldTable, getWorldTimesTable, isUsingMySQL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLDB

public SQLDB(IPlan plugin)

Method Detail

init

public void init()
          throws DatabaseInitException

Initializes the Database.

All tables exist in the database after call to this. Updates Schema to latest version. Converts Unsaved Bukkit player files to database data. Cleans the database.

Overrides:

init in class Database

Throws:

DatabaseInitException - if Database fails to initiate.

scheduleClean

public void scheduleClean(long secondsDelay)

setupDatabase

public void setupDatabase()
                   throws DatabaseInitException

Ensures connection functions correctly and all tables exist.

Updates to latest schema.

Throws:

DatabaseInitException - if something goes wrong.

getAllTables

public Table[] getAllTables()

Get all tables in a good order.

Returns:

Table array.

getAllTablesInRemoveOrder

public Table[] getAllTablesInRemoveOrder()

Get all tables for removal of data.

Returns:

Tables in the order the data should be removed in.

setupDataSource

public abstract void setupDataSource()
                              throws DatabaseInitException

Setups the BasicDataSource

Throws:

DatabaseInitException

close

public void close()
           throws SQLException

Closes the SQLDB

Specified by:

close in class Database

Throws:

SQLException - DB Error

getVersion

public int getVersion()
               throws SQLException

Description copied from class: Database

Used to get the database schema version.

Specified by:

getVersion in class Database

Returns:

@throws SQLException

Throws:

SQLException - If a database error occurs.

setVersion

public void setVersion(int version)
                throws SQLException

Description copied from class: Database

Used to set the database schema version.

Specified by:

setVersion in class Database

Parameters:

version - Integer starting from 0, incremented by one when schema is updated.

Throws:

SQLException - If a database error occurs.

isNewDatabase

public boolean isNewDatabase()
                      throws SQLException

Specified by:

isNewDatabase in class Database

Throws:

SQLException

wasSeenBefore

public boolean wasSeenBefore(UUID uuid)

Description copied from class: Database

Check if the user is saved in the database.

Specified by:

wasSeenBefore in class Database

Parameters:

uuid - UUID of the user.

Returns:

true/false

removeAccount

public void removeAccount(UUID uuid)
                   throws SQLException

Description copied from class: Database

Removes all data related to an account from the database.

Specified by:

removeAccount in class Database

Parameters:

uuid - UUID of the account.

Throws:

SQLException - If a database error occurs.

removeAllData

public void removeAllData()
                   throws SQLException

Description copied from class: Database

Used to clear all data from the database.

Uses DELETE * FROM table.

Specified by:

removeAllData in class Database

Throws:

SQLException - if remove fails.

setAvailable

public void setAvailable()

getConnection

public Connection getConnection()
                         throws SQLException

Throws:

SQLException

commit

public void commit(Connection connection)
            throws SQLException

Commits changes to the .db file when using SQLite Database.

MySQL has Auto Commit enabled.

Specified by:

commit in class Database

Throws:

SQLException

rollback

public void rollback(Connection connection)
              throws SQLException

Reverts transaction when using SQLite Database.

MySQL has Auto Commit enabled.

Throws:

SQLException

isOpen

public boolean isOpen()