Railway REST API: Eine SQL-Abfrage in einen Endpunkt umwandeln

REST-API · Eisenbahn zu einem Endpunkt

Drehen Sie einen Eisenbahn SQL-Abfrage in eine REST-API Endpunkt

Speichern Sie eine Abfrage im Abfrage-Generator, klicken Sie Neuer EndpunktSie verfügen über eine URL unter api.querystreams.com mit einem eigenen Schlüssel. Die SQL-Abfrage wird schreibgeschützt auf dem Agenten ausgeführt, der bereits mit Ihrer Railway-Datenbank verbunden ist. Der Aufrufer erhält JSON- oder CSV-Daten und sieht weder die SQL-Abfrage noch das Schema oder ein Passwort. Es muss weder Hosting noch das Öffnen eines Ports erforderlich sein. Die Abfrage wird in etwa 90 Sekunden gespeichert, und der kostenlose Tarif deckt Ihren ersten Endpunkt ab.

Etwa 90 Sekunden nach einer gespeicherten Abfrage Kein Server zum Hosten Die Zugangsdaten bleiben bei Ihnen Eine Taste pro Anrufer, jederzeit widerrufbar.

Was am Ende dabei herauskommt

Eine URL bei api.querystreams.com Diese Funktion gibt die Zeilen Ihrer gespeicherten Railway-Abfrage als JSON- oder CSV-Datei an jeden mit einem entsprechenden Schlüssel zurück. Sie wurde vor der Weitergabe über die Konsole im Portal getestet. Beispiel:

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

{
  "Spalten": [ { "Name": "customer_id", "Typ": "ganze Zahl" }, { "Name": "Name", "Typ": "Zeichenkette" }, { "Name": "Stadt", "Typ": "Zeichenkette" } ],
  "Zeilen": [
    { "customer_id": 1042, "Name": "Northwind Traders", "Stadt": "Seattle" },
    { "customer_id": 1057, "Name": "Alpine Outfitters", "Stadt": "Denver" },
    { "customer_id": 1063, "Name": "Harbour Foods", "Stadt": "Halifax" }
  ],
  "Meta": { "Zeilenanzahl": 3, "agent_duration_ms": 41, "request_id": "req_7Hq2mKd9" }
}

Railway speichert Ihre Daten in der Cloud, betrieben vom jeweiligen Anbieter. Jemand anderes möchte einen Teil davon in seiner App, seinem Dashboard oder seinem Skript nutzen, doch die üblichen Lösungen sind mit zu vielen offenen Daten verbunden: ein Datenbank-Login, der das Projekt überdauert, ein nächtlicher Export, der schon am Morgen veraltet ist, oder ein kleiner API-Server, der nun von jemandem betrieben und aktualisiert werden muss. Query Streams macht den Endpunkt zu einer gespeicherten Abfrage plus einem Schlüssel. Der Agent, der bereits mit Ihrer Railway-Postgres-Datenbank verbunden ist, führt die Abfrage aus, api.querystreams.com prüft den Schlüssel und das Ratenlimit, und der Aufrufer erhält die Zeilen. SQL-Code, Schema und Zugangsdaten verlassen niemals Ihr Konto.

Was Sie benötigen

Ein Query Streams-Konto

Jeder Tarif beinhaltet die REST-API. Die kostenlose Version bietet einen Endpunkt, zwei Schlüssel und 250 Zeilen pro Aufruf – ausreichend für diese Anleitung. Jetzt anmelden unter mein.querystreams.de.

Der Agent läuft auf jedem ständig eingeschalteten Computer, mit zusätzlicher Bahnverbindung.

Es benötigt lediglich einen Internetanschluss.

Eine gespeicherte Abfrage im Abfrage-Generator

Der Endpunkt umschließt genau eine gespeicherte Abfrage. Schreiben Sie die SELECT-Anweisung, führen Sie sie einmal aus und speichern Sie sie. Fügen Sie einen dynamischen Filter hinzu (einen dynamischen Filter). @variable in der WHERE-Klausel), wenn Aufrufer die Möglichkeit haben sollen, zu filtern.

