Leveraging Open Source for Database Development: Database Version Control with Liquibase
1 like436 views
This document provides a comprehensive overview of Liquibase, a tool for database change management that allows tracking changes, rolling back versions, and managing database updates using changesets. It includes practical examples, installation instructions, and best practices for managing database scripts and data. Additionally, it discusses the commands used during the demo and links to various documentation resources.
![8Copyright © 2016 Oracle and/or its affiliates. All rights reserved.
Changelog Master
{
"databaseChangeLog": [
{"include": {"file":"changelog/db.changelog-1.json"}}
]
}](https://image.slidesharecdn.com/leveragingopensourcefordatabasedevelopment-liquibase-161129140655/85/Leveraging-Open-Source-for-Database-Development-Database-Version-Control-with-Liquibase-8-320.jpg)
![9Copyright © 2016 Oracle and/or its affiliates. All rights reserved.
ChangeSet
{"databaseChangeLog": [
{"preConditions": [{
"runningAs": {
"username": "lb_demo"
}
}]
},
{"changeSet": {
"id": "1",
"author": "BlaineCarter",
"changes": [
{"createTable": {
"tableName": "lb_person",
"columns": [
{"column": {
"name": "id",
"type": "int",
"autoIncrement": true,
"constraints": {
"primaryKey": true,
"nullable": false
…...](https://image.slidesharecdn.com/leveragingopensourcefordatabasedevelopment-liquibase-161129140655/85/Leveraging-Open-Source-for-Database-Development-Database-Version-Control-with-Liquibase-9-320.jpg)
![21Copyright © 2016 Oracle and/or its affiliates. All rights reserved.
Load Data From a File
"changes": [
{
"loadData": {
"file": "changelog/groups.csv",
"schemaName": "lb_demo",
"tableName": "lb_groups"
}
}]
groups.csv
name,description
Trucks,People who like trucks
Rockets,People who like rockets
Horses,People who like horses
Snakes,People who like snakes](https://image.slidesharecdn.com/leveragingopensourcefordatabasedevelopment-liquibase-161129140655/85/Leveraging-Open-Source-for-Database-Development-Database-Version-Control-with-Liquibase-21-320.jpg)
Leveraging Open Source for Database Development: Database Version Control with Liquibase
- 1. Copyright © 2014 Oracle and/or its affiliates. All rights reserved. |
- 2. 2Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Howdy, I’m Blaine Carter Oracle Developer Advocate for Open Source Oracle Corporation Email: [email protected] Twitter: @OraBlaineOS Blog: learncodeshare.net Team: community.oracle.com/docs/DOC-917690
- 3. 3Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Database Script Management – The Hard Way MasterCreate directory: RunAllVer5.sql CreateLB_Groups.sql CreateLB_People.sql LoadLB_GroupsData.sql Update4to5 directory: UpdateAllVer4to5.sql AddColGroupsRules.sql AddColPeopleFavorite_color.sql Problems: Which script has been run? Update or Rollback to a specific version? Test data? → LoadTestData.sql?
- 4. Copyright © 2016 Oracle and/or its affiliates. All rights reserved. 4 Leveraging Open Source for Oracle Database Development Liquibase Cross platform database change management. http://www.liquibase.org/ https://github.com/liquibase/liquibase Blaine Carter
- 5. 5Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Version Control / Change Management Basics: ● Track changes. ● Rollback / Switch to a specific revision. ● Branch / Merge - http://www.liquibase.org/development/branches.html ● Diffs
- 6. 6Copyright © 2016 Oracle and/or its affiliates. All rights reserved. What is Liquibase? Liquibase is change management for your database. ● Database changes are made using changeSets. ● When you run an update, the changeSets are run in order. ● Liquibase tracks what has been run, when and who ran it. ● You can roll back to a specific version. ● Populate default and/or test data. ● Contexts - http://www.liquibase.org/documentation/contexts.html ● Diffs - http://www.liquibase.org/documentation/diff.html ● Documentation - http://www.liquibase.org/documentation/dbdoc.html ● SQL Output - http://www.liquibase.org/documentation/sql_output.html ● Offline - http://www.liquibase.org/documentation/offline.html
- 7. 7Copyright © 2016 Oracle and/or its affiliates. All rights reserved. How Does It Work?
- 8. 8Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Changelog Master { "databaseChangeLog": [ {"include": {"file":"changelog/db.changelog-1.json"}} ] }
- 9. 9Copyright © 2016 Oracle and/or its affiliates. All rights reserved. ChangeSet {"databaseChangeLog": [ {"preConditions": [{ "runningAs": { "username": "lb_demo" } }] }, {"changeSet": { "id": "1", "author": "BlaineCarter", "changes": [ {"createTable": { "tableName": "lb_person", "columns": [ {"column": { "name": "id", "type": "int", "autoIncrement": true, "constraints": { "primaryKey": true, "nullable": false …...
- 10. 10Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Java Command Line java $JAVA_OPTS -jar /opt/liquibase/liquibase.jar --driver=oracle.jdbc.OracleDriver --classpath="/usr/lib/oracle/12.1/client64/lib/ojdbc7.jar" --url=jdbc:oracle:thin:lb_demo/dd@dbaccess --changeLogFile=changelog/db.changelog-master.json updateSQL >> output.sql options --logLevel=DEBUG --logFile=liquibase.logFile $JAVA_OPTS is used for my Oracle Exadata Express cloud connection.
- 11. 11Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Properties File (liquibase.properties) driver: oracle.jdbc.OracleDriver classpath: /usr/lib/oracle/12.1/client64/lib/ojdbc7.jar url: jdbc:oracle:thin:lb_demo/dd@dbaccess changeLogFile: changelog/db.changelog-master.json
- 12. 12Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Liquibase Best Recommended Practices http://www.liquibase.org/bestpractices.html Ignore the directory structure I’m using in the demo’s.
- 13. 13Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Software We’ll Be Using • SQL Developer • Oracle Exadata Express Cloud Database or Virtual Box • Liquibase - http://www.liquibase.org
- 14. 14Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Install Download - http://www.liquibase.org/download/index.html Install – It's just Java, extract it and go.
- 15. 15Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Enough blah blah, let's see it.
- 16. 16Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Create Changelog and ChangeSet Files Changelog Example: http://www.liquibase.org/quickstart.html - step 1 Changeset Example: http://www.liquibase.org/quickstart.html - step 2 Recommended to only perform one change per Change set, but you can do more if you need.
- 17. 17Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Run It http://www.liquibase.org/quickstart.html - step 3 Jar File: java $JAVA_OPTS -jar /opt/liquibase/liquibase.jar updateSQL Shell Script: /opt/liquibase/liquibase updateSQL Batch File: c:toolsliquibaseliquibase.bat updateSQL Put the Liquibase directory in your path and run it: liquibase update The shell script / batch files use the same JAVA_OPTS environment variable for my cloud connection.
- 18. 18Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Rollback X Number of Change Sets Warning: Rolling back anything in the database can be tricky. Be very careful if you ever do this in Production. liquibase rollbackCount 1
- 19. 19Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Tag a Changeset You can tag a changeset in the file: "changeSet": { "id": "1", "author": "BlaineCarter", "tagDatabase": {"tag":"ver-1"}, "changes": [ You can also use the command line: liquibase tag ver-1
- 20. 20Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Rollback to Tag http://www.liquibase.org/documentation/rollback.html liquibase rollback ver-1 Other Options: http://www.liquibase.org/documentation/command_line.html
- 21. 21Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Load Data From a File "changes": [ { "loadData": { "file": "changelog/groups.csv", "schemaName": "lb_demo", "tableName": "lb_groups" } }] groups.csv name,description Trucks,People who like trucks Rockets,People who like rockets Horses,People who like horses Snakes,People who like snakes
- 22. 22Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Insert Data "changes": [ { "insert": { "schemaName": "lb_demo", "tableName": "lb_people", "columns": [ { "column": { "name": "firstname", "value": "Bob" } }, { "column": { "name": "lastname", "value": "Trucker" } } ...
- 23. 23Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Context Test In the change set: "changeSet": { "id": "loadData-example", "author": "liquibase-docs", "context": "test", Liquibase.properties contexts: !test Command Line overrides the properties file: liquibase --contexts=test update Context vs Labels http://www.liquibase.org/2014/11/contexts-vs-labels.html
- 24. 24Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Data Changes Are NOT Automatically Rolled Back. Define your own Rollback { "rollback": { "delete": { "tableName": "lb_people" } } }
- 25. 25Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Diff http://www.liquibase.org/documentation/diff.html Command Line: liquibase.sh --driver=oracle.jdbc.OracleDriver --url=jdbc:oracle:thin:lb_demo/dd@unknownDB diff --referenceUrl=jdbc:oracle:thin:lb_demo/dd@goodDB Liquibase.properties: referenceUrl: jdbc:oracle:thin:lb_diff_demo/dd@dbaccess
- 26. 26Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Generate Changelog (Reverse Engineer) http://www.liquibase.org/documentation/generating_changelogs.html Note that this command currently has some limitations. It does not export the following types of objects: Stored procedures, functions, packages & Triggers liquibase --changeLogFile=generated.json generateChangeLog
- 27. 27Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Review The Output The output won’t be perfect. Generated by update: id INTEGER GENERATED BY DEFAULT AS IDENTITY NOT NULL Generated by generateChangeLog: ID NUMBER(*, 0) DEFAULT "LB_DEMO"."ISEQ$$_69966".nextval NOT NULL
- 28. 28Copyright © 2016 Oracle and/or its affiliates. All rights reserved. DBDoc http://www.liquibase.org/documentation/dbdoc.html liquibase DBDoc docs
- 29. 29Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Extensions / Plugins https://liquibase.jira.com/wiki/display/CONTRIB/LiquiBase+Extensions+Portal
- 30. 30Copyright © 2016 Oracle and/or its affiliates. All rights reserved. We Can Make It Better • Github – Repo – Fork – Change – Pull Request – Not just code • https://github.com/liquibase/liquibase • https://github.com/liquibase/liquibase/blob/master/LICENSE.txt
- 31. 31Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Thank You, Now Go Out And Try It. Oracle Developer Advocate for Open Source Oracle Corporation Email: [email protected] Twitter: @OraBlaineOS Blog: learncodeshare.net Team: community.oracle.com/docs/DOC-917690
- 32. 32Copyright © 2016 Oracle and/or its affiliates. All rights reserved. Commands Used For The Demo (by slide number) #17 liquibase updateSQL liquibase update #18 liquibase rollbackCount 1 liquibase update #19 liquibase update liquibase tag myCoolTag #20 liquibase rollback ver-1 liquibase update #21 liquibase update #23 liquibase --contexts=test update #24 liquibase rollbackCount 2 liquibase rollbackCount 1 liquibase --contexts=test rollbackCount 2 liquibase --contexts=test update #25 liquibase diff liquibase --diffTypes=tables,columns diff liquibase diffChangeLog #26 liquibase --changeLogFile=generated.json generateChangeLog #28 liquibase dropAll liquibase DBDoc docs liquibase update liquibase DBDoc docs