|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.torque.task.TorqueSQLExec
This task uses an SQL -> Database map in the form of a properties file to insert each SQL file listed into its designated database.
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 | |
private boolean |
autocommit
Autocommit flag. |
private org.apache.tools.ant.types.Path |
classpath
|
private java.sql.Connection |
conn
Database connection |
private java.lang.String |
delimiter
SQL Statement delimiter |
private java.lang.String |
delimiterType
The delimiter type indicating whether the delimiter will only be recognized on a line by itself |
private java.lang.String |
driver
DB driver. |
private java.lang.String |
encoding
Encoding to use when reading SQL statements from a file |
private int |
goodSql
|
private org.apache.tools.ant.AntClassLoader |
loader
|
private java.lang.String |
onError
Action to perform if an error is found |
private java.io.File |
output
Results Output file. |
private java.lang.String |
password
Password |
private boolean |
print
Print SQL results. |
private java.lang.String |
rdbms
RDBMS Product needed for this SQL. |
private boolean |
showheaders
Print header columns. |
private java.lang.String |
sqlCommand
SQL input command |
private java.io.File |
sqldbmap
Properties file that maps an individual SQL file to a database. |
private java.lang.String |
srcDir
Src directory for the files listed in the sqldbmap. |
private java.sql.Statement |
statement
SQL statement |
private int |
totalSql
|
private java.lang.String |
url
DB url. |
private java.lang.String |
userId
User name. |
private java.lang.String |
version
RDBMS Version needed for this SQL. |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
TorqueSQLExec()
|
Method Summary | |
void |
addText(java.lang.String sql)
Set the sql command to execute |
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. |
private void |
insertDatabaseSqlFiles(java.lang.String url,
java.lang.String database,
java.util.List transactions)
Take the base url, the target database and insert a set of SQL files into the target database. |
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 |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private int goodSql
private int totalSql
private org.apache.tools.ant.types.Path classpath
private org.apache.tools.ant.AntClassLoader loader
private java.sql.Connection conn
private boolean autocommit
private java.sql.Statement statement
private java.lang.String driver
private java.lang.String url
private java.lang.String userId
private java.lang.String password
private java.lang.String sqlCommand
private java.lang.String delimiter
private java.lang.String delimiterType
private boolean print
private boolean showheaders
private java.io.File output
private java.lang.String rdbms
private java.lang.String version
private java.lang.String onError
private java.lang.String encoding
private java.lang.String srcDir
private java.io.File sqldbmap
Constructor Detail |
public TorqueSQLExec()
Method Detail |
public void setSqlDbMap(java.lang.String sqldbmap)
sqldbmap
- filename for the sqldbmappublic java.io.File getSqlDbMap()
public void setSrcDir(java.lang.String srcDir)
srcDir
- sql source directorypublic java.lang.String getSrcDir()
public void setClasspath(org.apache.tools.ant.types.Path classpath)
classpath
- the classpathpublic org.apache.tools.ant.types.Path createClasspath()
public void setClasspathRef(org.apache.tools.ant.types.Reference r)
r
- reference to the classpathpublic void addText(java.lang.String sql)
sql
- sql command to executepublic void setDriver(java.lang.String driver)
driver
- driver class namepublic void setUrl(java.lang.String url)
url
- connection urlpublic void setUserid(java.lang.String userId)
userId
- database userpublic void setEncoding(java.lang.String encoding)
encoding
- the encoding to use on the filespublic void setPassword(java.lang.String password)
password
- database passwordpublic void setAutocommit(boolean autocommit)
autocommit
- the autocommit flagpublic void setDelimiter(java.lang.String delimiter)
For example, set this to "go" and delimitertype to "ROW" for Sybase ASE or MS SQL Server.
delimiter
- public void setDelimiterType(TorqueSQLExec.DelimiterType delimiterType)
delimiterType
- public void setPrint(boolean print)
print
- public void setShowheaders(boolean showheaders)
showheaders
- public void setOutput(java.io.File output)
output
- public void setRdbms(java.lang.String vendor)
vendor
- public void setVersion(java.lang.String version)
version
- public void setOnerror(TorqueSQLExec.OnError action)
action
- public void execute() throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
private void insertDatabaseSqlFiles(java.lang.String url, java.lang.String database, java.util.List transactions)
url
- database
- transactions
- protected void runStatements(java.io.Reader reader, java.io.PrintStream out) throws java.sql.SQLException, java.io.IOException
reader
- out
-
java.sql.SQLException
java.io.IOException
protected boolean isValidRdbms(java.sql.Connection conn)
conn
- protected void execSQL(java.lang.String sql, java.io.PrintStream out) throws java.sql.SQLException
sql
- out
-
java.sql.SQLException
protected void printResults(java.io.PrintStream out) throws java.sql.SQLException
out
-
java.sql.SQLException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |