com.codelanx.codelanxlib.data

Interface SQLDataType

All Superinterfaces:

AutoCloseable, DataType

All Known Implementing Classes:

MySQL, SQLite

public interface SQLDataType
extends DataType, AutoCloseable

Represents an object that connects to an SQL database and allows operations to be made upon it

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
boolean	checkTable(String tablename) Checks if a table exists within the set database
default void	close()
default void	commit() Pushes any queued transactions to the database
Connection	getConnection() Returns the Connection object for ease of use in exposing more internal API
default boolean	isAutoCommit() Returns whether or not this connection automatically commits changes to the database.
default PreparedStatement	prepare(String stmt) Returns a PreparedStatement in which you can easily protect against SQL injection attacks.
default ResultSet	query(String query) Executes a query, but does not update any information
default void	rollback() Cancel any queued transactions
default void	setAutoCommit(boolean set) Sets whether or not to automatically commit changes to the database.
default int	update(String query) Executes a query that can change values

Method Detail

checkTable

boolean checkTable(String tablename)
            throws SQLException

Checks if a table exists within the set database

Parameters:

tablename - Name of the table to check for

Returns:

true if exists, false otherwise

Throws:

SQLException - The query on the database fails

Since:

0.1.0

query

default ResultSet query(String query)
                 throws SQLException

Executes a query, but does not update any information

Parameters:

query - The string query to execute

Returns:

A ResultSet from the query

Throws:

SQLException - The connection cannot be established

Since:

0.1.0

update

default int update(String query)
            throws SQLException

Executes a query that can change values

Parameters:

query - The string query to execute

Returns:

0 for no returned results, or the number of returned rows

Throws:

SQLException - The connection cannot be established

Since:

0.1.0

prepare

default PreparedStatement prepare(String stmt)
                           throws SQLException

Returns a PreparedStatement in which you can easily protect against SQL injection attacks.

Parameters:

stmt - The string to prepare

Returns:

A PreparedStatement from the passed string

Throws:

SQLException - The connection cannot be established

Since:

0.1.0

isAutoCommit

default boolean isAutoCommit()
                      throws SQLException

Returns whether or not this connection automatically commits changes to the database.

Returns:

the current state of this connection's auto-commit mode

Throws:

SQLException - database access error or closed connection

Since:

0.1.0

setAutoCommit

default void setAutoCommit(boolean set)
                    throws SQLException

Sets whether or not to automatically commit changes to the database. If disabled, transactions will be grouped and not executed except from a manual call to commit() or rollback().

Parameters:

set - true to enable, false to disable

Throws:

SQLException - The connection cannot be established, or an access error occurred

Since:

0.1.0

commit

default void commit()
             throws SQLException

Pushes any queued transactions to the database

Throws:

SQLException - The connection cannot be established, an access error occurred, or auto-commit is enabled

Since:

0.1.0

rollback

default void rollback()
               throws SQLException

Cancel any queued transactions

Throws:

SQLException - The connection cannot be established, an access error occurred, or auto-commit is enabled

Since:

0.1.0

getConnection

Connection getConnection()

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

Returns:

The Connection object in use by this SQLDataType

Since:

0.1.0

close

default void close()

Specified by:

close in interface AutoCloseable