{"id":1275,"date":"2020-11-17T07:34:59","date_gmt":"2020-11-17T07:34:59","guid":{"rendered":"https:\/\/www.gudusoft.com\/?page_id=1275"},"modified":"2026-07-13T18:34:43","modified_gmt":"2026-07-14T02:34:43","slug":"sqlflow-restful-api","status":"publish","type":"page","link":"https:\/\/www.gudusoft.com\/de\/sqlflow-restful-api\/","title":{"rendered":"SQLFlow REST-API: Automatisierte Extraktion der SQL-Datenherkunft"},"content":{"rendered":"

A Data-Lineage-API<\/strong> erm\u00f6glicht die programmatische Extraktion von Datenherkunft: Sie \u00fcbermitteln SQL-Code \u00fcber HTTP und erhalten einen strukturierten Herkunftsgraphen im JSON-Format, der jede Quelltabelle und -spalte, jedes Ziel sowie die Transformationsbeziehungen zwischen ihnen auflistet. Gudu SQLFlow REST-API<\/strong> Genau das leistet es f\u00fcr 39 SQL-Dialekte auf Spaltenebene, einschlie\u00dflich gespeicherter Prozeduren und dynamischem SQL. Dieselbe Analyse, die den interaktiven Diagrammen von SQLFlow zugrunde liegt, ist als strukturierte Herkunftsdaten \u00fcber HTTP verf\u00fcgbar.<\/p>\n\n\n\n

\n
39<\/b>SQL-Dialekte, jeder mit einem eigenen Parser<\/span><\/div>\n
Spaltenebene<\/b>Stammbaum, direkt und indirekt<\/span><\/div>\n
JSON<\/b>\u00fcber HTTP \u2013 ein POST-Request, SQL-Eingabe, Graphausgabe<\/span><\/div>\n
Null<\/b>Zugriff auf Ihre Daten \u2013 nur statische Analyse<\/span><\/div>\n<\/div>\n\n\n\n
\n\n

Sehen Sie sich zuerst die Ausgabe an:<\/strong> F\u00fcgen Sie eine Abfrage in die kostenloser SQLFlow-Lineage-Visualisierer<\/a>Exportieren Sie anschlie\u00dfend den Graphen als JSON, um zu sehen, wie die Herkunftsinformationen als Daten aussehen, bevor Sie eine Zeile Integrationscode schreiben.<\/p>\n\n<\/div><\/div>\n\n\n\n

Warum sollten Sie eine Data-Lineage-API in Ihre Technologieinfrastruktur integrieren?<\/h2>\n\n\n\n

Interaktive Herkunftsdiagramme erm\u00f6glichen es Menschen, die Herkunft von Daten zu erforschen. Die wertvollsten Anwendungen von Herkunftsdaten sind jedoch automatisiert: das Blockieren eines Pull Requests, der einen nachfolgenden Bericht unbemerkt besch\u00e4digt, die Aktualisierung der Herkunft eines Datenkatalogs ohne manuelle Pflege oder die Beantwortung der Frage \u201eWelche Daten stammen aus dieser Spalte?\u201c innerhalb der eigenen internen Tools. All dies erfordert Herkunftsdaten als bedarfsgerechte Daten von einem aufrufbaren Dienst.<\/p>\n\n\n\n

SQLFlow verwendet den Ansatz der statischen SQL-Analyse. Die API analysiert den gesendeten SQL-Text und greift dabei niemals auf die Zeilen Ihrer Tabellen zu. Dadurch bleibt die Sicherheitspr\u00fcfung kurz: Es wird lediglich SQL-Code \u00fcbertragen. On-Premise-Version<\/a> Selbst das bleibt innerhalb Ihres Netzwerks. Der zugrundeliegende Motor ist der Allgemeiner SQL-Parser<\/a>, ein kommerzielles SQL-Compiler-Frontend, das seit Mitte der 2000er Jahre entwickelt und anhand von rund 13.600 Test-Fixtures pro Dialekt validiert wurde, sodass die zur\u00fcckgegebene Herkunft aus einem vollst\u00e4ndigen semantischen Modell des SQL-Codes und nicht aus einem Regex-Abgleich erstellt wird.<\/p>\n\n\n\n

Was die SQLFlow REST-API zur\u00fcckgibt<\/h2>\n\n\n\n

Konzeptionell stellt die API die vollst\u00e4ndige SQLFlow-Analyseoberfl\u00e4che als JSON-\u00fcber-HTTP bereit:<\/p>\n\n\n\n

\n
F\u00e4higkeit<\/th>Sie senden<\/th>Du kommst zur\u00fcck<\/th><\/tr><\/thead>
Stammbaum<\/td>SQL-Text plus Dialektkennung<\/td>Der vollst\u00e4ndige Herkunftsgraph auf Spaltenebene als JSON: Tabellen, Spalten und Quell-Ziel-Beziehungen<\/td><\/tr>\n
Upstream-\/Downstream-Trace<\/td>Eine Tabelle oder Spalte von Interesse<\/td>Nur der Subgraph, der dieses Objekt speist (Upstream) oder von ihm gespeist wird (Downstream), f\u00fcr die gezielte Wirkungsanalyse<\/td><\/tr>\n
Abstammung auf Tabellenebene<\/td>SQL-Text, angeforderte Tabellengranularit\u00e4t<\/td>Ein kompakter Abh\u00e4ngigkeitsgraph zwischen Tabellen, wenn Spaltendetails irrelevant w\u00e4ren.<\/td><\/tr>\n
Direkte vs. indirekte Abstammung<\/td>Ein Hinweis auf die Anfrage<\/td>Reine Datenflussbeziehungen oder zus\u00e4tzlich die Spalten, die die Ergebnisse formen durch WO<\/code>, VERBINDEN<\/code>, Und GRUPPE NACH<\/code> Klauseln<\/td><\/tr>\n
Aufrufdiagramm gespeicherter Prozeduren<\/td>PL\/SQL- oder T-SQL-Prozedurr\u00fcmpfe<\/td>Welche Prozeduren welche aufrufen, mit nachvollziehbarer Herkunft \u00fcber Parameter, tempor\u00e4re Tabellen und dynamisches SQL<\/td><\/tr>\n
ER-Diagramm<\/td>DDL-Skripte<\/td>Abgeleitete Prim\u00e4r-\/Fremdschl\u00fcsselbeziehungen als Entity-Relationship-Modell<\/td><\/tr>\n
Exporte<\/td>Ein analysierter Job<\/td>JSON oder CSV f\u00fcr Maschinen, PNG f\u00fcr Dokumentation und Tickets<\/td><\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n

Jede Anfrage gibt ihren Dialekt explizit an. SQLFlow liefert dialektspezifische Parser f\u00fcr 39 Datenbanken und Abfrage-Engines, von Snowflake, BigQuery, Databricks und Redshift bis hin zu Oracle, SQL Server, Teradata, Hive und Trino. Dadurch wird herstellerspezifische Syntax, wie z. B. tempor\u00e4re Tabellen in T-SQL, gem\u00e4\u00df der Herstellerdefinition analysiert und nicht durch eine generische ANSI-Grammatik approximiert. Die vollst\u00e4ndige Liste finden Sie auf der Website. \u00dcberblick \u00fcber SQL-Datenherkunftstools<\/a>.<\/p>\n\n\n\n

Minimalbeispiel: POST-SQL-Anfrage, Empfang eines Herkunftsdiagramms<\/h2>\n\n\n\n

Die Kerninteraktion besteht aus einem HTTP-Aufruf. Sie senden SQL-Text und einen Dialekt; die Antwort ist der Herkunftsgraph. Endpunktpfade, Authentifizierung und die vollst\u00e4ndige Parameterreferenz befinden sich im SQLFlow-API-Dokumentation<\/a>Die Struktur des Austauschs sieht folgenderma\u00dfen aus:<\/p>\n\n\n\n

curl -s -X POST "$SQLFLOW_API\/lineage" \\ -H "Authorization: Bearer $SQLFLOW_TOKEN" \\ --form "dbvendor=snowflake" \\ --form 'sqltext=CREATE VIEW customer_ltv AS SELECT c.customer_id, SUM(o.amount) AS lifetime_value FROM customers c JOIN orders o ON o.customer_id = c.customer_id WHERE o.status = ''paid'' GROUP BY c.customer_id;'<\/code><\/pre>\n\n\n\n
Die Antwort ist ein Graph: eine Liste von Datenbankobjekten (Tabellen, Sichten und deren Spalten) und eine Liste der Beziehungen zwischen den Spalten. Zur Veranschaulichung gek\u00fcrzt und vereinfacht:<\/p>\n\n\n\n
{ "relationships": [ { "type": "direct", "target": {"object": "customer_ltv", "column": "lifetime_value"}, "sources": [{"object": "orders", "column": "amount", "via": "SUM"}] }, { "type": "direct", "target": {"object": "customer_ltv", "column": "customer_id"}, "sources": [{"object": "customers", "column": "customer_id"}] }, { "type": "indirect", "target": {"object": "customer_ltv", "column": "lifetime_value"}, "sources": [{"object": "orders", "column": "status", "via": "WHERE"}] } ] }<\/code><\/pre>\n\n\n\n
Beachten Sie die dritte Beziehung. Bestellungen.Status<\/code> Es erscheint zwar nie in der Ausgabe der Ansicht, filtert aber die zu summierenden Zeilen und hat daher definitiv Auswirkungen. Lebensdauerwert<\/code>SQLFlow modelliert dies als indirekte Abstammung<\/strong>Diese Daten unterscheiden sich vom direkten Datenfluss und k\u00f6nnen separat angefordert werden. Die meisten Lineage-Tools treffen diese Unterscheidung nicht, und genau das ben\u00f6tigt ein Anwender einer Wirkungsanalyse: das Ablegen von Datenflussdaten. Bestellungen.Status<\/code> w\u00fcrde diese Ansicht verf\u00e4lschen, obwohl keine Ausgabespalte daraus \u201estammt\u201c.<\/p>\n\n\n\n
\n\n
Anwendungsfall: Herkunftspr\u00fcfungen in CI<\/h2>\n\n\n\n
Die wirkungsvollste Integration ist diejenige, die vor der Auslieferung fehlerhafter SQL-Anweisungen ausgef\u00fchrt wird. In einem CI-Job bei jedem Pull Request, der SQL betrifft:<\/p>\n\n\n\n
  1. Poste die ge\u00e4nderten SQL-Dateien am Lineage-Endpunkt und erhalte den neuen Graphen.<\/li>\n
  2. Vergleiche es mit dem Graphen des Hauptzweigs: Welche Spalten haben Quellen hinzugewonnen oder verloren, welche nachgelagerten Objekte haben ihre Eingaben ge\u00e4ndert?<\/li>\n
  3. Die \u00dcberpr\u00fcfung schl\u00e4gt fehl, oder die Differenz wird als Kommentar in der \u00dcberpr\u00fcfung ver\u00f6ffentlicht, wenn eine \u00c4nderung Spalten betrifft, die gesch\u00fctzte Ziele wie regulatorische Berichte oder Management-Dashboards speisen.<\/li><\/ol>\n\n\n\n
    Da die Analyse statisch ist, funktioniert sie auch mit Code, der noch nie ausgef\u00fchrt wurde. Die fehlerhafte Abh\u00e4ngigkeit wird erst bei der Code\u00fcberpr\u00fcfung erkannt, nicht erst, wenn der Batchlauf um 2 Uhr nachts fehlschl\u00e4gt. Dasselbe Muster steuert Schema-Migrationen: vor einem Fallspalte<\/code> Bei lands gibt ein Downstream-Trace-Aufruf alle Objekte aus, die die Spalte direkt oder \u00fcber einen Filter verwenden.<\/p>\n\n<\/div><\/div>\n\n\n\n
    Anwendungsfall: Bef\u00fcllung Ihres Datenkatalogs<\/h2>\n\n\n\n
    Katalogplattformen eignen sich gut f\u00fcr die Organisation von Metadaten, Besitzverh\u00e4ltnissen und die Auffindbarkeit; die SQL-Historie auf Spaltenebene ist jedoch meist ihre gr\u00f6\u00dfte Schw\u00e4che. SQLFlow fungiert als Engine f\u00fcr die Historienanalyse: Es analysiert Ihre SQL-Umgebung und \u00fcbertr\u00e4gt die Ergebnisse anschlie\u00dfend in den bereits vorhandenen Katalog. Enterprise-Implementierungen beinhalten vorgefertigte Exportadapter f\u00fcr DataHub, Microsoft Purview und OpenMetadata<\/strong>Die JSON- und CSV-Exporte dienen als Grundlage f\u00fcr alle benutzerdefinierten Anpassungen. Im gro\u00dfen Ma\u00dfstab werden Batch- und inkrementelle Scans \u00fcber mehr als 100 Datenbanken und \u00fcber eine Million Spalten hinweg durchgef\u00fchrt. Dank eines persistenten Herkunftsarchivs bleibt der Katalog stets aktuell, ohne dass die Herkunft manuell gepflegt werden muss.<\/p>\n\n\n\n
    Anwendungsfall: Herkunftsnachverfolgung innerhalb Ihrer eigenen Tools<\/h2>\n\n\n\n
    Interne Datenplattformen entwickeln immer wieder dieselben Funktionen: ein Panel zur Herkunft von Metriken, eine \u00dcberpr\u00fcfung veralteter Funktionen, eine Migrationsabh\u00e4ngigkeits\u00fcbersicht. Anstatt einen SQL-Parser zu erstellen, rufen Sie die API von Ihrem Dienst aus auf und stellen Sie das Diagramm nach Ihren W\u00fcnschen dar. Wenn Sie das interaktive Diagramm selbst anstelle von rohem JSON ben\u00f6tigen, bietet SQLFlow auch ein einbettbares JavaScript-Widget mit einer API von \u00fcber 30 Methoden, das sich in jede Webanwendung integrieren l\u00e4sst. F\u00fcr die reine JVM-Integration im Backend steht eine Java-Bibliothek mit derselben Engine zur Verf\u00fcgung. API, Widget und Bibliothek liefern konsistente Ergebnisse, da sie denselben Parser verwenden.<\/p>\n\n\n\n
    \n\n
    Wandeln Sie Ihre SQL-Abfrage in einen Herkunftsgraphen \u00fcber HTTP um.<\/h2>\n\n\n\n
    Untersuchen Sie den Graphen im kostenlosen Visualisierer und senden Sie dann die gleiche SQL-Anweisung per POST aus Ihrer Pipeline an die REST-API.<\/p>\n\n\n\n
    \n
    Testen Sie SQLFlow kostenlos<\/a><\/div>\n\n\n\n
    Lesen Sie die API-Dokumentation.<\/a><\/div>\n<\/div>\n\n<\/div><\/div>\n\n\n\n
    Wie schneidet diese Option im Vergleich zu anderen programmatischen Herkunftsanalyseoptionen ab?<\/h2>\n\n\n\n
    Dies ist ein SQL-Analysedienst, keine Parserbibliothek oder ein Laufzeitkollektor.<\/strong> Drei Kategorien sind es wert, bekannt zu sein. Open-Source-Parsing-Bibliotheken<\/strong> wie sqllineage<\/code> Und sqlglot<\/code> Sie eignen sich hervorragend zum Parsen einzelner Anweisungen innerhalb eines Python-Prozesses und sind f\u00fcr einfache SELECT- und INSERT-Logik m\u00f6glicherweise ausreichend; die L\u00fccke zeigt sich bei gespeicherten Prozeduren, dynamischem SQL, Dialekt-Sonderf\u00e4llen und der Aufl\u00f6sung von Views oder Sternerweiterungen, die einen Schema-Kontext erfordern. Laufzeit-Abstammungsstandards<\/strong> \u00c4hnlich wie OpenLineage, das die Herkunft von Job-Ausf\u00fchrungsereignissen erfasst, was hervorragend f\u00fcr die Herkunftsnachverfolgung auf Orchestrator-Ebene, von Ausf\u00fchrung zu Ausf\u00fchrung, geeignet ist, sieht es nur Code, der tats\u00e4chlich ausgef\u00fchrt wurde, und zwar in der Granularit\u00e4t, die die ausgebende Integration bietet. Katalogbasierte Plattformen<\/strong> Die Lineage-APIs von SQLFlow bieten Zugriff auf alle erfassten Daten, sodass ihre Ergebnisse nur so tief reichen wie die erfassten Daten. Die REST-API von SQLFlow hingegen ist ein spezialisierter SQL-Analysedienst, der die Lineage auf Spaltenebene direkt aus dem Code berechnet \u2013 einschlie\u00dflich des SQL-Codes, der nie ausgef\u00fchrt wurde, und der Prozeduren, die andere Tools \u00fcberspringen. Die beiden Ans\u00e4tze erg\u00e4nzen sich gut; viele Teams nutzen SQLFlow zur Lineage-Berechnung und einen Katalog, um die Ergebnisse den Endbenutzern bereitzustellen.<\/p>\n\n\n\n
    Wo die API ausgef\u00fchrt wird: in der Cloud oder in Ihrem eigenen Netzwerk<\/h2>\n\n\n\n
    Die REST-API ist in beiden SQLFlow-Bereitstellungen verf\u00fcgbar. SQLFlow Cloud<\/a> ist der schnellste Einstieg: eine SaaS-L\u00f6sung mit kostenlosem Tarif, Premium-Tarif f\u00fcr $49,99\/Monat, keine zu betreibende Infrastruktur. SQLFlow vor Ort<\/a> Die Bereitstellung erfolgt \u00fcber Docker oder Kubernetes innerhalb Ihres Netzwerks, funktioniert vollst\u00e4ndig isoliert und kostet 1.300.500 TP\/Monat oder einmalig 1.300.4800 TP pro ausgew\u00e4hltem Datenbanktyp. Die Installation ist auf zwei Servern m\u00f6glich. \u00dcblicherweise wird die Integration zun\u00e4chst in der Cloud prototypisch entwickelt und anschlie\u00dfend werden dieselben API-Aufrufe auf einen lokalen Host \u00fcbertragen, sodass SQL-Daten Ihre Infrastruktur nicht verlassen.<\/p>\n\n\n\n
    H\u00e4ufig gestellte Fragen<\/h2>\n\n\n\n
    Gibt die API die Herkunftsinformationen auf Spalten- oder Tabellenebene zur\u00fcck?<\/h3>\n\n\n
    Beides. Die Spaltenebene ist die Standardtiefe: F\u00fcr jede Ausgabespalte erhalten Sie die exakten Quellspalten sowie die Funktionen, Joins und Mengenoperationen zwischen ihnen, wobei direkte und indirekte Abh\u00e4ngigkeiten unterschieden werden. Sie k\u00f6nnen die Tabellenebene als Granularit\u00e4t anfordern, wenn ein kompakter Abh\u00e4ngigkeitsgraph ausreicht.<\/p>\n\n\n\n
    Welche SQL-Dialekte unterst\u00fctzt die Data-Lineage-API?<\/h3>\n\n\n
    39 Dialekte, jeder mit eigenem Parser: Snowflake, BigQuery, Redshift, Databricks, Oracle, SQL Server, PostgreSQL, MySQL, Teradata, Hive, Spark SQL, Trino und weitere. Sie geben den gew\u00fcnschten Dialekt in jeder Anfrage an.<\/p>\n\n\n\n
    Kann es gespeicherte Prozeduren und dynamisches SQL analysieren?<\/h3>\n\n\n
    Ja. Oracle PL\/SQL und SQL Server T-SQL verf\u00fcgen \u00fcber dedizierte Prozedurparser. Die Herkunft des Codes wird \u00fcber Prozedurparameter und tempor\u00e4re Tabellen nachverfolgt, dynamischer SQL-Code innerhalb von Prozeduren wird aufgel\u00f6st und analysiert, und die API kann den Aufrufgraphen der einzelnen Prozeduren zur\u00fcckgeben.<\/p>\n\n\n\n
    Ben\u00f6tigt die API Zugriff auf meine Daten?<\/h3>\n\n\n
    Nein. Es f\u00fchrt eine statische Analyse des von Ihnen \u00fcbermittelten SQL-Textes durch und liest niemals Tabellenzeilendaten. Bei der On-Premise-Edition verbleibt der SQL-Text selbst ebenfalls innerhalb Ihres Netzwerks.<\/p>\n\n\n\n
    Welche Ausgabeformate stehen zur Verf\u00fcgung?<\/h3>\n\n\n
    JSON ist das prim\u00e4re Format f\u00fcr die programmatische Nutzung; der CSV-Export eignet sich f\u00fcr Tabellenkalkulationen und Massenimporte, und der PNG-Export erzeugt das gerenderte Diagramm f\u00fcr die Dokumentation. Enterprise-Implementierungen bieten Exportadapter f\u00fcr DataHub, Microsoft Purview und OpenMetadata.<\/p>\n\n\n\n
    Wo finde ich die vollst\u00e4ndige API-Referenz?<\/h3>\n\n\n
    Bei docs.gudusoft.com<\/a>Dies umfasst Endpunktpfade, Authentifizierung, Anfrageparameter pro Funktion und das vollst\u00e4ndige Antwortschema. Informationen dar\u00fcber, welche Pl\u00e4ne API-Zugriff beinhalten, finden Sie hier. SQLFlow-Preisgestaltung<\/a>.<\/p>\n\n\n\n
    \n\n
    Ermitteln Sie die Herkunft Ihrer SQL-Abfragen als JSON.<\/h2>\n\n\n
    F\u00fcgen Sie eine Abfrage in den kostenlosen Visualisierer ein, um die Graphstruktur zu untersuchen, und verbinden Sie dann die REST-API mit Ihrer Pipeline.<\/p>\n\n\n
    \n
    Testen Sie SQLFlow kostenlos<\/a><\/div>\n\n\n\n
    Sprechen Sie mit uns \u00fcber die API-Integration.<\/a><\/div>\n<\/div>\n\n<\/div><\/div>\n\n\n\n