-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PR review and edits the the "Add a database" section
Nathan, please review my changes for correctness. Also, please search for NATHAN in the milestone1-step1.md file and address the two issues/questions I call out.
- Loading branch information
Showing
6 changed files
with
55 additions
and
49 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ title: "Milestone 1: Test" | |
|
||
## Overview | ||
|
||
With your [new Database class defined](milestone1-step1.md), Liquibase should be able to run user-defined SQL statements against the database. Give it a try! | ||
With your [new Database class defined](milestone1-step1.md), Liquibase should be able to run user-defined SQL statements on the database. Give it a try! | ||
|
||
## Testing | ||
|
||
|
@@ -24,7 +24,7 @@ create table company (id int not null primary key, name varchar(255)) | |
--rollback drop table company | ||
``` | ||
|
||
and run `liquibase update` against your database using that changelog file. | ||
and run `liquibase update` on your database using that changelog file. | ||
|
||
If there are any failures with creating the databasechangelog table, managing the lock, marking the change sets ran, or anything else. [GOTO step 3](milestone1-step3.md). | ||
|
||
|
@@ -38,12 +38,13 @@ Once `update` works, any Liquibase functionality that doesn't rely on modeled ch | |
|
||
## Next Steps | ||
|
||
If/when you run into problems when testing, [go to step 3](milestone1-step3.md). | ||
If/when you run into problems during testing, [go to step 3](milestone1-step3.md). | ||
|
||
If everything seems to work, Congratulations!! :material-party-popper: Now is a great time to release the first version of your extension. | ||
After releasing, you can move on to [Milestone 2](milestone2-step1.md) to add advanced support. | ||
After releasing, you can proceed to [Milestone 2](milestone2-step1.md) to add advanced support. | ||
|
||
!!! tip | ||
|
||
If you'd like your database extension to be included in the main Liquibase documentation and be a more official part of Liquibase, [contact the Liquibase team](mailto:[email protected]) and we can work | ||
with you to bring it more officially into the fold. | ||
If you'd like your database extension to be included in the main Liquibase documentation and be a more official part of Liquibase, | ||
[contact the Liquibase team](mailto:[email protected]) and we will work with you to make it more visible in documentation | ||
and in the supported databases list. |
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 |
---|---|---|
|
@@ -8,26 +8,27 @@ title: "Milestone 1: Fix & Retest" | |
|
||
The functionality you [tested for milestone 1](milestone1-step2.md) relies on: | ||
|
||
- Create and populate `databasechangeloglock` table | ||
- Create and populate `databasechangelog` table | ||
- Create and populate the `databasechangeloglock` table | ||
- Create and populate the `databasechangelog` table | ||
- Execute user-specified SQL | ||
|
||
## Improving Your Database Support | ||
|
||
The standard [liquibase.changelog.ChangeLogHistoryService](https://javadocs.liquibase.com/liquibase-core/liquibase/changelog/ChangeLogHistoryService.html){:target="_blank"}, | ||
[liquibase.lockservice.LockService](https://javadocs.liquibase.com/liquibase-core/liquibase/lockservice/LockService.html){:target="_blank"}, and [liquibase.executor.Executor](https://javadocs.liquibase.com/liquibase-core/liquibase/executor/Executor.html){:target="_blank"} | ||
implementations which drive that rely on SQL and/or JDBC standards guided by dialect info from your `Database` class. | ||
implementations rely on SQL and/or JDBC standards guided by dialect information from your `Database` class. | ||
|
||
If you run into any problems with those standard services, the most likely fix is overriding additional `liquibase.database.Database` methods to more correctly | ||
describe how your database works. | ||
If you run into any problems with those standard services, the most likely fix is to override additional `liquibase.database.Database` methods to more correctly describe how your database works. | ||
|
||
For example, if the `databasechangeloglock` table isn't being created correctly because your database quotes object names in a special way, override the `escapeObjectName` function. | ||
|
||
The full list of methods you can override can be found in [liquibase.database.Database API](https://javadocs.liquibase.com/liquibase-core/liquibase/database/Database.html){:target="_blank"}. | ||
|
||
!!! tip | ||
|
||
Exactly what you need to override will depend on the actual problems you hit. If you have questions on what it takes to fix your problem, ask [on the forum](https://forum.liquibase.org){:target="_blank"}. | ||
Exactly what you need to override will depend on the actual problems you hit. If you have questions on what | ||
it takes to fix your problem, ask [on the forum](https://forum.liquibase.org){:target="_blank"} or | ||
[contact the Liquibase team](mailto:[email protected]). | ||
|
||
## Advanced Fixes | ||
|
||
|
@@ -43,14 +44,14 @@ Instead, you may need to [override one or more](../add-a-sql-generator.md) of th | |
|
||
## Iterate | ||
|
||
After you have made a potential fix to the problem you found, re-run your test and see if Liquibase is working better. | ||
After you make a potential fix to the problem you found, re-run your test and see if Liquibase is working better. | ||
|
||
- Sometimes your fix didn't work as well as you hoped. Try a new one | ||
- Sometimes your fix resolved one issue, but now you have hit another. Fix that up | ||
- Eventually, you will be done. Congratulations!! :material-party-popper: | ||
|
||
## Next Steps | ||
|
||
With Liquibase working against your database, now is a great time to release the first version of your extension and get feedback. | ||
With Liquibase working for your database, now is a great time to release the first version of your extension and get feedback. | ||
|
||
When you are ready to build advanced support, you can move on to [milestone 2](milestone2-step1.md) | ||
When you are ready to build advanced support, you can start working on [milestone 2](milestone2-step1.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
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