Richten Sie es in vier Schritten ein

1. Abfrage speichern

   In Abfrage-Generator Wählen Sie Ihre Railway-Verbindung, schreiben Sie die zu veröffentlichende SELECT-Abfrage und führen Sie sie einmal aus, um die Zeilen anzuzeigen. Beschränken Sie sich auf die vom Aufrufer benötigten Spalten; der Endpunkt liefert genau das Ergebnis der Abfrage.

   Gespeicherte Anfrage · Kunden

   SELECT Kunden-ID, Name, Stadt
   VON öffentliche Kunden
   BEFEHL VON Name
   LIMIT 100;

   Wenn Anrufer filtern können sollen, fügen Sie einen dynamischen Filter hinzu, zum Beispiel WHERE city = @city. Jede @variable wird in Schritt 3 zu einem API-Parameter. Klicken Sie Speichern Sie und geben Sie der Abfrage einen Namen; dieser Name wird zum Anzeigenamen des Endpunkts.

2. Erstellen Sie den Endpunkt

   Öffnen API in der oberen Leiste klicken Sie auf Neuer EndpunktDer Zauberer hat vier Schritte. Abfrage auswählen, Konfigurieren, Sperrparameter und Teilen. An Abfrage auswählenKlicken Sie auf die soeben gespeicherte Abfrage; Abfragen, deren Agent offline ist, werden ausgegraut angezeigt. Weiter.

   Open API

   Abkürzung. Im Abfrage-Generator können Sie die geöffnete Abfrage direkt anzeigen; der Assistent startet dann bei Konfigurieren mit der bereits ausgewählten Suchanfrage.

3. Parameter konfigurieren und sperren

   An Konfigurieren Die Standardeinstellungen sind für einen ersten Endpunkt richtig: Anzeigename aus der Anfrage ausgefüllt, Lebensdauer Dauerhaft (wählen) Ablauf für einen vorübergehenden Anteil), Antwortmodus Statisch (eine JSON-Antwort; auswählen) Streaming (für Ergebnisse, die über die statische Rudergrenze Ihres Plans hinausgehen), Inneres Format JSON. Antwortmodus und -format sind nach der Erstellung festgelegt, daher legen Sie diese hier fest. Klicken Sie hier. Weiter.

   An Sperrparameter Alle dynamischen Filter in der Abfrage werden aufgelistet. Lassen Sie diejenigen unverändert, die vom Aufrufer festgelegt werden können. Abrufbar und gib jedem ein Name der Abfragezeichenfolge; Haken Erforderlich Falls ein Aufruf ohne diese Angabe fehlschlägt, legen Sie einen Wert fest, den der Aufrufer nicht ändern darf. Gesperrtoder ein Date-Szenario wie zum Beispiel Monatsbeginn. Versteckt Behält den Standardwert der Abfrage bei und lehnt jeden Versuch ab, diesen festzulegen. Klicken Sie hier. Weiter.

4. Teilen und Ihren Schlüssel erhalten

   An Teilen Sie können einladen Menschen per E-Mail oder fügen Sie eine hinzu Serviceschlüssel für einen Server oder ein Automatisierungstool, oder beides vorerst überspringen. Klicken Sie hier. Erstellen und meinen Schlüssel erhaltenAuf dem Erfolgsbildschirm werden die Endpunkt-URL und Ihr Schlüssel angezeigt: eine 49-stellige Zeichenkette, die mit „.“ beginnt. qsapi_Kopieren Sie es. Sie können es später vom Endpunkt aus wieder anzeigen lassen. Teilen Die Tabulatortaste sorgt dafür, dass die Daten nicht verloren gehen, wenn Sie den Bildschirm schließen.

   Klicken Sie auf Schicken In der Konsole den ersten Aufruf direkt vom Portal aus tätigen. Im Antwortbereich wird Folgendes angezeigt: Status, Zeit und Größe, Die Körper Der Tab zeigt das JSON an, und der Aufruf erscheint auf dem Aktivität Drücken Sie die Tabulatortaste einige Sekunden später.

