Skip to content

Commit 5b4b7c8

Browse files
rg-buildmonkeyrg-buildmonkey
committed
Bump version to flyway-10.22.0
Please see the GH release for the release notes Clean postgres collations from PR 3791 Use default storage engine for MySQL schema history table. From PR 3642 Include Placeholder separator when throwing unknown default placeholder exception.
1 parent 2dbbab3 commit 5b4b7c8

File tree

103 files changed

+1413
-553
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+1413
-553
lines changed

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
### Database Migrations Made Easy.
44

5-
![Flyway](https://flywaydb.org/assets/logo/flyway-logo.png "Flyway")
5+
![Flyway](https://documentation.red-gate.com/download/attachments/138346876/FD?version=3&modificationDate=1633982869952&api=v2 "Flyway")
6+
67

78
#### Evolve your database schema easily and reliably across all your instances.
89
Simple, focused and powerful.
@@ -23,6 +24,9 @@ SBT, Ant, Spring Boot, Grails, Play!, DropWizard, Grunt, Griffon, Ninja, ...
2324
You can find our getting started guides [here](https://documentation.red-gate.com/flyway/getting-started-with-flyway).
2425
Our reference documentation can be found [here](https://documentation.red-gate.com/flyway/flyway-cli-and-api).
2526

27+
## Download
28+
You can downlod Flyway from [here](https://documentation.red-gate.com/fd/flyway-open-source-224002364.html)
29+
2630
## About
2731
Flyway is brought to you by [Redgate](https://www.red-gate.com/) with the help of many contributors.
2832

‎documentation/Flyway CLI and API/Commands/Auth.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,24 @@ subtitle: Auth
33
---
44
# Auth
55

6-
`auth` initiates an online or offline license acquisition flow that can be used instead of the legacy [license key](Configuration/Parameters/Flyway/License Key) workflow.
6+
`auth` initiates an online license acquisition flow.
77

8-
If `auth` is run on a machine that is connected to the internet with an accessible browser, Flyway will launch a web browser prompting the user to log in with their Redgate account
9-
username and password. Please note that `auth` is not supported on WSL, nor when using SSH. For these cases and any where a web browser is inaccessible on the same machine that is
10-
running Flyway, it is recommended to use an [non-interactive mechanism](<Configuration/Flyway Licensing>) to license Flyway.
8+
For an overview of ways to license Flyway see [Flyway Licensing](<Configuration/Flyway Licensing>)
119

12-
Upon successful login, a license permit is then saved to disk in the `Flyway CLI` directory of the Redgate app data folder. If the user is offline, a
13-
[link to create a license permit](https://permits.red-gate.com/offline?productCode=63) will be printed to the console. The user can then copy the license permit
14-
from that site and paste it into the console to authorize Flyway.
10+
If `auth` is run on a machine that is connected to the internet with an accessible browser, Flyway will launch a web browser prompting the user to log in with their Redgate account
11+
username and password.
1512

13+
- `auth` needs to be able to launch a web browser and so doesn't work on WSL or when interacting with Flyway over SSH. For these cases it is recommended to use a [non-interactive mechanism](<Configuration/Flyway Licensing>) to license Flyway.
14+
- If you need an offline licensing mechanism please look at [License Permits](<Configuration/License Permits>)
1615

1716
## Flags:
1817

19-
| Parameter | Edition | Description
20-
|-----------------------|--------------------| -----------------------------------------------------
21-
| -IAgreeToTheEula | All | (Mandatory) By using this option you consent to the [Redgate EULA](https://www.red-gate.com/eula)
22-
| -logout | All | Logs a user out of their authorized session of Flyway
23-
| -startTeamsTrial | All | Starts a Teams trial
24-
| -startEnterpriseTrial | All | Starts an Enterprise trial
18+
| Parameter | Edition | Description |
19+
|-------------------------|-----------|---------------------------------------------------------------------------------------------------|
20+
| `-IAgreeToTheEula` | Community | (Mandatory) By using this option you consent to the [Redgate EULA](https://www.red-gate.com/eula) |
21+
| `-logout` | Community | Logs a user out of their authorized session of Flyway |
22+
| `-startTeamsTrial` | Community | Starts a Teams trial |
23+
| `-startEnterpriseTrial` | Community | Starts an Enterprise trial |
2524

2625
## Logout
2726

@@ -31,6 +30,7 @@ logged out of their session and Flyway will run as Community Edition. If a valid
3130
honor these as authorizations and logout will not remove them.
3231

3332
## App Data Folder Locations
33+
Flyway stores permits in a central location rather than it's installation location.
3434

3535
### Windows
3636

‎documentation/Flyway CLI and API/Commands/Deploy.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
subtitle: Deploy
3+
---
4+
5+
# Deploy
6+
7+
The `deploy` command executes a deployment script against a target database.
8+
Can be used in conjunction with scripts generated by `flyway prepare`.
9+
10+
## Usage examples
11+
12+
### Deploying an arbitrary SQL script
13+
14+
```
15+
flyway deploy -scriptFilename="D__deployment.sql" -environment=production
16+
```
17+
18+
### Deploying a deployment script generated by [prepare](<Commands/Prepare>)
19+
20+
```
21+
flyway prepare -source=schemaModel -target=production -scriptFilename=D__deployment.sql
22+
flyway deploy -scriptFilename="D__deployment.sql" -environment=production
23+
```
24+
25+
Note that it is also possible to chain these commands:
26+
27+
```
28+
flyway prepare deploy -source=schemaModel -target=production -environment=production
29+
```
30+
31+
## Complete list of parameters
32+
33+
### Optional
34+
35+
| Parameter | Namespace | Description |
36+
|------------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------------------------------------|
37+
| `scriptFilename` | deploy | The path to the script that will be deployed. Defaults to `deployments/D__deployment.sql`. |
38+
| [`batch`](<Configuration/Parameters/Flyway/Batch>) | (root) | Whether to batch SQL statements when executing them. |
39+
| [`configFiles`](<Configuration/Parameters/Flyway/Config Files>) | (root) | The location of the flyway configuration files. |
40+
| [`encoding`](<Configuration/Parameters/Flyway/Encoding>) | (root) | The encoding of the script to be deployed. |
41+
| [`environment`](<Configuration/Parameters/Flyway/Environment>) | (root) | The name of the environment to deploy to. |
42+
| [{environment parameters}](<Configuration/Parameters/Environments>) | (root) | Environment configuration for the target environment. |
43+
| [`executeInTransaction`](<Configuration/Parameters/Flyway/Execute In Transaction>) | (root) | Whether to run the script within a transaction. |
44+
| [`workingDirectory`](<Configuration/Parameters/Flyway/Working Directory>) | (root) | The directory to consider the current working directory. All relative paths will be considered relative to this. |
45+
46+
## JSON output format
47+
48+
```json
49+
{
50+
"scriptExecuted": "C:\\workingDirectory\\D__deployment.sql",
51+
"deploymentResults": [],
52+
"database": "production"
53+
}
54+
```

‎documentation/Flyway CLI and API/Commands/Diff Apply.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎documentation/Flyway CLI and API/Commands/Diff.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subtitle: Diff
55
# Diff - Preview
66

77
The `diff` command calculates the differences between a specified source and target.
8-
The result of a diff command can then be used with the `generate`, `diffApply` and `diffText` commands to generate scripts and apply changes.
8+
The result of a diff command can then be used with the `generate`, `model` and `diffText` commands to generate scripts and apply changes.
99

1010
More information about the `diff` command can be found below:
1111
- [Diff Command Concept](<Concepts/Diff concept>)

‎documentation/Flyway CLI and API/Commands/Model.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
subtitle: Model
3+
---
4+
# Model - Preview
5+
6+
The `model` command allows differences found by running the diff command to be applied to the schema model.
7+
8+
More information about the `model` command can be found below:
9+
- [Model Command Concept](<Concepts/Model concept>)
10+
- [Model Command Usage](<Usage/Command-line/Command-line - model>)

0 commit comments

Comments
 (0)