blob: 167556516ae8938e37705de49f4c007c0a5da2c7 [file] [log] [blame]
===== dbm-status
====== Purpose
Outputs count or list of unrun change sets to STDOUT or a file.
====== Description
Usage:
[source,java]
----
grails <<environment>> dbm-status <<filename>> --verbose=<<verbose>> --contexts=<<contexts>> --defaultSchema=<<defaultSchema>> --dataSource=<<dataSource>>
----
Required arguments: __none__.
Optional arguments:
* `filename` - The path to the output file to write to. If not specified output is written to the console
* `verbose` - If `true` (the default) the changesets are listed; if `false` only the count is displayed
* `contexts` - A comma-delimited list of http://www.liquibase.org/manual/contexts[context] names. If specified, only changesets tagged with one of the context names will be included
* `defaultSchema` - The default schema name to use
* `dataSource` - if provided will run the script for the specified dataSource. Not needed for the default dataSource.
NOTE: Note that the `verbose`, `contexts`, `defaultSchema` and `dataSource` parameter name and value must be quoted if executed in Windows, e.g.
[source,groovy]
----
grails dbm-status "--verbose=<<verbose>>" "--contexts=<<contexts>>" "--defaultSchema=<<defaultSchema>>" "--dataSource=<<dataSource>>"
----
NOTE: 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`.
[source,groovy]
----
--dataSource=reports
----