org.ametys.core.datasource.dbtype

Interface SQLDatabaseType

All Known Implementing Classes:

DerbySQLDatabaseType, StaticSQLDatabaseType

public interface SQLDatabaseType

Interface for the SQL database types

Method Summary

Modifier and Type	Method and Description
String	getDriver() Get the driver of the database type.
I18nizableText	getDriverNotFoundMessage() Get the error message key when the specified driver was not found
String	getId() Get the id of the database type.
I18nizableText	getLabel() Get the label of the database type.
String	getTemplate() Get the url template to use for this database type
String	getValidationQuery() Get the query to validate a connection
String	languageEscapeTableName(String tableNameToEscape) Some db systems requires the table names to be escaped
String	languageLimitQuery(String queryToLimit, String limit, String offset) Add a limit/offset element to the given query

Method Detail

getId

String getId()

Get the id of the database type.

Returns:

the id. Can not be null.

getLabel

I18nizableText getLabel()

Get the label of the database type.

Returns:

the label

getDriver

String getDriver()

Get the driver of the database type.

Returns:

the driver. Can not be null.

getValidationQuery

String getValidationQuery()

Get the query to validate a connection

Returns:

A SQL query to ensure that a connection is still alive

getTemplate

String getTemplate()

Get the url template to use for this database type

Returns:

the url template

getDriverNotFoundMessage

I18nizableText getDriverNotFoundMessage()

Get the error message key when the specified driver was not found

Returns:

the error message

languageEscapeTableName

String languageEscapeTableName(String tableNameToEscape)

Some db systems requires the table names to be escaped

Parameters:

tableNameToEscape - The non-null table name

Returns:

The escaped table name or at least the table name if no escape is required

languageLimitQuery

String languageLimitQuery(String queryToLimit,
                          String limit,
                          String offset)

Add a limit/offset element to the given query

Parameters:

queryToLimit - The sql query that will be amended

limit - The max number of the results to return

offset - The initial offset of the results to return

Returns:

The initial query amended to handle the limit and offset.