Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractSqlMojo - Class in org.tentackle.maven.plugin.sql
-
Base tentackle sql mojo.
- AbstractSqlMojo() - Constructor for class org.tentackle.maven.plugin.sql.AbstractSqlMojo
B
- BackendInfoParameter - Class in org.tentackle.maven.plugin.sql
-
Maven parameter to create a
BackendInfo. - BackendInfoParameter() - Constructor for class org.tentackle.maven.plugin.sql.BackendInfoParameter
- backendInfos - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
The backends to create SQL code for.
- backendNames - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Comma-separated list of backend names.
The following special names are recognized: all: all non-deprecated backends none: does not match any backend deprecated: all deprecated backends - backendProperties - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
The backend property files.
- backends - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Backend configuration via pom if not from property files.
- bundleDir - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Optional directory where to create bundle property files.
Contains all attribute- and relation names with their comments.
Useful to copy and paste into the project for auto table config or default editors.
C
- checkAndLogReservedTable(Entity) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Checks and logs whether the table name is already used by Tentackle.
- checkFallbackTableAliases() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Check for numbered fallback aliases.
- checkFallbackTableAliases() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- checkReservedTables - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Check for reserved table names.
InvokesMetaDataUtilities.isReservedTable(String). - closeResources(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Closes the resources.
- closeResources(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
- closeResources(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- comment - Variable in class org.tentackle.maven.plugin.sql.SequenceParameter
-
the optional comment.
- connectableBackendInfos - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Connectable backends to create SQL code for.
- copyFileSets(List) - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
-
Copies the contents of the given filesets to the generated sql file.
- createBackendInfo(AbstractTentackleMojo) - Method in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
Creates a backend info from this parameter.
- createSequences(Backend) - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
-
Creates the SQL code for sequences.
- createSqlFile(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Creates the sqlFile, sqlDirName, and sqlWriter.
- createSqlFile(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
- CreateSqlMojo - Class in org.tentackle.maven.plugin.sql
-
Generates an SQL script to create the database tables according to the model.
- CreateSqlMojo() - Constructor for class org.tentackle.maven.plugin.sql.CreateSqlMojo
D
- DatabaseVersionLoader - Interface in org.tentackle.maven.plugin.sql
-
Determines the database version in an application-specific way.
The implementing class must provide a no-args constructor. - dumpAnnotationsAsOptions - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
List of annotations that should be printed as attribute options.
A comma separates multiple annotations.
If the annotation ends with a|, it matches only annotations without parameters.
The special annotation@*matches all annotations and@*|matches all annotations without parameters. - dumpAsComment - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Model dump should be dumped as comment blocks (default).
- dumpBundles() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Dumps attribute and relation bundles.
- dumpBundles() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- dumpColumnGap - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Minimum number of spaces between columns in the attribute section (default = 2).
- dumpCompact - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Compact model dump.
Omits implicit configuration in dumped model code.
By default, all configuration keywords are printed for proofreading.
In compact mode, however, only the keywords that are actually required are printed, making it more suitable as input for source code generation. - dumpDir - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Optional directory where to dump the model.
Useful for debugging to verify that the model was interpreted correctly or to pretty-print the model source. - dumpModel() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Dumps the model.
- dumpModel() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- dumpModelIndex - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Creates an additional file containing the names of the dumped files.
Usually combined withAbstractSqlMojo.dumpModelSourceto createMETA-INF/MODEL-INDEX.LISTin order to load the model from a jar file. - dumpModelSource - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Dumps the original model source instead of the parsed entity.
- dumpVariables - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Model dump should include variables (default).
E
- enableValidation() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
-
Enables the metadata validation.
- entityAliases - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
The entity aliases.
- execute() - Method in class org.tentackle.tentackle_sql_maven_plugin.HelpMojo
- executeImpl() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
- executeImpl() - Method in class org.tentackle.maven.plugin.sql.RunSqlMojo
F
- filesets - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Explicit filesets given instead of the model directory.
G
- generate(String) - Method in class org.tentackle.maven.plugin.sql.MigrateGenerator
-
Generates the SQL file.
- generateHeaderComment - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Create a header comment.
- getAfterAll() - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed after anything else.
- getAfterTable(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed after table migration.
- getAlwaysAfter() - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed after anything else, unconditionally.
- getAlwaysBefore() - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed before anything else, unconditionally.
- getBackendInfosToExecute() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Gets the backend infos to execute.
- getBackendInfosToExecute() - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
- getBackendInfosToExecute() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- getBackendInfosToExecute() - Method in class org.tentackle.maven.plugin.sql.RunSqlMojo
- getBeforeAll() - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed before anything else.
- getBeforeTable(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed before table migration.
- getColumnMigrations(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the explicit column migrations for a table.
- getDatabaseVersion(AbstractSqlMojo, BackendInfo) - Method in interface org.tentackle.maven.plugin.sql.DatabaseVersionLoader
-
Determines the database version.
- getDependencies(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the dependencies.
- getDropTables() - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the drop table hints.
- getEntityAliases() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Gets the entity aliases.
- getHintFileNames() - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the names of the analyzed hintfiles.
The directory name is included as well. - getHints(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the migration hints.
- getInstance() - Static method in interface org.tentackle.maven.plugin.sql.VersionFileFilter
-
The singleton.
- getMigrateTable(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the sql code to be executed instead of table migration.
- getModel() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Gets the entity model.
- getModelDefaults() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Gets the model defaults.
- getModelLocation(String) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Returns the model source location to be used in the intro comment.
- getModelLocation(String) - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- getName() - Method in class org.tentackle.maven.plugin.sql.SemanticVersionFileFilter
- getName() - Method in interface org.tentackle.maven.plugin.sql.VersionFileFilter
-
Gets the name of the filter.
- getRenameColumns(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the name columns hints.
- getRenameTable(String) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Gets the "rename" table hint.
- getSqlFileName() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Gets the created sql file name without the leading path.
- getSqlFileName() - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
- getSqlFileName() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- getSqlFileName() - Method in class org.tentackle.maven.plugin.sql.RunSqlMojo
H
- HelpMojo - Class in org.tentackle.tentackle_sql_maven_plugin
-
Display help information on tentackle-sql-maven-plugin.
Callmvn tentackle-sql:help -Ddetail=true -Dgoal=<goal-name>to display parameter details. - HelpMojo() - Constructor for class org.tentackle.tentackle_sql_maven_plugin.HelpMojo
I
- increment - Variable in class org.tentackle.maven.plugin.sql.SequenceParameter
-
the optional increment, defaults to 1.
- isAlienTable(String) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Returns whether the given table name is reserved and must not be used by the model.
- isHintApplying(String, String) - Method in class org.tentackle.maven.plugin.sql.SemanticVersionFileFilter
-
Checks whether hint applies.
- isValid(String, File) - Method in class org.tentackle.maven.plugin.sql.SemanticVersionFileFilter
- isValid(String, File) - Method in interface org.tentackle.maven.plugin.sql.VersionFileFilter
-
Checks whether given migration hint file's version is logically greater or equal the given version.
L
- load(AbstractSqlMojo, boolean, List, String, List) - Method in class org.tentackle.maven.plugin.sql.MigrationHints
-
Load the migration hints.
- loadMigrationHints(BackendInfo, AbstractSqlMojo, boolean, List) - Method in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
Load the migration hints.
M
- mapSchemas - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Map schema names to flat table names.
- MigrateGenerator - Class in org.tentackle.maven.plugin.sql
-
Generator for the run script.
- MigrateGenerator(MigrateSqlMojo, File, BackendInfo, Map) - Constructor for class org.tentackle.maven.plugin.sql.MigrateGenerator
-
Creates the generator.
- MigrateSqlMojo - Class in org.tentackle.maven.plugin.sql
-
Generates an SQL script to migrate the database tables according to the model.
- MigrateSqlMojo() - Constructor for class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- MigrateTemplateModel - Class in org.tentackle.maven.plugin.sql
-
Holds the template model for the migration sql generator.
- MigrateTemplateModel(MigrateSqlMojo, BackendInfo, Map) - Constructor for class org.tentackle.maven.plugin.sql.MigrateTemplateModel
-
Creates the model.
- migrationHints - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
optional migration hints.
- MigrationHints - Class in org.tentackle.maven.plugin.sql
-
Migration hints.
- MigrationHints() - Constructor for class org.tentackle.maven.plugin.sql.MigrationHints
-
Creates the migration hints for a backend.
- minVersion - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
Optional minimum version number.
This is usually the version of the database model. - modelDefaults - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
The model defaults.
- modelDir - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Directory holding the model files to be processed.
Ignored if fileset explicitly given. - modelName - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
The model name.
N
- name - Variable in class org.tentackle.maven.plugin.sql.SequenceParameter
-
the sequence name.
O
- openResources(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Opens the resources such as session and creates the SQL file.
- openResources(BackendInfo) - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- org.tentackle.maven.plugin.sql - package org.tentackle.maven.plugin.sql
-
Tentackle SQL backend maven plugin.
- org.tentackle.tentackle_sql_maven_plugin - package org.tentackle.tentackle_sql_maven_plugin
P
- password - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
the password.
- processBackend(BackendInfoParameter, BackendInfo) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Processes the backend.
Provided to be overridden inMigrateSqlMojo. - processBackend(BackendInfoParameter, BackendInfo) - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- processFileSet(BackendInfo, FileSet) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Process all files in a fileset.
- processFileSet(BackendInfo, FileSet) - Method in class org.tentackle.maven.plugin.sql.CreateSqlMojo
- processFileSet(BackendInfo, FileSet) - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- processFileSet(BackendInfo, FileSet) - Method in class org.tentackle.maven.plugin.sql.RunSqlMojo
R
- RunSqlMojo - Class in org.tentackle.maven.plugin.sql
-
Runs an SQL script.
Example: - RunSqlMojo() - Constructor for class org.tentackle.maven.plugin.sql.RunSqlMojo
S
- schemaNames - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
alternate way to set schemas as a comma-separated string.
- schemas - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
allowed schemas.
- SemanticVersionFileFilter - Class in org.tentackle.maven.plugin.sql
-
Default semantic version filter.
- SemanticVersionFileFilter() - Constructor for class org.tentackle.maven.plugin.sql.SemanticVersionFileFilter
- SequenceParameter - Class in org.tentackle.maven.plugin.sql
-
Parameter to create a sequence.
- SequenceParameter() - Constructor for class org.tentackle.maven.plugin.sql.SequenceParameter
- serverId - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
server ID from settings.xml.
- sqlDir - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Directory holding the SQL-generated scripts.
- sqlDirName - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Output directory for diagnostics
- sqlFile - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
The created SQL file.
- sqlWriter - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Writer to the SQL file.
- start - Variable in class org.tentackle.maven.plugin.sql.SequenceParameter
-
the optional start value, defaults to 1.
T
- totalErrors - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
total number of errors.
U
- url - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
the backend url.
- useDropIfExists - Variable in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Use IF EXISTS for drop index, constraint, and column if the backend supports it.
If not supported, a warning will be logged. - user - Variable in class org.tentackle.maven.plugin.sql.BackendInfoParameter
-
the username.
V
- validate() - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
- validate() - Method in class org.tentackle.maven.plugin.sql.MigrateSqlMojo
- validate() - Method in class org.tentackle.maven.plugin.sql.ValidateSqlMojo
- ValidateSqlMojo - Class in org.tentackle.maven.plugin.sql
-
Validates the database against the model.
The build fails if something to migrate found.
Alternative to thevalidateconfiguration option of themigrategoal. - ValidateSqlMojo() - Constructor for class org.tentackle.maven.plugin.sql.ValidateSqlMojo
- VersionFileFilter - Interface in org.tentackle.maven.plugin.sql
-
Filters files according to their version.
W
- writeModelIntroComment(BackendInfo, String) - Method in class org.tentackle.maven.plugin.sql.AbstractSqlMojo
-
Writes the intro for a model to the SQL file.
All Classes and Interfaces|All Packages|Serialized Form