org.waarp.common.database.model

Interface DbModel

All Known Implementing Classes:

DbModelAbstract, DbModelCommonMariadbMySql, DbModelH2, DbModelH2Ftp, DbModelH2Kernel, DbModelH2R66, DbModelMariadb, DbModelMariaDbFtp, DbModelMariaDbKernel, DbModelMariadbR66, DbModelMysql, DbModelMysqlFtp, DbModelMysqlKernel, DbModelMysqlR66, DbModelOracle, DbModelOracleFtp, DbModelOracleKernel, DbModelOracleR66, DbModelPostgresql, DbModelPostgresqlFtp, DbModelPostgresqlKernel, DbModelPostgresqlR66, EmptyDbModel

public interface DbModel

Interface for Database Model

This class is an interface for special functions that needs special implementations according to the database model used.

Method Summary

Modifier and Type	Method and Description
void	createTables(DbSession session) Create all necessary tables into the database
int	currentNumberOfPooledConnections()
Connection	getDbConnection(String server, String user, String passwd)
DbType	getDbType()
DbModelAbstract.DbTypeResolver	getDbTypeResolver()
String	limitRequest(String allfields, String request, int limit) Add a limit on the request to get the "limit" first rows.
boolean	needUpgradeDb(DbSession session, String version, boolean tryFix) Check if Database is ok from version
long	nextSequence(DbSession dbSession)
void	releaseResources() Release any internal resources if needed
void	resetSequence(DbSession session, long newvalue) Reset the sequence (example)
boolean	upgradeDb(DbSession session, String version) Upgrade Database from version
void	validConnection(DbSession dbSession) Validate connection

Method Detail

getDbConnection

Connection getDbConnection(String server,
                           String user,
                           String passwd)
                    throws SQLException

Parameters:

server -

user -

passwd -

Returns:

a connection according to the underlying Database Model

Throws:

SQLException

releaseResources

void releaseResources()

Release any internal resources if needed

currentNumberOfPooledConnections

int currentNumberOfPooledConnections()

Returns:

the number of Pooled Connections if any

getDbType

DbType getDbType()

Returns:

the current DbType used

getDbTypeResolver

DbModelAbstract.DbTypeResolver getDbTypeResolver()

Returns:

the current DbTypeResolver

createTables

void createTables(DbSession session)
           throws WaarpDatabaseNoConnectionException

Create all necessary tables into the database

Parameters:

session - SQL session

Throws:

WaarpDatabaseNoConnectionException

resetSequence

void resetSequence(DbSession session,
                   long newvalue)
            throws WaarpDatabaseNoConnectionException

Reset the sequence (example)

Parameters:

session - SQL session

Throws:

WaarpDatabaseNoConnectionException

nextSequence

long nextSequence(DbSession dbSession)
           throws WaarpDatabaseNoConnectionException,
                  WaarpDatabaseSqlException,
                  WaarpDatabaseNoDataException

Parameters:

dbSession -

Returns:

The next unique specialId

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

WaarpDatabaseNoDataException

validConnection

void validConnection(DbSession dbSession)
              throws WaarpDatabaseNoConnectionException

Validate connection

Parameters:

dbSession -

Throws:

WaarpDatabaseNoConnectionException

limitRequest

String limitRequest(String allfields,
                    String request,
                    int limit)

Add a limit on the request to get the "limit" first rows. Note that it must be compatible to add the "limit" condition.
DO NOT CHANGE (add) ANYTHING to the request

On Oracle: select allfield from (request) where rownnum <= limit
On others: request LIMIT limit

Parameters:

allfields - string representing the equivalent to "*" in "select *" but more precisely as "field1, field2" in "select field1, field2"

request -

limit -

Returns:

the new request String which will limit the result to the specified number of rows

upgradeDb

boolean upgradeDb(DbSession session,
                  String version)
           throws WaarpDatabaseNoConnectionException

Upgrade Database from version

Parameters:

session -

version -

Returns:

True if the Database is upgraded

Throws:

WaarpDatabaseNoConnectionException

needUpgradeDb

boolean needUpgradeDb(DbSession session,
                      String version,
                      boolean tryFix)
               throws WaarpDatabaseNoConnectionException

Check if Database is ok from version

Parameters:

session -

version -

tryFix - True will imply a try to fix if possible

Returns:

True if the Database needs an upgrade

Throws:

WaarpDatabaseNoConnectionException