Mongofly é um starter do Spring Boot para executar scripts do MongoDB. Ele é inspirado na forma de funcionamento do Flyway.
Atualmente o projeto encontra-se apenas no repositório JitPack e funciona em projetos já configurados com o Spring Data MongoDB.
- Spring Boot 2.x
- Spring Data MongoDB
Esse starter utiliza o MongoDB já configurado no projeto para executar os scripts. Por isso é necessário que você já tenha configurado o Spring Data MongoDB no projeto informando qual é o banco e outras informações que forem relevantes ao seu projeto.
Atualmente o Mongofly encontra-se no repostório de projetos JitPack, por isso é necessário ensinar ao seu gerenciador de dependencias que deve buscar bibliotecas de lá também.
No caso do Maven ficará assim:
<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>
E no Gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Para outros gerenciadores de dependencias consultar a página do projeto no JitPack: https://jitpack.io/mongofly
Também é necessário criar uma pasta chamada mongofly no seu classpath (por exemplo src/main/resources/mongofly), onde ficarão armazenados os scripts do MongoDB que devem ser executados. Assim que o projeto for iniciado, o Mongofly irá verificar na collection também chamada mongofly os arquivos que ainda não foram executados com sucesso e executar-los.
Os scripts ficarão dentro da pasta mongofly. A seguir as indicações de como o Mongofly espera estes arquivos.
Os scripts devem ser arquivos do tipo json. Dentro de cada json pode ter um ou muitos comandos do MongoDB.
O nome do arquivo deve seguir a nomeclatura: versao__nome_de_sua_preferencia.json, onde a versão deve sempre iniciar com a letra "v" e seguir com dois underscore _ após a versão. Exemplos de nomes de arquivos válidos seriam:
v1__meu_primeiro_script.json
v2__meu-segundo-script.json
v3__meuTerceiroScript.json
Os arquivos serão executados em ordem crescente de versão e por isso as versões não devem ser repetidas para evitar que sejam executados em uma ordem indesejada.
Apenas são aceitos comandos que utilizam a nomeclatura padrão do MongoDB, as que normalmente se iniciam por "db.collection.operation", por exemplo: db.users.insert(...);
Todo commando deve encerrar com ponto e virgula ;.
Os comandos podem ser separados dentro do arquivo por linhas em branco se assim preferir. Também é permitido usar quebras de linha em um commando para identar o mesmo, não há restrições quanto a formatação dos arquivos.
A seguir um exemplo de conteúdo de um arquivo válido, o arquivo se chama v1__add_users_and_change_felipe_password.json:
db.users.insert({
"name": "Flavio",
"login": "flaviochess",
"password": "123",
"age": 28
});
db.users.insert({
"name": "Jairo",
"login": "jairovsky",
"password": "!@#",
"age": 24
});
db.users.update(
{"login" : "Felipe"},
{$set:
{"password": "mudar@123"}
}
);
Este projeto teve como ideia inicial atender uma demanda pessoal, por isso não foram incluídos todos os comandos existentes no MongoDB até o momento, mas acredito que a cobertura desta biblioteca já atenda uma necessidade em geral. Na versão atual o projeto aceita basicamente insert, insertOne, insertMany, update, updateOne, updateMany, remove, deleteOne, deleteMany e createIndex. Veja a seguir a documentação oficial dos comandos do MongoDB e alguns detalhes extras:
Sempre que o projeto for inciado o Mongofly irá verificar os arquivos da pasta mongofly e verificar quais ainda não foram executados, olhando a collection também de nome mongofly (criada automaticamente). Ao termino da execução de cada arquivo é criado ou atualizado um documento na collection mongofly informando se o arquivo executou com sucesso ou não. Um exemplo seria:
{
"version": 1,
"script": "v1__add_users_and_change_felipe_password.json",
"executedOn": "2019-04-24 16:27:21",
"success": true
}
Se ocorrer um erro, será lançado uma exceção que interromperá o start da aplicação e inserido um documento com o campo success como false. Nestes casos é possível corrigir o script e executar a aplicação novamente. Neste momento o Mongofly irá ignorar os scritps que estão como success = true pois já foram executados com exito e continuará a partir do success = false. Caso agora o script esteja correto, o documento será atualizado para true e continuará a execução dos demais arquivos, se houver.
A collection mongofly será criada apenas após a execução do primeiro arquivo.
- Java 8 - Linguagem de programação
- Spring Boot 2 - Framework de desenvolvimento
- Maven - Gerenciador de dependencias
Para contribuir com este projeto por favor leio o CONTRIBUTING.md para mais detalhes de como o projeto está estruturado, do nosso código de conduta e os processos de como nos enviar pull requests.
Utilizamos SemVer para o versionamento. Para verificiar as versões disponíveis, veja as releases deste repositório.
- Flavio Andrade - Initial work - flaviochess
Veja também a lista de contribuidores que participaram deste projeto.
Este projeto possui a licença Apache License 2.0 - veja o arquivo LICENSE.md para mais detalhes.
- As pessoas que criaram e mantém o driver de MongoDB para Java, cujo é muito bem feito.
- Aos criadores do FlyWay cujo a maneira fácil de gerenciar scripts de banco inspirou este projeto.
- Ao PurpleBooth por seu READEME-Template.