A Schema Migration Tool for the Neo4j Database

1. © 2022 Neo4j, Inc. All rights reserved.
A Schema Migration Tool for the
Neo4j Database
Brad Tumy, Pavel Kutáč,
DX, BE developer

2. © 2022 Neo4j, Inc. All rights reserved.
2
Agenda
● Overview
● Before the migration tool
● With the migration tool
● Rollout & Rollback schema
● How the tool works
● Standalone or containerized
● Closing

3. © 2022 Neo4j, Inc. All rights reserved.
Overview
3
Database Schema Migrations …
“Pleaseworkpleaseworkpleasework
pleaseworkpleaseworkpleasework”
The Programmer’s Prayer

4. © 2022 Neo4j, Inc. All rights reserved.
© 2022 Neo4j, Inc. All rights reserved.
4
Before the migration tool
Release process:
• Easy to make
mistakes
• Requires many
manual steps
• DB architect
knows all
credentials

5. © 2022 Neo4j, Inc. All rights reserved.
© 2022 Neo4j, Inc. All rights reserved.
5
With migration tool
• Release process:
• Fully
automated
• Anyone can do
release after
PR approval
• No need to
share DB
credentials

6. © 2022 Neo4j, Inc. All rights reserved.
Rollout & Rollback schema
6

7. © 2022 Neo4j, Inc. All rights reserved.
© 2022 Neo4j, Inc. All rights reserved.
7
Example of DOWN file
Example of UP file

8. © 2022 Neo4j, Inc. All rights reserved.
How tool works
8

9. © 2022 Neo4j, Inc. All rights reserved.
Using the tool as a binary
• Execution:
◦ From local computer
◦ From CI/CD pipeline
◦ Your own servers
◦ …
9

10. © 2022 Neo4j, Inc. All rights reserved.
Using the tool with Neo4j docker image
• Replace entrypoint
• Expose HTTP server to:
◦ Start or Stop Neo4j DB
◦ Query current schema version
◦ Migrate to different schema version
◦ Delete everything and insert fresh data
• Local development & CI/CD pipeline
• Not suitable for production
10

11. © 2022 Neo4j, Inc. All rights reserved.
In closing …
• Key Takeaways:
◦ Simplifies releases
◦ Adheres to principle of least privilege (DBA doesn’t need to know all
credentials)
◦ Reduces errors
• What else?
◦ It’s open source: github.com/indykite/neo4j-graph-tool
◦ Come see it in action at our IndyKite booth!
11

12. © 2022 Neo4j, Inc. All rights reserved.
12
Thank you!
Pavel Kutáč
Brad Tumy