Skip to content

Commit 896c302

Browse files
Version Information Page
#6497
1 parent 4658fbc commit 896c302

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

docs/development/upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Which gives output like:
9898

9999
### Upcoming - UI View
100100

101-
We will provide a mechanism to verify the release number via the Waltz user interface.
101+
Waltz 1.48 will provide mechanism to verify the release number via the Waltz user interface.
102102
Issue: [#6497](https://github.com/finos/waltz/issues/6497)
103103

104104

waltz-schema/src/main/resources/liquibase/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,22 @@
22

33
Waltz uses [Liquibase](http://www.liquibase.org/index.html) to manage it's schema.
44

5+
6+
## About
7+
8+
Liquibase is an open-source database change management tool that allows developers to manage and automate changes to database schemas.
9+
It provides a way to define, track, and execute changes to database structures, such as tables, columns, indexes, and constraints.
10+
11+
Waltz uses Liquibase by defining changes XML "changelog" files which are versioned and stored alongside the application code (in `waltz-scheme\src\main\resources\liquibase`.
12+
The changelog describes how to migrate the database it to newer versions, and Liquibase ensures that the changes are applied in the correct order.
13+
14+
515
## Authoring
616

717
The changelog file follows the [best practice guidelines](http://www.liquibase.org/bestpractices.html) outlined
818
on the liquibase site.
919

20+
1021
### Change Ids
1122

1223
Id's have undergone several changes since project inception. The current format is:
@@ -19,7 +30,6 @@ For example:
1930
Strictly speaking the date is not required, but it helps when searching for changes in a certain time range.
2031

2132

22-
2333
## Updating the database
2434

2535
Liquibase can either apply the changes directly to the database or prepare an sql file for manual execution.
@@ -33,6 +43,7 @@ An _alternative_ mechanism to get the files is to download and extract them from
3343
For example:
3444
![liquibase-zips.png](liquibase-zips.png)
3545

46+
3647
### Executing the changes using Liquibase:
3748

3849
This approach uses Liquibase to directly modify the database.
@@ -41,6 +52,7 @@ For more information see:
4152

4253
- Liquibase [update](https://docs.liquibase.com/commands/update/update.html) command
4354

55+
4456
#### Sample .bat file (MSSQL)
4557
```
4658
C:/tools/liquibase-3.5.5-bin/liquibase.bat ^
@@ -80,6 +92,7 @@ For more information see:
8092

8193
- Liquibase [update-sql](https://docs.liquibase.com/commands/update/update-sql.html) command
8294

95+
8396
#### Sample .bat file (MSSQL)
8497
```
8598
C:/tools/liquibase-3.5.5-bin/liquibase.bat ^
@@ -92,6 +105,7 @@ C:/tools/liquibase-3.5.5-bin/liquibase.bat ^
92105
updateSQL
93106
```
94107

108+
95109
### Sample .sh file (PostgreSQL)
96110
```
97111
#!/bin/sh

0 commit comments

Comments
 (0)