API REST Postgres de PlanetScale : Transformez une requête SQL en point de terminaison

API REST · PlanetScale vers un point de terminaison

Tournez un Échelle planétaire Requête SQL dans un API REST point de terminaison

Enregistrez une requête dans le générateur de requêtes, cliquez Nouveau point de terminaisonVous disposez d'une URL à l'adresse api.querystreams.com avec sa propre clé. La requête SQL s'exécute en lecture seule sur l'agent déjà installé avec votre base de données PlanetScale ; l'appelant reçoit un fichier JSON ou CSV et n'a jamais accès à la requête, au schéma ni au mot de passe. Aucun hébergement ni port à ouvrir. Comptez environ 90 secondes à partir d'une requête enregistrée, et le forfait gratuit couvre votre premier point de terminaison.

Environ 90 secondes après une requête enregistrée Aucun serveur à héberger Vos identifiants vous suivent. Une seule clé par appelant, révocation possible à tout moment.

Ce que vous obtiendrez

Une URL à api.querystreams.com qui renvoie les lignes de votre requête PlanetScale enregistrée au format JSON ou CSV à toute personne possédant une clé, testée depuis la console du portail avant d'être partagée. Par exemple :

{
  "ville": "Seattle"
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"city": "Seattle"}'

{
  « colonnes »: [ { "nom": "customer_id", "taper": "entier" }, { "nom": "nom", "taper": "chaîne" }, { "nom": "ville", "taper": "chaîne" } ],
  "rangées": [
    { "customer_id": 1042, "nom": « Les Marchands du Vent du Nord », "ville": "Seattle" },
    { "customer_id": 1057, "nom": « Pourvoyeurs alpins », "ville": "Denver" },
    { "customer_id": 1063, "nom": "Harbour Foods", "ville": "Halifax" }
  ],
  "méta": { "row_count": 3, "agent_duration_ms": 41, "request_id": "req_7Hq2mKd9" }
}

PlanetScale Postgres héberge vos données dans le cloud, gérées par son fournisseur. Si un tiers souhaite y accéder via son application, son tableau de bord ou son script, les solutions habituelles impliquent trop de ressources : un identifiant de base de données qui disparaît avec le projet, une exportation nocturne obsolète, ou un serveur API qu'il faut désormais gérer et maintenir. Query Streams transforme le point de terminaison en une requête enregistrée associée à une clé. L'agent déjà installé sur votre base de données PlanetScale Postgres exécute la requête, api.querystreams.com vérifie la clé et la limite de requêtes, et l'utilisateur reçoit les lignes. Le code SQL, le schéma et les identifiants restent toujours sur votre compte.

Ce dont vous aurez besoin

Un compte Query Streams

Chaque forfait inclut l'API REST. Le forfait gratuit vous offre un point de terminaison, deux clés et 250 lignes par requête, ce qui est suffisant pour créer ce guide. Inscrivez-vous sur mon.querystreams.com.

L'agent installé sur n'importe quel ordinateur toujours allumé, avec la connexion PlanetScale ajoutée.

Il suffit d'un accès internet.

Une requête enregistrée dans le générateur de requêtes

Le point de terminaison encapsule exactement une requête enregistrée. Rédigez la requête SELECT, exécutez-la une fois, puis enregistrez-la. Ajoutez un filtre dynamique (un @variable dans la clause WHERE) si les appelants doivent pouvoir filtrer.

Configurez-le en quatre étapes

1. Enregistrer la requête

   Dans Générateur de requêtes Choisissez votre connexion PlanetScale, rédigez la requête SELECT à publier et exécutez-la une fois pour visualiser les lignes. Limitez-vous aux colonnes nécessaires à l'appelant ; le point de terminaison renvoie exactement ce que la requête renvoie.

   Requête enregistrée · clients

   SELECTIONNER identifiant_client, nom, ville
   DE clients publics
   COMMANDE PAR nom
   LIMITE 100;

   Si les appelants doivent pouvoir filtrer, ajoutez un filtre dynamique, par exemple. OÙ ville = @ville. Chaque @variable devient un paramètre d'API à l'étape 3. Cliquez Économiser et donnez un nom à la requête ; ce nom devient le nom d'affichage du point de terminaison.

2. Créer le point de terminaison

   Ouvrir API dans la barre supérieure et cliquez Nouveau point de terminaisonLe magicien comporte quatre étapes, Sélectionner une requête, Configurer, Paramètres de verrouillage et Partager. Sur Sélectionner une requête, cliquez sur la requête que vous venez d'enregistrer ; les requêtes dont l'agent est hors ligne sont grisées. Cliquez Suivant.

   API ouverte

   Raccourci. Depuis le générateur de requêtes, vous pouvez exposer directement la requête ouverte ; l’assistant démarre alors à Configurer avec la requête déjà sélectionnée.

