nginstack

Class: UpdateOptions

@nginstack/devops/lib/update/UpdateOptions~ UpdateOptions

new UpdateOptions( [updateType])

Opções de uma atualização do sistema.

Parameters:
Name Type Argument Description
updateType DBKey | number <optional>

Chave que identifica o tipo de atualização nos eventos do sistema. Utilize um dos valores definidos em module:@nginstack/devops/keys/UpdateTypes.

Members

allowExclusiveProducts :boolean

Em uma atualização de sistema, desabilita a validação de apenas efetuar a atualização se os produtos da base destino também estiverem licenciados na base origem.

Type:
  • boolean
Default Value:
  • false

disableDatabaseSchemaUpdate :boolean

Desativa a atualização do esquema da base de dados. Quando esta opção está ativa, os comandos DDL de modificação do esquema de dados serão apenas apresentados ao usuário e devem ser executados pelo DBA diretamente no SGBD.

Todos os comandos de criação e alteração de tabelas devem ser executados no momento em que eles forem relacionados pelo processo de atualização. A não execução desses comandos pode afetar a integridade da base de dados atualizada, pois as colunas e tabelas não existentes serão ignoradas durante o sincronismo de registros.

Type:
  • boolean

disableEngineRestart :boolean

Em uma atualização de Engine, indica que não deve ser solicitado o reinício do Engine servidor da base de destino após sua atualização.

Desativar o reinício do Engine no processo de atualização pode provocar erros, pois podem existir dependências com as melhorias existentes apenas na nova versão do Engine. Utilize essa opção apenas quando tiver algum outro fluxo alternativo que atualize o Engine de forma separada antes da atualização do sistema.

Type:
  • boolean

disableEngineUpdate :boolean

Em uma atualização de sistema ou de produtos, indica que o Engine não deve ser atualizado.

Desativar a atualização do Engine no processo de atualização pode provocar erros, pois pode haver dependências de melhorias existentes apenas na nova versão do Engine. Utilize essa opção apenas quando tiver algum outro fluxo alternativo que atualize o Engine de forma separada antes da atualização do sistema.

Type:
  • boolean
Default Value:
  • false

ignoreOtherEngineServers :boolean

Durante uma atualização de sistema ou de produtos, indica que os Engines servidores, cadastrados em "Admin > Servidores > Engines Servidores", não devem ser atualizados.

Type:
  • boolean

ignoreSystemRequirements :boolean

Indica que os requisitos mínimos de sistema que não foram satisfeitos devem ser ignorados.

Caso não seja informado será considerado o valor padrão falso, indicando que o processo de atualização não deve ser iniciado. Caso seja informado como verdadeiro as falhas de verificação serão registradas como avisos no relatório final do processo.

Type:
  • boolean

messageComplement :string

Complemento que deve ser adicionado na mensagem final de resultado da atualização.

Útil para adicionar detalhes sobre operações que foram realizados fora do processo de atualização, mas relacionadas a ela.

Type:
  • string

onlineIndexCreation :boolean|null

Determina se os índices devem ser criados de forma online, sem bloquear a consulta ou alteração dos registros da tabela indexada.

O recurso de criação de índices online ou concorrentemente é suportado pelo PostgreSQL e pela versão Enterprise do Oracle e do Microsoft SQL Server. A ativação dessa funcionalidade em versões dos SGBDs que não tenham esse recurso disponível provocará erros na criação dos índices.

Quando esta propriedade não é informada, seu valor será null e indicará que a criação dos índices deve ser online sempre que o SGBD suportar esse recurso.

Type:
  • boolean | null

onlineIndexDrop :boolean|null

Determina se os índices devem ser removidos de forma online, sem bloquear a consulta ou alteração dos registros da tabela indexada.

O recurso de remoção de índices online ou concorrentemente é suportado pelo PostgreSQL e pela versão Enterprise do Oracle e do Microsoft SQL Server. A ativação dessa funcionalidade em versões dos SGBDs que não tenham esse recurso disponível provocará erros na remoção dos índices.

Quando esta propriedade não é informada, seu valor será null e indicará que a remoção dos índices deve ser online sempre que o SGBD suportar esse recurso.

Type:
  • boolean | null

preserveUnlicensedProducts :boolean

Indica que os registros associados a produtos não licenciados do sistema devem ser preservados.

Por padrão os produtos não licenciados são removidos, pois a permanência deles pode afetar a integridade do sistema. Produtos não licenciados não são atualizados e suas configurações podem ficar defasadas em relação às modificações realizadas nos demais produtos, podendo provocar erros de integridade na configuração do modelo de dados.

