impex:generatetablelisting

Full name:

org.kuali.maven.plugins:maven-impex-plugin:1.1.8:generatetablelisting

Description:

Examine the directory that SQL files were generated to and produce a file that contains a listing of any tables that contained data at the point in time the export was run.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
artifactId String - The artifactId (aka "schema") for this set of impex data
Default value is: ${project.artifactId}.
baseSqlDir File - The directory where SQL is being generated - targetDatabase is automatically appended to this value
Default value is: ${project.build.directory}/impex/sql.
extension String - The extension for SQL files
Default value is: sql.
forceMojoExecution boolean - Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.
Default value is: false.
metaFileSuffix String - The suffix to append to the end of the file stored in META-INF
Default value is: tables.
targetDatabase String - The database vendor being targeted

Optional Parameters

Name Type Since Description
encoding String - The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on.
Default value is: ${project.build.sourceEncoding}.
skip boolean - When true, skip the execution of this mojo
Default value is: false.
startMavenLogger boolean - When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system
Default value is: true.

Parameter Details

artifactId:

The artifactId (aka "schema") for this set of impex data
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${impex.artifactId}
  • Default: ${project.artifactId}

baseSqlDir:

The directory where SQL is being generated - targetDatabase is automatically appended to this value
  • Type: java.io.File
  • Required: Yes
  • Expression: ${impex.baseSqlDir}
  • Default: ${project.build.directory}/impex/sql

encoding:

The encoding to use when reading/writing files. If not specified this defaults to the platform specific encoding of whatever machine the build is running on.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

extension:

The extension for SQL files
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${impex.extension}
  • Default: sql

forceMojoExecution:

Setting this parameter to true will force the execution of this mojo, even if it would get skipped usually.
  • Type: boolean
  • Required: Yes
  • Expression: ${forceMojoExecution}
  • Default: false

metaFileSuffix:

The suffix to append to the end of the file stored in META-INF
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${impex.metaFileSuffix}
  • Default: tables

skip:

When true, skip the execution of this mojo
  • Type: boolean
  • Required: No
  • Default: false

startMavenLogger:

When true, redirect logging from Log4j and Jakarta Commons Logging to the Maven logging system
  • Type: boolean
  • Required: No
  • Expression: ${startMavenLogger}
  • Default: true

targetDatabase:

The database vendor being targeted
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${impex.targetDatabase}