API REST di MariaDB SkySQL: Trasforma una query SQL in un endpoint

API REST · SkySQL verso un endpoint

Girare un SkySQL Query SQL in un API REST endpoint

Salva una query in Query Builder, fai clic Nuovo endpointe hai un URL su api.querystreams.com con la sua chiave. La query SQL viene eseguita in sola lettura sull'agente già presente nel tuo database SkySQL; chi effettua la chiamata riceve un file JSON o CSV e non vede mai la query SQL, lo schema o la password. Non c'è bisogno di ospitare nulla, né di aprire porte. Il tempo di risposta è di circa 90 secondi da una query salvata e il piano gratuito copre il primo endpoint.

Circa 90 secondi da una query salvata Nessun server da ospitare Le credenziali restano con te Una chiave per ogni chiamante, revocabile in qualsiasi momento.

Quello che otterrai alla fine

Un URL a api.querystreams.com che restituisce le righe della query SkySQL salvata in formato JSON o CSV a chiunque possieda una chiave, testata dalla console del portale prima della condivisione. In questo modo:

{
  "città": "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"}'

{
  "colonne": [ { "nome": "customer_id", "tipo": "intero" }, { "nome": "nome", "tipo": "corda" }, { "nome": "città", "tipo": "corda" } ],
  "file": [
    { "customer_id": 1042, "nome": "Commercianti del Vento del Nord", "città": "Seattle" },
    { "customer_id": 1057, "nome": "Alpine Outfitters", "città": "Denver" },
    { "customer_id": 1063, "nome": "Harbour Foods", "città": "Halifax" }
  ],
  "meta": { "conteggio_righe": 3, "durata_agente_ms": 41, "request_id": "req_7Hq2mKd9" }
}

MariaDB SkySQL archivia i tuoi dati nel cloud, gestiti dal suo provider. Qualcuno desidera accedervi per la propria applicazione, dashboard o script, e le soluzioni tradizionali spesso comportano il trasferimento di troppe informazioni: credenziali di accesso al database che non sono più valide, un'esportazione notturna obsoleta già a colazione, o un piccolo server API che qualcuno deve gestire e aggiornare. Query Streams trasforma l'endpoint in una query salvata con una chiave. L'agente già presente nel tuo servizio MariaDB Cloud esegue la query, api.querystreams.com verifica la chiave e il limite di richieste, e chi effettua la chiamata riceve le righe. Il codice SQL, lo schema e le credenziali non lasciano mai il tuo account.

Cosa ti servirà

Un account Query Streams

Ogni piano include l'API REST. Il piano gratuito offre un endpoint, due chiavi e 250 righe per chiamata, sufficienti per realizzare questa guida. Registrati su my.querystreams.com.

L'agente su qualsiasi computer sempre acceso, con la connessione SkySQL aggiunta

È sufficiente una connessione a Internet.

Una query salvata in Query Builder

L'endpoint incapsula esattamente una query salvata. Scrivi la SELECT, eseguila una volta, salvala. Aggiungi un filtro dinamico (un @variable nella clausola WHERE) se i chiamanti devono essere in grado di filtrare.

Configuralo in quattro passaggi

1. Salva la query

   In Generatore di query Scegli la tua connessione SkySQL, scrivi la query SELECT che desideri pubblicare ed eseguila una volta per visualizzare le righe. Limitati alle colonne necessarie al chiamante; l'endpoint restituisce esattamente ciò che restituisce la query.

   Query salvata · clienti

   SELEZIONARE ID cliente, nome, città
   DA clienti
   ORDINE DI nome
   LIMITE 100;

   Se i chiamanti devono essere in grado di filtrare, aggiungi un filtro dinamico, ad esempio DOVE city = @city. Ogni @variable diventa un parametro API nel passaggio 3. Fai clic Risparmiare e assegnare un nome alla query; tale nome diventerà il nome visualizzato dell'endpoint.

2. Crea l'endpoint

   Apri API nella barra superiore e fai clic Nuovo endpointLa procedura guidata prevede quattro passaggi, Query di selezione, Configurare, Parametri di blocco e Condividi. SU Query di selezione, fai clic sulla query appena salvata; le query il cui agente è offline sono visualizzate in grigio. Fai clic Avanti.

   API aperta

   Scorciatoia. Da Query Builder è possibile esporre direttamente la query aperta; la procedura guidata inizia quindi da Configurare con la query già selezionata.

