Entendendo os gatilhos<\/h2>\n
Antes de realizar opera\u00e7\u00f5es de manuten\u00e7\u00e3o no seu banco de dados, \u00e9 importante entender as diversas formas como elas podem ser acionadas. Cada gatilho serve a prop\u00f3sitos distintos para facilitar as tarefas de manuten\u00e7\u00e3o. Os tr\u00eas principais gatilhos comumente usados s\u00e3o:<\/p>\n
- \n
- Manual, baseado em API<\/strong>: Esse gatilho permite executar opera\u00e7\u00f5es pontuais usando uma chamada de API. \u00c9 \u00fatil em situa\u00e7\u00f5es como a restaura\u00e7\u00e3o de um backup de banco de dados ou a reconstru\u00e7\u00e3o de \u00edndices quando o desempenho cai repentinamente.<\/li>\n
- Agendamento (como o CRON)<\/strong>: Esse gatilho permite automatizar atividades de manuten\u00e7\u00e3o programadas durante per\u00edodos de baixo tr\u00e1fego de usu\u00e1rios. \u00c9 ideal para executar opera\u00e7\u00f5es com uso intensivo de recursos, como arquivamento e limpeza. Voc\u00ea pode usar pacotes como node-schedule<\/a> para configurar agendamentos no Node.js que acionam opera\u00e7\u00f5es automaticamente quando necess\u00e1rio.<\/li>\n
- Notifica\u00e7\u00f5es de banco de dados<\/strong>: Esse gatilho permite executar opera\u00e7\u00f5es de manuten\u00e7\u00e3o como resposta a altera\u00e7\u00f5es no banco de dados. Por exemplo, quando um usu\u00e1rio publica um coment\u00e1rio em uma plataforma, os dados salvos podem acionar instantaneamente verifica\u00e7\u00f5es de caracteres irregulares, linguagem ofensiva ou emojis. Voc\u00ea pode implementar essa funcionalidade no Node.js usando pacotes como o pg-listen<\/a>.<\/li>\n<\/ul>\n
Pr\u00e9-requisitos<\/h2>\n
Para seguir este guia, voc\u00ea deve ter as seguintes ferramentas em seu computador local:<\/p>\n
- \n
- Git<\/a>: Para gerenciar o controle de vers\u00e3o do c\u00f3digo-fonte do seu aplicativo<\/li>\n
- Node.js<\/a>: para criar seu aplicativo de backend<\/li>\n
- psql<\/a>: Para interagir com seu banco de dados PostgreSQL remoto usando seu terminal<\/li>\n
- PGAdmin<\/a> (opcional): Para interagir com seu banco de dados PostgreSQL remoto usando uma interface gr\u00e1fica de usu\u00e1rio (GUI).<\/li>\n<\/ul>\n
Cria\u00e7\u00e3o e hospedagem de um aplicativo Node.js<\/h3>\n
Vamos configurar um projeto Node.js, fazer o commit dele para o GitHub e configurar um pipeline de implanta\u00e7\u00e3o autom\u00e1tica na Kinsta. Voc\u00ea tamb\u00e9m precisa provisionar um banco de dados PostgreSQL na Kinsta<\/a> para testar suas rotinas de manuten\u00e7\u00e3o nele.<\/p>\n
Comece criando um novo diret\u00f3rio em seu sistema local usando o seguinte comando:<\/p>\n
mkdir node-db-maintenance<\/code><\/pre>\nEm seguida, v\u00e1 para a pasta rec\u00e9m-criada e execute o seguinte comando para criar um novo projeto:<\/p>\n
cd node-db-maintenance\nyarn init -y # or npm init -y<\/code><\/pre>\nIsso inicializa um projeto Node.js para voc\u00ea com a configura\u00e7\u00e3o padr\u00e3o. Agora voc\u00ea pode instalar as depend\u00eancias necess\u00e1rias executando o seguinte comando:<\/p>\n
yarn add express pg nodemon dotenv<\/code><\/pre>\nAqui est\u00e1 uma r\u00e1pida descri\u00e7\u00e3o de cada pacote:<\/p>\n
- \n
express<\/code>: permite que voc\u00ea configure uma API REST baseada em Express.<\/li>\npg<\/code>: permite que voc\u00ea interaja com um banco de dados PostgreSQL por meio do seu aplicativo Node.js.<\/li>\nnodemon<\/code>: permite que a sua build de desenvolvimento seja atualizada \u00e0 medida que voc\u00ea desenvolve o aplicativo, liberando-o da necessidade constante de parar e iniciar o aplicativo cada vez que fizer uma altera\u00e7\u00e3o.<\/li>\ndotenv<\/code>: permite carregar vari\u00e1veis de ambiente de um arquivo .env<\/strong> para seu objetoprocess.env<\/code>.<\/li>\n<\/ul>\nEm seguida, adicione os seguintes scripts ao seu arquivo package.json<\/strong> para poder iniciar seu servidor de desenvolvimento com facilidade, bem como executar o seu servidor em produ\u00e7\u00e3o:<\/p>\n
{\n \/\/ ... \n \"scripts\": {\n \"start-dev\": \"nodemon index.js\",\n \"start\": \"NODE_ENV=production node index.js\"\n },\n \/\/ \u2026\n}<\/code><\/pre>\nAgora voc\u00ea pode criar um arquivo index.js<\/strong> que cont\u00e9m o c\u00f3digo-fonte do seu aplicativo. Cole o seguinte c\u00f3digo no arquivo:<\/p>\n
const express = require(\"express\")\nconst dotenv = require('dotenv');\n\nif (process.env.NODE_ENV !== 'production') dotenv.config();\nconst app = express()\nconst port = process.env.PORT || 3000\n\napp.get(\"\/health\", (req, res) => res.json({status: \"UP\"}))\n\napp.listen(port, () => {\n console.log(`Server running at port: ${port}`);\n});<\/code><\/pre>\nO c\u00f3digo acima inicializa um servidor Express<\/a> e configura vari\u00e1veis de ambiente usando o pacote
dotenv<\/code> se n\u00e3o estiver no modo de produ\u00e7\u00e3o. Tamb\u00e9m configura um caminho\/health<\/code> que retorna um objeto JSON{status: \"UP\"}<\/code>. Por fim, inicia o aplicativo usando a fun\u00e7\u00e3oapp.listen()<\/code> para escutar na porta especificada, com o padr\u00e3o3000<\/code> se nenhuma porta for fornecida por meio da vari\u00e1vel de ambiente.<\/p>\nAgora que voc\u00ea tem um aplicativo b\u00e1sico pronto, inicialize um novo reposit\u00f3rio git com seu provedor git de prefer\u00eancia (BitBucket<\/a>, GitHub<\/a> ou GitLab<\/a>) e envie seu c\u00f3digo. A Kinsta suporta a implanta\u00e7\u00e3o de aplicativos de todos esses provedores git. Para este artigo, vamos usar o GitHub.<\/p>\n
Quando seu reposit\u00f3rio estiver pronto, siga estes passos para implantar seu aplicativo na Kinsta:<\/p>\n
- \n
- Fa\u00e7a login ou crie uma conta para visualizar seu painel MyKinsta<\/a>.<\/li>\n
- Autorize a Kinsta com seu provedor Git.<\/li>\n
- Na barra lateral esquerda, clique em Aplicativos<\/strong>, e da\u00ed em Adicionar aplicativo<\/strong>.<\/li>\n
- Selecione o reposit\u00f3rio e o branch do qual voc\u00ea deseja implantar.<\/li>\n
- Selecione um dos locais de centros de dados dispon\u00edveis na lista de 27 op\u00e7\u00f5es. A Kinsta detecta automaticamente as configura\u00e7\u00f5es de build para seus aplicativos por meio do Nixpacks<\/a>.<\/li>\n
- Escolha os recursos do aplicativo, como RAM e espa\u00e7o em disco.<\/li>\n
- Clique em Criar aplicativo<\/strong>.<\/li>\n<\/ol>\n
Quando a implanta\u00e7\u00e3o estiver conclu\u00edda, copie o link do aplicativo implantado e navegue at\u00e9
\/health<\/code>. Voc\u00ea dever\u00e1 ver o seguinte JSON em seu navegador:<\/p>\n{status: \"UP\"}<\/code><\/pre>\nIsso indica que o aplicativo foi configurado corretamente.<\/p>\n
Configura\u00e7\u00e3o de uma inst\u00e2ncia do PostgreSQL na Kinsta<\/h3>\n
A Kinsta fornece uma interface f\u00e1cil para voc\u00ea provisionar inst\u00e2ncias de banco de dados. Comece criando uma nova conta na Kinsta<\/a>, se voc\u00ea ainda n\u00e3o tiver uma. Em seguida, siga as etapas abaixo:<\/p>\n
- \n
- Fa\u00e7a login em seu painel MyKinsta.<\/li>\n
- Na barra lateral esquerda, clique em Bancos de dados<\/strong>, e ent\u00e3o em Adicionar banco de dados<\/strong>.<\/li>\n
- Selecione PostgreSQL<\/strong> como o tipo de banco de dados e escolha a vers\u00e3o que preferir. Escolha um nome para o seu banco de dados e modifique o nome de usu\u00e1rio e a senha, se desejar.<\/li>\n
- Selecione um local de centro de dados na lista de 27 op\u00e7\u00f5es.<\/li>\n
- Escolha o tamanho do seu banco de dados.<\/li>\n
- Clique em Criar banco de dados<\/strong>.<\/li>\n<\/ol>\n
Depois que o banco de dados for criado, certifique-se de recuperar o host, a porta, o nome de usu\u00e1rio e a senha do banco de dados.<\/p>\n
![\"Credenciais](\"https:\/\/kinqsta.com\/wp-content\/uploads\/2023\/11\/database-credentials-from-kinsta-1024x435.jpg\")
Credenciais de banco de dados geradas pela Kinsta.<\/figcaption><\/figure>\n Voc\u00ea pode ent\u00e3o inserir esses valores na sua CLI do psql (ou na interface do PGAdmin) para gerenciar o banco de dados. Para testar seu c\u00f3digo localmente, crie um arquivo .env<\/strong> no diret\u00f3rio raiz do seu projeto e armazene os seguintes segredos nele:<\/p>\n
DB_USER_NAME=your database user name\nDB_HOST=your database host\nDB_DATABASE_NAME=your database\u2019s name\nDB_PORT=your database port\nPGPASS=your database password<\/code><\/pre>\nAo fazer a implanta\u00e7\u00e3o na Kinsta, voc\u00ea precisa adicionar esses valores como vari\u00e1veis de ambiente<\/a> para a implanta\u00e7\u00e3o do seu aplicativo.<\/p>\n
Para preparar as opera\u00e7\u00f5es de banco de dados, baixe e execute este script SQL<\/a> para criar tabelas (usu\u00e1rios, publica\u00e7\u00f5es, coment\u00e1rios) e inserir dados de amostra. Use o comando abaixo, substituindo os espa\u00e7os reservados por seus dados espec\u00edficos, para adicionar os dados ao seu banco de dados PostgreSQL rec\u00e9m-criado:<\/p>\n
psql -h <host> -p <port> -U <username> -d <db_name> -a -f <sql file e.g. test-data.sql><\/code><\/pre>\nCertifique-se de inserir o nome e o caminho exatos do arquivo no comando acima. A execu\u00e7\u00e3o desse comando solicita que voc\u00ea digite a senha do banco de dados para obter autoriza\u00e7\u00e3o.<\/p>\n
Quando esse comando terminar de ser executado, voc\u00ea estar\u00e1 pronto para come\u00e7ar a escrever opera\u00e7\u00f5es para a manuten\u00e7\u00e3o do seu banco de dados. Sinta-se \u00e0 vontade para enviar seu c\u00f3digo para o seu reposit\u00f3rio Git quando terminar cada opera\u00e7\u00e3o para v\u00ea-lo em a\u00e7\u00e3o na plataforma da Kinsta.<\/p>\n
Escrevendo rotinas de manuten\u00e7\u00e3o<\/h2>\n
Esta se\u00e7\u00e3o explica v\u00e1rias opera\u00e7\u00f5es comumente usadas para a manuten\u00e7\u00e3o de bancos de dados PostgreSQL.<\/p>\n
1. Cria\u00e7\u00e3o de backups<\/h3>\n
O backup regular de bancos de dados \u00e9 uma opera\u00e7\u00e3o comum e essencial. Envolve criar uma c\u00f3pia de todo o conte\u00fado do banco de dados, e armazen\u00e1-la em um local seguro. Esses backups s\u00e3o cruciais para restaurar os dados em caso de perda acidental ou erros que afetem a integridade dos dados.<\/p>\n
Embora plataformas como a Kinsta ofere\u00e7am backups automatizados<\/a> como parte de seus servi\u00e7os, \u00e9 importante saber como configurar uma rotina de backup personalizada, se necess\u00e1rio.<\/p>\n
O PostgreSQL oferece a ferramenta pg_dump<\/a> para criar backups de banco de dados. No entanto, ela precisa ser executada diretamente da linha de comando, e n\u00e3o h\u00e1 um pacote npm para ela. De modo que voc\u00ea precisa usar o pacote @getvim\/execute<\/a> para executar o comando
pg_dump<\/code> no ambiente local do seu aplicativo Node.<\/p>\nInstale o pacote executando o seguinte comando:<\/p>\n
yarn add @getvim\/execute<\/code><\/pre>\nEm seguida, importe o pacote em seu arquivo index.js <\/strong>adicionando esta linha de c\u00f3digo na parte superior:<\/p>\n
const {execute} = require('@getvim\/execute');<\/code><\/pre>\nOs backups s\u00e3o gerados como arquivos no sistema de arquivos local do seu aplicativo Node. Assim, \u00e9 melhor criar um diret\u00f3rio dedicado para eles com o nome backup<\/strong> no diret\u00f3rio raiz do projeto.<\/p>\n
Agora, voc\u00ea pode usar o seguinte caminho para gerar e baixar backups do seu banco de dados quando necess\u00e1rio:<\/p>\n
app.get('\/backup', async (req, res) => {\n\n \/\/ Create a name for the backup file\n const fileName = \"database-backup-\" + new Date().valueOf() + \".tar\";\n\n \/\/ Execute the pg_dump command to generate the backup file\n execute(\"PGPASSWORD=\" + process.env.PGPASS + \" pg_dump -U \" + process.env.DB_USER_NAME \n + \" -d \" + process.env.DB_DATABASE_NAME \n + \" -h \" + process.env.DB_HOST\n + \" -p \" + process.env.DB_PORT\n + \" -f backup\/\" + fileName + \" -F t\"\n\n).then(async () => {\n console.log(\"Backup created\");\n res.redirect(\"\/backup\/\" + fileName)\n }).catch(err => {\n console.log(err);\n res.json({message: \"Something went wrong\"})\n })\n\n})<\/code><\/pre>\nAl\u00e9m disso, voc\u00ea precisa adicionar a seguinte linha no in\u00edcio do seu arquivo index.js<\/strong> depois que o aplicativo Express for inicializado:<\/p>\n
app.use('\/backup', express.static('backup'))<\/code><\/pre>\nIsso permite que a pasta backup<\/strong> seja servida estaticamente usando a fun\u00e7\u00e3o de middleware
express.static<\/code>, permitindo que o usu\u00e1rio baixe os arquivos de backup gerados a partir do aplicativo Node.<\/p>\n - Selecione PostgreSQL<\/strong> como o tipo de banco de dados e escolha a vers\u00e3o que preferir. Escolha um nome para o seu banco de dados e modifique o nome de usu\u00e1rio e a senha, se desejar.<\/li>\n
- Node.js<\/a>: para criar seu aplicativo de backend<\/li>\n
- Agendamento (como o CRON)<\/strong>: Esse gatilho permite automatizar atividades de manuten\u00e7\u00e3o programadas durante per\u00edodos de baixo tr\u00e1fego de usu\u00e1rios. \u00c9 ideal para executar opera\u00e7\u00f5es com uso intensivo de recursos, como arquivamento e limpeza. Voc\u00ea pode usar pacotes como node-schedule<\/a> para configurar agendamentos no Node.js que acionam opera\u00e7\u00f5es automaticamente quando necess\u00e1rio.<\/li>\n