Comprendre les d\u00e9clencheurs<\/h2>\n
Avant de construire des op\u00e9rations de maintenance pour votre base de donn\u00e9es, il est important de comprendre les diff\u00e9rentes fa\u00e7ons dont elles peuvent \u00eatre d\u00e9clench\u00e9es. Chaque d\u00e9clencheur a des fonctions distinctes pour faciliter les t\u00e2ches de maintenance. Les trois principaux d\u00e9clencheurs couramment utilis\u00e9s sont les suivants<\/p>\n
- \n
- Manuel, bas\u00e9 sur l’API <\/strong>: Ce d\u00e9clencheur vous permet d’ex\u00e9cuter des op\u00e9rations ponctuelles \u00e0 l’aide d’un appel API. Il est utile dans des situations telles que la restauration d’une sauvegarde de base de donn\u00e9es ou la reconstruction d’index lorsque les performances chutent soudainement.<\/li>\n
- Planification (comme CRON) <\/strong>: Ce d\u00e9clencheur vous permet d’automatiser les activit\u00e9s de maintenance planifi\u00e9es pendant les p\u00e9riodes de faible trafic utilisateur. Il est id\u00e9al pour ex\u00e9cuter des op\u00e9rations gourmandes en ressources telles que l’archivage et le nettoyage. Vous pouvez utiliser des packages tels que node-schedule<\/a> pour configurer des planifications dans Node.js qui d\u00e9clenchent automatiquement les op\u00e9rations lorsque cela est n\u00e9cessaire.<\/li>\n
- Notifications de base de donn\u00e9es <\/strong>: Ce d\u00e9clencheur vous permet d’effectuer des op\u00e9rations de maintenance en r\u00e9ponse \u00e0 des modifications de la base de donn\u00e9es. Par exemple, lorsqu’un utilisateur publie un commentaire sur une plateforme, les donn\u00e9es enregistr\u00e9es peuvent instantan\u00e9ment d\u00e9clencher des v\u00e9rifications concernant les caract\u00e8res irr\u00e9guliers, le langage offensant ou les emojis. La mise en \u0153uvre de cette fonctionnalit\u00e9 dans Node.js est possible \u00e0 l’aide de packages tels que pg-listen<\/a>.<\/li>\n<\/ul>\n
Pr\u00e9-requis<\/h2>\n
Pour suivre ce guide, vous devez disposer des outils suivants sur votre ordinateur local :<\/p>\n
- \n
- Git<\/a> : Pour g\u00e9rer le contr\u00f4le de version du code source de votre application<\/li>\n
- Node.js<\/a> : pour construire votre application backend<\/li>\n
- psql<\/a> : Pour interagir avec votre base de donn\u00e9es PostgreSQL distante en utilisant votre terminal<\/li>\n
- PGAdmin<\/a> (optionnel) : Pour interagir avec votre base de donn\u00e9es PostgreSQL distante en utilisant une interface utilisateur graphique (GUI).<\/li>\n<\/ul>\n
Cr\u00e9er et h\u00e9berger une application Node.js<\/h3>\n
Mettons en place un projet Node.js, livrons-le sur GitHub et mettons en place un pipeline de d\u00e9ploiement automatique vers Kinsta. Vous devez \u00e9galement provisionner une base de donn\u00e9es PostgreSQL sur Kinsta<\/a> pour y tester vos routines de maintenance.<\/p>\n
Commencez par cr\u00e9er un nouveau r\u00e9pertoire sur votre syst\u00e8me local en utilisant la commande suivante :<\/p>\n
mkdir node-db-maintenance<\/code><\/pre>\nEnsuite, allez dans le dossier nouvellement cr\u00e9\u00e9 et ex\u00e9cutez la commande suivante pour cr\u00e9er un nouveau projet :<\/p>\n
cd node-db-maintenance\nyarn init -y # or npm init -y<\/code><\/pre>\nCeci initialise un projet Node.js pour vous avec la configuration par d\u00e9faut. Vous pouvez maintenant installer les d\u00e9pendances n\u00e9cessaires en ex\u00e9cutant la commande suivante :<\/p>\n
yarn add express pg nodemon dotenv<\/code><\/pre>\nVoici une description rapide de chaque paquet :<\/p>\n
- \n
express<\/code> : vous permet de mettre en place une API REST bas\u00e9e sur Express.<\/li>\npg<\/code> : le paquet REST : vous permet d’interagir avec une base de donn\u00e9es PostgreSQL \u00e0 travers votre application Node.js.<\/li>\nnodemon<\/code> : permet \u00e0 votre build de d\u00e9veloppement d’\u00eatre mis \u00e0 jour au fur et \u00e0 mesure que vous d\u00e9veloppez votre application, vous lib\u00e9rant ainsi du besoin constant d’arr\u00eater et de d\u00e9marrer votre application \u00e0 chaque fois que vous effectuez un changement.<\/li>\ndotenv<\/code> : vous permet de charger des variables d’environnement depuis un fichier .env<\/strong> dans votre objetprocess.env<\/code>.<\/li>\n<\/ul>\nEnsuite, ajoutez les scripts suivants dans votre fichier package.json<\/strong> pour pouvoir d\u00e9marrer facilement votre serveur de d\u00e9veloppement et l’ex\u00e9cuter \u00e9galement en production :<\/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>\nVous pouvez maintenant cr\u00e9er un fichier index.js<\/strong> qui contient le code source de votre application. Collez le code suivant dans le fichier :<\/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>\nCe code initialise un serveur Express<\/a> et configure les variables d’environnement en utilisant le paquetage
dotenv<\/code> si vous n’\u00eates pas en mode production. Il met \u00e9galement en place une route\/health<\/code> qui renvoie un objet JSON{status: \"UP\"}<\/code>. Enfin, il d\u00e9marre l’application \u00e0 l’aide de la fonctionapp.listen()<\/code> pour \u00e9couter sur le port sp\u00e9cifi\u00e9, par d\u00e9faut3000<\/code> si aucun port n’est fourni via la variable d’environnement.<\/p>\nMaintenant que vous avez une application de base pr\u00eate, initialisez un nouveau d\u00e9p\u00f4t git avec votre fournisseur git pr\u00e9f\u00e9r\u00e9 (BitBucket<\/a>, GitHub<\/a>, ou GitLab<\/a>) et poussez votre code. Kinsta prend en charge le d\u00e9ploiement d’applications \u00e0 partir de tous ces fournisseurs git. Pour cet article, nous utiliserons GitHub.<\/p>\n
Lorsque votre d\u00e9p\u00f4t est pr\u00eat, suivez les \u00e9tapes suivantes pour d\u00e9ployer votre application sur Kinsta :<\/p>\n
- \n
- Connectez-vous ou cr\u00e9ez un compte pour afficher votre tableau de bord MyKinsta<\/a>.<\/li>\n
- Autorisez Kinsta avec votre fournisseur Git.<\/li>\n
- Dans la colonne lat\u00e9rale de gauche, cliquez sur Applications<\/strong>, puis sur Ajouter une application<\/strong>.<\/li>\n
- S\u00e9lectionnez le d\u00e9p\u00f4t et la branche \u00e0 partir desquels vous souhaitez effectuer le d\u00e9ploiement.<\/li>\n
- S\u00e9lectionnez l’un des centres de donn\u00e9es disponibles dans la liste des 27 options. Kinsta d\u00e9tecte automatiquement les param\u00e8tres de construction de vos applications via Nixpacks<\/a>.<\/li>\n
- Choisissez les ressources de votre application, telles que la m\u00e9moire vive et l’espace disque.<\/li>\n
- Cliquez sur Cr\u00e9er une application<\/strong>.<\/li>\n<\/ol>\n
Une fois le d\u00e9ploiement termin\u00e9, copiez le lien de l’application d\u00e9ploy\u00e9e et naviguez vers
\/health<\/code>. Vous devriez voir le JSON suivant dans votre navigateur :<\/p>\n{status: \"UP\"}<\/code><\/pre>\nCela indique que l’application a \u00e9t\u00e9 correctement configur\u00e9e.<\/p>\n
Configurer une instance PostgreSQL sur Kinsta<\/h3>\n
Kinsta fournit une interface facile pour provisionner des instances de base de donn\u00e9es. Commencez par cr\u00e9er un nouveau compte Kinsta<\/a> si vous n’en avez pas d\u00e9j\u00e0 un. Ensuite, suivez les \u00e9tapes ci-dessous :<\/p>\n
- \n
- Connectez-vous \u00e0 votre tableau de bord MyKinsta.<\/li>\n
- Dans la colonne lat\u00e9rale de gauche, cliquez sur Bases de donn\u00e9es<\/strong>, puis sur Ajouter une base de donn\u00e9es<\/strong>.<\/li>\n
- S\u00e9lectionnez PostgreSQL<\/strong> comme type de base de donn\u00e9es et choisissez votre version pr\u00e9f\u00e9r\u00e9e. Choisissez un nom pour votre base de donn\u00e9es et modifiez le nom d’utilisateur et le mot de passe si vous le souhaitez.<\/li>\n
- S\u00e9lectionnez un emplacement de centre de donn\u00e9es dans la liste des 27 options.<\/li>\n
- Choisissez la taille de votre base de donn\u00e9es.<\/li>\n
- Cliquez sur Cr\u00e9er une base de donn\u00e9es<\/strong>.<\/li>\n<\/ol>\n
Une fois la base de donn\u00e9es cr\u00e9\u00e9e, veillez \u00e0 r\u00e9cup\u00e9rer l’h\u00f4te, le port, le nom d’utilisateur et le mot de passe de la base de donn\u00e9es.<\/p>\n
![\"Identifiants](\"https:\/\/kinqsta.com\/wp-content\/uploads\/2023\/11\/database-credentials-from-kinsta-1024x435.jpg\")
Identifiants de la base de donn\u00e9es g\u00e9n\u00e9r\u00e9s par Kinsta<\/figcaption><\/figure>\n Vous pouvez ensuite ins\u00e9rer ces valeurs dans votre CLI psql (ou l’interface graphique PGAdmin) pour g\u00e9rer la base de donn\u00e9es. Pour tester votre code localement, cr\u00e9ez un fichier .env<\/strong> dans le r\u00e9pertoire racine de votre projet et stockez-y les secrets suivants :<\/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>\nLors du d\u00e9ploiement sur Kinsta, vous devez ajouter ces valeurs en tant que variables d’environnement<\/a> au d\u00e9ploiement de votre application.<\/p>\n
Pour pr\u00e9parer les op\u00e9rations de base de donn\u00e9es, t\u00e9l\u00e9chargez et ex\u00e9cutez ce script SQL<\/a> pour cr\u00e9er des tables (utilisateurs, messages, commentaires) et ins\u00e9rer des donn\u00e9es d’exemple. Utilisez la commande ci-dessous, en rempla\u00e7ant les espaces r\u00e9serv\u00e9s par vos propres donn\u00e9es, pour ajouter les donn\u00e9es \u00e0 votre base de donn\u00e9es PostgreSQL nouvellement cr\u00e9\u00e9e :<\/p>\n
psql -h <host> -p <port> -U <username> -d <db_name> -a -f <sql file e.g. test-data.sql><\/code><\/pre>\nVeillez \u00e0 saisir le nom et le chemin d’acc\u00e8s exacts du fichier dans la commande ci-dessus. L’ex\u00e9cution de cette commande vous invite \u00e0 saisir le mot de passe de votre base de donn\u00e9es pour autorisation.<\/p>\n
Une fois cette commande ex\u00e9cut\u00e9e, vous \u00eates pr\u00eat \u00e0 \u00e9crire des op\u00e9rations pour la maintenance de votre base de donn\u00e9es. N’h\u00e9sitez pas \u00e0 pousser votre code vers votre d\u00e9p\u00f4t Git lorsque vous avez termin\u00e9 chaque op\u00e9ration pour le voir en action sur la plateforme Kinsta.<\/p>\n
\u00c9crire des routines de maintenance<\/h2>\n
Cette section explique plusieurs op\u00e9rations couramment utilis\u00e9es pour la maintenance des bases de donn\u00e9es PostgreSQL.<\/p>\n
1. Cr\u00e9er des sauvegardes<\/h3>\n
Sauvegarder r\u00e9guli\u00e8rement les bases de donn\u00e9es est une op\u00e9ration courante et essentielle. Elle consiste \u00e0 cr\u00e9er une copie de l’ensemble du contenu de la base de donn\u00e9es, qui est stock\u00e9e dans un endroit s\u00fbr. Ces sauvegardes sont cruciales pour restaurer les donn\u00e9es en cas de perte accidentelle ou d’erreurs affectant l’int\u00e9grit\u00e9 des donn\u00e9es.<\/p>\n
Bien que des plateformes comme Kinsta proposent des sauvegardes automatis\u00e9es<\/a> dans le cadre de leurs services, il est important de savoir comment mettre en place une routine de sauvegarde personnalis\u00e9e si n\u00e9cessaire.<\/p>\n
PostgreSQL propose l’outil pg_dump<\/a> pour cr\u00e9er des sauvegardes de bases de donn\u00e9es. Cependant, il doit \u00eatre ex\u00e9cut\u00e9 directement depuis la ligne de commande, et il n’existe pas de paquetage npm pour cet outil. Vous devez donc utiliser le paquet @getvim\/execute<\/a> pour ex\u00e9cuter la commande
pg_dump<\/code> dans l’environnement local de votre application Node.<\/p>\nInstallez le paquetage en ex\u00e9cutant la commande suivante :<\/p>\n
yarn add @getvim\/execute<\/code><\/pre>\nEnsuite, importez le paquetage dans votre fichier index.js <\/strong>en ajoutant cette ligne de code en haut :<\/p>\n
const {execute} = require('@getvim\/execute');<\/code><\/pre>\nLes sauvegardes sont g\u00e9n\u00e9r\u00e9es sous forme de fichiers sur le syst\u00e8me de fichiers local de votre application Node. Il est donc pr\u00e9f\u00e9rable de cr\u00e9er un r\u00e9pertoire d\u00e9di\u00e9 \u00e0 ces sauvegardes sous le nom de backup<\/strong> dans le r\u00e9pertoire racine du projet.<\/p>\n
Vous pouvez maintenant utiliser la route suivante pour g\u00e9n\u00e9rer et t\u00e9l\u00e9charger des sauvegardes de votre base de donn\u00e9es lorsque cela est n\u00e9cessaire :<\/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>\nVous devez \u00e9galement ajouter la ligne suivante au d\u00e9but de votre fichier index.js<\/strong> apr\u00e8s l’initialisation de l’application Express :<\/p>\n
app.use('\/backup', express.static('backup'))<\/code><\/pre>\nCela permet au dossier backup<\/strong> d’\u00eatre servi statiquement en utilisant la fonction middleware
express.static<\/code>, permettant \u00e0 l’utilisateur de t\u00e9l\u00e9charger les fichiers de sauvegarde g\u00e9n\u00e9r\u00e9s \u00e0 partir de l’application Node.<\/p>\n - S\u00e9lectionnez PostgreSQL<\/strong> comme type de base de donn\u00e9es et choisissez votre version pr\u00e9f\u00e9r\u00e9e. Choisissez un nom pour votre base de donn\u00e9es et modifiez le nom d’utilisateur et le mot de passe si vous le souhaitez.<\/li>\n
- Node.js<\/a> : pour construire votre application backend<\/li>\n
- Planification (comme CRON) <\/strong>: Ce d\u00e9clencheur vous permet d’automatiser les activit\u00e9s de maintenance planifi\u00e9es pendant les p\u00e9riodes de faible trafic utilisateur. Il est id\u00e9al pour ex\u00e9cuter des op\u00e9rations gourmandes en ressources telles que l’archivage et le nettoyage. Vous pouvez utiliser des packages tels que node-schedule<\/a> pour configurer des planifications dans Node.js qui d\u00e9clenchent automatiquement les op\u00e9rations lorsque cela est n\u00e9cessaire.<\/li>\n