Astro DB
Astro DB est une base de données SQL entièrement gérée conçue pour l’écosystème Astro. Développez localement dans Astro et déployez vers n’importe quelle base de données compatible libSQL.
Astro DB est une solution complète pour configurer, développer et interroger vos données. Une base de données locale est créée dans .astro/content.db
chaque fois que vous exécutez astro dev
pour gérer vos données sans avoir besoin de Docker ou d’une connexion réseau.
Installation
Titre de la section InstallationInstallez l’intégration @astrojs/db
à l’aide de la commande intégrée astro add
:
Définir votre base de données
Titre de la section Définir votre base de donnéesL’installation de @astrojs/db
avec la commande astro add
créera automatiquement un fichier db/config.ts
dans votre projet où vous définirez vos tables de base de données :
Dans Astro DB, les données sont stockées dans des tables SQL. Les tables structurent vos données en lignes et en colonnes, où les colonnes imposent le type de chaque valeur de ligne.
Définissez vos tables dans votre fichier db/config.ts
en fournissant la structure des données de votre base de données libSQL existante ou les données que vous collecterez dans une nouvelle base de données. Cela permettra à Astro de générer une interface TypeScript pour interroger cette table à partir de votre projet. Le résultat est une prise en charge complète de TypeScript lorsque vous accédez à vos données avec la saisie semi-automatique des propriétés et la vérification des types.
Pour configurer une table de base de données, importez et utilisez les utilitaires defineTable()
et column
depuis astro:db
. Ensuite, définissez un nom (sensible à la casse) pour votre table et le type de données dans chaque colonne.
Cet exemple configure une table Comment
avec les colonnes de texte requises pour author
et body
et la rend disponible pour votre projet via l’exportation defineDb()
.
Colonnes
Titre de la section ColonnesAstro DB prend en charge les types de colonnes suivants :
Références des tables
Titre de la section Références des tablesLes relations entre les tables sont un modèle courant dans la conception des bases de données. Par exemple, une table Blog
peut être en relation étroite avec d’autres tables Comment
, Author
, et Category
.
Vous pouvez définir ces relations entre les tables et les enregistrer dans votre schéma de base de données à l’aide de colonnes de référence. Pour établir une relation, vous aurez besoin de :
- Une colonne identifiant de la table référencée. Il s’agit généralement d’une colonne
id
avec la propriétéprimaryKey
. - Une colonne sur la table de base pour stocker l’
id
référencé. Celle-ci utilise la propriétéreferences
pour établir une relation.
Cet exemple montre que la colonne authorId
d’une table Comment
fait référence à la colonne id
d’une table Author
.
Alimentez votre base de données pour le développement
Titre de la section Alimentez votre base de données pour le développementEn cours de développement, Astro utilisera la configuration de votre base de données pour générer des types locaux en fonction de vos schémas. Ces derniers seront générés à partir de votre fichier de départ à chaque démarrage du serveur de développement et vous permettront d’interroger et de travailler avec la forme de vos données avec la sûreté du typage et la saisie semi-automatique.
Vous n’aurez pas accès aux données de production pendant le développement, sauf si vous vous connectez à une base de données distante pendant le développement. Cela protège vos données tout en vous permettant de tester et de développer avec une base de données fonctionnelle et la sûreté du typage.
Pour introduire des données de développement à des fins de test et de débogage dans votre projet Astro, créez un fichier db/seed.ts
. Importez à la fois l’objet db
et vos tables définies dans astro:db
. Puis insérez des données initiales dans chaque table. Ces données de développement doivent correspondre à la forme de votre schéma de base de données et de vos données de production.
L’exemple suivant définit deux lignes de données de développement pour une table Comment
et une table Author
:
Votre serveur de développement redémarrera automatiquement votre base de données chaque fois que ce fichier sera modifié, en régénérant vos types et en initialisant ces données de développement à partir de seed.ts
à chaque fois.
Connecter une base de données libSQL pour la production
Titre de la section Connecter une base de données libSQL pour la productionAstro DB peut se connecter à n’importe quelle base de données libSQL locale ou à n’importe quel serveur qui expose le protocole distant libSQL, qu’il soit géré ou auto-hébergé.
Pour connecter Astro DB à une base de données libSQL, définissez les variables d’environnement suivantes obtenues auprès de votre fournisseur de base de données :
ASTRO_DB_REMOTE_URL
: l’URL de connexion à l’emplacement de votre base de données libSQL locale ou distante. Cela peut inclure des options de configuration d’URL telles que la synchronisation et le chiffrement en tant que paramètres.ASTRO_DB_APP_TOKEN
: le jeton d’authentification de votre serveur libSQL. Ceci est nécessaire pour les bases de données distantes et n’est pas nécessaire pour les bases de données locales comme les fichiers ou les bases de données en mémoire.
Selon votre service, vous pouvez avoir accès à une interface CLI ou à une interface Web pour récupérer ces valeurs. La section suivante illustre la connexion à Turso et la définition de ces valeurs à titre d’exemple, mais vous êtes libre d’utiliser n’importe quel fournisseur.
Premiers pas avec Turso
Titre de la section Premiers pas avec TursoTurso est l’entreprise à l’origine de libSQL, le fork open source de SQLite qui alimente Astro DB. Ils fournissent une plate-forme de base de données libSQL entièrement gérée et sont entièrement compatibles avec Astro.
Les étapes ci-dessous vous guideront tout au long du processus d’installation de Turso CLI, de connexion (ou d’inscription), de création d’une nouvelle base de données, d’obtention des variables d’environnement requises et de transmission du schéma à la base de données distante.
-
Installez le CLI de Turso.
-
Connectez-vous ou inscrivez-vous à Turso.
-
Créez une nouvelle base de données. Dans cet exemple, le nom de la base de données est
andromeda
. -
Exécutez la commande
show
pour voir les informations sur la base de données nouvellement créée :Copiez la valeur
URL
et définissez-la comme valeur pourASTRO_DB_REMOTE_URL
. -
Créez un nouveau jeton pour authentifier les requêtes vers la base de données :
Copiez la sortie de la commande et définissez-la comme valeur pour
ASTRO_DB_APP_TOKEN
. -
Transférez vos schéma et métadonnées de base de données vers la nouvelle base de données Turso.
-
Félicitations, vous avez maintenant une base de données connectée ! Accordez-vous une pause. 👾
Pour découvrir davantage de fonctionnalités de Turso, consultez la documentation de Turso.
Connexion à des bases de données distantes
Titre de la section Connexion à des bases de données distantesAstro DB vous permet de vous connecter à des bases de données locales et distantes. Par défaut, Astro utilise un fichier de base de données local pour les commandes dev
et build
, recréant des tables et insérant des données de développement à chaque fois.
Pour vous connecter à une base de données distante hébergée, utilisez l’indicateur --remote
. Celui-ci permet un accès en lecture et en écriture à votre base de données distante, ce qui vous permet d’accepter et de conserver les données utilisateur dans les environnements de production.
Bien que les connexions à distance soient généralement possibles avec n’importe quelle plateforme de déploiement utilisant le mode de rendu statique ou serveur, il existe actuellement certaines limitations. Les environnements d’exécution non-Node comme Cloudflare et Deno ne prennent actuellement pas en charge les bases de données sur les routes rendues par le serveur lors de l’utilisation de libSQL. La prise en charge de ces plateformes est prévue pour une implémentation future.
Configurez votre commande de construction pour utiliser l’indicateur --remote
:
Vous pouvez également utiliser l’indicateur directement dans la ligne de commande :
Soyez prudent lorsque vous utilisez --remote
en développement. Cela entraîne la connexion à votre base de données de production en direct et toutes les modifications (insertions, mises à jour, suppressions) seront conservées.
L’indicateur --remote
utilise la connexion à la base de données distante à la fois localement pendant la construction et sur le serveur. Assurez-vous de définir les variables d’environnement nécessaires à la fois dans votre environnement de développement local et sur votre plateforme de déploiement.
Lors du déploiement de votre projet Astro DB, assurez-vous que la commande de construction de votre plate-forme de déploiement est définie sur npm run build
(ou l’équivalent pour votre gestionnaire de packages) pour utiliser l’indicateur --remote
configuré dans votre fichier package.json
.
Options de configuration d’URL distantes
Titre de la section Options de configuration d’URL distantesLa variable d’environnement ASTRO_DB_REMOTE_URL
configure l’emplacement de votre base de données ainsi que d’autres options telles que la synchronisation et le chiffrement.
Schéma d’URL et hôte
Titre de la section Schéma d’URL et hôtelibSQL prend en charge HTTP et WebSockets comme protocole de transport pour un serveur distant. Il prend également en charge l’utilisation d’un fichier local ou d’une base de données en mémoire. Ceux-ci peuvent être configurés à l’aide des schémas d’URL suivants dans l’URL de connexion :
memory:
utilisera une base de données en mémoire. L’hôte doit être vide dans ce cas.file:
utilisera un fichier local. L’hôte est le chemin d’accès au fichier (file:path/to/file.db
).libsql:
utilisera un serveur distant via le protocole préféré par la bibliothèque (cela peut être différent selon les versions). L’hôte est l’adresse du serveur (libsql://your.server.io
).http:
utilisera un serveur distant via HTTP.https:
peut être utilisé pour activer une connexion sécurisée. L’hôte est le même que pourlibsql:
.ws:
utilisera un serveur distant via WebSockets.wss:
peut être utilisé pour activer une connexion sécurisée. L’hôte est le même que pourlibsql:
.
Les détails de la connexion libSQL (par exemple, la clé de chiffrement, la réplication, l’intervalle de synchronisation) peuvent être configurés comme paramètres de requête dans l’URL de connexion à distance.
Par exemple, pour qu’un fichier local chiffré fonctionne comme une réplique intégrée sur un serveur libSQL, vous pouvez définir les variables d’environnement suivantes :
L’utilisation d’un fichier de base de données est une fonctionnalité avancée et des précautions doivent être prises lors du déploiement pour éviter de remplacer votre base de données et de perdre vos données de production.
De plus, cette méthode ne fonctionnera pas dans les déploiements sans serveur, car le système de fichiers n’est pas conservé dans ces environnements.
encryptionKey
Titre de la section encryptionKeylibSQL prend en charge nativement les bases de données chiffrées. La transmission de ce paramètre de recherche activera le chiffrement à l’aide de la clé donnée :
syncUrl
Titre de la section syncUrlLes répliques intégrées sont une fonctionnalité des clients libSQL qui crée une copie synchronisée complète de votre base de données sur un fichier local ou en mémoire pour des lectures ultra-rapides. Les écritures sont envoyées vers une base de données distante définie sur syncUrl
et synchronisées avec la copie locale.
Utilisez cette propriété pour transmettre une URL de connexion distincte afin de transformer la base de données en une réplique intégrée d’une autre base de données. Cela ne doit être utilisé qu’avec les schémas file:
et memory:
. Le paramètre doit être codé au format URL.
Par exemple, pour avoir une réplique intégrée en mémoire d’une base de données sur libsql://votre.server.io
, vous pouvez définir l’URL de connexion comme suit :
syncInterval
Titre de la section syncIntervalIntervalle en secondes entre les synchronisations de répliques intégrées. Par défaut, la synchronisation se fait uniquement au démarrage et après les écritures.
Cette propriété n’est utilisée que lorsque syncUrl
est également définie. Par exemple, pour configurer une réplique intégrée en mémoire afin qu’elle se synchronise toutes les minutes, définissez la variable d’environnement suivante :
Interrogez votre base de données
Titre de la section Interrogez votre base de donnéesVous pouvez interroger votre base de données depuis n’importe quelle page Astro ou endpoint ou action de votre projet en utilisant l’ORM db
et le constructeur de requêtes fourni.
Drizzle ORM
Titre de la section Drizzle ORMAstro DB comprend un client intégré Drizzle ORM. Il n’y a pas d’installation ou de configuration manuelle requise pour utiliser le client. Le client Astro DB db
est automatiquement configuré pour communiquer avec votre base de données (locale ou distante) lorsque vous lancez Astro. Il utilise la définition exacte de votre schéma de base de données pour des requêtes SQL avec sûreté du typage et des erreurs TypeScript lorsque vous référencez une colonne ou une table qui n’existe pas.
Sélectionner
Titre de la section SélectionnerL’exemple suivant sélectionne toutes les lignes d’une table Comment
. Cela renvoie le tableau complet des données de développement provenant de db/seed.ts
, qui est alors disponible pour être utilisé dans votre modèle de page :
select()
de l’API Drizzle pour un aperçu complet.
Insérer
Titre de la section InsérerPour accepter les entrées de l’utilisateur, comme le traitement des demandes de formulaire et l’insertion de données dans votre base de données hébergée à distance, configurez votre projet Astro pour un rendu à la demande (EN) et ajoutez un adaptateur (EN) pour votre environnement de déploiement.
Cet exemple insère une ligne dans une table Comment
sur la base d’une requête POST de formulaire analysée :
Vous pouvez également utiliser Astro Actions pour insérer des données dans une table Astro DB. L’exemple suivant insère une ligne dans une table Comment
à l’aide d’une action :
Consultez la [référence insert()
de l’API Drizzle] (https://orm.drizzle.team/docs/insert) pour une vue d’ensemble complète.
Supprimer
Titre de la section SupprimerVous pouvez également interroger votre base de données à partir d’un point de terminaison d’API. Cet exemple supprime une ligne d’une table Comment
par le paramètre id
:
Consultez la référence delete()
de l’API Drizzle pour un aperçu complet.
Filtrage
Titre de la section FiltragePour rechercher les résultats d’une table en fonction d’une propriété spécifique, utilisez les options Drizzle pour les sélections partielles. Par exemple, ajoutez un appel à .where()
à votre requête select()
et passez la comparaison que vous voulez faire.
L’exemple suivant recherche toutes les lignes d’une table Comment
qui contiennent l’expression « Astro DB ». Utilisez l’opérateur like()
pour vérifier si une phrase est présente dans le body
:
Utilitaires de Drizzle
Titre de la section Utilitaires de DrizzleTous les utilitaires Drizzle permettant de construire des requêtes sont exposés à partir du module astro:db
. Cela inclut :
- Opérateurs de filtre comme
eq()
etgt()
- Les aides à l’agrégation comme
count()
- L’aide
sql
pour écrire des requêtes SQL brutes
Les relations
Titre de la section Les relationsVous pouvez interroger des données liées provenant de plusieurs tables à l’aide d’une liaison SQL. Pour créer une requête de liaison, ajoutez un opérateur de liaison à votre déclaration db.select()
. Chaque fonction accepte une table à l’origine de la liaison et une condition pour faire correspondre les lignes entre les deux tables.
Cet exemple utilise une fonction innerJoin()
pour faire la liaison entre les auteurs de Commentaires
et leurs informations Author
sur la base de la colonne authorId
. Cette fonction retourne un tableau d’objets avec chaque ligne Author
et Comment
comme propriétés de premier niveau :
Voir la référence de liaison Drizzle pour tous les opérateurs de liaison disponibles et les options de configuration.
Transactions par paquets
Titre de la section Transactions par paquetsToutes les requêtes de bases de données distantes sont effectuées sous la forme d’une requête réseau. Vous pouvez avoir besoin de regrouper les requêtes en une seule transaction lorsque vous effectuez un grand nombre de requêtes, ou de procéder à des retours en arrière automatiques en cas d’échec d’une requête.
Cet exemple permet de lancer plusieurs lignes en une seule requête à l’aide de la méthode db.batch()
:
Voir la documentation Drizzle db.batch()
pour plus de détails.
Envoi des modifications vers votre base de données
Titre de la section Envoi des modifications vers votre base de donnéesVous pouvez transférer les modifications apportées pendant le développement vers votre base de données.
Pousser les schémas de table
Titre de la section Pousser les schémas de tableVotre schéma de table peut changer au fil du temps à mesure que votre projet se développe. Vous pouvez tester en toute sécurité les modifications de configuration localement et les transférer vers votre base de données distante lors du déploiement.
Vous pouvez transférer les modifications de votre schéma local vers votre base de données distante via le CLI à l’aide de la commande astro db push --remote
:
Cette commande vérifiera que vos modifications locales peuvent être effectuées sans perte de données et, si nécessaire, vous suggérera comment apporter des modifications en toute sécurité à votre schéma afin de résoudre les conflits.
Pousser les changements majeurs de schéma
Titre de la section Pousser les changements majeurs de schémaCela détruira votre base de données. N’exécutez cette commande que si vous n’avez pas besoin de vos données de production.
Si vous devez modifier le schéma de votre table d’une manière incompatible avec vos données existantes hébergées chez Astro Studio, vous devrez réinitialiser votre base de données de production.
Pour pousser une mise à jour du schéma de table qui inclut un changement radical, ajoutez le drapeau --force-reset
pour réinitialiser toutes les données de production :
Renommer des tables
Titre de la section Renommer des tablesIl est possible de renommer une table après avoir transmis votre schéma à votre base de données distante.
Si vous n’avez pas de données de production importantes, alors vous pouvez réinitialiser votre base de données en utilisant l’option --force-reset
. Cet indicateur supprimera toutes les tables de la base de données et en créera de nouvelles afin qu’elles correspondent exactement à votre schéma actuel.
Pour renommer une table tout en préservant vos données de production, vous devez effectuer une série de modifications non cassantes pour transférer votre schéma local vers votre base de données distante en toute sécurité.
L’exemple suivant renomme une table Comment
en Feedback
:
-
Dans le fichier de configuration de votre base de données, ajoutez la propriété
deprecated: true
à la table que vous voulez renommer : -
Ajoutez un nouveau schéma de table (correspondant exactement aux propriétés de la table existante) avec le nouveau nom :
-
Poussez vers votre base de données distante avec
astro db push --remote
. Cela ajoutera la nouvelle table et marquera l’ancienne comme obsolète. -
Mettez à jour le code de votre projet local pour utiliser la nouvelle table au lieu de l’ancienne. Il se peut que vous deviez également migrer des données vers la nouvelle table.
-
Une fois que vous êtes sûr que l’ancienne table n’est plus utilisée dans votre projet, vous pouvez supprimer le schéma de votre
config.ts
: -
Poussez à nouveau vers votre base de données distante avec
astro db push --remote
. L’ancienne table sera supprimée, ne laissant que la nouvelle table renommée.
Pousser les données d’une table
Titre de la section Pousser les données d’une tableVous devrez peut-être transférer des données vers votre base de données distante pour l’amorçage ou les migrations de données. Vous pouvez créer un fichier .ts
avec le module astro:db
pour écrire des requêtes avec sûreté du typage. Ensuite, exécutez le fichier sur votre base de données distante à l’aide de la commande astro db execute <file-path> --remote
:
Les commentaires suivants peuvent être initiés à l’aide de la commande astro db execute db/seed.ts --remote
:
Voir la référence CLI pour une liste complète des commandes.
Construire des intégrations Astro DB
Titre de la section Construire des intégrations Astro DBLes intégrations Astro permettent d’étendre les projets des utilisateurs avec des tables Astro DB supplémentaires et des données de départ.
Utilisez la méthode extendDb()
dans le hook astro:db:setup
pour enregistrer des fichiers de configuration et de données initiales (seed) Astro DB supplémentaires.
L’aide defineDbIntegration()
fournit le support TypeScript et l’auto-complétion pour le crochet astro:db:setup
.
Les fichiers de configuration et de données initiales des intégrations suivent le même format que leurs équivalents définis par l’utilisateur.
Opérations avec sûreté du typage dans les intégrations
Titre de la section Opérations avec sûreté du typage dans les intégrationsLorsque vous travaillez sur des intégrations, il se peut que vous ne puissiez pas bénéficier des types de table générés par Astro et exportés depuis astro:db
.
Pour une sécurité totale des types, utilisez l’utilitaire asDrizzleTable()
pour créer un objet de référence de table que vous pouvez utiliser pour les opérations de base de données.
Par exemple, dans le cas d’une intégration mettant en place la table de base de données Pets
suivante :
Le fichier seed (données initiales) peut importer Pets
et utiliser asDrizzleTable()
pour insérer des lignes dans votre table avec vérification du type :
La valeur retournée par asDrizzleTable('Pets', Pets)
est équivalente à import { Pets } from 'astro:db'
, mais elle est disponible même si la génération de type d’Astro ne peut pas fonctionner.
Vous pouvez l’utiliser dans tout code d’intégration qui doit interroger ou insérer dans la base de données.
Migrer depuis Astro Studio vers Turso
Titre de la section Migrer depuis Astro Studio vers Turso- Dans le tableau de bord du Studio, accédez au projet que vous souhaitez migrer. Dans l’onglet Paramètres, utilisez le bouton « Exporter la base de données » pour télécharger une copie de votre base de données.
- Suivez les instructions officielles pour installer le CLI de Turso et inscrivez-vous ou connectez-vous à votre compte Turso.
- Créez une nouvelle base de données sur Turso en utilisant la commande
turso db create
. - Récupérez l’URL de la base de données à l’aide de Turso CLI et utilisez-la comme variable d’environnement
ASTRO_DB_REMOTE_URL
. - Créez un jeton pour accéder à votre base de données et utilisez-le comme variable d’environnement
ASTRO_DB_APP_TOKEN
. - Transférez votre schéma de base de données et vos métadonnées vers la nouvelle base de données Turso.
- Importez l’export de la base de données de l’étape 1 dans votre nouvelle base de données Turso.
- Une fois que vous avez confirmé que votre projet se connecte à la nouvelle base de données, vous pouvez supprimer le projet en toute sécurité dans Astro Studio.