|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.codehaus.mojo.sql.SqlExecMojo
Executes SQL against a database.
Field Summary | |
static java.lang.String |
ON_ERROR_ABORT
Call setOnError(String) with this value to abort SQL command execution
if an error is found. |
static java.lang.String |
ON_ERROR_CONTINUE
Call setOnError(String) with this value to continue SQL command execution
if an error is found. |
Fields inherited from interface org.apache.maven.plugin.Mojo |
ROLE |
Constructor Summary | |
SqlExecMojo()
|
Method Summary | |
void |
addText(java.lang.String sql)
Set an inline SQL command to execute. |
org.codehaus.mojo.sql.SqlExecMojo.Transaction |
createTransaction()
Add a SQL transaction to execute |
void |
execute()
Load the sql file and then execute it |
java.lang.String |
getDriver()
|
java.lang.String |
getOnError()
|
java.lang.String |
getPassword()
|
java.io.File[] |
getSrcFiles()
|
int |
getSuccessfulStatements()
Number of SQL statements executed so far that caused errors. |
int |
getTotalStatements()
Number of SQL statements executed so far, including the ones that caused errors. |
java.lang.String |
getUrl()
|
java.lang.String |
getUsername()
|
void |
setAppend(boolean append)
whether output should be appended to or overwrite an existing file. |
void |
setDelimiter(java.lang.String delimiter)
Set the delimiter that separates SQL statements. |
void |
setDelimiterType(DelimiterType delimiterType)
Set the delimiter type: "normal" or "row" (default "normal"). |
void |
setDriver(java.lang.String driver)
|
void |
setEncoding(java.lang.String encoding)
Set the file encoding to use on the SQL files read in |
void |
setEscapeProcessing(boolean enable)
Set escape processing for statements. |
void |
setKeepformat(boolean keepformat)
whether or not format should be preserved. |
void |
setOnError(java.lang.String action)
|
void |
setOutput(java.io.File output)
Set the output file; |
void |
setPassword(java.lang.String password)
|
void |
setPrint(boolean print)
Print result sets from the statements; optional, default false |
void |
setShowheaders(boolean showheaders)
Print headers for result sets from the statements; optional, default true. |
void |
setSrcFiles(java.io.File[] files)
|
void |
setUrl(java.lang.String url)
|
void |
setUsername(java.lang.String username)
|
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ON_ERROR_ABORT
setOnError(String)
with this value to abort SQL command execution
if an error is found.
public static final java.lang.String ON_ERROR_CONTINUE
setOnError(String)
with this value to continue SQL command execution
if an error is found.
Constructor Detail |
public SqlExecMojo()
Method Detail |
public org.codehaus.mojo.sql.SqlExecMojo.Transaction createTransaction()
public void addText(java.lang.String sql)
public void setEncoding(java.lang.String encoding)
encoding
- the encoding to use on the filespublic void setDelimiter(java.lang.String delimiter)
For example, set this to "go" and delimitertype to "ROW" for Sybase ASE or MS SQL Server.
public void setDelimiterType(DelimiterType delimiterType)
The delimiter type takes two values - normal and row. Normal means that any occurrence 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.
public void setPrint(boolean print)
public void setShowheaders(boolean showheaders)
public void setOutput(java.io.File output)
public void setAppend(boolean append)
public void setKeepformat(boolean keepformat)
keepformat
- The keepformat to setpublic void setEscapeProcessing(boolean enable)
public void execute() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
public java.lang.String getUsername()
public void setUsername(java.lang.String username)
public java.lang.String getPassword()
public void setPassword(java.lang.String password)
public java.lang.String getUrl()
public void setUrl(java.lang.String url)
public java.lang.String getDriver()
public void setDriver(java.lang.String driver)
public java.io.File[] getSrcFiles()
public void setSrcFiles(java.io.File[] files)
public int getSuccessfulStatements()
public int getTotalStatements()
public java.lang.String getOnError()
public void setOnError(java.lang.String action)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |