org.compiere.db
Interface CompiereDatabase

All Known Implementing Classes:

DB_DB2, DB_Oracle, DB_PostgreSQL, DB_SQLServer

public interface CompiereDatabase

Interface for Compiere Databases

Version:

$Id: CompiereDatabase.java,v 1.5 2006/09/22 23:35:19 jjanke Exp $

Author:

Jorg Janke

Field Summary

static int	CMD_CREATE_DATABASE Create Database/Schema Commands
static int	CMD_CREATE_USER Create User commands
static int	CMD_DROP_DATABASE Drop Database/Schema Commands

Method Summary

void	close() Close
String	convertStatement(String oraStatement) Convert an individual Oracle Style statements to target database statement syntax
String	getAlternativeSQL(int reExNo, String msg, String sql) Check and generate an alternative SQL
Blob	getBlob(Connection connection, byte[] bytes) Get the Database specific Blob data type
Connection	getCachedConnection(CConnection connection, boolean autoCommit, int transactionIsolation) Get new Cached Connection on Server
String	getCatalog() Get JDBC Catalog
Clob	getClob(Connection connection, String clobString) Get the Database specific Clob data type
String[]	getCommands(int cmdType) Get SQL Commands.
String	getConnectionURL(CConnection connection) Get Database Connection String
String	getConnectionURL(String dbHost, int dbPort, String dbName, String userName) Get Connection URL
String	getConnectionURL(String connectionURL, String userName) Get Database Connection String
String	getConstraintType(Connection conn, String tableName, String IXName) Get constraint type associated with the index
DataSource	getDataSource(CConnection connection) Create DataSource
String	getDescription() Get Database Description
Driver	getDriver() Get and register Database Driver
Connection	getDriverConnection(CConnection connection) Get new Connection from Driver
Connection	getDriverConnection(String dbUrl, String dbUid, String dbPwd) Get new Driver Connection
String	getName() Get Database Name
String	getSchema() Get JDBC Schema
int	getStandardPort() Get Standard JDBC Port
String	getStatus() Get Status
String	getSystemDatabase(String databaseName) Get Name of System Database
String	getSystemUser() Get Name of System User
String	getType() Return the Type
boolean	isConnectionValid(Connection conn) Check if a connect is valid
boolean	isSupported(String sql) Check if DBMS support the sql statement or the function
String	nullValue(String sqlClause, int dataType) Get a string representation of literal used in SQL clause
boolean	supportsBLOB() Supports BLOB
String	TO_CHAR(String columnName, int displayType, String AD_Language) Create SQL for formatted Date, Number
String	TO_DATE(Timestamp time, boolean dayOnly) Create SQL TO Date String from Timestamp
String	TO_NUMBER(BigDecimal number, int displayType) Return number as string for INSERT statements with correct precision
String	toString() String Representation
String	updateSetSelectList(String sql) change update set (...) = (select ... from ) standard format

Field Detail

CMD_CREATE_USER

static final int CMD_CREATE_USER

Create User commands

See Also:

Constant Field Values

CMD_CREATE_DATABASE

static final int CMD_CREATE_DATABASE

Create Database/Schema Commands

See Also:

Constant Field Values

CMD_DROP_DATABASE

static final int CMD_DROP_DATABASE

Drop Database/Schema Commands

See Also:

Constant Field Values

Method Detail

isConnectionValid

boolean isConnectionValid(Connection conn)

Check if a connect is valid

Parameters:

conn - Connection

Returns:

true if connection is valid

getType

String getType()

Return the Type

Returns:

database type Environment.DBTYPE_*

getName

String getName()

Get Database Name

Returns:

database short name

getDescription

String getDescription()

Get Database Description

Returns:

database long name and version

getDriver

Driver getDriver()
                 throws SQLException

Get and register Database Driver

Returns:

Driver

Throws:

SQLException

getStandardPort

int getStandardPort()

Get Standard JDBC Port

Returns:

standard port

getConnectionURL

String getConnectionURL(CConnection connection)

Get Database Connection String

Parameters:

connection - Connection Descriptor

Returns:

connection String

getConnectionURL

String getConnectionURL(String dbHost,
                        int dbPort,
                        String dbName,
                        String userName)

Get Connection URL

Parameters:

dbHost - db Host

dbPort - db Port

dbName - db Name

userName - user name

Returns:

url

getConnectionURL

String getConnectionURL(String connectionURL,
                        String userName)

