Skip to content

Commit

Permalink
Use auto-generated configuration properties documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ilopmar committed Feb 6, 2019
1 parent 110f659 commit a2ae0bd
Showing 1 changed file with 1 addition and 251 deletions.
252 changes: 1 addition & 251 deletions src/main/docs/guide/configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,257 +22,7 @@ include::{flywaytests}/resources/databasemigrations/V1__create-books-schema.sql[

There are several options available for configuration:

//TODO: https://github.com/micronaut-projects/micronaut-docs/issues/5
//include::{includedir}configurationProperties/io.micronaut.configuration.dbmigration.flyway.FlywayConfigurationProperties.adoc[]

++++
<a id="io.micronaut.configuration.dbmigration.flyway.FlywayConfigurationProperties" href="#io.micronaut.configuration.dbmigration.flyway.FlywayConfigurationProperties">&#128279;</a>
++++
.Configuration Properties for FlywayConfigurationProperties
|===
|Property |Type |Description

| `+flyway.datasources.*.configuration+`
|org.flywaydb.core.api.configuration.Configuration
|


| `+flyway.datasources.*.dry-run-output+`
|java.io.OutputStream
|


| `+flyway.datasources.*.error-overrides+`
|java.lang.String[]
|


| `+flyway.datasources.*.group+`
|boolean
|


| `+flyway.datasources.*.installed-by+`
|java.lang.String
|


| `+flyway.datasources.*.mixed+`
|boolean
|


| `+flyway.datasources.*.ignore-missing-migrations+`
|boolean
|


| `+flyway.datasources.*.ignore-ignored-migrations+`
|boolean
|


| `+flyway.datasources.*.ignore-pending-migrations+`
|boolean
|


| `+flyway.datasources.*.ignore-future-migrations+`
|boolean
|


| `+flyway.datasources.*.validate-on-migrate+`
|boolean
|


| `+flyway.datasources.*.clean-on-validation-error+`
|boolean
|


| `+flyway.datasources.*.clean-disabled+`
|boolean
|


| `+flyway.datasources.*.locations+`
|java.lang.String[]
|


| `+flyway.datasources.*.encoding+`
|java.lang.String
|


| `+flyway.datasources.*.schemas+`
|java.lang.String[]
|


| `+flyway.datasources.*.table+`
|java.lang.String
|


| `+flyway.datasources.*.target+`
|org.flywaydb.core.api.MigrationVersion
|


| `+flyway.datasources.*.placeholder-replacement+`
|boolean
|


| `+flyway.datasources.*.placeholders+`
|java.util.Map
|


| `+flyway.datasources.*.placeholder-prefix+`
|java.lang.String
|


| `+flyway.datasources.*.placeholder-suffix+`
|java.lang.String
|


| `+flyway.datasources.*.sql-migration-prefix+`
|java.lang.String
|


| `+flyway.datasources.*.undo-sql-migration-prefix+`
|java.lang.String
|


| `+flyway.datasources.*.repeatable-sql-migration-prefix+`
|java.lang.String
|


| `+flyway.datasources.*.sql-migration-separator+`
|java.lang.String
|


| `+flyway.datasources.*.sql-migration-suffixes+`
|java.lang.String[]
|


| `+flyway.datasources.*.data-source+`
|javax.sql.DataSource
|


| `+flyway.datasources.*.connect-retries+`
|int
|


| `+flyway.datasources.*.init-sql+`
|java.lang.String
|


| `+flyway.datasources.*.baseline-version+`
|org.flywaydb.core.api.MigrationVersion
|


| `+flyway.datasources.*.baseline-description+`
|java.lang.String
|


| `+flyway.datasources.*.baseline-on-migrate+`
|boolean
|


| `+flyway.datasources.*.out-of-order+`
|boolean
|


| `+flyway.datasources.*.callbacks+`
|org.flywaydb.core.api.callback.Callback[]
|


| `+flyway.datasources.*.skip-default-callbacks+`
|boolean
|


| `+flyway.datasources.*.resolvers+`
|org.flywaydb.core.api.resolver.MigrationResolver[]
|


| `+flyway.datasources.*.skip-default-resolvers+`
|boolean
|


| `+flyway.datasources.*.stream+`
|boolean
|


| `+flyway.datasources.*.batch+`
|boolean
|


| `+flyway.datasources.*.oracle-sqlplus+`
|boolean
|


| `+flyway.datasources.*.license-key+`
|java.lang.String
|


| `+flyway.datasources.*.enabled+`
|boolean
|Set whether this flyway configuration is enabled. Default value (true).


| `+flyway.datasources.*.clean-schema+`
|boolean
|Set whether Flyway will clean the schema before running the migrations. Default value (false).


| `+flyway.datasources.*.async+`
|boolean
|Whether flyway migrations should run asynchronously.


| `+flyway.datasources.*.url+`
|java.lang.String
|The JDBC url of the database to migrate


| `+flyway.datasources.*.user+`
|java.lang.String
|The user of the database to migrate


| `+flyway.datasources.*.password+`
|java.lang.String
|The password of the database to migrate


|===
include::{includedir}configurationProperties/io.micronaut.configuration.dbmigration.flyway.FlywayConfigurationProperties.adoc[]

NOTE: By default Micronaut will configure Flyway to use the datasources defined under `datasources` configuration key. If
you want to use a different datasource you need to define the properties `+flyway.datasources.*.url+`, `+flyway.datasources.*.user+`
Expand Down

0 comments on commit a2ae0bd

Please sign in to comment.