nginstack

Class: DBBackup

@nginstack/engine/lib/database/DBBackup~ DBBackup

new DBBackup(backupFileName, dbServerHost, dbName [, userId] [, password])

Classe responsável por realizar o backup e restauração de uma base.

Parameters:
Name Type Argument Description
backupFileName string

Nome do arquivo de backup.
dbServerHost string

Endereço da base.
dbName string

Nome da base.
userId string <optional>

Nome ou e-mail do usuário na base de dados.
password string <optional>

Password do usuário na base de dados.

Members

<static> DRY_RUN :number

Processa o arquivo sem modificar a base de dados, permitindo validar se o arquivo está íntegro.

Type:
  • number

<static> IGNORE_DUPLICATED_KEYS :number

Indica que chaves duplicadas devem ser ignoradas durante a restauração.

Type:
  • number

<static> IGNORE_EXISTING_TABLES :number

Indica que não serão restaurados os registros de tabelas já existentes no momento da restauração.

Type:
  • number

<static> MERGE_ILOG_TABLE :number

Insere dados da tabela iLog mesclando com a tabela existente, caso haja uma.

Type:
  • number

Methods

backup(ignoredTables)

Realiza o backup da base de dados.

Parameters:
Name Type Description
ignoredTables string

Tabelas que serão ignoradas na geração do backup.

partialBackup(initialLogDate, ignoredTables)

Realiza o backup da base de dados, porém, incluirá os dados da tabela iLog cujo campo iDate seja maior ou igual a initialLogDate.

Parameters:
Name Type Description
initialLogDate Date
ignoredTables string

restore(options)

Restaura uma cópia da base de dados criada previamente pelo método backup.

Importante: sempre que for possível, este método retornará um objeto contendo informações sobre as tabelas restauradas, mesmo que a restauração tenha sido interrompida por um erro. Por esse motivo, as propriedades success e error sempre devem ser verificadas e a ausência do lançamento de um erro não deve ser interpretada como sucesso.

Parameters:
Name Type Description
options number

Opções da restauração. As opções DBBackup.IGNORE_DUPLICATED_KEYS, DBBackup.IGNORE_EXISTING_TABLES, DBBackup.MERGE_ILOG_TABLE e DBBackup.DRY_RUN devem ser combinadas em um número utilizando o operador Bitwise OR (|).
Returns:

Resultado da restauração. Observar a propriedade success para determinar se houve uma falha durante o processo.

Type
RestoreResult
Example
const backup = new DBBackup(path, server, dbName, userId, password);
 const result = backup.restore(DBBackup.MERGE_ILOG_TABLE | DBBackup.DRY_RUN);
 if (!result.success) {
   throw new Error(result.error);
 }