ch.brickwork.bsetl.db

Class Db

java.lang.Object

ch.brickwork.bsetl.db.Db

Direct Known Subclasses:

H2Db, MSSQLDb, PostgresDB

public class Db
extends Object

A connection to a database

Constructor Summary

Constructors

Constructor and Description
Db() open connection to default, can be used for testing purposes and opens a H2 file DB connection to file default.h2
Db(String url, String driver, String user, String password, File executeQueryDumpFile, int maxStatementsPerTransaction) open connection to any database.

Method Summary

Modifier and Type	Method and Description
void	addPreprocessor(Preprocessor preprocessor) add preprocessor which will be applied to any row being inserted on this connection
void	appendToFile(String text) append to file only
protected String	beginTransactionStatement()
void	cleanDuplicates(String tableName, String uniqueKeyPropertyName)
void	closeConnection()
protected String	commitStatement()
void	copyTableFrom(String tableName, Db sourceDb)
void	copyView(String viewName, Db sourceDb)
boolean	createOrReplaceTable(TableStructure tableStructure)
boolean	createView(ViewStructure viewStructure)
protected void	dropTableIfExists(String tableName)
protected void	dropViewIfExists(String viewName)
protected void	dumpQuery(String query)
protected String	encode(String value) e.g.
protected String	escapedQuoteLiteral() the escaped literal for the apostrophe used within a string; something like "''" or "\'"
boolean	execute(String query) run a SQL query without a result
protected boolean	executeQuery(String query)
TableStructure	getTableStructure(String tableName) if used with connection-less dbs, returns first ever created definition of table, otherwise current defintion of table
ViewStructure	getViewStructure(String viewName)
void	insert(List<Map<String,Object>> rowsToInsert, String targetTableName) insert a result into table "targetTableName" on this connection.
void	insert(Result rowsToInsert, String targetTableName) insert a result into table "targetTableName" on this connection.
protected boolean	isCharacterLike(String dataType) for a dataType, returns true if this is a "String-like" type, typically a VARCHAR.
protected String	mapDataType(String originalDataType) when copying a table to this connection, the original data type (copied from an other connection with maybe a different DB system) can be mapped to an other datatype.
protected Object	mapValue(Object o) maps value if necessary; e.g.
Result	query(String query) run a SQL query where you know it generates a result set
static String	quote(Object unquoted) simply quote a String-like object, e.g.
protected String	quoteIdentifierIfNecessary(String unquotedTableName) if some circumstances, table and column names themselves have to be quoted, e.g.
protected String	quoteIfNecessary(Object o) makes an acceptable literal out of object o.
void	switchExecuteQueryFile(File newFile)
protected String	tableStructureEntry(ch.brickwork.bsetl.db.PropertyStructure propertyStructure) generates a "line" entry in a CREATE TABLE statement
String	toSQLSet(Set setOfValues) turns a set of objects into a set of the form
String	wherePropertyIn(String propertyName, Set set) for a list of elements, returns a clause like
String	wrap(Object value) based on type of object, maps, quotes and encodes properly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Db

public Db()
   throws SQLException,
          ClassNotFoundException,
          IOException

open connection to default, can be used for testing purposes and opens a H2 file DB connection to file default.h2

Throws:

SQLException

ClassNotFoundException

IOException

Db

public Db(String url,
          String driver,
          String user,
          String password,
          File executeQueryDumpFile,
          int maxStatementsPerTransaction)
   throws ClassNotFoundException,
          SQLException,
          IOException

open connection to any database. driver must be present on classpath

Parameters:

