grace <<environment>> dbm-db-doc <<destination>> --contexts=<<contexts>> --dataSource=<<dataSource>>dbm-db-doc
Purpose
Generates Javadoc-like documentation based on current database and change log.
Description
Writes to the folder specified by the destination parameter, or to the grails.plugin.databasemigration.dbDocLocation configuration option (defaults to target/dbdoc).
Usage:
Required arguments: none .
Optional arguments:
-
destination- The path to write to -
contexts- A comma-delimited list of context names. If specified, only changesets tagged with one of the context names will be included -
dataSource- if provided will run the script for the specified dataSource. Not needed for the default dataSource.
Note that the contexts and dataSource parameter name and value must be quoted if executed in Windows, e.g.
|
grace dbm-db-doc "--contexts=<<contexts>>" "--dataSource=<<dataSource>>"
For the dataSource parameter, if the data source is configured as reports underneath the dataSources key in application.[yml|groovy], the value should be reports.
|
--dataSource=reports