nginstack

Module: @nginstack/engine/lib/database/Database

Classes

Database

Type Definitions

ArchiveLogFileInfo

Objeto literal contendo informações sobre um arquivo de backup de logs. Cada arquivo corresponde a um dia de arquivamento.

Type:
  • Object
Properties:
Name Type Argument Description
eventKey number <nullable>

Chave do evento registrado na tabela iSysEvent que gerou essas informações. Pode ser um evento de arquivamento ou de restauração. Nulo caso venha de uma restauração com dryRun ativo.
path string

Caminho relativo do arquivo de backup.
storageProvider number <nullable>

Chave do provedor de armazenamento onde o arquivo de backup está armazenado. Se estiver em disco local, o valor deste campo será null.
logDate Date

Data em que os registros de log presentes no arquivo de backup foram originalmente gerados.
archiveDate Date

Data em que o arquivo de backup foi gerado.
recordCount number

Quantidade de registros de log presentes no arquivo de backup.
recordCountPerClassKey Record.<string, number>

Quantidade de registros de log presentes no arquivo de backup, agrupados por chave de classe.
recordCountPerTableName Record.<string, number>

Quantidade de registros de log presentes no arquivo de backup, agrupados por nome de tabela.

ArchiveLogOptionsByTableClass

Type:
  • Object
Properties:
Name Type Argument Description
tableClass number

Chave da classe que define a tabela dos registros aos quais os logs fazem referência. Corresponde ao campo iTableClass da tabela iLog. Somente os registros com esta iTableClass serão arquivados.
includedClasses Array.<number> <optional>

Lista de chaves das classes aos quais os logs fazem referência. Corresponde ao campo iClass da tabela iLog. Caso esta lista seja informada, somente os registros com a iClass presente nesta lista serão arquivados. Possui prioridade de filtro sobre a propriedade excludedClasses.
excludedClasses Array.<number> <optional>

Lista de chaves das classes aos quais os logs fazem referência. Corresponde ao campo iClass da tabela iLog. Caso esta lista seja informada, os registros com a iClass presente nesta lista não serão arquivados. Será desconsiderada caso a propriedade includedClasses seja informada.
retentionInDays number

Quantidade máxima de dias que os registros da tabela iLog devem ter de vida para serem mantidos na base de dados. Todos os registros mais antigos que a quantidade de dias informada, e que seguem os outros filtros informados, serão arquivados.
storageProvider number <optional>

Chave do provedor de armazenamento onde os logs arquivados devem ser armazenados. Caso não seja informado, os logs serão armazenados no disco local, no diretório do Engine em que este método foi executado.
tag string <optional>

Filtra o arquivamento pelo campo iTag dos registros de log.

ArchiveLogOptionsByType

Type:
  • Object
Properties:
Name Type Argument Description
logType number

Chave do tipo de log que deve ser arquivado. Corresponde ao campo iType da tabela iLog. Somente os registros com este iType serão arquivados.
retentionInDays number

Quantidade máxima de dias que os registros da tabela iLog devem ter de vida para serem mantidos na base de dados. Todos os registros mais antigos que a quantidade de dias informada, e que seguem os outros filtros informados, serão arquivados.
storageProvider number <optional>

Chave do provedor de armazenamento onde os logs arquivados devem ser armazenados. Caso não seja informado, os logs serão armazenados no disco local, no diretório do Engine em que este método foi executado.
tag string <optional>

Filtra o arquivamento pelo campo iTag dos registros de log.

DatabaseVersionInfo

Objeto literal contendo informações sobre o servidor de banco de dados e o driver de conexão.

Type:
  • Object
Properties:
Name Type Description
server VersionInfo

Informações de versão do banco de dados.
client VersionInfo

Informações de versão do driver de conexão com o banco.

RestoreLogOptions

Type:
  • Object
Properties:
Name Type Argument Description
retentionInDays number <optional>

Quantidade máxima de dias que os registros restaurados devem permanecer na base de dados. Todos os registros mais antigos que a quantidade de dias informada serão removidos automaticamente no próximo arquivamento. O padrão é 30 dias.
storageProvider number <optional>

Chave do provedor de armazenamento onde o arquivo de backup de logs arquivados está armazenado. Caso não seja informado, a restauração buscará o arquivo no disco local.
dryRun boolean <optional>

Indica se a restauração deve ser feita em modo de simulação, ou seja, sem efetivar as alterações. O valor padrão é false, ou seja, a restauração é efetivada normalmente caso esta opção não seja informada.

VersionInfo

Type:
  • Object
Properties:
Name Type Description
major number

Número da versão principal.
minor number

Número da versão secundária.
name string

Informação de versão para exibição.