3. Configura e blocca i parametri

   SU Configurare Le impostazioni predefinite sono corrette per un primo endpoint: Nome da visualizzare riempito dalla query, Durata Permanente (scegli In scadenza per una quota temporanea), Modalità di risposta Statico (una risposta JSON; scegli Streaming per risultati che superano il limite di righe statico del tuo piano), Formato grafico JSON. La modalità e il formato della risposta sono fissi una volta creati, quindi decidili qui. Fai clic Avanti.

   SU Parametri di blocco Ogni filtro dinamico nella query è elencato. Lascia invariati quelli che i chiamanti possono impostare come Chiamabile e dare a ciascuno un Nome della stringa di query; tic tac Necessario se una chiamata senza di esso dovesse fallire. Fissa un valore che il chiamante non deve modificare con Chiuso, o uno scenario di appuntamento come Inizio del mese. Nascosto mantiene il valore predefinito della query e rifiuta qualsiasi tentativo di impostarlo. Fare clic Avanti.

4. Condividi e ottieni la tua chiave

   SU Condividi puoi invitare Persone tramite e-mail o aggiungi un Chiave di servizio per un server o uno strumento di automazione, oppure salta entrambi per ora. Fai clic Crea e ottieni la mia chiave. La schermata di successo mostra l'URL dell'endpoint e la tua chiave: una stringa di 49 caratteri che inizia con qsapi_. Copialo. Puoi visualizzarlo di nuovo in seguito dall'endpoint Condivisione scheda, in modo che non vada persa se chiudi lo schermo.

   Cliccare Inviare nella console per effettuare la prima chiamata dal portale stesso. Il riquadro di risposta mostra Stato, Tempo e Misurare, IL Corpo la scheda mostra il JSON e la chiamata appare su Attività premere il tasto pochi secondi dopo.

Chiamalo da qualsiasi luogo

Sostituisci l'ID dell'endpoint con il tuo dalla barra degli URL della console e qsapi_LA_TUA_CHIAVE con la tua chiave. I parametri richiamabili vanno nella stringa di query su GET; qui la query salvata espone città:

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

{
  "colonne": [ { "nome": "customer_id", "tipo": "intero" }, { "nome": "nome", "tipo": "corda" }, { "nome": "città", "tipo": "corda" } ],
  "file": [
    { "customer_id": 1042, "nome": "Commercianti del Vento del Nord", "città": "Seattle" },
    { "customer_id": 1057, "nome": "Alpine Outfitters", "città": "Denver" },
    { "customer_id": 1063, "nome": "Harbour Foods", "città": "Halifax" }
  ],
  "meta": { "conteggio_righe": 3, "durata_agente_ms": 41, "request_id": "req_7Hq2mKd9" }
}

Le righe vengono restituite come oggetti indicizzati dal nome della colonna, con l'elenco delle colonne e un meta blocco che indica il numero di righe, se il risultato è stato troncato e l'ID della richiesta che puoi citare all'assistenza. La stessa chiamata come POST inserisce i parametri in un corpo JSON, che è la scelta giusta per lunghi elenchi di valori:

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

File CSV anziché JSON, con riga di intestazione inclusa. Accetta: testo/csv fa lo stesso. Gli endpoint di streaming restituiscono NDJSON (un oggetto JSON per riga) con un finale {"_summary": true, "row_count": N} riga; controlla quell'ultima riga.

?sample=true

Massimo cinque file, non fatturate. Utile per cablare un cliente.

?compression=lz4

Un corpo con telaio LZ4 per chiamanti ad alto volume con decoder; il Codice la scheda contiene il frammento del decodificatore per lingua. La semplice compressione gzip avviene automaticamente quando il client invia Accept-Encoding: gzip.

Autorizzazione: Portatore qsapi_…

Accettato come alias per Chiave X-API. Utilizzalo dal codice del browser.

Dove si collega

Cosa consentono i piani

Ogni chiamata ha anche un timeout fisso di 60 secondi e un limite di risposta di 8 MiB, e i byte restituiti vengono conteggiati nel limite dati mensile del tuo piano, lo stesso limite utilizzato dai componenti aggiuntivi di Excel e Fogli Google. La versione gratuita ha un endpoint e 5 MB al mese, che sono più che sufficienti per una piccola tabella richiamata più volte al giorno. Consulta la pagina dei prezzi per le indennità previste dal piano.

Tenerlo al sicuro

Quando qualcosa non funziona

Ogni corpo di errore ha la forma {"errore": {"codice": "…", "messaggio": "…"}} e ogni risposta porta con sé un X-QS-Request-Id Intestazione. Citare l'ID quando si scrive all'assistenza.

Domande che le persone si pongono

Guide correlate

• Connetti MariaDB SkySQL a Claude con MCP
• API REST del database: trasforma qualsiasi query SQL in un endpoint
• API REST di Microsoft SQL Server
• API REST di PostgreSQL
• API REST MySQL
• API REST di Snowflake