{"componentChunkName":"component---src-templates-blog-post-js","path":"/flyway-java/","result":{"data":{"markdownRemark":{"html":"

Bancos de dados são ferramentas importantíssimas que são utilizadas na construção de aplicações, existem muitas opções de bancos de dados disponíveis e cada uma atende a uma necessidade específica. Com o advento dos microsserviços e a ideia de cada aplicação administrar o seu próprio estado, os bancos de dados confirmam a sua importância.

\n

Mas criar, atualizar e deletar colunas e tabelas não é uma tarefa das mais simples em grandes aplicações ou com cenários complexos, o Flyway surge como uma ferramenta para facilitar as migrações e o versionamento nos bancos de dados.

\n

Contudo o Flyway não é um bala de prata e nem tem a intenção de substituir a função de um DBA, o FLyway é uma ferramenta para nos ajudar no dia-a-dia.

\n

Adicionando o Flyway no projeto

\n

Vou adicionar o Flyway em um projeto que já existe e utiliza o MySQL como repositório de dados.

\n

É uma aplicação Java com Maven então é só adicionar a dependência no pom.xml:

\n
<!-- Flyway -->\n<dependency>\n    <groupId>org.flywaydb</groupId>\n    <artifactId>flyway-core</artifactId>\n</dependency>
\n

Configurando Properties

\n

É necessário configurar os dados de conexão do banco no Flyway. Como estamos usando Spring Boot podemos adicionar isso no arquivo application.yml:

\n
spring:\n  flyway:\n    url: jdbc:mysql://${DATABASE_HOST:localhost}:${DATABASE_PORT:3306}/${DATABASE:register}?createDatabaseIfNotExist=true\n    user: ${DATABASE_USER:root}\n    password: ${DATABASE_PASSWD:root}\n    schemas:\n    - ${DATABASE:register}
\n

Aqui configuramos a url, user, password e o schema que o Flyway irá usar para se conectar no banco de dados.

\n

Adicionando os Scripts

\n

Vamos adicionar os scripts que o Flyway irá rodar, para isso precisamos criar a pasta dentro de resources na nossa aplicação, por padrão o Flyway irá procurar pelo caminho resources/db/migration então basta criar os diretórios e adicionar os scripts.

\n

Outro padrão do Flyway para gerenciamento de versão dos scripts é a convenção de nomenclatura dos arquivos, eles seguem o padrão V seguido do número da versão acompanhado de underline exemplo:

\n

V1_1__meu-script.sql

\n

Para essa aplicação vamos ter dois scripts iniciais, um para criar as tabelas e outro para executar a carga inicial:

\n

V1_0__create_tables.sql:

\n
create table perfil (\n    id integer not null auto_increment,\n    name varchar(255),\n    primary key (id)\n) engine=InnoDB;\n\ncreate table user (\n    id integer not null auto_increment,\n    email varchar(255),\n    pass varchar(255),\n    primary key (id)\n) engine=InnoDB;\n\ncreate table user_perfis (\n    user_id integer not null,\n    perfis_id integer not null,\n    primary key (user_id, perfis_id)\n) engine=InnoDB;\n\nalter table user_perfis add constraint perfil_id_constraint foreign key (perfis_id) references perfil (id);\n\nalter table user_perfis add constraint user_id_constraint foreign key (user_id) references user (id);
\n

V1_1__init.sql:

\n
INSERT INTO register.`user`\n(email, pass)\nVALUES('jonhdoe@email.com', '$2a$10$JgDI7KttG8BX9AO.3mGTref9mjDxHKtx3sjqnaP3Vq88BzUNxA38S');\n\nINSERT INTO register.perfil\n(name)\nVALUES('USER');\n\nINSERT INTO register.perfil\n(name)\nVALUES('ADMIN');\n\nINSERT INTO register.user_perfis\n(user_id, perfis_id)\nVALUES(1, 1);
\n

Executando o Flyway

\n

Quando iniciamos a nossa aplicação o Flyway é automaticamente iniciado e executa os scripts, a saída no console da aplicação é parecido com isso:

\n
INFO 77800 --- [  restartedMain] o.f.c.internal.license.VersionPrinter    : Flyway Community Edition 7.1.1 by Redgate\nINFO 77800 --- [  restartedMain] o.f.c.i.database.base.DatabaseType       : Database: jdbc:mysql://localhost:3306/register (MySQL 8.0)\nINFO 77800 --- [  restartedMain] o.f.core.internal.command.DbValidate     : Successfully validated 2 migrations (execution time 00:00.152s)\nINFO 77800 --- [  restartedMain] o.f.c.i.s.JdbcTableSchemaHistory         : Creating Schema History table `register`.`flyway_schema_history` ...\nINFO 77800 --- [  restartedMain] o.f.core.internal.command.DbMigrate      : Current version of schema `register`: << Empty Schema >>\nINFO 77800 --- [  restartedMain] o.f.core.internal.command.DbMigrate      : Migrating schema `register` to version \"1.0 - create tables\"\nINFO 77800 --- [  restartedMain] o.f.core.internal.command.DbMigrate      : Migrating schema `register` to version \"1.1 - init\"\nINFO 77800 --- [  restartedMain] o.f.core.internal.command.DbMigrate      : Successfully applied 2 migrations to schema `register` (execution time 00:00.625s)
\n

Aqui podemos ver a mensagem de que o script foi executado com sucesso, mas o que acontece se executarmos a nossa aplicação novamente?

\n
INFO 78443 --- [  restartedMain] o.f.c.internal.license.VersionPrinter    : Flyway Community Edition 7.1.1 by Redgate\nINFO 78443 --- [  restartedMain] o.f.c.i.database.base.DatabaseType       : Database: jdbc:mysql://localhost:3306/register (MySQL 8.0)\nINFO 78443 --- [  restartedMain] o.f.core.internal.command.DbValidate     : Successfully validated 2 migrations (execution time 00:00.115s)\nINFO 78443 --- [  restartedMain] o.f.core.internal.command.DbMigrate      : Current version of schema `register`: 1.1\nINFO 78443 --- [  restartedMain] o.f.core.internal.command.DbMigrate      : Schema `register` is up to date. No migration necessary.
\n

Podemos ver que os scripts são validados porém o Flyway consegue gerenciar se o script já foi executado, isso acontece graças a tabela flywayschemahistory que guarda as informações dos scripts executados:

\n
| instaled_rank | version | description   | type | script                  | checksum    | installed_by | installed_on        | execution_time | success |\n|---------------|---------|---------------|------|-------------------------|-------------|--------------|---------------------|----------------|---------|\n| 1             | 1.0     | create tables | SQL  | V1_0__create_tables.sql | 1225588812  | root         | 2021-01-11 17:57:36 | 460            | 1       |\n| 2             | 1.1     | init          | SQL  | V1_1__init.sql          | -1406395169 | root         | 2021-01-11 17:57:36 | 27             | 1       |
\n

Essa tabela trás informações que servem para o Flyway se gerenciar e gerenciar os scripts.

\n

Flyway em um banco já populado

\n

Se adicionarmos o Flyway em uma aplicação que já possui um banco de dados populado ocorrerá um erro, mas podemos resolver isso com uma configuração simples no application.yml:

\n
spring:\n  flyway:\n    baseline-on-migrate: true
\n

Código fonte

\n

Segue o código no GitHub

","fields":{"slug":"/flyway-java/"},"frontmatter":{"date":"11 de janeiro de 2021","description":"Adicionando o Flyway na aplicação para automatizar o banco de dados","title":"Versionando o banco de dados com Flyway","tags":["Flyway","Spring Boot","Banco de Dados","Java"],"author":"Guilherme Alves","image":{"id":"60864dc3-518a-5457-9beb-a21e8d4e0e00","publicURL":"/static/fcb10b58f3511682b601cdfd150b3350/flyway-java.png","childImageSharp":{"fluid":{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB/Ca1DAAAACXBIWXMAAAsSAAALEgHS3X78AAAB0klEQVQoz3VTa2/aMBTNz98f6KdO+7BqEn1o+1QBrWhR2TSpCptaUCnhkSJKQpeRJ3nZcU5tE0Ko2itZyr32PT7H50YBjzzP5drGNn9b+2i/uqdUE0JIeZAxJmuu6yKKoh1QUaeGAaLrmzrbgStbsCRJZLNt2+UF4tvzPFiWhSzLBCJEGzGXcD9/QTqZ7hgWRCSgaFosDPi+L0F0fvNgMIDjOFC7XYxGY3lhGU86woMDsNnTJuesS4bj8QSqKppGkqGmjXDT6aDVaqHX62HCWTSbFxg8PoKmCUwvQXvsYNjXoWtzqM8BaMZKpkqapqCUyoKQdd1uy3VxeYnVaiNfnDFME0kcC2Vo9pf41jUxWcUw3QisYo6CSojH//Wzg/b1FXr3d4WlbOcuX7ec0cnfJT7VNbSG/2H4acX5wpSEZrjRLNzNXTxMuYz+EC+2DytIEaYUcztEQjLZGExnsP85sFMG3XRhrYK9UZKATkhwfm+iwaWc/TFQUxc46y5w9HuG2u2cy4olP8EwPD1F+PUI68NDkEYd0fGxrO+5TLlLjM+SFxN4ESmMy+Vjv/hJKVc0BLUTBN9/YH1ex5qbta439oZ7b7Df+yuqec7NYWGI92Ir+RW10kRG1YJ2rgAAAABJRU5ErkJggg==","aspectRatio":1.7582417582417582,"src":"/static/fcb10b58f3511682b601cdfd150b3350/5cd30/flyway-java.png","srcSet":"/static/fcb10b58f3511682b601cdfd150b3350/c67b7/flyway-java.png 320w,\n/static/fcb10b58f3511682b601cdfd150b3350/d3930/flyway-java.png 640w,\n/static/fcb10b58f3511682b601cdfd150b3350/5cd30/flyway-java.png 689w","sizes":"(max-width: 689px) 100vw, 689px"}}}},"timeToRead":5}},"pageContext":{"slug":"/flyway-java/","previous":{"fields":{"slug":"/kafka-producer-avro/"},"frontmatter":{"title":"Produzindo mensagens com Kafka e Schema Registry","date":"01 jan, 2021"}},"next":{"fields":{"slug":"/kafka-consumer/"},"frontmatter":{"title":"Consumindo mensagens do Kafka sem dor de cabeça","date":"18 jan, 2021"}}}},"staticQueryHashes":["63159454"]}