Allow HTML In Comments. Any HTML embedded in comments normally gets encoded so that it's rendered as text. This option allows it to be rendered as HTML.

No description.

Deprecated.
this seems to no longer be a supported option in SchemaSpy

Comments Initially Displayed. Column comments are normally hidden by default. This option displays them by default.

Specifies additional properties to be used when connecting to the database. Specify the entries directly, escaping the ='s with \= and separating each key\=value pair with a ;. May also be a file name, useful for hiding connection properties from public logs.

The CSS Stylesheet. Allows you to override the default SchemaSpyCSS stylesheet.

The name of the database being analysed.

The type of database being analysed - defaults to ora.

Exclude matching columns from relationship analysis to simplify the generated graphs. This is a regular expression that's used to determine which columns to exclude. It must match table name, followed by a dot, followed by column name. For example: -x "(book.isbn)|(borrower.address)" Note that each column name regular expression must be surround by ()'s and separated from other column names by a |.

Generate higher-quality diagrams. Various installations of Graphviz (depending on OS and/or version) will default to generating either higher or lower quality images. That is, some might not have the "lower quality" libraries and others might not have the "higher quality" libraries.

The host address of the database being analysed.

Only include matching tables/views. This is a regular expression that's used to determine which tables/views to include. For example: -i "(.*book.*)|(library.*)" includes only those tables/views with 'book' in their names or that start with 'library'. You might want to use "description" with this option to describe the subset of tables.

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)

Detail of execution logging.

Generate lower-quality diagrams. Various installations of Graphviz (depending on OS and/or version) will default to generating either higher or lower quality images. That is, some might not have the "lower quality" libraries and others might not have the "higher quality" libraries.

Deprecated.
will be removed

Don't generate ads in reports.

Only generate files needed for insertion/deletion of data (e.g. for scripts).

Don't include implied foreign key relationships in the generated table details.

Deprecated.
will be removed

Don't generate sourceforge logos in reports.

Don't query or display row counts.

No schema required for this database (e.g. derby).

Don't query or display row counts.

The output directory where the final HTML reports will be generated. Note that the reports are always generated in a directory called "schemaspy". The output directory refers to the directory in which the "schemaspy" will be generated.

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

Database password to use - defaults to none.

If specified, SchemaSpy will look for JDBC drivers on this path, rather than using the application classpath. Useful if your database has a non-O/S driver not bundled with the plugin.

The port, required by some drivers.

Whether to create the report only on the execution root of a multi-module project.

Database schema to use - defaults to the specified user.

Schema description. Displays the specified textual description on summary pages. If your description includes an equals sign then escape it with a backslash. NOTE: This field doesn't seem to be used by SchemaSpy in the current version.

Evaluate specified schemas. Similar to -showAllSchemas, but explicitly specifies which schema to evaluate without interrogating the database's metadata. Can be used with databases like MySQL where a database isn't composed of multiple schemas.

Evaluate all schemas in a database. Generates a high-level index of the schemas evaluated and allows for traversal of cross-schema foreign key relationships. Use with -schemaSpec "schemaRegularExpression" to narrow-down the schemas to include.

Single Sign-On. Don't require a user to be specified with -user to simplify configuration when running in a single sign-on environment.

Directory containing the site.xml file.

The output directory for the intermediate report.

Some databases, like Derby, will crash if you use the old driver object to establish a connection (eg "connection = driver.connect(...)"). In this case, set useDriverManager to true to use the DriverManager.getConnection() method instead (eg "connection = java.sql.DriverManager.getConnection(...)"). Other databases (eg MySQL) seem to only work with the first method, so don't use this parameter unless you have to.

Connect to the database with this user id.

No description.