Database (Plan 4.0.0 API)

java.lang.Object
- main.java.com.djrapitops.plan.database.Database

Direct Known Subclasses:

SQLDB
```
public abstract class Database
extends Object
```
Abstract class representing a Database.
All methods should be only called from an asynchronous thread, unless stated otherwise.

Author:

Rsl1122

Field Summary

Fields
Modifier and Type	Field and Description
`protected ActionsTable`	`actionsTable` Table representing plan_actions in the database.
`protected CommandUseTable`	`commandUseTable` Table representing plan_commandusages in the database.
`protected org.apache.commons.dbcp2.BasicDataSource`	`dataSource`
`protected IPsTable`	`ipsTable` Table representing plan_ips in the database.
`protected KillsTable`	`killsTable` Table representing plan_kills in the database.
`protected NicknamesTable`	`nicknamesTable` Table representing plan_nicknames in the database.
`protected IPlan`	`plugin` Instance of Plan used with this database.
`protected SecurityTable`	`securityTable` Table representing plan_security in the database.
`protected ServerTable`	`serverTable` Table representing plan_servers in the database.
`protected SessionsTable`	`sessionsTable` Table representing plan_sessions in the database.
`protected TPSTable`	`tpsTable` Table representing plan_tps in the database.
`protected UserInfoTable`	`userInfoTable` Table representing plan_user_info in the database.
`protected UsersTable`	`usersTable` Table representing plan_users in the database.
`protected VersionTable`	`versionTable` Table representing plan_version in the database.
`protected WorldTable`	`worldTable` Table representing plan_worlds in the database.
`protected WorldTimesTable`	`worldTimesTable` Table representing plan_world_times in the database.

Constructor Summary

Constructors
Constructor and Description

Database(IPlan plugin)
Super constructor.

Constructors
Constructor and Description
`Database(IPlan plugin)` Super constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`close()` Closes the database and it's resources.
`abstract void`	`commit(Connection connection)`
`ActionsTable`	`getActionsTable()`
`Map<String,Integer>`	`getCommandUse()` Used to get the Command usage mep.
`CommandUseTable`	`getCommandUseTable()` Used to get the command usage table.
`String`	`getConfigName()` Used to get the config name of the database type.
`org.apache.commons.dbcp2.BasicDataSource`	`getDataSource()`
`IPsTable`	`getIpsTable()` Used to get the ips table.
`KillsTable`	`getKillsTable()` Used to get the kills table.
`abstract String`	`getName()` Used to get the name of the database type.
`NicknamesTable`	`getNicknamesTable()` Used to get the nicknames table.
`Set<UUID>`	`getSavedUUIDs()` Used to fetch the saved UUIDs in the users table.
`SecurityTable`	`getSecurityTable()` Used to get the security table.
`ServerTable`	`getServerTable()`
`SessionsTable`	`getSessionsTable()` Used to get the users table.
`TPSTable`	`getTpsTable()` Used to get the tps table.
`UserInfoTable`	`getUserInfoTable()`
`UsersTable`	`getUsersTable()` Used to get the users table.
`abstract int`	`getVersion()` Used to get the database schema version.
`WorldTable`	`getWorldTable()` Used to get the worlds table.
`WorldTimesTable`	`getWorldTimesTable()` Used to get the world times table.
`void`	`init()` Initiates the database.
`abstract boolean`	`isNewDatabase()`
`boolean`	`isUsingMySQL()`
`abstract void`	`removeAccount(UUID uuid)` Removes all data related to an account from the database.
`abstract void`	`removeAllData()` Used to clear all data from the database.
`abstract void`	`setVersion(int version)` Used to set the database schema version.
`abstract boolean`	`wasSeenBefore(UUID uuid)` Check if the user is saved in the database.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - plugin
```
protected final IPlan plugin
```
    Instance of Plan used with this database.
  - usersTable
```
protected UsersTable usersTable
```
    Table representing plan_users in the database.
  - userInfoTable
```
protected UserInfoTable userInfoTable
```
    Table representing plan_user_info in the database.
  - actionsTable
```
protected ActionsTable actionsTable
```
    Table representing plan_actions in the database.
  - killsTable
```
protected KillsTable killsTable
```
    Table representing plan_kills in the database.
  - nicknamesTable
```
protected NicknamesTable nicknamesTable
```
    Table representing plan_nicknames in the database.
  - sessionsTable
```
protected SessionsTable sessionsTable
```
    Table representing plan_sessions in the database.
  - ipsTable
```
protected IPsTable ipsTable
```
    Table representing plan_ips in the database.
  - commandUseTable
```
protected CommandUseTable commandUseTable
```
    Table representing plan_commandusages in the database.
  - tpsTable
```
protected TPSTable tpsTable
```
    Table representing plan_tps in the database.
    
    Since:
    
    3.5.0
  - versionTable
```
protected VersionTable versionTable
```
    Table representing plan_version in the database.
  - securityTable
```
protected SecurityTable securityTable
```
    Table representing plan_security in the database.
    
    Since:
    
    3.5.2
  - worldTable
```
protected WorldTable worldTable
```
    Table representing plan_worlds in the database.
    
    Since:
    
    3.6.0
  - worldTimesTable
```
protected WorldTimesTable worldTimesTable
```
    Table representing plan_world_times in the database.
    
    Since:
    
    3.6.0
  - serverTable
```
protected ServerTable serverTable
```
    Table representing plan_servers in the database.
  - dataSource
```
protected org.apache.commons.dbcp2.BasicDataSource dataSource
```
- Constructor Detail
  - Database
