com.codelanx.commons.data.types

Class MySQL

java.lang.Object

com.codelanx.commons.data.types.MySQL

All Implemented Interfaces:

DataType, SQLDataType, AutoCloseable

public class MySQL
extends Object
implements SQLDataType

Instantiable MySQL connector

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MySQL.ConnectionPrefs Subclass for managing connection preferences.

Constructor Summary

Constructors

Constructor and Description
MySQL(MySQL.ConnectionPrefs pref) Creates a new MySQL object for use in working with a database
MySQL(String host, String user, String pass, String database, String port) Creates a new MySQL object for use in working with a database

Method Summary

Modifier and Type	Method and Description
boolean	checkColumn(String tableName, String columnName) Checks if a table has the following column
boolean	checkConnection() Checks to make sure the connection is active to the MySQL server
boolean	checkTable(String tableName) Checks if a table exists within the set database
void	close()
Connection	getConnection() Returns the Connection object for ease of use in exposing more internal API
boolean	isSendingErrorOutput() Determines whether or not to automatically print errors to the console
static Cache<MySQL>	newCache(MySQL.ConnectionPrefs prefs, long keepAliveMS) Returns a new cached MySQL connection, which will automatically renew itself at the specified interval via keepAliveMS, in milliseconds.
Connection	open() Opens a connection to the SQL database.
void	setErrorOutput(boolean errors) Sets whether or not to print errors to the console automatically.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codelanx.commons.data.SQLDataType

batchUpdate, commit, isAutoCommit, operate, prepare, query, query, rollback, setAutoCommit, update

Constructor Detail

MySQL

public MySQL(String host,
             String user,
             String pass,
             String database,
             String port)

Creates a new MySQL object for use in working with a database

Parameters:

host - The hostname to use

user - The username to use

pass - The password to use

database - The database to use

port - The port number to use

Since:

0.1.0

MySQL

public MySQL(MySQL.ConnectionPrefs pref)

Creates a new MySQL object for use in working with a database

Parameters:

pref - A MySQL.ConnectionPrefs for this MySQL object

Since:

0.1.0

Method Detail

open

public Connection open()
                throws SQLException

Opens a connection to the SQL database. Make sure to call SQLDataType.close() or wrap in try-with-resources after you are finished working with the database for your segment of your code.

Returns:

The Connection object

Throws:

SQLException - If the connection fails to open

Since:

0.1.0

checkTable

public boolean checkTable(String tableName)

Checks if a table exists within the set database

Specified by:

checkTable in interface SQLDataType

Parameters:

tableName - Name of the table to check for

Returns:

true if the table exists

Since:

0.1.0

checkColumn

public boolean checkColumn(String tableName,
                           String columnName)

Checks if a table has the following column

Specified by:

checkColumn in interface SQLDataType

Parameters:

tableName - The table to look in

columnName - The column to search for

Returns:

true if the column exists

Since:

0.1.0

close

public void close()

Specified by:

close in interface SQLDataType

Specified by:

close in interface AutoCloseable

Since:

0.1.0

checkConnection

public boolean checkConnection()

Checks to make sure the connection is active to the MySQL server

Returns:

true if connected, false otherwise

Since:

0.1.0

getConnection

public Connection getConnection()

Returns the Connection object for ease of use in exposing more internal API

Specified by:

getConnection in interface SQLDataType

Returns:

The Connection object in use by this SQLDataType

Since:

0.1.0

newCache

public static Cache<MySQL> newCache(MySQL.ConnectionPrefs prefs,
                                    long keepAliveMS)

Returns a new cached MySQL connection, which will automatically renew itself at the specified interval via keepAliveMS, in milliseconds. Keep in mind, due to the way Cache works, until Cache.get() is called a connection may remain open past the specified keep-alive

Parameters:

prefs - The MySQL.ConnectionPrefs relevant to the connection

keepAliveMS - The time in milliseconds to keep a connection open

Returns:

A new self-renewing Cache object with an instance of this

Since:

0.1.0

setErrorOutput

public void setErrorOutput(boolean errors)

Description copied from interface: SQLDataType

Sets whether or not to print errors to the console automatically. This is defaulted to true

Specified by:

setErrorOutput in interface SQLDataType

Parameters:

errors - false to disable error output

isSendingErrorOutput

public boolean isSendingErrorOutput()

Description copied from interface: SQLDataType

Determines whether or not to automatically print errors to the console

Specified by:

isSendingErrorOutput in interface SQLDataType

Returns:

true if content is printed to the console.