{"id":43380,"date":"2024-02-15T08:55:04","date_gmt":"2024-02-15T08:55:04","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=43380"},"modified":"2024-02-15T08:55:05","modified_gmt":"2024-02-15T08:55:05","slug":"what-is-flyway-and-use-cases-of-flyway","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/what-is-flyway-and-use-cases-of-flyway\/","title":{"rendered":"What is Flyway and use cases of Flyway?"},"content":{"rendered":"\n

What is Flyway ?<\/h2>\n\n\n
\n
\"\"
What is Flyway <\/em><\/strong><\/figcaption><\/figure>\n<\/div>\n\n\n

Flyway is an open-source database migration tool that helps you manage schema changes in a safe and repeatable way. It’s designed to be vendor-neutral, working across various database platforms like MySQL, PostgreSQL, Oracle, and more. Flyway uses version control best practices to track and apply database migrations in a controlled and automated manner.<\/p>\n\n\n\n

Here’s what Flyway offers:<\/p>\n\n\n\n

    \n
  • Versioned migrations:<\/strong> Each change to your database schema is represented as a migration script with a version number. This allows you to track the evolution of your database and easily roll back to previous versions if needed.<\/li>\n\n\n\n
  • Repeatable deployments:<\/strong> Flyway ensures that migrations are applied in the correct order consistently across different environments, like development, testing, and production. This helps avoid inconsistencies and potential issues.<\/li>\n\n\n\n
  • Automatic checksums:<\/strong> Flyway verifies the integrity of migration scripts before applying them, ensuring you’re applying the correct version and avoiding unexpected changes.<\/li>\n\n\n\n
  • Flexible scripting:<\/strong> You can write migration scripts in various languages like SQL, PL\/SQL, and T-SQL, depending on your database platform.<\/li>\n\n\n\n
  • Integration with CI\/CD pipelines:<\/strong> Flyway can be easily integrated into your continuous integration and continuous delivery (CI\/CD) pipeline, allowing you to automate database schema changes along with code deployments.<\/li>\n<\/ul>\n\n\n\n

    Top 10 use cases of Flyway ?<\/h2>\n\n\n\n

    Top 10 Use Cases of Flyway:<\/p>\n\n\n\n

      \n
    1. Managing schema changes in complex applications:<\/strong> Flyway helps manage complex applications with frequent database schema changes, ensuring a controlled and organized evolution.<\/li>\n\n\n\n
    2. Maintaining consistency across environments:<\/strong> Flyway ensures your database schemas are consistent across development, testing, and production environments, avoiding discrepancies and potential errors.<\/li>\n\n\n\n
    3. Rolling back changes easily:<\/strong> If you encounter issues after a migration, Flyway allows you to easily roll back to a previous version, minimizing downtime and impact.<\/li>\n\n\n\n
    4. Automating database deployments:<\/strong> Integrate Flyway with your CI\/CD pipeline to automate database schema changes alongside code deployments, streamlining the process and reducing manual intervention.<\/li>\n\n\n\n
    5. Collaboration and version control:<\/strong> Flyway promotes collaboration among developers by tracking changes and allowing for easy review and rollback of migrations.<\/li>\n\n\n\n
    6. Improved database governance:<\/strong> Flyway helps enforce database schema versioning and change management policies, leading to better governance and control.<\/li>\n\n\n\n
    7. Reduced risk of errors:<\/strong> By automating migrations and verifying checksums, Flyway helps minimize the risk of human errors and unexpected changes.<\/li>\n\n\n\n
    8. Supports diverse database platforms:<\/strong> Flyway’s vendor-neutral approach provides flexibility to use it with different database platforms, avoiding vendor lock-in.<\/li>\n\n\n\n
    9. Open-source and community-driven:<\/strong> Flyway is an open-source project with an active community, offering access to resources and support.<\/li>\n\n\n\n
    10. Scalability and performance:<\/strong> Flyway is designed to handle large databases and complex migrations efficiently.<\/li>\n<\/ol>\n\n\n\n

      Whether you’re working on a small project or a large-scale enterprise application, Flyway can be a valuable tool to manage your database schema changes effectively and efficiently.<\/p>\n\n\n\n

      What are the feature of Flyway ?<\/h2>\n\n\n\n

      Now, Let\u2019s explore the features of Flyway<\/strong>, a popular database migration tool:<\/p>\n\n\n\n

        \n
      1. Version Control for Databases<\/strong>:\n
          \n
        • Flyway enables version control for your database schema.<\/li>\n\n\n\n
        • You can track changes over time, making it easier to manage and deploy updates.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
        • Simple and Reliable<\/strong>:\n
            \n
          • Flyway follows the \u201cplain old SQL\u201d approach.<\/li>\n\n\n\n
          • No proprietary XML formats or complex configurations.<\/li>\n\n\n\n
          • It just works, with zero required dependencies.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
          • Convention Over Configuration<\/strong>:\n
              \n
            • Flyway encourages convention over configuration.<\/li>\n\n\n\n
            • It simplifies the setup process and decreases boilerplate code.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
            • SQL and Java Migrations<\/strong>:\n
                \n
              • Write migrations in plain SQL or Java.<\/li>\n\n\n\n
              • SQL migrations support database-specific syntax (e.g., PL\/SQL, T-SQL).<\/li>\n<\/ul>\n<\/li>\n\n\n\n
              • Automated Deployment Pipeline<\/strong>:\n
                  \n
                • Flyway integrates seamlessly into your deployment pipeline.<\/li>\n\n\n\n
                • From version control to continuous delivery, it automates database development.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                • Change Reports and Drift Detection<\/strong>:\n
                    \n
                  • Flyway provides change reports to track modifications.<\/li>\n\n\n\n
                  • Detect drift between your database schema and expected state.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                  • Migration Script Auto-Generation<\/strong>:\n
                      \n
                    • Flyway can generate migration scripts based on changes detected in your schema.<\/li>\n\n\n\n
                    • Saves time and ensures consistency.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                    • Schema Comparison and Static Data Versioning<\/strong>:\n
                        \n
                      • Compare schemas between databases.<\/li>\n\n\n\n
                      • Version static data alongside schema changes.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                      • Built-in Git Client<\/strong>:\n
                          \n
                        • Flyway includes a Git client for seamless integration with version control.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                        • Technical Support and Enterprise Features<\/strong>:\n
                            \n
                          • Flyway offers different editions (Community, Teams, and Enterprise).<\/li>\n\n\n\n
                          • Enterprise includes advanced features like migration script auto-generation, drift detection, and SQL code standard checks.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n

                            Flyway extends DevOps to your databases, accelerating software delivery while ensuring quality code! \ud83d\ude80\ud83d\uddc4\ufe0f<\/p>\n\n\n\n

                            How Flyway works and Architecture?<\/h2>\n\n\n
                            \n
                            \"\"
                            Flyway works and Architecture<\/em><\/strong><\/figcaption><\/figure>\n<\/div>\n\n\n

                            Flyway<\/strong> is a powerful database migration tool that simplifies managing and applying changes to your database schema. Let\u2019s explore how it works and its architecture:<\/p>\n\n\n\n

                              \n
                            1. Schema History Table<\/strong>:\n
                                \n
                              • When you point Flyway to an empty database, it looks for its schema history table<\/strong>.<\/li>\n\n\n\n
                              • If not found, Flyway creates it. This table tracks the state of the database.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                              • Scanning for Migrations<\/strong>:\n
                                  \n
                                • Flyway scans the filesystem or classpath for migration scripts (written in SQL or Java).<\/li>\n\n\n\n
                                • Migrations are sorted by their version number and applied in order.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                • Applying Migrations<\/strong>:\n
                                    \n
                                  • Each migration is executed within a single database transaction.<\/li>\n\n\n\n
                                  • The schema history table is updated to reflect the applied migrations.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                  • Versioned vs. Repeatable Migrations<\/strong>:\n
                                      \n
                                    • Versioned migrations have unique versions and are applied exactly once.<\/li>\n\n\n\n
                                    • Repeatable migrations are re-applied whenever their checksum changes.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                    • Upgrading to Newer Versions<\/strong>:\n
                                        \n
                                      • Create a new migration with a higher version number.<\/li>\n\n\n\n
                                      • Flyway detects it and upgrades the database accordingly.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                      • Maven Plugin Integration<\/strong>:\n
                                          \n
                                        • Use the Flyway Maven plugin to perform database migrations.<\/li>\n\n\n\n
                                        • Configure it via the <configuration><\/code> tag in your pom.xml<\/code>.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                        • Other Configuration Options<\/strong>:\n
                                            \n
                                          • Configure Flyway using Maven properties or an external .conf<\/code> file.<\/li>\n\n\n\n
                                          • Specify database credentials, schemas, and other properties.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n

                                            Flyway automates database evolution, making it easy to manage schema changes reliably! \ud83d\ude80\ud83d\uddc4\ufe0f<\/p>\n\n\n\n

                                            How to Install Flyway it?<\/h2>\n\n\n\n

                                            Now, Let\u2019s find how to install Flyway<\/strong>, a powerful database schema change management tool:<\/p>\n\n\n\n

                                              \n
                                            1. Download Flyway<\/strong>:\n
                                                \n
                                              • Visit the official Flyway website to download the Flyway distribution.<\/li>\n\n\n\n
                                              • Select the accurate version for your operating system (Windows, macOS, or Linux).<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                              • Extract the Archive<\/strong>:\n
                                                  \n
                                                • Once downloaded, extract the Flyway archive to a local directory.<\/li>\n\n\n\n
                                                • You\u2019ll find the Flyway executable and necessary files inside.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                                • Set Up Environment Variables (Optional)<\/strong>:\n
                                                    \n
                                                  • Add the Flyway installation directory to your system\u2019s PATH environment variable.<\/li>\n\n\n\n
                                                  • This step ensures you can run Flyway from any location in the command prompt or terminal.<\/li>\n<\/ul>\n<\/li>\n\n\n\n
                                                  • Verify Installation<\/strong>:\n
                                                      \n
                                                    • Open a terminal or command prompt.<\/li>\n\n\n\n
                                                    • Type flyway --version<\/code> and press Enter.<\/li>\n\n\n\n
                                                    • If successful, you\u2019ll see the Flyway version information.<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n\n\n\n

                                                      That\u2019s it! You\u2019ve successfully installed Flyway. Now you\u2019re ready to manage your database schema changes with ease. \ud83d\ude80\ud83d\uddc4\ufe0f<\/p>\n\n\n\n

                                                      Basic Tutorials of Flyway: Getting Started<\/h2>\n\n\n
                                                      \n
                                                      \"\"
                                                      Basic Tutorials of Flyway<\/em><\/strong><\/figcaption><\/figure>\n<\/div>\n\n\n

                                                      This step-by-step guide will introduce you to Flyway’s basic functionalities through a simple example. We’ll focus on the Community Edition, but note that some features mentioned here might only be available in the Teams Edition.<\/p>\n\n\n\n

                                                      1. Prerequisites:<\/strong><\/p>\n\n\n\n

                                                        \n
                                                      • Java Runtime Environment (JRE):<\/strong> Download and install if not already present.<\/li>\n\n\n\n
                                                      • Database:<\/strong> Choose a compatible database like MySQL, PostgreSQL, or Oracle. Set up your database and user credentials.<\/li>\n\n\n\n
                                                      • Flyway download:<\/strong> Download the Flyway Community Edition from https:\/\/flywaydb.org\/. Extract the downloaded archive.<\/li>\n<\/ul>\n\n\n\n

                                                        2. Project Setup:<\/strong><\/p>\n\n\n\n

                                                          \n
                                                        • Create a new project directory.<\/li>\n\n\n\n
                                                        • Inside the project directory, create a file named flyway.conf<\/code> (configuration file).<\/li>\n\n\n\n
                                                        • In flyway.conf<\/code>, add the following basic configuration details:<\/li>\n<\/ul>\n\n\n
                                                          # Database connection details<\/span>\nurl=your_database_url\nuser=your_database_user\npassword=your_database_password\n\n# Database schema<\/span>\nschemas=public<\/span>\n\n# Placeholders for migration scripts<\/span>\nlocations=filesystem:migrations\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
                                                          Replace placeholders with your actual database details and desired location for migration scripts (usually a folder named migrations<\/code>).<\/p>\n\n\n\n
                                                          3. Create Initial Migration:<\/strong><\/p>\n\n\n\n
                                                            \n
                                                          • Create a new folder named migrations<\/code> under your project directory.<\/li>\n\n\n\n
                                                          • Inside migrations<\/code>, create a file named V1__create_users_table.sql<\/code>. The V1__<\/code> prefix indicates the version number.<\/li>\n\n\n\n
                                                          • Add the following SQL script to create a users<\/code> table:<\/li>\n<\/ul>\n\n\n\n
                                                            SQL<\/p>\n\n\n
                                                            CREATE TABLE users (\n  id SERIAL PRIMARY KEY,\n  username VARCHAR(255<\/span>) NOT NULL<\/span> UNIQUE,\n  email VARCHAR(255<\/span>) NOT NULL<\/span> UNIQUE\n);\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
                                                            4. Run Flyway Migration:<\/strong><\/p>\n\n\n\n
                                                              \n
                                                            • Open a terminal and navigate to your project directory.<\/li>\n\n\n\n
                                                            • Run the following command to execute the migration:<\/li>\n<\/ul>\n\n\n
                                                              flyway migrate\n<\/code><\/span><\/pre>\n\n\n
                                                              Flyway will connect to your database, detect the migration script, and apply it. You can check your database to confirm the users<\/code> table creation.<\/p>\n\n\n\n
                                                              5. Add Another Migration:<\/strong><\/p>\n\n\n\n
                                                                \n
                                                              • Create a new file named V2__add_password_column.sql<\/code> within the migrations<\/code> folder.<\/li>\n\n\n\n
                                                              • Add the following SQL script to add a password<\/code> column to the users<\/code> table:<\/li>\n<\/ul>\n\n\n\n
                                                                SQL<\/p>\n\n\n
                                                                ALTER TABLE users ADD password VARCHAR(255<\/span>) NOT NULL<\/span>;\n<\/code><\/span>Code language:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
                                                                  \n
                                                                • Run flyway migrate<\/code> again to apply this new migration.<\/li>\n<\/ul>\n\n\n\n
                                                                  6. Additional Notes:<\/strong><\/p>\n\n\n\n
                                                                    \n
                                                                  • You can add multiple migration scripts with unique version prefixes to manage schema evolution gradually.<\/li>\n\n\n\n
                                                                  • Flyway offers various commands for advanced tasks like checking migration status, rolling back changes, and more.<\/li>\n\n\n\n
                                                                  • Consider using a version control system like Git to track your migration scripts alongside your codebase for better management and collaboration.<\/li>\n<\/ul>\n\n\n\n
                                                                    This basic tutorial provides a starting point for using Flyway.<\/p>\n","protected":false},"excerpt":{"rendered":"
                                                                    What is Flyway ? Flyway is an open-source database migration tool that helps you manage schema changes in a safe and repeatable way. It’s designed to be vendor-neutral, working across various database platforms like MySQL, PostgreSQL, Oracle, and more. Flyway uses version control best practices to track and apply database migrations in a controlled and…<\/p>\n","protected":false},"author":41,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"_kad_post_classname":"","_joinchat":[],"footnotes":""},"categories":[2],"tags":[],"class_list":["post-43380","post","type-post","status-publish","format-standard","hentry","category-uncategorised"],"_links":{"self":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/43380","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/users\/41"}],"replies":[{"embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/comments?post=43380"}],"version-history":[{"count":1,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/43380\/revisions"}],"predecessor-version":[{"id":43398,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/posts\/43380\/revisions\/43398"}],"wp:attachment":[{"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/media?parent=43380"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/categories?post=43380"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.devopsschool.com\/blog\/wp-json\/wp\/v2\/tags?post=43380"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}