-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor Flyway Command-Line main method
Closes #3664: Bump Snowflake JDBC to 3.13.30 @sseide Bump SQLite JDBC to 3.41.2.1 to address CVE-2021-20227, CVE-2022-35737 and CVE-2022-46908 @sseide Bump MariaDB JDBC to 2.7.9 to address multiple issues @sseide Closes #3648: Ensure Flyway uses ALL_CREDENTIALS when using versions of Oracle where ALL_SCHEDULER_CREDENTIALS is deprecated update version of msal4j to fix vulnerability allow escaped single quotes in SQL string literals Closes #3621: allow escaped single quotes in SQL string literals Update version of snowflake-jdbc to fix SNYK-JAVA-NETSNOWFLAKE-5425048 Remove redundant edition flags documentation Remove migrations testing tutorial Adding Flyway Reports; Single file HTML reports that expose important details and stats about your Flyway pipeline in an easy to read and share format. Closes #3652: Remove redundant html extension on automatically generated reports and empty reports add direct support for Alpine linux
- Loading branch information
Showing
126 changed files
with
2,780 additions
and
1,028 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 0 additions & 39 deletions
39
documentation/Flyway CLI and API/Configuration/Parameters/Edition.md
This file was deleted.
Oops, something went wrong.
38 changes: 38 additions & 0 deletions
38
documentation/Flyway CLI and API/Configuration/Parameters/Report Filename.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
pill: reportFilename | ||
subtitle: flyway.reportFilename | ||
--- | ||
|
||
# Report Filename | ||
|
||
## Description | ||
Filename for the report file. The report is a html file containing the details of the migration including SQL script execution times and success/failure statuses as well as the results of `check`. | ||
This filename will also be used for a supplementary json file as well, excluding any html or htm extension. | ||
|
||
|
||
## Default | ||
report.html | ||
|
||
## Usage | ||
|
||
### Commandline | ||
```powershell | ||
./flyway -reportFilename=flyway_report.html info | ||
``` | ||
|
||
### Configuration File | ||
```properties | ||
flyway.reportFilename=flyway_report.html | ||
``` | ||
|
||
### Environment Variable | ||
```properties | ||
FLYWAY_REPORT_FILENAME=flyway_report.html | ||
``` | ||
|
||
## Notes | ||
This parameter replaces the deprecated `flyway.check.reportFilename` parameter. | ||
If you are using `check`, `flyway.check.reportFilename` will overwrite `flyway.reportFilename` for all reports. | ||
If you are not using `check`, `flyway.check.reportFilename` will be ignored. | ||
|
||
Empty `reportFilename` will be replaced by the default value. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
subtitle: placeholder page | ||
--- | ||
Flyway produces reporting of activity outcome - this section describes the nature of the report and how you could use it. | ||
<div id="children"> | ||
{% include childPages.html %} | ||
</div> |
17 changes: 17 additions & 0 deletions
17
documentation/Flyway CLI and API/Reports/Reports - Change.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
subtitle: Change Report | ||
--- | ||
{% include enterprise.html %} | ||
|
||
The change report indicates the difference between applied migration scripts on your target database and pending migrations scripts (ie. the set of instructions you want to use to change your target database). | ||
|
||
You might want this to: | ||
|
||
* Pre-deployment - check the effect of your pending changes (DBA review) | ||
* Post-deployment -capture a history of changes for retrospective auditing or reporting | ||
|
||
## Learn more | ||
* [Check concept](Concepts/Check Concept) - how does it work ? | ||
* [Check command](Commands/Check) - What is the command structure ? | ||
* [Tutorial - Using Flyway Check](Tutorials\Tutorial - Using Flyway Check with SQL Server.md) - how do I use it ? | ||
* Get a [Flyway Enterprise Trial](https://www.red-gate.com/products/flyway/enterprise/trial/) |
15 changes: 15 additions & 0 deletions
15
documentation/Flyway CLI and API/Reports/Reports - Code Analysis.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
subtitle: Code Analysis | ||
--- | ||
|
||
The code analysis report shows you the results of the static analysis tool(s) that Flyway integrates with. | ||
* An integration with [SQlFluff](https://www.sqlfluff.com/) exists for all editions | ||
* Teams customers can configure how their pipeline can be halted based on policy around rule violations | ||
* Enterprise customers also get an easy mechanism to create and use custom rules based on regex pattern matching | ||
|
||
## Learn more | ||
|
||
* [Check concept](Concepts/Check Concept) - how does it work ? | ||
* [Check command](Commands/Check) - What is the command structure ? | ||
* [Flyway Teams Edition](https://www.red-gate.com/products/flyway/teams/) | ||
* Get a [Flyway Enterprise Trial](https://www.red-gate.com/products/flyway/enterprise/trial/) |
16 changes: 16 additions & 0 deletions
16
documentation/Flyway CLI and API/Reports/Reports - Drift.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
subtitle: Drift Report | ||
--- | ||
{% include enterprise.html %} | ||
|
||
The drift report indicates the differences between structure of your target database and structure created by the migrations applied by Flyway. | ||
|
||
You might want this to: | ||
* Check if changes have been made to your database outside of the Flyway migration control mechanism | ||
* The target database is in the state you expect it t be in prior to applying new migrations | ||
|
||
## Learn more | ||
|
||
* [Check concept](Concepts/Check Concept) - how does it work ? | ||
* [Check command](Commands/Check) - What is the command structure ? | ||
* Get a [Flyway Enterprise Trial](https://www.red-gate.com/products/flyway/enterprise/trial/) |
18 changes: 18 additions & 0 deletions
18
documentation/Flyway CLI and API/Reports/Reports - Dry Run.MD
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
subtitle: Dry Run Report | ||
--- | ||
{% include teams.html %} | ||
|
||
Flyway Dry Run lets you preview the SQL that Flyway would execute on your DB based on the migration state of the DB, the pending migrations and the way you have configured Flyway. | ||
|
||
You might want this to: | ||
|
||
* preview the changes Flyway will make to the database | ||
* submit the SQL statements for review to a DBA before applying them | ||
* use Flyway to determine what needs updating, yet use a different tool to apply the actual database changes | ||
|
||
## Learn More | ||
|
||
* [Dry Run Concept](Concepts/Dry Runs) - how does it work ? | ||
* [Dry Run Tutorial](Tutorials/Tutorial - Dry Runs) - how do I use it ? | ||
* Get a [Flyway Teams Trial](https://www.red-gate.com/products/flyway/teams/trial/) |
16 changes: 16 additions & 0 deletions
16
documentation/Flyway CLI and API/Reports/Reports - Info.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
subtitle: Info Report | ||
--- | ||
|
||
Shows the details and status information about all the migrations that Flyway knows about. | ||
Info lets you know where you stand. At a glance you will see which migrations have already been applied, which other ones are still pending, when they were executed and whether they were successful or not. | ||
|
||
You might want this to: | ||
|
||
* Check the current migration state of your target DB | ||
* Understand what is yet to be deployed in a more digestible format than the raw filenames | ||
|
||
## Learn More | ||
|
||
* [Info](Commands/info) | ||
* Find out about [Flyway Editions](https://www.red-gate.com/products/flyway/editions) |
17 changes: 17 additions & 0 deletions
17
documentation/Flyway CLI and API/Reports/Reports - Migration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
subtitle: Migration Report | ||
--- | ||
|
||
Database migration is the core of what Flyway does, it takes a set of sequenced changes (migrations), applies them to your database and keeps track of what happened and when. | ||
|
||
You might want this to: | ||
|
||
* Have a record of what happened when for audit or reporting purposes | ||
* Understand and be able to communicate failures in a more richly descriptive manner | ||
|
||
## Learn More | ||
|
||
* [Migrate Command](Commands/Migrate) - how does it work ? | ||
* [Migrate - CLI reference](Usage/Command-line/Command-line - Migrate) - What is the command structure ? | ||
* [First Steps: Command-line](Getting Started/First Steps/First Steps - Command-line) - how do I use it ? | ||
* Find out about [Flyway Editions](https://www.red-gate.com/products/flyway/editions) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.