Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Version Information Page #6525

Merged
merged 1 commit into from
Mar 26, 2023
Merged

Version Information Page #6525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/development/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Which gives output like:

### Upcoming - UI View

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


Expand Down
16 changes: 15 additions & 1 deletion waltz-schema/src/main/resources/liquibase/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@

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


## About

Liquibase is an open-source database change management tool that allows developers to manage and automate changes to database schemas.
It provides a way to define, track, and execute changes to database structures, such as tables, columns, indexes, and constraints.

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`.
The changelog describes how to migrate the database it to newer versions, and Liquibase ensures that the changes are applied in the correct order.


## Authoring

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


### Change Ids

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



## Updating the database

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


### Executing the changes using Liquibase:

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

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


#### Sample .bat file (MSSQL)
```
C:/tools/liquibase-3.5.5-bin/liquibase.bat ^
Expand Down Expand Up @@ -80,6 +92,7 @@ For more information see:

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


#### Sample .bat file (MSSQL)
```
C:/tools/liquibase-3.5.5-bin/liquibase.bat ^
Expand All @@ -92,6 +105,7 @@ C:/tools/liquibase-3.5.5-bin/liquibase.bat ^
updateSQL
```


### Sample .sh file (PostgreSQL)
```
#!/bin/sh
Expand Down