Package com.plotsquared.core.database

Class MySQL

java.lang.Object

com.plotsquared.core.database.Database

com.plotsquared.core.database.MySQL

public class MySQL
extends Database

Connects to and uses a MySQL database

Constructor Summary

Constructors

Constructor	Description
MySQL(String hostname, String port, String database, String username, String password)	Creates a new MySQL instance.

Method Summary

Modifier and Type	Method	Description
boolean	checkConnection()	Checks if a connection is open with the database.
boolean	closeConnection()	Closes the connection with the database.
Connection	forceConnection()
Connection	getConnection()	Gets the connection with the database.
Connection	openConnection()	Opens a connection with the database.
ResultSet	querySQL(String query)	Executes a SQL Query.
int	updateSQL(String query)	Executes an Update SQL Query.

Methods inherited from class java.lang.Object

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

Constructor Details

MySQL

public MySQL(String hostname,
 String port,
 String database,
 String username,
 String password)

Creates a new MySQL instance.

Parameters:

hostname - Name of the host

port - Port number

database - Database name

username - Username

password - Password

Method Details

forceConnection

public Connection forceConnection()
                           throws SQLException

Specified by:

forceConnection in class Database

Throws:

SQLException

openConnection

public Connection openConnection()
                          throws SQLException

Description copied from class: Database

Opens a connection with the database.

Specified by:

openConnection in class Database

Returns:

Opened connection

Throws:

SQLException - if the connection can not be opened

checkConnection

public boolean checkConnection()
                        throws SQLException

Description copied from class: Database

Checks if a connection is open with the database.

Specified by:

checkConnection in class Database

Returns:

true if the connection is open

Throws:

SQLException - if the connection cannot be checked

getConnection

public Connection getConnection()

Description copied from class: Database

Gets the connection with the database.

Specified by:

getConnection in class Database

Returns:

Connection with the database, null if none

closeConnection

public boolean closeConnection()
                        throws SQLException

Description copied from class: Database

Closes the connection with the database.

Specified by:

closeConnection in class Database

Returns:

true if successful

Throws:

SQLException - if the connection cannot be closed

querySQL

public ResultSet querySQL(String query)
                   throws SQLException

Description copied from class: Database

Executes a SQL Query. If the connection is closed, it will be opened.

Specified by:

querySQL in class Database

Parameters:

query - Query to be run

Returns:

the results of the query

Throws:

SQLException - If the query cannot be executed

updateSQL

public int updateSQL(String query)
              throws SQLException

Description copied from class: Database

Executes an Update SQL Query. See Statement.executeUpdate(String). If the connection is closed, it will be opened.

Specified by:

updateSQL in class Database

Parameters:

query - Query to be run

Returns:

Result Code, see Statement.executeUpdate(String)

Throws:

SQLException - If the query cannot be executed