Package fr.multimc.api.commons.data.sources.database

Class Database

java.lang.Object

fr.multimc.api.commons.data.sources.database.Database

All Implemented Interfaces:

IDataSource

public class Database
extends Object
implements IDataSource

Constructor Summary

Constructors

Constructor	Description
Database(File databaseFile, Logger logger)	Database constructor for SQLITE
Database(String ip, int port, String userName, String password, String databaseName, Logger logger)	Database constructor for MYSQL

Method Summary

Modifier and Type	Method	Description
SQLState	connect()	Initialize the connection object with a new connection to the database
SQLState	disconnect()	Close the connection with the database
QueryResult	executeQuery(String query, QueryType queryType)	Execute a given query
DatabaseType	getDatabaseType()
DataSourceType	getDataSourceType()
SQLState	isTableExist(String tableName)	Check if a given table exists in the database
SQLState	reconnect()	Reset the connection object and reconnect it to the database

Methods inherited from class java.lang.Object

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

Constructor Details

Database

public Database(String ip,
 int port,
 String userName,
 String password,
 String databaseName,
 Logger logger)

Database constructor for MYSQL

Parameters:

ip - Database IP

port - Database port

userName - Database username

password - Database password

databaseName - Database name

logger - Plugin logger

Database

public Database(File databaseFile,
 Logger logger)

Database constructor for SQLITE

Parameters:

databaseFile - Database file

logger - Plugin logger

Method Details

connect

public SQLState connect()

Initialize the connection object with a new connection to the database

Returns:

Custom SQLState, can be SUCCESS or SQLERROR

reconnect

public SQLState reconnect()

Reset the connection object and reconnect it to the database

Returns:

Custom SQLState, can be SUCCESS or SQLERROR

disconnect

public SQLState disconnect()

Close the connection with the database

Returns:

Custom SQLState, can be SUCCESS or SQLERROR

executeQuery

public QueryResult executeQuery(String query,
 QueryType queryType)

Execute a given query

Parameters:

query - SQL Query to execute

queryType - QueryType of the query (SELECT or UPDATE)

Returns:

QueryResult object that contain a SQLState and a ResultSet if the query is a SELECT

isTableExist

public SQLState isTableExist(String tableName)

Check if a given table exists in the database

Parameters:

tableName - Target table name

Returns:

Custom SQLState, can be TABLE_EXIST, TABLE_NOT_EXIST or SQLERROR

getDatabaseType

public DatabaseType getDatabaseType()

getDataSourceType

public DataSourceType getDataSourceType()

Specified by:

getDataSourceType in interface IDataSource