diff --git a/src/docs/asciidoc/configuration.adoc b/src/docs/asciidoc/configuration.adoc index 18e0db85..225e4b46 100644 --- a/src/docs/asciidoc/configuration.adoc +++ b/src/docs/asciidoc/configuration.adoc @@ -23,7 +23,7 @@ There are a few configuration options for the plugin. All configurations are pre |databaseChangeLogLockTableName |'databasechangeloglock' |the Liquibase lock table name |================================== -NOTE: All of the above configs can be used for a multiple datasources +NOTE: All of the above configs can be used for multiple datasources *Multiple DataSource Example:* diff --git a/src/docs/asciidoc/generalUsage.adoc b/src/docs/asciidoc/generalUsage.adoc index 576eee66..9047ac49 100644 --- a/src/docs/asciidoc/generalUsage.adoc +++ b/src/docs/asciidoc/generalUsage.adoc @@ -17,7 +17,7 @@ To create the changelog additions, you can either manually create the changes or You have a few options with `dbm-gorm-diff`: * `dbm-gorm-diff` will dump to the console if no filename is specified, so you can copy/paste from there -* if you include the `--add` parameter when running the script with a filename it will register an include for the the filename in the main changelog for you +* if you include the `--add` parameter when running the script with a filename it will register an include for the filename in the main changelog for you Regardless of which approach you use, be sure to inspect generated changes and adjust as necessary. diff --git a/src/docs/asciidoc/gorm.adoc b/src/docs/asciidoc/gorm.adoc index 726ec7c3..a41158f8 100644 --- a/src/docs/asciidoc/gorm.adoc +++ b/src/docs/asciidoc/gorm.adoc @@ -22,4 +22,4 @@ So a good workflow would be: *dbm-generate-gorm-changelog* -The <> script is useful for when you want to switch from `create-drop` mode to doing proper migrations. It's not very useful if you already have a database that's in sync with your code, since you can just use the <> script that creates a changelog from your database. \ No newline at end of file +The <> script is useful for when you want to switch from `create-drop` mode to doing proper migrations. It's not very useful if you already have a database that's in sync with your code, since you can just use the <> script that creates a changelog from your database. diff --git a/src/docs/asciidoc/groovyChanges.adoc b/src/docs/asciidoc/groovyChanges.adoc index 48972010..6f31e4b1 100644 --- a/src/docs/asciidoc/groovyChanges.adoc +++ b/src/docs/asciidoc/groovyChanges.adoc @@ -53,24 +53,18 @@ databaseChangeLog = { === Available variables These variables are available throughout the change closure: -* `changeSet` -** the current Liquibase `ChangeSet` instance -* `resourceAccessor` -** the current Liquibase `ResourceAccessor` instance -* `ctx` -** the Spring `ApplicationContext` -* `application` -** the `GrailsApplication` + +* `changeSet` - the current Liquibase `ChangeSet` instance +* `resourceAccessor` - the current Liquibase `ResourceAccessor` instance +* `ctx` - the Spring `ApplicationContext` +* `application` - the `GrailsApplication` The `change` and `rollback` closures also have the following available: -* `database` -** the current Liquibase `Database` instance -* `databaseConnection` -** the current Liquibase `DatabaseConnection` instance, which is a wrapper around the JDBC `Connection` (but doesn't implement the `Connection` interface) -* `connection` -** the real JDBC `Connection` instance (a shortcut for `database.connection.wrappedConnection`) -* `sql` -** a `groovy.sql.Sql` instance which uses the current `connection` and can be used for arbitrary queries and updates + +* `database` - the current Liquibase `Database` instance +* `databaseConnection` - the current Liquibase `DatabaseConnection` instance, which is a wrapper around the JDBC `Connection` (but doesn't implement the `Connection` interface) +* `connection` - the real JDBC `Connection` instance (a shortcut for `database.connection.wrappedConnection`) +* `sql` - a `groovy.sql.Sql` instance which uses the current `connection` and can be used for arbitrary queries and updates *init* @@ -78,15 +72,15 @@ This is where any optional initialization should happen. You can't access the da *validate* -If there are any necessary validation checks before executing changes or rollbacks they should be done here. You can log warnings by calling `warn(String message)` and stop processing by calling `error(String message)`. It may make more sense to use one or more `preCondition`s instead of directly validating here. +If there are any necessary validation checks before executing changes or rollbacks they should be done here. You can log warnings by calling `warn(String message)` and stop processing by calling `error(String message)`. It may make more sense to use one or more ++preCondition++s instead of directly validating here. *change* -All migration changes are done in the `change` closure. You can make changes directly (using the `sql` instance or the `connection`) and/or return one or more `SqlStatement`s. You can call `sqlStatement(SqlStatement statement)` multiple times to register instances to be run. You can also call the `sqlStatements(statements)` method with an array or list of instances to be run. +All migration changes are done in the `change` closure. You can make changes directly (using the `sql` instance or the `connection`) and/or return one or more ++SqlStatement++s. You can call `sqlStatement(SqlStatement statement)` multiple times to register instances to be run. You can also call the `sqlStatements(statements)` method with an array or list of instances to be run. *rollback* -All rollback changes are done in the `rollback` closure. You can make changes directly (using the `sql` instance or the `connection`) and/or return one or more `SqlStatement`s. You can call `sqlStatement(SqlStatement statement)` multiple times to register instances to be run. You can also call the `sqlStatements(statements)` method with an array or list of instances to be run. +All rollback changes are done in the `rollback` closure. You can make changes directly (using the `sql` instance or the `connection`) and/or return one or more ++SqlStatement++s. You can call `sqlStatement(SqlStatement statement)` multiple times to register instances to be run. You can also call the `sqlStatements(statements)` method with an array or list of instances to be run. *confirm* diff --git a/src/docs/asciidoc/groovyPreconditions.adoc b/src/docs/asciidoc/groovyPreconditions.adoc index a568bfd3..9205ccaa 100644 --- a/src/docs/asciidoc/groovyPreconditions.adoc +++ b/src/docs/asciidoc/groovyPreconditions.adoc @@ -4,7 +4,7 @@ In addition to the built-in Liquibase preconditions (see http://www.liquibase.or === General format -This is general format of a Groovy-based precondition: +This is the general format of a Groovy-based precondition: [source,groovy] ---- @@ -43,6 +43,7 @@ databaseChangeLog = { ---- As you can see there are a few ways to indicate that a precondition wasn't met: + * use a simple assertion * use an assertion with a message * call the `fail(String message)` method (throws a `PreconditionFailedException`) @@ -50,29 +51,18 @@ As you can see there are a few ways to indicate that a precondition wasn't met: === Available variables -* `database` -** the current Liquibase `Database` instance -* `databaseConnection` -** the current Liquibase `DatabaseConnection` instance, which is a wrapper around the JDBC `Connection` (but doesn't implement the `Connection` interface) -* `connection` -** the real JDBC `Connection` instance (a shortcut for `database.connection.wrappedConnection`) -* `sql` -** a `groovy.sql.Sql` instance which uses the current `connection` and can be used for arbitrary queries and updates -* `resourceAccessor` -** the current Liquibase `ResourceAccessor` instance -* `ctx` -** the Spring `ApplicationContext` -* `application` -** the `GrailsApplication` -* `changeSet` -** the current Liquibase `ChangeSet` instance -* `changeLog` -** the current Liquibase `DatabaseChangeLog` instance +* `database` - the current Liquibase `Database` instance +* `databaseConnection` - the current Liquibase `DatabaseConnection` instance, which is a wrapper around the JDBC `Connection` (but doesn't implement the `Connection` interface) +* `connection` - the real JDBC `Connection` instance (a shortcut for `database.connection.wrappedConnection`) +* `sql` - a `groovy.sql.Sql` instance which uses the current `connection` and can be used for arbitrary queries and updates +* `resourceAccessor` - the current Liquibase `ResourceAccessor` instance +* `ctx` - the Spring `ApplicationContext` +* `application` - the `GrailsApplication` +* `changeSet` - the current Liquibase `ChangeSet` instance +* `changeLog` - the current Liquibase `DatabaseChangeLog` instance === Utility methods -* `createDatabaseSnapshotGenerator()` -** retrieves the `DatabaseSnapshotGenerator` for the current `Database` -* `createDatabaseSnapshot(String schemaName = null)` -** creates a `DatabaseSnapshot` for the current `Database` (and schema if specified) +* `createDatabaseSnapshotGenerator()` - retrieves the `DatabaseSnapshotGenerator` for the current `Database` +* `createDatabaseSnapshot(String schemaName = null)` - creates a `DatabaseSnapshot` for the current `Database` (and schema if specified) diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc index 1051ff93..559fab02 100644 --- a/src/docs/asciidoc/index.adoc +++ b/src/docs/asciidoc/index.adoc @@ -138,4 +138,4 @@ include::ref/Update Scripts/dbm-update-count.adoc[] include::ref/Update Scripts/dbm-update-sql.adoc[] [[ref-update-scripts-dbm-update]] -include::ref/Update Scripts/dbm-update.adoc[] \ No newline at end of file +include::ref/Update Scripts/dbm-update.adoc[] diff --git a/src/docs/asciidoc/ref/Diff Scripts/dbm-diff.adoc b/src/docs/asciidoc/ref/Diff Scripts/dbm-diff.adoc index 75de7848..ca117e14 100644 --- a/src/docs/asciidoc/ref/Diff Scripts/dbm-diff.adoc +++ b/src/docs/asciidoc/ref/Diff Scripts/dbm-diff.adoc @@ -8,7 +8,7 @@ Compares two databases and creates a changelog that will make the changes requir Executes against the database configured in `application.[yml|groovy]` for the current environment (defaults to `dev`) and another configured datasource in `application.[yml|groovy]`. -If a filename parameter is specified then the output will be written to the named file, otherwise it will write to the console. If the filename ends with .groovy a Groovy DSL file will be created, otherwise a standard XML file will be created. +If a filename parameter is specified then the output will be written to the named file, otherwise it will be written to the console. If the filename ends with .groovy a Groovy DSL file will be created, otherwise a standard XML file will be created. File are written to the migrations folder, so specify the filename relative to the migrations folder (`grails-app/migrations` by default). @@ -26,8 +26,8 @@ Optional arguments: * `filename` - The path to the output file to write to. If not specified output is written to the console * `defaultSchema` - The default schema name to use -* `add` - if specified add an include in the root changelog file referencing the new file -* `dataSource` - if provided will run the script for the specified dataSource. Not needed for the default dataSource. +* `add` - If specified add an include in the root changelog file referencing the new file +* `dataSource` - If provided will run the script for the specified dataSource. Not needed for the default dataSource. NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value must be quoted if executed in Windows, e.g. [source,groovy] @@ -35,7 +35,7 @@ NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value mu grails dbm-diff "--defaultSchema=<>" "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Diff Scripts/dbm-gorm-diff.adoc b/src/docs/asciidoc/ref/Diff Scripts/dbm-gorm-diff.adoc index e0cfa583..72069d55 100644 --- a/src/docs/asciidoc/ref/Diff Scripts/dbm-gorm-diff.adoc +++ b/src/docs/asciidoc/ref/Diff Scripts/dbm-gorm-diff.adoc @@ -37,7 +37,7 @@ NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value mu grails dbm-gorm-diff "--defaultSchema=<>" "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Documentation Scripts/dbm-db-doc.adoc b/src/docs/asciidoc/ref/Documentation Scripts/dbm-db-doc.adoc index 5ad9a017..2f4f502c 100644 --- a/src/docs/asciidoc/ref/Documentation Scripts/dbm-db-doc.adoc +++ b/src/docs/asciidoc/ref/Documentation Scripts/dbm-db-doc.adoc @@ -28,7 +28,7 @@ NOTE: Note that the `contexts` and `dataSource` parameter name and value must be grails dbm-db-doc "--contexts=<>" "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-add-migration.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-add-migration.adoc index 65baefd4..c5b45e45 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-add-migration.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-add-migration.adoc @@ -7,7 +7,7 @@ Adds a template migration file to your project and to the changelog file. ===== Description This script provides a template in which to place your migration behaviour code, whether -grails code or raw SQL. +Grails code or raw SQL. Usage: [source,java] @@ -19,4 +19,4 @@ Required arguments: * `migrationName` - The name of the migration - will be used as a filename and the default migration id. -NOTE: This script only supports .groovy-style migrations at the moment. \ No newline at end of file +NOTE: This script only supports .groovy-style migrations at the moment. diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync-sql.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync-sql.adoc index 652844ee..15f0c8b9 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync-sql.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync-sql.adoc @@ -14,7 +14,7 @@ Usage: grails <> dbm-changelog-sync-sql <> --contexts=<> --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -29,7 +29,7 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-changelog-sync "--contexts=<>" "--defaultSchema=<>" "--dataSource=<>" ---- -NOTE: For the `dataSource` parameter if the data source is configured as `reports` underneath the `dataSources` key` in `application.[yml|groovy]` +NOTE: For the `dataSource` parameter if the data source is configured as `reports` underneath the `dataSources` key in `application.[yml|groovy]` the suffix of `reports` will be used as the parameter value. [source,groovy] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync.adoc index 3db2a542..bff33f45 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-sync.adoc @@ -6,7 +6,7 @@ Mark all changes as executed in the database. ===== Description -Registers all changesets as having been run in the Liquibase control table. This is useful when then changes have already been applied, for example if you've just created a changelog from your database using the <> script. +Registers all changesets as having been run in the Liquibase control table. This is useful when the changes have already been applied, for example if you've just created a changelog from your database using the <> script. Usage: [source,java] @@ -14,13 +14,13 @@ Usage: grails <> dbm-changelog-sync --contexts=<> --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: * `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. +* `dataSource` - If provided will run the script for the specified dataSource. Not needed for the default dataSource. NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name and value must be quoted if executed in Windows, e.g. [source,groovy] @@ -28,7 +28,7 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-changelog-sync "--contexts=<>" "--defaultSchema=<>" "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-to-groovy.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-to-groovy.adoc index 758ce0a2..61376e73 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-to-groovy.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-changelog-to-groovy.adoc @@ -20,4 +20,4 @@ Required arguments: Optional arguments: -* `groovy_file_name` - The name and path of the Groovy file \ No newline at end of file +* `groovy_file_name` - The name and path of the Groovy file diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-clear-checksums.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-clear-checksums.adoc index 99c2a9d8..ee21a1d5 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-clear-checksums.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-clear-checksums.adoc @@ -12,7 +12,7 @@ Usage: grails <> dbm-clear-checksums --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -24,7 +24,7 @@ NOTE: Note that the `dataSource` parameter name and value must be quoted if exec grails dbm-clear-checksums "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-create-changelog.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-create-changelog.adoc index cc54b219..37e2c4e1 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-create-changelog.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-create-changelog.adoc @@ -28,7 +28,7 @@ NOTE: Note that the `dataSource` parameter name and value must be quoted if exec grails dbm-create-changelog "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-drop-all.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-drop-all.adoc index 48adf84b..3a1d32e5 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-drop-all.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-drop-all.adoc @@ -12,7 +12,7 @@ Usage: grails <> dbm-drop-all <> --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -26,7 +26,7 @@ NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value mu grails dbm-drop-all "--defaultSchema=<>" "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-locks.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-locks.adoc index 1fb7f214..78e63b8a 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-locks.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-locks.adoc @@ -12,7 +12,7 @@ Usage: grails <> dbm-list-locks <> --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -26,7 +26,7 @@ NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value mu grails dbm-list-locks "--defaultSchema=<>" "--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`. +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] ---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-tags.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-tags.adoc index 869aff2d..65f61843 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-tags.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-list-tags.adoc @@ -14,7 +14,7 @@ grails <> dbm-list-tags --defaultSchema=<> Required arguments: -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -24,4 +24,4 @@ NOTE: Note that the `defaultSchema` parameter name and value must be quoted if e [source,groovy] ---- grails dbm-tag "--defaultSchema=<>" ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-mark-next-changeset-ran.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-mark-next-changeset-ran.adoc index 10e20f12..e76f0cde 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-mark-next-changeset-ran.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-mark-next-changeset-ran.adoc @@ -14,7 +14,7 @@ Usage: grails <> dbm-mark-next-changeset-ran <> --contexts=<> --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -29,9 +29,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-mark-next-changeset-ran "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-register-changelog.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-register-changelog.adoc index 7367778f..b2c25034 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-register-changelog.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-register-changelog.adoc @@ -31,4 +31,4 @@ the suffix of `reports` will be used as the parameter value. [source,groovy] ---- --dataSource=reports ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-release-locks.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-release-locks.adoc index b37ea0e5..b46b15cb 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-release-locks.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-release-locks.adoc @@ -12,7 +12,7 @@ Usage: grails <> dbm-release-locks --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -25,9 +25,9 @@ NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value mu grails dbm-release-locks "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-status.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-status.adoc index 0fd1e489..c802f8d5 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-status.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-status.adoc @@ -12,7 +12,7 @@ Usage: grails <> dbm-status <> --verbose=<> --contexts=<> --defaultSchema=<> --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -28,9 +28,9 @@ NOTE: Note that the `verbose`, `contexts`, `defaultSchema` and `dataSource` para grails dbm-status "--verbose=<>" "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-tag.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-tag.adoc index 7fecca37..8d9f84a9 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-tag.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-tag.adoc @@ -29,9 +29,9 @@ NOTE: Note that the `defaultSchema` and `dataSource` parameter name and value mu grails dbm-tag "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-validate.adoc b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-validate.adoc index 6776d747..4628c8b4 100644 --- a/src/docs/asciidoc/ref/Maintenance Scripts/dbm-validate.adoc +++ b/src/docs/asciidoc/ref/Maintenance Scripts/dbm-validate.adoc @@ -14,7 +14,7 @@ Usage: grails <> dbm-validate --dataSource=<> ---- -Required arguments: _none_ . +Required arguments: __none__. Optional arguments: @@ -26,9 +26,9 @@ NOTE: Note that the `dataSource` parameter name and value must be quoted if exec grails dbm-validate "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-future-rollback-sql.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-future-rollback-sql.adoc index 2961030a..a35146be 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-future-rollback-sql.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-future-rollback-sql.adoc @@ -27,9 +27,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-future-rollback-sql "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-changelog.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-changelog.adoc index d482940e..54944c68 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-changelog.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-changelog.adoc @@ -34,9 +34,9 @@ NOTE: Note that the `diffTypes`, `defaultSchema`, and `dataSource` parameter nam grails dbm-generate-changelog "--diffTypes=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-gorm-changelog.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-gorm-changelog.adoc index e43bce30..1b395488 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-gorm-changelog.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-generate-gorm-changelog.adoc @@ -32,9 +32,9 @@ NOTE: Note that the `dataSource` parameter name and value must be quoted if exec grails dbm-generate-gorm-changelog "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count-sql.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count-sql.adoc index a24ee325..601d2b74 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count-sql.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count-sql.adoc @@ -30,9 +30,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-rollback-count-sql "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count.adoc index 792b80cf..4e967d94 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-count.adoc @@ -29,9 +29,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-rollback-count "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-sql.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-sql.adoc index 7d92c156..20c1b8d7 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-sql.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-sql.adoc @@ -31,9 +31,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-rollback-sql "--contexts=<>" "--defaultSchema=<>" --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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date-sql.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date-sql.adoc index c9cdb8ca..f113a0ed 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date-sql.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date-sql.adoc @@ -32,10 +32,10 @@ NOTE: Note that the `contexts`, `defaultSchema`, `dataSource` parameter name and grails dbm-rollback-to-date-sql "--contexts=<>" "--defaultSchema=<>" "--dataSource=<>" ---- -NOTE: For the `dataSource` parameter; If the data source is configured as `reports` underneath the `dataSources` key in `application.[yml|groovy]`, +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date.adoc index 65b98509..f3d15f99 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback-to-date.adoc @@ -31,9 +31,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-rollback-to-date "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback.adoc b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback.adoc index bfc636eb..38a5b90b 100644 --- a/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback.adoc +++ b/src/docs/asciidoc/ref/Rollback Scripts/dbm-rollback.adoc @@ -30,9 +30,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-rollback "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Update Scripts/dbm-previous-changeset-sql.adoc b/src/docs/asciidoc/ref/Update Scripts/dbm-previous-changeset-sql.adoc index 8be4abbd..c2ff73f2 100644 --- a/src/docs/asciidoc/ref/Update Scripts/dbm-previous-changeset-sql.adoc +++ b/src/docs/asciidoc/ref/Update Scripts/dbm-previous-changeset-sql.adoc @@ -29,4 +29,4 @@ NOTE: Note that the `contexts` and `defaultSchema` parameter name and value must [source,groovy] ---- grails dbm-update-count-sql "--contexts=<>" "--defaultSchema=<>" ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Update Scripts/dbm-update-count-sql.adoc b/src/docs/asciidoc/ref/Update Scripts/dbm-update-count-sql.adoc index 5674d622..4a0c9d14 100644 --- a/src/docs/asciidoc/ref/Update Scripts/dbm-update-count-sql.adoc +++ b/src/docs/asciidoc/ref/Update Scripts/dbm-update-count-sql.adoc @@ -33,9 +33,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-update-count-sql "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Update Scripts/dbm-update-count.adoc b/src/docs/asciidoc/ref/Update Scripts/dbm-update-count.adoc index 0ca69070..c0e0c698 100644 --- a/src/docs/asciidoc/ref/Update Scripts/dbm-update-count.adoc +++ b/src/docs/asciidoc/ref/Update Scripts/dbm-update-count.adoc @@ -30,9 +30,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, `dataSource` parameter name and grails dbm-update-count "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Update Scripts/dbm-update-sql.adoc b/src/docs/asciidoc/ref/Update Scripts/dbm-update-sql.adoc index d6b9e8c3..81f244f6 100644 --- a/src/docs/asciidoc/ref/Update Scripts/dbm-update-sql.adoc +++ b/src/docs/asciidoc/ref/Update Scripts/dbm-update-sql.adoc @@ -31,9 +31,9 @@ NOTE: Note that the `contexts`, `defaultSchema`, and `dataSource` parameter name grails dbm-update-sql "--contexts=<>" "--defaultSchema=<>" --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`. +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 ----- \ No newline at end of file +---- diff --git a/src/docs/asciidoc/ref/Update Scripts/dbm-update.adoc b/src/docs/asciidoc/ref/Update Scripts/dbm-update.adoc index d9161bb6..3be1f502 100644 --- a/src/docs/asciidoc/ref/Update Scripts/dbm-update.adoc +++ b/src/docs/asciidoc/ref/Update Scripts/dbm-update.adoc @@ -28,9 +28,9 @@ NOTE: Note that the `contexts` and `defaultSchema` parameter name and value must grails dbm-update "--contexts=<>" "--defaultSchema=<>" "--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`. +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 ----- \ No newline at end of file +----