Get Database Connection String

Parameters:

connectionURL - Connection URL

userName - user name

Returns:

connection String

getCatalog

String getCatalog()

Get JDBC Catalog

Returns:

catalog

getSchema

String getSchema()

Get JDBC Schema

Returns:

schema

supportsBLOB

boolean supportsBLOB()

Supports BLOB

Returns:

true if BLOB is supported

toString

String toString()

String Representation

Overrides:

toString in class Object

Returns:

info

convertStatement

String convertStatement(String oraStatement)

Convert an individual Oracle Style statements to target database statement syntax

Parameters:

oraStatement - oracle statement

Returns:

converted Statement

isSupported

boolean isSupported(String sql)

Check if DBMS support the sql statement or the function

Returns:

true: yes

updateSetSelectList

String updateSetSelectList(String sql)

change update set (...) = (select ... from ) standard format

Parameters:

sql - update clause

Returns:

new sql

getConstraintType

String getConstraintType(Connection conn,
                         String tableName,
                         String IXName)

Get constraint type associated with the index

Returns:

String[0] = 0: do not know, 1: Primary Key 2: Foreign Key String[1] - String[n] = Constraint Name

getAlternativeSQL

String getAlternativeSQL(int reExNo,
                         String msg,
                         String sql)

Check and generate an alternative SQL

Returns:

String, the alternative SQL, null if no alternative

getSystemUser

String getSystemUser()

Get Name of System User

Returns:

e.g. sa, system

getSystemDatabase

String getSystemDatabase(String databaseName)

Get Name of System Database

Parameters:

databaseName - database Name

Returns:

e.g. master or database Name

TO_DATE

String TO_DATE(Timestamp time,
               boolean dayOnly)

Create SQL TO Date String from Timestamp

Parameters:

time - Date to be converted

dayOnly - true if time set to 00:00:00

Returns:

date function

TO_CHAR

String TO_CHAR(String columnName,
               int displayType,
               String AD_Language)

Create SQL for formatted Date, Number

Parameters:

columnName - the column name in the SQL

displayType - Display Type

AD_Language - 6 character language setting (from Env.LANG_*)

Returns:

TRIM(TO_CHAR(columnName,'9G999G990D00','NLS_NUMERIC_CHARACTERS='',.''')) or TRIM(TO_CHAR(columnName,'TM9')) depending on DisplayType and Language

See Also:

DisplayType, Env

TO_NUMBER

String TO_NUMBER(BigDecimal number,
                 int displayType)

Return number as string for INSERT statements with correct precision

Parameters:

number - number

displayType - display Type

Returns:

number as string

nullValue

String nullValue(String sqlClause,
                 int dataType)

Get a string representation of literal used in SQL clause

Parameters:

sqlClause - "S", "U","I", "W"

dataType - java.sql.Types

Returns:

db2: nullif(x,x)

getCommands

String[] getCommands(int cmdType)

Get SQL Commands. The following variables are resolved:

Parameters:

cmdType - CMD_*

Returns:

array of commands to be executed

getCachedConnection

Connection getCachedConnection(CConnection connection,
                               boolean autoCommit,
                               int transactionIsolation)
                               throws Exception

Get new Cached Connection on Server

Parameters:

connection - info

autoCommit - true if autocommit connection

transactionIsolation - Connection transaction level

Returns:

connection or null

Throws:

Exception

getDriverConnection

Connection getDriverConnection(CConnection connection)
                               throws SQLException

Get new Connection from Driver

Parameters:

connection - info

Returns:

connection or null

Throws:

SQLException

getDriverConnection

Connection getDriverConnection(String dbUrl,
                               String dbUid,
                               String dbPwd)
                               throws SQLException

Get new Driver Connection

Parameters:

dbUrl - URL

dbUid - user

dbPwd - password

Returns:

connection

Throws:

SQLException

getDataSource

DataSource getDataSource(CConnection connection)

Create DataSource

Parameters:

connection - connection

Returns:

data dource

getStatus

String getStatus()

Get Status

Returns:

status info

close

void close()

Close

getClob

Clob getClob(Connection connection,
             String clobString)

Get the Database specific Clob data type

Parameters:

connection - connection

clobString - clob string

Returns:

Clob

getBlob

Blob getBlob(Connection connection,
             byte[] bytes)

Get the Database specific Blob data type

Parameters:

connection - connection

bytes - bytes

Returns:

Blob