Type:
  • boolean

products :Array.<(DBKey|number)>

Em uma atualização de sistema, indica quais as chaves do produtos que devem ser atualizados. Caso não seja informado, serão atualizados todos os produtos que estejam licenciados na base destino da atualização.

Se um produto licenciado na base destino não estiver licenciado na origem, será gerado um erro. O objetivo dessa validação é evitar que a base destino seja atualizada com uma versão inferior do produto contido na origem. Essa validação pode ser desligada por meio da propriedade allowExclusiveProducts.

Type:
  • Array.<(DBKey|number)>

recipients :string

Lista separada por vírgula dos destinatários do email com o resultado da atualização do sistema.

Type:
  • string

sourceAuthToken :string

Token de autorização da base de origem da atualização. Pode ser informado no lugar de nome e senha de usuário da base de origem.

Type:
  • string
Default Value:
  • ''

sourceDBName :string

Nome da base de dados origem da atualização. Caso não seja informado, será considerada a mesma base que está executando a atualização.

Type:
  • string
Default Value:
  • ''

sourcePassword :string

Senha do usuário na base origem da atualização. É requirido apenas quando #sourceUserName é informado.

Type:
  • string
Default Value:
  • ''

sourceServer :string

Endereço do servidor origem da atualização. Caso não seja informado, será considerada o mesmo servidor que está executando a atualização.

Type:
  • string
Default Value:
  • ''

sourceUserName :string

Nome do usuário na base origem da atualização. Caso não seja informado, será considerado o usuário corrente da sessão em execução.

Type:
  • string
Default Value:
  • ''

targetAuthToken :string

Token de autorização da base que receberá a atualização. Pode ser informado no lugar de nome e senha de usuário da base destino.

Type:
  • string
Default Value:
  • ''

targetDBName :string

Nome da base de dados que receberá a atualização.

Type:
  • string

targetPassword :string

Senha do usuário na base que receberá a atualização.

Type:
  • string

targetServer :string

Endereço do servidor que receberá a atualização.

Type:
  • string

targetUserName :string

Nome do usuário na base que receberá a atualização.

Type:
  • string

trackingId :string

Identificador único que deve ser utilizado para rastrear as alterações realizadas pelo processo de atualização. O valor informado será gravado na coluna iTag dos registros da tabela iLog.

Type:
  • string

updateType :number|null

Chave do tipo de atualização realizada.

Será um dos valores definidos em module:@nginstack/devops/keys/UpdateTypes.

Type:
  • number | null

Methods

getProductDataSetFilter()

Obtém uma instância de ProductDataSetFilter a partir das configurações informadas dos produtos e origem da atualização. Na primeira execução será criada uma nova instância que será reutilizada nas demais chamadas a este método.

Returns:
Type
ProductDataSetFilter

getSourceConnection()

Obtém uma instância de Connection a partir das configurações informadas da origem da atualização. Na primeira execução será criada uma nova instância que será reutilizada nas demais chamadas a este método.

Returns:
Type
Connection

getSourceDatabase()

Obtém uma instância de Database a partir das configurações informadas da origem da atualização. Na primeira execução será criada uma nova instância que será reutilizada nas demais chamadas a este método.

Returns:
Type
Database

getTargetConnection()

Obtém uma instância de Connection a partir das configurações informadas do destino da atualização. Na primeira execução será criada uma nova instância que será reutilizada nas demais chamadas a este método.

Returns:
Type
Connection

getTargetDatabase()

Obtém uma instância de Database a partir das configurações informadas do destino da atualização. Na primeira execução será criada uma nova instância que será reutilizada nas demais chamadas a este método.

Returns:
Type
Database

newSourceConnection()

Cria uma instância de Connection a partir das configurações informadas da origem da atualização.

Returns:
Type
Connection

newSourceDatabase()

Cria uma instância de Database a partir das configurações informadas da origem da atualização.

Returns:
Type
Database

newTargetConnection()

Cria uma instância de Connection a partir das configurações informadas do destino da atualização.

Returns:
Type
Connection

newTargetDatabase()

Cria uma instância de Database a partir das configurações informadas do destino da atualização.

Returns:
Type
Database

toJSON()

Cria uma representação das opções da atualização para serem serializadas em um JSON.

Returns:
Type
Object

validate()

Verifica se todas as opções requeridas foram informadas e se os valores informados estão corretos.