```
public Database(IPlan plugin)
```
    Super constructor.
    
    Parameters:
    
    plugin - current instance of Plan.
- Method Detail
  - init
```
public void init()
          throws DatabaseInitException
```
    Initiates the database.
    
    Throws:
    
    DatabaseInitException - if SQLException or other exception occurs.
  - wasSeenBefore
```
public abstract boolean wasSeenBefore(UUID uuid)
```
    Check if the user is saved in the database.
    
    Parameters:
    
    uuid - UUID of the user.
    
    Returns:
    
    true/false
  - getName
```
public abstract String getName()
```
    Used to get the name of the database type.
    Thread safe.
    
    Returns:
    
    SQLite/MySQL
  - getConfigName
```
public String getConfigName()
```
    Used to get the config name of the database type.
    Thread safe.
    
    Returns:
    
    sqlite/mysql
  - isNewDatabase
```
public abstract boolean isNewDatabase()
                               throws SQLException
```
    Throws:
    
    SQLException
  - getVersion
```
public abstract int getVersion()
                        throws SQLException
```
    Used to get the database schema version.
    
    Returns:
    
    Integer starting from 0, incremented by one when schema is updated.
    
    Throws:
    
    SQLException - If a database error occurs.
  - setVersion
```
public abstract void setVersion(int version)
                         throws SQLException
```
    Used to set the database schema version.
    
    Parameters:
    
    version - Integer starting from 0, incremented by one when schema is updated.
    
    Throws:
    
    SQLException - If a database error occurs.
  - close
```
public abstract void close()
                    throws SQLException
```
    Closes the database and it's resources.
    
    Throws:
    
    SQLException - If a database error occurs.
  - removeAccount
```
public abstract void removeAccount(UUID uuid)
                            throws SQLException
```
    Removes all data related to an account from the database.
    
    Parameters:
    
    uuid - UUID of the account.
    
    Throws:
    
    SQLException - If a database error occurs.
  - removeAllData
```
public abstract void removeAllData()
                            throws SQLException
```
    Used to clear all data from the database.
    Uses DELETE * FROM table.
    
    Throws:
    
    SQLException - if remove fails.
  - getSavedUUIDs
```
public Set<UUID> getSavedUUIDs()
                        throws SQLException
```
    Used to fetch the saved UUIDs in the users table.
    
    Returns:
    
    Set of saved UUIDs
    
    Throws:
    
    SQLException - If a database error occurs.
  - getCommandUse
```
public Map<String,Integer> getCommandUse()
                                  throws SQLException
```
    Used to get the Command usage mep.
    
    Returns:
    
    String command (key), Integer times used
    
    Throws:
    
    SQLException - If a database error occurs.
  - getUsersTable
```
public UsersTable getUsersTable()
```
    Used to get the users table.
    
    Returns:
    
    Table representing plan_users
  - getSessionsTable
```
public SessionsTable getSessionsTable()
```
    Used to get the users table.
    
    Returns:
    
    Table representing plan_sessions
  - getKillsTable
```
public KillsTable getKillsTable()
```
    Used to get the kills table.
    
    Returns:
    
    Table representing plan_kills
  - getIpsTable
```
public IPsTable getIpsTable()
```
    Used to get the ips table.
    
    Returns:
    
    Table representing plan_ips
  - getNicknamesTable
```
public NicknamesTable getNicknamesTable()
```
    Used to get the nicknames table.
    
    Returns:
    
    Table representing plan_nicknames
  - getCommandUseTable
```
public CommandUseTable getCommandUseTable()
```
    Used to get the command usage table.
    
    Returns:
    
    Table representing plan_commandusages
  - getTpsTable
```
public TPSTable getTpsTable()
```
    Used to get the tps table.
    
    Returns:
    
    Table representing plan_tps
  - getSecurityTable
```
public SecurityTable getSecurityTable()
```
    Used to get the security table.
    
    Returns:
    
    Table representing plan_security
  - getWorldTable
```
public WorldTable getWorldTable()
```
    Used to get the worlds table.
    
    Returns:
    
    Table representing plan_worlds
  - getWorldTimesTable
```
public WorldTimesTable getWorldTimesTable()
```
    Used to get the world times table.
    
    Returns:
    
    Table representing plan_world_times
  - getServerTable
```
public ServerTable getServerTable()
```
  - getActionsTable
```
public ActionsTable getActionsTable()
```
  - getUserInfoTable
```
public UserInfoTable getUserInfoTable()
```
  - getDataSource
```
public org.apache.commons.dbcp2.BasicDataSource getDataSource()
```
  - commit
```
public abstract void commit(Connection connection)
                     throws SQLException
```
    Throws:
    
    SQLException
  - isUsingMySQL
```
public boolean isUsingMySQL()
```

Class Database

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

plugin

usersTable

userInfoTable

actionsTable

killsTable

nicknamesTable

sessionsTable

ipsTable

commandUseTable

tpsTable

versionTable

securityTable

worldTable

worldTimesTable

serverTable

dataSource

Constructor Detail

Database

Method Detail

init

wasSeenBefore

getName

getConfigName

isNewDatabase

getVersion

setVersion

close

removeAccount

removeAllData

getSavedUUIDs

getCommandUse

getUsersTable

getSessionsTable

getKillsTable

getIpsTable

getNicknamesTable

getCommandUseTable

getTpsTable

getSecurityTable

getWorldTable

getWorldTimesTable

getServerTable

getActionsTable

getUserInfoTable

getDataSource

commit

isUsingMySQL