SQLDataType (CodelanxLib 0.2.0-SNAPSHOT API)

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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <T> void`	`batchUpdate(String query, int batchSize, Collection<T> params, Function<T,?>... paramMappers)` Executes a batch update on a database, and maps passed parameters based upon 0-indexed `paramMappers` for each parameter.
`boolean`	`checkColumn(String tableName, String columnName)` Checks if a table has the following column
`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.
`boolean`	`isSendingErrorOutput()` Determines whether or not to automatically print errors to the console
`default <R> SQLResponse<R>`	`operate(SQLFunction<? super PreparedStatement,R> oper, String sql, Object... params)` Runs a `PreparedStatement` using the provided `sql` parameter.
`default PreparedStatement`	`prepare(String stmt)` Returns a `PreparedStatement` in which you can easily protect against SQL injection attacks.
`default SQLResponse`	`query(SQLConsumer<? super ResultSet> oper, String sql, Object... params)` Executes a query, and applies the resulting `ResultSet` to the passed `SQLConsumer`
`default <R> SQLResponse<R>`	`query(SQLFunction<? super ResultSet,R> oper, String sql, Object... params)` Executes a query, and applies the resulting `ResultSet` to the passed `SQLFunction`.
`default void`	`rollback()` Cancel any queued transactions
`default void`	`setAutoCommit(boolean set)` Sets whether or not to automatically commit changes to the database.
`void`	`setErrorOutput(boolean errors)` Sets whether or not to print errors to the console automatically.
`default SQLResponse`	`update(String query, Object... params)` Executes a query that can change values

- Method Detail
  - checkTable
```
boolean checkTable(String tableName)
```
    Checks if a table exists within the set database
    
    Parameters:
    
    tableName - Name of the table to check for
    
    Returns:
    
    true if the table exists
    
    Since:
    
    0.1.0
  - checkColumn
```
boolean checkColumn(String tableName,
                    String columnName)
```
    Checks if a table has the following column
    
    Parameters:
    
    tableName - The table to look in
    
    columnName - The column to search for
    
    Returns:
    
    true if the column exists
    
    Since:
    
    0.1.0
  - query
```
default <R> SQLResponse<R> query(SQLFunction<? super ResultSet,R> oper,
                                 String sql,
                                 Object... params)
```
    Executes a query, and applies the resulting ResultSet to the passed SQLFunction. This method will return anything returned from the lambda body
    
    Type Parameters:
    
    R - The return type from the lambda body
    
    Parameters:
    
    oper - The operation to apply to the ResultSet
    
    sql - The SQL statement to execute
    
    params - Any PreparedStatement parameters
    
    Returns:
    
    The return value of the lambda
    
    Since:
    
    0.1.0
  - query
```
default SQLResponse query(SQLConsumer<? super ResultSet> oper,
                          String sql,
                          Object... params)
```
    Executes a query, and applies the resulting ResultSet to the passed SQLConsumer
    
    Parameters:
    
    oper - The operation to apply to the ResultSet
    
    sql - The SQL statement to execute
    
    params - Any PreparedStatement parameters
    
    Returns:
    
    An SQLResponse containing any required information
    
    Since:
    
    0.1.0
  - update
```
default SQLResponse update(String query,
                           Object... params)
```
    Executes a query that can change values
    
    Parameters:
    
    query - The string query to execute
    
    params - Any PreparedStatement parameters
    
    Returns:
    
    0 for no returned results, or the number of returned rows
    
    Since:
    
    0.1.0
  - batchUpdate
```
default <T> void batchUpdate(String query,
                             int batchSize,
                             Collection<T> params,
                             Function<T,?>... paramMappers)
```
    Executes a batch update on a database, and maps passed parameters based upon 0-indexed paramMappers for each parameter. An example of a usage would be:
    
    //A collection of objects to apply to each batch Collection<SomeObject> yourCollection; SQLDataType#batchUpdate("<SQL Query>", 500, yourCollection, (s) -> s.getName(), (s) -> s.getID(), (s) -> s.getLastName()); );
    
    In the above example, the PreparedStatement parameters would map each object so that "Parameter 1" would be the result of SomeObject#getName, and parameter 2 would be the result of SomeObject#getID, and so on
    
    Type Parameters:
    
    T - The type of the objects being batch committed
    
    Parameters:
    
    query - The SQL query to execute
    
    batchSize - The size of each batch
    
    params - The objects to use in each batch
    
    paramMappers - A series of functions for mapping objects to params
    
    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)
```
    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
    
    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
  - operate
```
default <R> SQLResponse<R> operate(SQLFunction<? super PreparedStatement,R> oper,
                                   String sql,
                                   Object... params)
```
    Runs a PreparedStatement using the provided sql parameter. The following SQLFunction will then be run using this constructed statement. This is typically more-so for use in one-time executed statements
    
    Type Parameters:
    
    R - The type of the return value
    
    Parameters:
    
    oper - The SQLFunction operation to use
    
    sql - The SQL statement to execute
    
    params - Parameters to pass to the PreparedStatement
    
    Returns:
    
    The returned result of the SQLFunction
    
    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
    
    Since:
    
    0.1.0
  - setErrorOutput
```
void setErrorOutput(boolean errors)
```
    Sets whether or not to print errors to the console automatically. This is defaulted to true
    
    Parameters:
    
    errors - false to disable error output
    
    Since:
    
    0.1.0
  - isSendingErrorOutput
```
boolean isSendingErrorOutput()
```
    Determines whether or not to automatically print errors to the console
    
    Returns:
    
    true if content is printed to the console.
    
    Since:
    
    0.1.0

Interface SQLDataType

Method Summary

Method Detail

checkTable

checkColumn

query

query

update

batchUpdate

prepare

isAutoCommit

setAutoCommit

commit

rollback

operate

getConnection

close

setErrorOutput

isSendingErrorOutput