{"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\/fr\/api-restful-sqlflow\/","title":{"rendered":"API REST SQLFlow\u00a0: Automatisation de l\u2019extraction de la lign\u00e9e des donn\u00e9es SQL"},"content":{"rendered":"

UN API de tra\u00e7abilit\u00e9 des donn\u00e9es<\/strong> permet d'extraire la lign\u00e9e par programmation\u00a0: vous soumettez du code SQL via HTTP et recevez un graphe de lign\u00e9e structur\u00e9 au format JSON, listant chaque table et colonne source, chaque cible et les relations de transformation entre elles. API REST Gudu SQLFlow<\/strong> Il r\u00e9alise pr\u00e9cis\u00e9ment cela pour 39 dialectes SQL, avec une granularit\u00e9 au niveau des colonnes, y compris les proc\u00e9dures stock\u00e9es et le SQL dynamique. La m\u00eame analyse qui alimente les diagrammes interactifs de SQLFlow est disponible sous forme de donn\u00e9es de tra\u00e7abilit\u00e9 structur\u00e9es via HTTP.<\/p>\n\n\n\n

\n
39<\/b>Les dialectes SQL, chacun avec un analyseur syntaxique d\u00e9di\u00e9<\/span><\/div>\n
Niveau de colonne<\/b>Arbre g\u00e9n\u00e9alogique, direct et indirect<\/span><\/div>\n
JSON<\/b>via HTTP \u2014 une requ\u00eate POST, SQL en entr\u00e9e, graphique en sortie<\/span><\/div>\n
Z\u00e9ro<\/b>acc\u00e8s \u00e0 vos donn\u00e9es \u2014 analyse statique uniquement<\/span><\/div>\n<\/div>\n\n\n\n
\n\n

Consultez d'abord le r\u00e9sultat\u00a0:<\/strong> collez une requ\u00eate dans le Visualiseur de lignage SQLFlow gratuit<\/a>, puis exportez le graphique au format JSON pour voir \u00e0 quoi ressemble la lign\u00e9e sous forme de donn\u00e9es avant d'\u00e9crire une seule ligne de code d'int\u00e9gration.<\/p>\n\n<\/div><\/div>\n\n\n\n

Pourquoi int\u00e9grer une API de tra\u00e7abilit\u00e9 des donn\u00e9es \u00e0 votre infrastructure ?<\/h2>\n\n\n\n

Les diagrammes de lignage interactifs permettent aux humains d'explorer la filiation. Cependant, les utilisations les plus pertinentes du lignage sont automatis\u00e9es\u00a0: bloquer une requ\u00eate d'extraction qui perturbe silencieusement un rapport en aval, maintenir \u00e0 jour le lignage d'un catalogue de donn\u00e9es sans intervention manuelle, ou encore r\u00e9pondre \u00e0 la question \u00ab\u00a0Quelles sont les sources de cette colonne\u00a0?\u00a0\u00bb au sein de vos outils internes. Toutes ces applications n\u00e9cessitent un acc\u00e8s aux donn\u00e9es de lignage, disponibles \u00e0 la demande, via un service accessible.<\/p>\n\n\n\n

L'approche de SQLFlow repose sur l'analyse statique du SQL. L'API analyse le texte SQL que vous lui envoyez sans jamais modifier les lignes de vos tables, ce qui simplifie l'analyse de s\u00e9curit\u00e9\u00a0: seul le code SQL transite sur le r\u00e9seau. \u00e9dition sur site<\/a> m\u00eame cela reste \u00e0 l'int\u00e9rieur de votre r\u00e9seau. Le moteur sous-jacent est le Analyseur SQL g\u00e9n\u00e9ral<\/a>, un compilateur SQL commercial frontal d\u00e9velopp\u00e9 depuis le milieu des ann\u00e9es 2000 et valid\u00e9 par rapport \u00e0 environ 13 600 jeux de tests par dialecte, de sorte que la lign\u00e9e que vous obtenez est construite \u00e0 partir d'un mod\u00e8le s\u00e9mantique complet du SQL, et non d'une correspondance d'expressions r\u00e9guli\u00e8res.<\/p>\n\n\n\n

Ce que renvoie l'API REST SQLFlow<\/h2>\n\n\n\n

Conceptuellement, l'API expose l'int\u00e9gralit\u00e9 de la surface d'analyse SQLFlow sous forme de JSON sur HTTP\u00a0:<\/p>\n\n\n\n

\n
Capacit\u00e9<\/th>Vous envoyez<\/th>Vous revenez<\/th><\/tr><\/thead>
Graphique de lignage<\/td>Texte SQL plus un identifiant de dialecte<\/td>Le graphe de lignage complet au niveau des colonnes au format JSON\u00a0: tables, colonnes et relations source-cible<\/td><\/tr>\n
Trace en amont \/ en aval<\/td>Un tableau ou une colonne d'int\u00e9r\u00eat<\/td>Seul le sous-graphe alimentant cet objet (en amont) ou aliment\u00e9 par lui (en aval) est concern\u00e9 par l'analyse d'impact cibl\u00e9e.<\/td><\/tr>\n
Lign\u00e9e au niveau de la table<\/td>Texte SQL, granularit\u00e9 de table demand\u00e9e<\/td>Un graphe de d\u00e9pendance compact entre les tables lorsque les d\u00e9tails des colonnes seraient superflus.<\/td><\/tr>\n
lign\u00e9e directe vs indirecte<\/td>Un drapeau sur la demande<\/td>Les relations de flux de donn\u00e9es pures, ou en outre les colonnes qui fa\u00e7onnent les r\u00e9sultats par le biais de O\u00d9<\/code>, REJOINDRE<\/code>, et GROUPER PAR<\/code> clauses<\/td><\/tr>\n
Graphe d'appel de proc\u00e9dure stock\u00e9e<\/td>Corps de proc\u00e9dure PL\/SQL ou T-SQL<\/td>Quelles proc\u00e9dures appellent lesquelles, avec une tra\u00e7abilit\u00e9 via les param\u00e8tres, les tables temporaires et le SQL dynamique<\/td><\/tr>\n
Diagramme ER<\/td>Scripts DDL<\/td>Relations inf\u00e9r\u00e9es entre cl\u00e9s primaires et \u00e9trang\u00e8res sous forme de mod\u00e8le entit\u00e9-relation<\/td><\/tr>\n
Exportations<\/td>Un emploi analys\u00e9<\/td>JSON ou CSV pour les machines, PNG pour la documentation et les tickets<\/td><\/tr>\n<\/tbody><\/table><\/figure>\n\n\n\n

Chaque requ\u00eate sp\u00e9cifie explicitement son dialecte. SQLFlow int\u00e8gre des analyseurs syntaxiques sp\u00e9cifiques \u00e0 chaque dialecte pour 39 bases de donn\u00e9es et moteurs de requ\u00eates, de Snowflake, BigQuery, Databricks et Redshift \u00e0 Oracle, SQL Server, Teradata, Hive et Trino. Ainsi, la syntaxe propre \u00e0 chaque fournisseur, comme les tables temporaires T-SQL, est analys\u00e9e conform\u00e9ment \u00e0 sa d\u00e9finition, et non approxim\u00e9e par une grammaire ANSI g\u00e9n\u00e9rique. La liste compl\u00e8te est disponible sur le site web de SQLFlow. Pr\u00e9sentation de l'outil de tra\u00e7abilit\u00e9 des donn\u00e9es SQL<\/a>.<\/p>\n\n\n\n

Exemple minimal\u00a0: requ\u00eate POST SQL, r\u00e9ception d\u2019un graphe de lignage<\/h2>\n\n\n\n

L'interaction principale consiste en un appel HTTP. Vous envoyez une requ\u00eate SQL et un dialecte\u00a0; la r\u00e9ponse est le graphe de lignage. Les chemins des points de terminaison, l'authentification et la documentation compl\u00e8te des param\u00e8tres se trouvent dans le Documentation de l'API SQLFlow<\/a>; la forme de l'\u00e9change ressemble \u00e0 ceci :<\/p>\n\n\n\n

curl -s -X POST \"$SQLFLOW_API\/lineage\" \\\n  -H \"Authorization: Bearer $SQLFLOW_TOKEN\" \\\n  --form \"dbvendor=snowflake\" \\\n  --form 'sqltext=CREATE VIEW customer_ltv AS\n    SELECT c.customer_id,\n           SUM(o.amount) AS lifetime_value\n    FROM   customers c\n    JOIN   orders o ON o.customer_id = c.customer_id\n    WHERE  o.status = ''paid''\n    GROUP  BY c.customer_id;'<\/code><\/pre>\n\n\n\n
La r\u00e9ponse est un graphique\u00a0: une liste d\u2019objets de base de donn\u00e9es (tables, vues et leurs colonnes) et une liste des relations entre les colonnes. Version simplifi\u00e9e et abr\u00e9g\u00e9e \u00e0 des fins d\u2019illustration\u00a0:<\/p>\n\n\n\n
{ "relations": [ { "type": "direct", "cible": {"objet": "customer_ltv", "colonne": "lifetime_value"}, "sources": [{"objet": "orders", "colonne": "amount", "via": "SUM"}] }, { "type": "direct", "cible": {"objet": "customer_ltv", "colonne": "customer_id"}, "sources": [{"objet": "customers", "colonne": "customer_id"}] }, { "type": "indirect", "cible": {"objet": "customer_ltv", "colonne": "lifetime_value"}, "sources": [{"objet": "orders", "colonne": "status", "via": "WHERE"}] } ] }<\/code><\/pre>\n\n\n\n
Notez la troisi\u00e8me relation. statut des commandes<\/code> n'appara\u00eet jamais dans le r\u00e9sultat de la vue, mais il filtre les lignes dont la somme est calcul\u00e9e, donc il a un impact certain. valeur_de_vie<\/code>SQLFlow mod\u00e9lise cela comme lign\u00e9e indirecte<\/strong>, distincte du flux de donn\u00e9es direct et pouvant \u00eatre demand\u00e9e s\u00e9par\u00e9ment. La plupart des outils de tra\u00e7abilit\u00e9 ne font pas cette distinction, et c'est pr\u00e9cis\u00e9ment ce dont un utilisateur d'analyse d'impact a besoin\u00a0: la suppression statut des commandes<\/code> cela fausserait cette vue m\u00eame si aucune colonne de sortie n'en \u00ab provient \u00bb.<\/p>\n\n\n\n
\n\n
Cas d'utilisation\u00a0: v\u00e9rifications de lignage dans l'int\u00e9gration continue<\/h2>\n\n\n\n
L'int\u00e9gration la plus efficace est celle qui s'ex\u00e9cute avant le d\u00e9ploiement de code SQL d\u00e9fectueux. Dans une t\u00e2che d'int\u00e9gration continue ex\u00e9cut\u00e9e sur chaque demande d'extraction qui modifie le code SQL\u00a0:<\/p>\n\n\n\n
  1. Envoyez les fichiers SQL modifi\u00e9s au point de terminaison de lignage et obtenez le nouveau graphique.<\/li>\n
  2. Comparez-le au graphique de la branche principale\u00a0: quelles colonnes ont gagn\u00e9 ou perdu des sources, quels objets en aval ont modifi\u00e9 leurs entr\u00e9es.<\/li>\n
  3. \u00c9chouez le contr\u00f4le ou publiez la diff\u00e9rence en tant que commentaire de r\u00e9vision lorsqu'une modification touche des colonnes qui alimentent des cibles prot\u00e9g\u00e9es telles que des rapports r\u00e9glementaires ou des tableaux de bord de direction.<\/li><\/ol>\n\n\n\n
    L'analyse \u00e9tant statique, elle fonctionne sur du code qui n'a jamais \u00e9t\u00e9 ex\u00e9cut\u00e9. La d\u00e9pendance d\u00e9fectueuse est d\u00e9tect\u00e9e lors de la revue de code, et non lors d'un \u00e9chec d'ex\u00e9cution par lots \u00e0 2 h du matin. Le m\u00eame principe s'applique aux migrations de sch\u00e9ma\u00a0: avant une COLONNE DE CHUTE<\/code> Dans les zones, un seul appel de tra\u00e7age en aval vous indique chaque objet qui consomme la colonne, directement ou via un filtre.<\/p>\n\n<\/div><\/div>\n\n\n\n
    Cas d'utilisation\u00a0: alimenter votre catalogue de donn\u00e9es<\/h2>\n\n\n\n
    Les plateformes de catalogue excellent dans l'organisation des m\u00e9tadonn\u00e9es, la gestion des droits de propri\u00e9t\u00e9 et la d\u00e9couverte des donn\u00e9es\u00a0; le tra\u00e7age des requ\u00eates SQL au niveau des colonnes est g\u00e9n\u00e9ralement leur point faible. SQLFlow s'int\u00e8gre comme moteur de tra\u00e7age\u00a0: il analyse votre environnement SQL, puis transf\u00e8re les r\u00e9sultats vers le catalogue que vous utilisez d\u00e9j\u00e0. Les d\u00e9ploiements en entreprise incluent des adaptateurs d'exportation pr\u00eats \u00e0 l'emploi. DataHub, Microsoft Purview et OpenMetadata<\/strong>Les exportations JSON et CSV alimentent toutes les donn\u00e9es personnalis\u00e9es. \u00c0 grande \u00e9chelle, ce syst\u00e8me effectue des analyses par lots et incr\u00e9mentales sur des ensembles de plus de 100 bases de donn\u00e9es et plus d'un million de colonnes, avec un r\u00e9f\u00e9rentiel de tra\u00e7abilit\u00e9 persistant. Ainsi, le catalogue reste \u00e0 jour sans intervention manuelle.<\/p>\n\n\n\n
    Cas d'utilisation\u00a0: tra\u00e7abilit\u00e9 au sein de vos propres outils<\/h2>\n\n\n\n
    Les plateformes de donn\u00e9es internes d\u00e9veloppent sans cesse les m\u00eames fonctionnalit\u00e9s\u00a0: un panneau \u00ab\u00a0D\u2019o\u00f9 vient cette m\u00e9trique\u00a0?\u00a0\u00bb, un outil de v\u00e9rification de la d\u00e9pr\u00e9ciation, une carte des d\u00e9pendances de migration. Plut\u00f4t que de cr\u00e9er un analyseur SQL, appelez l\u2019API depuis votre service et affichez le graphique comme vous le souhaitez. Si vous pr\u00e9f\u00e9rez le diagramme interactif au JSON brut, SQLFlow propose \u00e9galement un widget JavaScript int\u00e9grable avec une API de plus de 30\u00a0m\u00e9thodes, compatible avec toutes les applications web. Pour une int\u00e9gration JVM c\u00f4t\u00e9 serveur uniquement, une biblioth\u00e8que Java expose le m\u00eame moteur. L\u2019API, le widget et la biblioth\u00e8que renvoient tous des r\u00e9sultats coh\u00e9rents car ils partagent un seul analyseur.<\/p>\n\n\n\n
    \n\n
    Transformez votre SQL en un graphe de lignage via HTTP<\/h2>\n\n\n\n
    Examinez le graphique dans le visualiseur gratuit, puis envoyez la m\u00eame requ\u00eate SQL \u00e0 l'API REST depuis votre pipeline.<\/p>\n\n\n\n
    \n
    Essayez SQLFlow gratuitement<\/a><\/div>\n\n\n\n
    Consultez la documentation de l'API.<\/a><\/div>\n<\/div>\n\n<\/div><\/div>\n\n\n\n
    Comment cela se compare-t-il aux autres options de tra\u00e7abilit\u00e9 programmatique\u00a0?<\/h2>\n\n\n\n
    Il s'agit d'un service d'analyse SQL, et non d'une biblioth\u00e8que d'analyse syntaxique ou d'un collecteur d'ex\u00e9cution.<\/strong> Il est utile de conna\u00eetre trois cat\u00e9gories. Biblioth\u00e8ques d'analyse syntaxique open source<\/strong> comme SQL Lineage<\/code> et sqlglot<\/code> sont r\u00e9ellement performantes pour analyser des instructions individuelles au sein d'un processus Python, et pour une logique SELECT et INSERT simple, elles peuvent suffire\u00a0; la lacune appara\u00eet au niveau des proc\u00e9dures stock\u00e9es, du SQL dynamique, des cas particuliers de dialecte et de la r\u00e9solution des vues ou de l'expansion en \u00e9toile qui n\u00e9cessitent un contexte de sch\u00e9ma. normes de lignage d'ex\u00e9cution<\/strong> comme OpenLineage capture la lign\u00e9e \u00e0 partir des \u00e9v\u00e9nements d'ex\u00e9cution de t\u00e2ches, ce qui est excellent pour la lign\u00e9e au niveau de l'orchestrateur, ex\u00e9cution par ex\u00e9cution, mais ne voit que le code qui a r\u00e9ellement \u00e9t\u00e9 ex\u00e9cut\u00e9, \u00e0 la granularit\u00e9 fournie par l'int\u00e9gration \u00e9mettrice. Plateformes ax\u00e9es sur le catalogue<\/strong> Les API de tra\u00e7abilit\u00e9 expos\u00e9es couvrent l'ensemble des donn\u00e9es ing\u00e9r\u00e9es, de sorte que leurs r\u00e9ponses ne sont d\u00e9taill\u00e9es que jusqu'\u00e0 la source de l'ingestion. L'API REST de SQLFlow est un outil diff\u00e9rent\u00a0: un service d'analyse SQL sp\u00e9cialis\u00e9 qui calcule la tra\u00e7abilit\u00e9 au niveau des colonnes \u00e0 partir du code lui-m\u00eame, y compris les requ\u00eates SQL jamais ex\u00e9cut\u00e9es et les proc\u00e9dures ignor\u00e9es par d'autres outils. Ces deux approches se compl\u00e8tent bien\u00a0; de nombreuses \u00e9quipes utilisent SQLFlow pour calculer la tra\u00e7abilit\u00e9 et un catalogue pour la mettre \u00e0 disposition des utilisateurs finaux.<\/p>\n\n\n\n
    O\u00f9 l'API s'ex\u00e9cute\u00a0: dans le cloud ou sur votre propre r\u00e9seau<\/h2>\n\n\n\n
    L'API REST est disponible dans les deux d\u00e9ploiements SQLFlow. SQLFlow Cloud<\/a> est la solution de d\u00e9marrage la plus rapide\u00a0: un SaaS avec une offre gratuite, une offre premium \u00e0 $49,99\u00a0\u20ac\/mois, sans infrastructure \u00e0 g\u00e9rer. SQLFlow sur site<\/a> D\u00e9ployable via Docker ou Kubernetes au sein de votre r\u00e9seau, cette solution fonctionne en mode totalement isol\u00e9 du r\u00e9seau et est propos\u00e9e au prix de $500\/mois ou $4\u00a0800 en une seule fois par type de base de donn\u00e9es s\u00e9lectionn\u00e9. Elle peut \u00eatre install\u00e9e sur deux serveurs. Il est courant de prototyper l'int\u00e9gration dans le cloud, puis de transf\u00e9rer les m\u00eames appels d'API vers un h\u00f4te sur site afin que les requ\u00eates SQL ne quittent jamais votre infrastructure.<\/p>\n\n\n\n
    Foire aux questions<\/h2>\n\n\n\n
    L'API renvoie-t-elle la tra\u00e7abilit\u00e9 au niveau des colonnes ou au niveau des tables\u00a0?<\/h3>\n\n\n
    Les deux. Le niveau de d\u00e9tail par d\u00e9faut est celui des colonnes\u00a0: pour chaque colonne de sortie, vous obtenez les colonnes sources exactes ainsi que les fonctions, jointures et op\u00e9rations ensemblistes qui les relient, avec distinction entre les relations directes et indirectes. Vous pouvez demander une granularit\u00e9 au niveau de la table lorsqu'un graphe de d\u00e9pendances compact suffit.<\/p>\n\n\n\n
    Quels dialectes SQL l'API de tra\u00e7abilit\u00e9 des donn\u00e9es prend-elle en charge\u00a0?<\/h3>\n\n\n
    39 dialectes, chacun avec son propre analyseur syntaxique\u00a0: Snowflake, BigQuery, Redshift, Databricks, Oracle, SQL Server, PostgreSQL, MySQL, Teradata, Hive, Spark SQL, Trino, et bien d\u2019autres. Vous sp\u00e9cifiez le dialecte dans chaque requ\u00eate.<\/p>\n\n\n\n
    Peut-il analyser les proc\u00e9dures stock\u00e9es et le SQL dynamique\u00a0?<\/h3>\n\n\n
    Oui. Oracle PL\/SQL et SQL Server T-SQL disposent d'analyseurs syntaxiques proc\u00e9duraux d\u00e9di\u00e9s. La tra\u00e7abilit\u00e9 est assur\u00e9e par les param\u00e8tres des proc\u00e9dures et les tables temporaires, le SQL dynamique int\u00e9gr\u00e9 aux proc\u00e9dures est r\u00e9solu et analys\u00e9, et l'API peut renvoyer le graphe d'appels de proc\u00e9dure \u00e0 proc\u00e9dure.<\/p>\n\n\n\n
    L'API a-t-elle besoin d'acc\u00e9der \u00e0 mes donn\u00e9es\u00a0?<\/h3>\n\n\n
    Non. Il effectue une analyse statique du texte SQL que vous soumettez et ne lit jamais les donn\u00e9es des lignes de la table. Avec l'\u00e9dition sur site, le texte SQL lui-m\u00eame reste \u00e9galement au sein de votre r\u00e9seau.<\/p>\n\n\n\n
    Quels sont les formats de sortie disponibles\u00a0?<\/h3>\n\n\n
    Le format JSON est privil\u00e9gi\u00e9 pour les applications programmatiques\u00a0; l\u2019exportation CSV est adapt\u00e9e aux tableurs et aux chargements en masse, tandis que l\u2019exportation PNG produit le diagramme rendu pour la documentation. Les d\u00e9ploiements en entreprise ajoutent des adaptateurs d\u2019exportation pour DataHub, Microsoft Purview et OpenMetadata.<\/p>\n\n\n\n
    O\u00f9 se trouve la documentation compl\u00e8te de l'API\u00a0?<\/h3>\n\n\n
    \u00c0 docs.gudusoft.com<\/a>, couvrant les chemins d'acc\u00e8s aux points de terminaison, l'authentification, les param\u00e8tres de requ\u00eate par capacit\u00e9 et le sch\u00e9ma de r\u00e9ponse complet. Pour conna\u00eetre les forfaits incluant l'acc\u00e8s \u00e0 l'API, consultez Tarification de SQLFlow<\/a>.<\/p>\n\n\n\n
    \n\n
    R\u00e9cup\u00e9rez la lign\u00e9e au format JSON \u00e0 partir de votre SQL.<\/h2>\n\n\n
    Collez une requ\u00eate dans le visualiseur gratuit pour examiner la structure du graphique, puis connectez l'API REST \u00e0 votre pipeline.<\/p>\n\n\n
    \n
    Essayez SQLFlow gratuitement<\/a><\/div>\n\n\n\n
    Parlez-nous de l'int\u00e9gration API<\/a><\/div>\n<\/div>\n\n<\/div><\/div>\n\n\n\n