org.apache.torque.task
Class TorqueSQLExec

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.torque.task.TorqueSQLExec

All Implemented Interfaces:

java.lang.Cloneable

public class TorqueSQLExec
extends org.apache.tools.ant.Task

This task uses an SQL -> Database map in the form of a properties file to insert each SQL file listed into its designated database.

Version:

$Id: TorqueSQLExec.java 473814 2006-11-11 22:30:30Z tv $

Author:

Jeff Martin, Michael McCallum, Tim Stephenson, Jason van Zyl, Martin Poeschl

Nested Class Summary

static class	TorqueSQLExec.DelimiterType
static class	TorqueSQLExec.OnError Enumerated attribute with the values "continue", "stop" and "abort" for the onerror attribute.
class	TorqueSQLExec.Transaction Contains the definition of a new transaction element.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

TorqueSQLExec()

Method Summary

void	addText(java.lang.String sql) Deprecated. This method has no effect and will be removed in a future version.
org.apache.tools.ant.types.Path	createClasspath() Create the classpath for loading the driver.
protected void	execSQL(java.lang.String sql, java.io.PrintStream out) Exec the sql statement.
void	execute() Load the sql file and then execute it
java.io.File	getSqlDbMap() Get the sqldbmap properties file.
java.lang.String	getSrcDir() Get the src directory for the sql files listed in the sqldbmap file.
protected boolean	isValidRdbms(java.sql.Connection conn) Verify if connected to the correct RDBMS
protected void	printResults(java.io.PrintStream out) print any results in the statement.
protected void	runStatements(java.io.Reader reader, java.io.PrintStream out) Read the statements from the .sql file and execute them.
void	setAutocommit(boolean autocommit) Set the autocommit flag for the DB connection.
void	setClasspath(org.apache.tools.ant.types.Path classpath) Set the classpath for loading the driver.
void	setClasspathRef(org.apache.tools.ant.types.Reference r) Set the classpath for loading the driver using the classpath reference.
void	setDelimiter(java.lang.String delimiter) Set the statement delimiter.
void	setDelimiterType(TorqueSQLExec.DelimiterType delimiterType) Set the Delimiter type for this sql task.
void	setDriver(java.lang.String driver) Set the JDBC driver to be used.
void	setEncoding(java.lang.String encoding) Set the file encoding to use on the sql files read in
void	setOnerror(TorqueSQLExec.OnError action) Set the action to perform onerror
void	setOutput(java.io.File output) Set the output file.
void	setPassword(java.lang.String password) Set the password for the DB connection.
void	setPrint(boolean print) Set the print flag.
void	setRdbms(java.lang.String vendor) Set the rdbms required
void	setShowheaders(boolean showheaders) Set the showheaders flag.
void	setSqlDbMap(java.lang.String sqldbmap) Set the sqldbmap properties file.
void	setSrcDir(java.lang.String srcDir) Set the src directory for the sql files listed in the sqldbmap file.
void	setUrl(java.lang.String url) Set the DB connection url.
void	setUserid(java.lang.String userId) Set the user name for the DB connection.
void	setVersion(java.lang.String version) Set the version required

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

TorqueSQLExec

public TorqueSQLExec()

Method Detail

setSqlDbMap

public void setSqlDbMap(java.lang.String sqldbmap)

Set the sqldbmap properties file.

Parameters:

sqldbmap - filename for the sqldbmap

getSqlDbMap

public java.io.File getSqlDbMap()

Get the sqldbmap properties file.

Returns:

filename for the sqldbmap

setSrcDir

public void setSrcDir(java.lang.String srcDir)

Set the src directory for the sql files listed in the sqldbmap file.

Parameters:

srcDir - sql source directory

getSrcDir

public java.lang.String getSrcDir()

Get the src directory for the sql files listed in the sqldbmap file.

Returns:

sql source directory

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)

Set the classpath for loading the driver.

Parameters:

classpath - the classpath

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

Create the classpath for loading the driver.

Returns:

the classpath

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)

Set the classpath for loading the driver using the classpath reference.

Parameters:

r - reference to the classpath

addText

public void addText(java.lang.String sql)

Deprecated. This method has no effect and will be removed in a future version.

Set the sql command to execute

Parameters:

sql - sql command to execute

setDriver

public void setDriver(java.lang.String driver)

Set the JDBC driver to be used.

Parameters:

driver - driver class name

setUrl

public void setUrl(java.lang.String url)

Set the DB connection url.

Parameters:

url - connection url

setUserid

public void setUserid(java.lang.String userId)

Set the user name for the DB connection.

Parameters:

userId - database user

setEncoding

public void setEncoding(java.lang.String encoding)

Set the file encoding to use on the sql files read in

Parameters:

encoding - the encoding to use on the files

setPassword

public void setPassword(java.lang.String password)

Set the password for the DB connection.

Parameters:

password - database password

setAutocommit

public void setAutocommit(boolean autocommit)

Set the autocommit flag for the DB connection.

Parameters:

autocommit - the autocommit flag

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Set the statement delimiter.

For example, set this to "go" and delimitertype to "ROW" for Sybase ASE or MS SQL Server.

Parameters:

delimiter -

setDelimiterType

public void setDelimiterType(TorqueSQLExec.DelimiterType delimiterType)

Set the Delimiter type for this sql task. The delimiter type takes two values - normal and row. Normal means that any occurence of the delimiter terminate the SQL command whereas with row, only a line containing just the delimiter is recognized as the end of the command.

Parameters:

delimiterType -

setPrint

public void setPrint(boolean print)

Set the print flag.

Parameters:

print -

setShowheaders

public void setShowheaders(boolean showheaders)

Set the showheaders flag.

Parameters:

showheaders -

setOutput

public void setOutput(java.io.File output)

Set the output file.

Parameters:

output -

setRdbms

public void setRdbms(java.lang.String vendor)

Set the rdbms required

Parameters:

vendor -

setVersion

public void setVersion(java.lang.String version)

Set the version required

Parameters:

version -

setOnerror

public void setOnerror(TorqueSQLExec.OnError action)

Set the action to perform onerror

Parameters:

action -

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Load the sql file and then execute it

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

runStatements

protected void runStatements(java.io.Reader reader,
                             java.io.PrintStream out)
                      throws java.sql.SQLException,
                             java.io.IOException

Read the statements from the .sql file and execute them. Lines starting with '//', '--' or 'REM ' are ignored.

Parameters:

reader -

out -

Throws:

java.sql.SQLException

java.io.IOException

isValidRdbms

protected boolean isValidRdbms(java.sql.Connection conn)

Verify if connected to the correct RDBMS

Parameters:

conn -

execSQL

protected void execSQL(java.lang.String sql,
                       java.io.PrintStream out)
                throws java.sql.SQLException

Exec the sql statement.

Parameters:

sql -

out -

Throws:

java.sql.SQLException

printResults

protected void printResults(java.io.PrintStream out)
                     throws java.sql.SQLException

print any results in the statement.

Parameters:

out -

Throws:

java.sql.SQLException