url - if null, creates connection-less db (makes sense only in combination with executeQueryDumpFile

driver -

user -

password -

maxStatementsPerTransaction - if > 0, all statements will be wrapped in BEGIN TRANSACTION..COMMIT; blocks

executeQueryDumpFile - file to dump execute query statements (e.g. inserts), or null

Throws:

ClassNotFoundException

SQLException

IOException

Method Detail

appendToFile

public void appendToFile(String text)
                  throws IOException

append to file only

Parameters:

text -

Throws:

IOException

addPreprocessor

public void addPreprocessor(Preprocessor preprocessor)

add preprocessor which will be applied to any row being inserted on this connection

Parameters:

preprocessor -

query

public Result query(String query)
             throws SQLException

run a SQL query where you know it generates a result set

Parameters:

query -

Returns:

Throws:

SQLException

execute

public boolean execute(String query)
                throws SQLException,
                       IOException

run a SQL query without a result

Parameters:

query -

Returns:

Throws:

SQLException

IOException

executeQuery

protected boolean executeQuery(String query)
                        throws SQLException

Throws:

SQLException

dumpQuery

protected void dumpQuery(String query)
                  throws IOException

Throws:

IOException

closeConnection

public void closeConnection()
                     throws SQLException,
                            IOException

Throws:

SQLException

IOException

switchExecuteQueryFile

public void switchExecuteQueryFile(File newFile)
                            throws IOException

Throws:

IOException

insert

public void insert(Result rowsToInsert,
                   String targetTableName)
            throws SQLException,
                   IOException,
                   OperationNotAllowedException

insert a result into table "targetTableName" on this connection. rows will be preprocessed (if preprocessors available). rows will be truncated in too long for target structure.

Parameters:

rowsToInsert -

targetTableName -

Throws:

SQLException

IOException

OperationNotAllowedException

insert

public void insert(List<Map<String,Object>> rowsToInsert,
                   String targetTableName)
            throws SQLException,
                   IOException,
                   OperationNotAllowedException

insert a result into table "targetTableName" on this connection. rows will be preprocessed (if preprocessors available). rows will be truncated in too long for target structure.

Parameters:

rowsToInsert -

targetTableName -

Throws:

SQLException

IOException

OperationNotAllowedException

copyTableFrom

public void copyTableFrom(String tableName,
                          Db sourceDb)
                   throws SQLException,
                          IOException,
                          OperationNotAllowedException

Throws:

SQLException

IOException

OperationNotAllowedException

copyView

public void copyView(String viewName,
                     Db sourceDb)
              throws SQLException,
                     IOException,
                     OperationNotAllowedException

Throws:

SQLException

IOException

OperationNotAllowedException

beginTransactionStatement

protected String beginTransactionStatement()

commitStatement

protected String commitStatement()

toSQLSet

public String toSQLSet(Set setOfValues)

turns a set of objects into a set of the form

(o1, o2, ...)

suitable for usage within a WHERE clause. Respects format based on type of object. E.g. strings will deliver ('abc', 'def'), numbers will deliver (1,2,3)

Parameters:

setOfValues -

Returns:

SQL set, or "()" if no elements available

wherePropertyIn

public String wherePropertyIn(String propertyName,
                              Set set)

for a list of elements, returns a clause like

   WHERE ([propertyName] IN (.,.,.) OR [propertyName] IN (.,.,.) OR ...)
 

clause is partitioned to keep individual sets small. Max. size of a parition is 100

Parameters:

propertyName -

set -

Returns:

where clause with partitioned sql sets

quote

public static String quote(Object unquoted)

simply quote a String-like object, e.g. from "a" make "'a'"

Parameters:

unquoted -

Returns:

getTableStructure

public TableStructure getTableStructure(String tableName)
                                 throws SQLException,
                                        OperationNotAllowedException

if used with connection-less dbs, returns first ever created definition of table, otherwise current defintion of table

Parameters:

tableName -

Returns:

Throws:

SQLException

OperationNotAllowedException

createOrReplaceTable

public boolean createOrReplaceTable(TableStructure tableStructure)
                             throws SQLException,
                                    IOException,
                                    OperationNotAllowedException

Throws:

SQLException

IOException

OperationNotAllowedException

cleanDuplicates

public void cleanDuplicates(String tableName,
                            String uniqueKeyPropertyName)
                     throws SQLException,
                            IOException

Throws:

SQLException

IOException

dropTableIfExists

protected void dropTableIfExists(String tableName)
                          throws SQLException,
                                 IOException,
                                 OperationNotAllowedException

Throws:

SQLException

IOException

OperationNotAllowedException

getViewStructure

public ViewStructure getViewStructure(String viewName)
                               throws SQLException

Throws:

SQLException

createView

public boolean createView(ViewStructure viewStructure)
                   throws SQLException,
                          IOException,
                          OperationNotAllowedException

Throws:

SQLException

IOException

OperationNotAllowedException

dropViewIfExists

protected void dropViewIfExists(String viewName)
                         throws SQLException,
                                IOException,
                                OperationNotAllowedException

Throws:

SQLException

IOException

OperationNotAllowedException

isCharacterLike

protected boolean isCharacterLike(String dataType)

for a dataType, returns true if this is a "String-like" type, typically a VARCHAR. Used to determine whether a column must be truncated. if so, must have a length property in the information table (cf. getSourceColumnNameStatement)

Parameters:

dataType -

Returns:

wrap

public String wrap(Object value)

based on type of object, maps, quotes and encodes properly. Check mapValue, quoteIfNecessary, encode for further information

Parameters:

value -

Returns:

encode

protected String encode(String value)

e.g. in H2, STRINGENCODE('abc\ndef') will convert the String such that steering characters are interpreted correctly; default: no encoding

Parameters:

value -

Returns:

quoteIfNecessary

protected String quoteIfNecessary(Object o)

makes an acceptable literal out of object o. If o is null, returns "null" as a string; if non-null character-like, e.g. string, will quote it

Parameters:

o -

Returns:

literal representation of object o acceptable in a SQL statement on this connection

mapValue

protected Object mapValue(Object o)

maps value if necessary; e.g. time like values can be converted to strings; binary values can be mapped to hex strings prefixed by some 0x or whatever the DB likes to hear in this case

Parameters:

o -

Returns:

escapedQuoteLiteral

protected String escapedQuoteLiteral()

the escaped literal for the apostrophe used within a string; something like "''" or "\'"

Returns:

quoteIdentifierIfNecessary

protected String quoteIdentifierIfNecessary(String unquotedTableName)

if some circumstances, table and column names themselves have to be quoted, e.g. to deal with upper/lower case problems, this is done here

Parameters:

unquotedTableName -

Returns:

e.g. makes "\"MYTABLE\"" from "MYTABLE"

mapDataType

protected String mapDataType(String originalDataType)

when copying a table to this connection, the original data type (copied from an other connection with maybe a different DB system) can be mapped to an other datatype. E.g., you would transform a BOOLEAN from Postgres to a bit on MS-SQL

Parameters:

originalDataType -

Returns:

mapped type

tableStructureEntry

protected String tableStructureEntry(ch.brickwork.bsetl.db.PropertyStructure propertyStructure)

generates a "line" entry in a CREATE TABLE statement

Parameters:

propertyStructure -

Returns: