Sumário

• Sumário
  • Descrição
  • Ferramentas
  • Como usar
    • Instalação
    • Configuração
    • Execução

Descrição

Pacote NPM para realizar espelhamento de banco de dados. Útil para testes que precisam de conexão com o banco de dados.

Ferramentas

• [X] NodeJS - v20.17.0
• [X] Yarn - v3.8.5
• [X] TypeScript - v5.6.2
• [X] Knex - v3.1.0

Como usar

Instalação

Instale o pacote no seu projeto como dependência de desenvolvimento com o comando abaixo:

yarn add -D mirror-db
# ou
npm install --save-dev mirror-db

Configuração

Não é necessário muitas configurações, apenas um arquivo que definirá os dados de conexão para o banco de dados que será espelhado e para o banco de dados SQLite que servirá como cópia.

Para proceder, siga os passos abaixo:

1. Na raiz do seu projeto crie um arquivo JSON ou TypeScript com o nome dbmirror.config, você pode fazer isso executando o comando abaixo:

   mirror-db config

   Você pode renomear o arquivo e mudar seu diretório, mas nesse caso será necessário passar seu caminho ao realizar o espelhamento.

Execução

1. Execute o espelhamento com o comando abaixo

   mirror-db

2. Você deve visualizar todos os logs de execução, como no exemplo abaixo:

   > Configuring connections.
   > Configuring base (from) connection.
   > Configuring memory (to) connection.
   > Running in-memory database.
   > In-memory database started successfully.
   > Running base database.
   > Base database started successfully.
   > Checking base database state.
   > Checking in-memory database state.
   > Starting mirror.
   > Checking in-memory database state.
   > Foreign keys disabled.
   > Copying database with copycat method.
   > Fetching table names.
   > 15 tables found.
   > Copying tables.
   > All tables copied.
   > Destroying memory database connection.
   > Destroying base database connection.
   > Foreign keys enabled.

3. Verifique se o arquivo {nome}.sqlite foi criado ou modificado dentro do diretório escolhido.