Atualização do sistema
Atualiza todos os módulos e produtos que compõem o sistema, incluindo o Engine. Ele também permite a atualização parcial de produtos, mas essa opção não é recomendada devido à interdependência existente entre os produtos.
A atualização é composta pelas seguintes etapas:
- Atualização dos executáveis do Engine, quando o produto “Engine” é selecionado para atualização.
- Atualização dos scripts de definição do modelo de dados.
- Evolução do esquema do banco de dados, com a criação, alteração e exclusão de tabelas e campos.
- Sincronização dos registros de chave negativa dos produtos selecionados na atualização. A
sincronização insere, atualiza e remove os registros da base de destino, tornando-os iguais aos
da base de origem, exceto nos campos que podem ser alterados pelos usuários, indicados por
meio da propriedade
userCanChangeNegativeKey. - Execução dos scripts de pós-atualização, que podem ajustar configurações e migrar dados para a nova versão.
- Criação e remoção de índices.
A atualização do sistema requer as credenciais de um usuário com permissão aos escopo de autorização “system.update” e “security.externalAccess” na base de dados que será atualizada. Opcionalmente, pode ser utilizado um token de autorização para evitar o uso de credenciais de usuário. Esse token pode ser criado por meio do botão “Criar token de autorização” do processo “Administração do sistema > Atualização > Configuração”.
Objetivo
Realizar atualização dos componentes novos e correções de um ou mais produtos para uma base, dentro da política de segurança configurada para um grupo, papel ou usuário.
O procedimento deve ser realizado a partir do processo “Desenvolvimento > Atualização > Atualização do sistema”.
Fluxo Operacional
Atualização dos aplicativos da base de destino
Inicialmente, será verificado se a base de destino está com o Engine na mesma versão do Engine da base de origem. Caso os Engines estejam com versões diferentes, será feita uma sugestão para atualização imediata. Caso os Engines estejam com versões diferentes e não se deseje fazer uma atualização neste momento, uma última mensagem alertará para o risco que é seguir sem a atualização. Finalmente, caso o usuário opte por continuar sem a atualização, o processo seguirá normalmente nas etapas de atualização do esquema e dos demais registros do banco de dados.
Caso o usuário confirme que deseja atualizar o Engine da base de destino, o processo de atualização irá atualizar e reiniciar o Engine escolhido como destino da atualização e também os outros Engines. Para isso é necessário que todos os Engines servidores daquela base de dados estejam cadastrados no processo “Administração do sistema > Atualização > Endereços de servidores”.
O usuário pode ainda escolher atualizar apenas o Engine destino da atualização, deixando todos os demais Engines para serem atualizados num segundo momento. Para isso, no início da atualização, na grade “Opções da atualização”, deve ser selecionada a opção “Ignorar outros Engines servidores” e, depois de iniciada a atualização, quando questionado se deseja atualizar o Engine da base de destino o usuário deve confirmar a atualização.
Determinando as licenças que serão atualizadas
As licenças serão exibidas na grade de “Produtos Licenciados” e o usuário deve selecionar as que deseja atualizar.
- Atualização para licença custom - Deve ser configurada na base de destino, no cadastro de bases, para permitir que a seleção do produto custom esteja habilitada.
- Opções complementares - As opções são:
- Habilitar contagem de registros.
- Remover produtos não licenciados.
- Executar testes na origem.
Criação de tabelas e campos
Após selecionar as licenças que devem ser criadas, o usuário pode determinar quais tabelas e campos serão criados no banco de dados através das grades que serão exibidas no momento da configuração.
Alteração e exclusão de campos
O usuário pode determinar também quais campos serão alterados ou excluídos no banco de dados. Em casos de alteração, o novo e o antigo tipo do campo serão informados na grade.
Ignorando tabelas, campos e índices
Tabelas, campos ou índices existentes na base de dados e que não estejam definidos no modelo de dados do sistema serão sugeridos para remoção durante uma atualização. Tabelas e campos podem ter sido criados na base de dados para serem utilizados em processos customizados. Índices podem ter sido criados manualmente pelo administrador para otimizar a execução de alguma consulta ou rotina. Para sinalizar que esses elementos são importantes e não devem ser sugeridos para remoção, o administrador do sistema deve cadastrá-los utilizando as classes “Outras tabelas”, “Outras colunas” e “Outros índices”. Registros dessas classes podem ser manipulados pelos processos de mesmo nome localizados em “Desenvolvimento > Base de dados”. Durante a execução da atualização, as grades que exibem as sugestões de remoção possuem botões que permitem que o administrador indique os itens que devem ser ignorados. Ao utilizar esses botões serão criados registros das classes correspondentes.
Apesar de ignorado pelo processo de atualização, uma coluna registrada na classe “Outras colunas” continuará existindo e ocupando recursos de memória e disco no servidor. Por esse motivo é importante que, num momento oportuno, seja avaliado se essa coluna é mesmo relevante para o uso do sistema. Se a coluna for importante ela deve ser definida no modelo de dados, em um arquivo do tipo “x-model” ou “x-class”, e em seguida removida no processo “Outras colunas”, utilizando o botão de remoção da grade.
Criação de índices
Após selecionar as alterações, criações e\ou exclusões, o usuário poderá criar índices no banco de dados no intuito de otimizar as consultas realizadas na base.
Relatório final da atualização
Ao final do processo um relatório é exibido com as versões das licenças atualizadas, campos criados, excluídos e/ou alterados, índices inseridos e/ou excluídos, permissões geradas e diretórios/arquivos órfãos.
Reversão da atualização
Algumas operações realizadas pela atualização não podem ser desfeitas da mesma forma que as alterações de registros, que podem ser revertidas a partir do log transacional. É o caso das evoluções do esquema do banco de dados: a exclusão de um campo, por exemplo, remove os dados que ele continha. Os scripts de pós-atualização também podem migrar dados sem registrar essas alterações no log transacional.
Assim, a reversão completa de uma atualização requer a restauração de um backup do banco de dados feito antes dela, o que não é uma operação trivial. Ela exige uma interrupção do sistema em geral muito superior ao tempo necessário para estabilizar a versão atualizada. Sem a restauração do backup, ela também pode provocar perda de dados.
Por esse motivo, a orientação é sempre concluir a atualização e tratar eventuais problemas por meio de correções. Quando a atualização parte de uma base de homologação validada, a base de destino fica igual à origem em relação aos produtos atualizados. O comportamento validado na homologação passa a ser o mesmo na base de destino, e não há motivo para desfazer a atualização. Problemas que surjam depois dela costumam estar ligados a particularidades do ambiente de produção, como o volume de dados, customizações ou integrações. Eles são resolvidos com mais rapidez e segurança por uma correção do que pela reversão.
É recomendado que exista um backup atualizado do banco de dados antes da atualização, em especial nas atualizações de versões maiores ou quando a base de destino não é atualizada com frequência.
Os procedimentos a seguir descrevem como reverter a atualização caso seja necessário.
Restauração do backup
- Desative todos os Engines.
- Restaure o backup do banco de dados feito imediatamente antes da atualização.
- Retorne os executáveis do Engine à versão anterior em todos os servidores.
- Execute o descarte dos caches de dados e de chaves, conforme descrito no manual Backup e recuperação de dados .
- Reinicie os Engines.
A restauração do backup descarta as alterações feitas pelos usuários depois da atualização.
Atualização a partir de uma base na versão anterior
Também é possível atualizar a base novamente a partir de uma base de origem que esteja na versão anterior. Esse procedimento restaura o Engine e os registros de chave negativa da versão anterior. Essa é uma opção de restauração limitada, pois ela não é capaz de reverter todas as alterações no esquema do banco de dados, nem as migrações de dados feitas pelos scripts de pós-atualização. Ela é indicada apenas em cenários onde não existe um backup da base de dados confiável, que permita a reversão completa da atualização, ou quando a restauração do backup for inviável pelo tempo de parada que ela exige.
Para realizar este procedimento, a base de destino deve estar configurada para aceitar esse tipo de atualização por meio da opção “Permite atualizações de versões anteriores” da configuração das atualizações .
Esse procedimento tem as seguintes limitações:
- As remoções de colunas e tabelas realizadas pela atualização não são desfeitas, e nem todas as alterações feitas pelas rotinas de pós-atualização são revertidas. Por isso, pode ser necessário reconfigurar a base de dados após o downgrade de versão.
- As migrações de dados feitas pelas rotinas de atualização devem ser desfeitas manualmente. Para isso, desfaça as alterações realizadas nas versões indicadas pelo relatório de atualização.