Rufen Sie es von überall aus an

Ersetzen Sie die Endpunkt-ID durch Ihre eigene aus der URL-Leiste der Konsole und qsapi_IHR_SCHLÜSSEL mit Ihrem Schlüssel. Aufrufbare Parameter gehören in die Abfragezeichenfolge bei GET; hier wird die gespeicherte Abfrage bereitgestellt. Stadt:

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

{
  "Spalten": [ { "Name": "customer_id", "Typ": "ganze Zahl" }, { "Name": "Name", "Typ": "Zeichenkette" }, { "Name": "Stadt", "Typ": "Zeichenkette" } ],
  "Zeilen": [
    { "customer_id": 1042, "Name": "Northwind Traders", "Stadt": "Seattle" },
    { "customer_id": 1057, "Name": "Alpine Outfitters", "Stadt": "Denver" },
    { "customer_id": 1063, "Name": "Harbour Foods", "Stadt": "Halifax" }
  ],
  "Meta": { "Zeilenanzahl": 3, "agent_duration_ms": 41, "request_id": "req_7Hq2mKd9" }
}

Die Zeilen werden als Objekte zurückgegeben, die über den Spaltennamen indiziert sind, mit der Spaltenliste und einem Meta Ein Block, der die Anzahl der Zeilen, die Information, ob das Ergebnis gekürzt wurde, und die Anfrage-ID anzeigt, die Sie zur Unterstützung angeben können. Derselbe Aufruf wie ein POST-Request übermittelt die Parameter in einem JSON-Body, was die richtige Wahl für lange Wertelisten ist:

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 statt JSON, inklusive Kopfzeile. Akzeptierte Formate: text/csv Dasselbe gilt für Streaming-Endpunkte. Diese geben NDJSON (ein JSON-Objekt pro Zeile) mit einem abschließenden Wert zurück. {"_summary": true, "row_count": N} Zeile; überprüfen Sie die letzte Zeile.

?sample=true

Maximal fünf Reihen, nicht abgerechnet. Gut geeignet, um einen Kunden anzuschließen.

?compression=lz4

Ein Gehäuse des Typs LZ4 für Vieltelefonierer mit Decoder; Code Die Registerkarte enthält den Decoder-Codeausschnitt für jede Sprache. Die einfache Gzip-Komprimierung erfolgt automatisch, wenn Ihr Client sendet. Accept-Encoding: gzip.

Autorisierung: Bearer qsapi_…

Akzeptiert als Alias für X-API-Schlüssel. Verwenden Sie es im Browsercode.

Wo es eingesteckt wird

Was die Pläne erlauben

Jeder Aufruf hat ein festes Abfrage-Timeout von 60 Sekunden und eine Antwortgröße von maximal 8 MiB. Die zurückgegebenen Bytes werden auf Ihr monatliches Datenvolumen angerechnet – dasselbe, das auch die Add-ons für Excel und Google Sheets nutzen. Die kostenlose Version bietet einen Endpunkt und 5 MB Datenvolumen pro Monat, was für eine kleine Tabelle, die mehrmals täglich aufgerufen wird, problemlos ausreicht. Siehe die Preisseite für die Zulagen nach Plan.

Es sicher aufbewahren

Wenn etwas nicht funktioniert

Jeder Fehlerkörper hat die Form {"error": {"code": "…", "message": "…"}} und jede Antwort beinhaltet eine X-QS-Anforderungs-ID Header. Geben Sie die ID in Anführungszeichen an, wenn Sie sich an den Support wenden.

Fragen, die Menschen stellen

Verwandte Leitfäden

• Verbinden Sie die Bahnstrecke mit Claude über MCP.
• Datenbank-REST-API: Jede SQL-Abfrage in einen Endpunkt umwandeln
• Microsoft SQL Server REST-API
• PostgreSQL REST-API
• MySQL REST-API
• Snowflake REST-API