3. Configurer et verrouiller les paramètres

   Sur Configurer Les valeurs par défaut conviennent pour un premier point de terminaison : Nom d'affichage rempli à partir de la requête, Durée de vie Permanent (choisir) Expiration (pour une action temporaire), Mode de réponse Statique (une réponse JSON ; choisir) Streaming (pour des résultats dépassant la limite de lignes statique de votre plan), Format intérieur JSON. Le mode et le format de réponse sont fixes une fois créés ; veuillez les définir ici. Cliquez Suivant.

   Sur Paramètres de verrouillage Chaque filtre dynamique de la requête est listé. Laissez ceux que les appelants peuvent définir comme Appelable et donner à chacun un Nom de la chaîne de requête; cocher Requis Si un appel sans cette valeur doit échouer, fixez une valeur que l'appelant ne doit pas modifier. Fermé, ou un scénario de date tel que Début du mois. Caché conserve la valeur par défaut de la requête et rejette toute tentative de modification. Cliquez Suivant.

4. Partagez et obtenez votre clé

   Sur Partager vous pouvez inviter Personnes par e-mail ou ajoutez un Clé de service pour un serveur ou un outil d'automatisation, ou ignorez les deux pour le moment. Cliquez Créer et obtenir ma cléL'écran de confirmation affiche l'URL du point de terminaison et votre clé : une chaîne de 49 caractères commençant par « 49 ». qsapi_Copiez-le. Vous pourrez le révéler à nouveau ultérieurement à partir du point de terminaison. Partage L'onglet permet de ne pas le perdre si vous fermez l'écran.

   Cliquez sur Envoyer dans la console pour effectuer le premier appel depuis le portail lui-même. Le volet de réponse affiche Statut, Temps et Taille, le Corps L'onglet affiche le JSON et l'appel apparaît sur le Activité onglet quelques secondes plus tard.

Appelez-le de n'importe où

Remplacez l'identifiant du point de terminaison par le vôtre, provenant de la barre d'adresse de la console. qsapi_VOTRE_CLÉ avec votre clé. Les paramètres appelables sont placés dans la chaîne de requête lors d'une requête GET ; ici, la requête enregistrée expose ville:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?city=Seattle" \ -H "X-API-Key: qsapi_YOUR_KEY"

{
  « colonnes »: [ { "nom": "customer_id", "taper": "entier" }, { "nom": "nom", "taper": "chaîne" }, { "nom": "ville", "taper": "chaîne" } ],
  "rangées": [
    { "customer_id": 1042, "nom": « Les Marchands du Vent du Nord », "ville": "Seattle" },
    { "customer_id": 1057, "nom": « Pourvoyeurs alpins », "ville": "Denver" },
    { "customer_id": 1063, "nom": "Harbour Foods", "ville": "Halifax" }
  ],
  "méta": { "row_count": 3, "agent_duration_ms": 41, "request_id": "req_7Hq2mKd9" }
}

Les lignes sont renvoyées sous forme d'objets indexés par nom de colonne, avec la liste des colonnes et un méta Ce bloc indique le nombre de lignes, si le résultat a été tronqué et l'identifiant de la requête que vous pouvez citer pour obtenir de l'aide. Un appel POST place les paramètres dans un corps JSON, ce qui est idéal pour les longues listes de valeurs.

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"city": "Seattle"}}'

?format=csv

CSV au lieu de JSON, ligne d'en-tête incluse. Accepter : texte/csv Il en va de même. Les points de terminaison de flux renvoient du NDJSON (un objet JSON par ligne) avec un résultat final {"_summary": true, "row_count": N} ligne ; vérifiez cette dernière ligne.

?sample=true

Cinq rangées maximum, non facturées. Idéal pour le câblage d'un client.

?compression=lz4

Un châssis LZ4 pour les appelants à volume élevé avec décodeur ; Code L'onglet contient l'extrait de code du décodeur pour chaque langue. La compression gzip simple s'effectue automatiquement lorsque votre client envoie des données. Accept-Encoding: gzip.

Autorisation : Porteur qsapi_…

Accepté comme alias pour Clé X-APIUtilisez-le depuis le code du navigateur.

Là où il se branche

Ce que les plans permettent

Chaque requête est soumise à un délai d'attente fixe de 60 secondes et à une limite de réponse de 8 Mio. Les octets renvoyés sont décomptés de votre forfait de données mensuel, le même que celui utilisé par les modules complémentaires Excel et Google Sheets. La version gratuite inclut un point de terminaison et 5 Mo par mois, ce qui suffit amplement pour une petite table consultée plusieurs fois par jour. Consultez la page des prix pour les indemnités prévues par le régime.

Le garder en sécurité

Quand quelque chose ne fonctionne pas

Chaque corps d'erreur a la forme {"erreur": {"code": "…", "message": "…"}} et chaque réponse comporte un Identifiant de requête X-QS En-tête. Veuillez indiquer l'identifiant lorsque vous écrivez au support.

Questions que se posent les gens

Guides associés

• Connectez PlanetScale Postgres à Claude avec MCP.
• API REST de base de données : transformez n’importe quelle requête SQL en un point de terminaison
• API REST de Microsoft SQL Server
• API REST PostgreSQL
• API REST MySQL
• API REST Snowflake