Aller au contenu

Importer depuis Hasura

Provisa peut convertir des métadonnées Hasura existantes en un config.yaml Provisa, en préservant les tables suivies, les relations, les autorisations et les schémas distants.

Import interactif (Admin → Import Hasura Config)

La surface d'administration exécute les mêmes convertisseurs : un import ne nécessite ni accès shell ni allers-retours de fichier de configuration. Requiert la capacité org_settings ; l'import atterrit dans l'organisation dans laquelle agit la session.

  1. Téléverser. Choisissez un répertoire de métadonnées Hasura v2 zippé, un projet DDN zippé, un export de métadonnées consolidé (.yaml/.json, y compris l'enveloppe {resource_version, metadata} que retourne l'API de métadonnées), ou un unique fichier .hml. Laissez le format sur Detect automatically sauf si le téléversement est ambigu.
  2. Associer les domaines (optionnel). Chaque paire associe un schéma v2 ou un sous-graphe DDN à un domaine Provisa ; tout ce qui n'est pas associé conserve son nom d'origine.
  3. Convertir et prévisualiser. Le serveur convertit et retourne des comptages, les avertissements du convertisseur, et la configuration générée. Rien n'est écrit à cette étape.
  4. Réviser et modifier. La configuration est modifiable sur place — détails de connexion, noms de domaines, noms de rôles. Ce que vous appliquez est ce qui est affiché.
  5. Appliquer. Replace the existing semantic layer supprime chaque source, table, rôle et règle absent de la configuration ; laissé désactivé, l'import fusionne avec ce que possède déjà l'organisation. L'application charge la configuration et reconstruit les schémas de l'organisation.

Endpoints : POST /admin/import/hasura/preview et POST /admin/import/hasura/apply.


Hasura v2

Exporter les métadonnées

Depuis votre console ou CLI Hasura :

hasura metadata export --output metadata.yaml

Ou utilisez l'API Hasura :

curl -X POST http://localhost:8080/v1/metadata \
  -H "X-Hasura-Admin-Secret: <secret>" \
  -d '{"type":"export_metadata","args":{}}' \
  > metadata.json

Convertir

Le convertisseur v2 lit un répertoire de métadonnées Hasura (la structure produite par hasura metadata export, ou la structure plate tables.yaml / actions.yaml) et écrit une configuration Provisa :

python -m provisa.hasura_v2 ./metadata -o config.yaml

Omettez -o pour écrire la configuration sur stdout.

Options :

Option Rôle
-o, --output Chemin YAML de sortie (par défaut : stdout)
--source-overrides Fichier YAML avec des surcharges de connexion par source (hôte, port, identifiants)
--domain-map Correspondances schéma-vers-domaine sous forme de paires SCHEMA=DOMAIN
--auth-env-file Fichier .env avec la configuration d'authentification ; convertit JWT/JWK, le secret admin, et la carte des revendications
--dry-run Analyse et valide sans écrire de sortie

Ce qui est converti

Concept Hasura Équivalent Provisa
Table suivie tables[] avec publish: true
Relation objet relationships[] avec cardinality: many-to-one. Une relation déclarée par la seule colonne FK (foreign_key_constraint_on: artist_id) ne nomme aucune cible dans l'export ; le convertisseur la résout via la relation tableau inverse, et l'abandonne avec un avertissement [relationships] lorsqu'il n'y en a aucune. (REQ-1680)
Relation tableau relationships[] avec cardinality: one-to-many
Autorisation select Visibilité de rôle + filtre RLS. Un terme de variable de session (X-Hasura-User-Id) devient current_setting('provisa.user_id'), que la requête lie à l'id utilisateur et aux revendications de l'identité au moment de la requête. (REQ-1682)
Autorisation colonne visible_to / writable_by
Autorisation insert/update/delete writable_by de mutation + RLS
Schéma distant Enregistrement de source graphql_remote plus une table atterrie par champ racine Query que les SDL de rôle exposent ; une colonne est visible pour tout rôle dont le SDL l'expose, un argument racine non nul devient une colonne de filtre natif _nf_, les champs imbriqués sont nommés dans un avertissement. (REQ-1681)
Champ calculé Entrée functions[] avec kind: query

Connexions et domaines dans l'onglet d'import

L'export nomme ses bases de données par variable d'environnement, donc après la première conversion, l'onglet liste chaque source SQL avec la connexion devinée par la conversion. Renseignez l'hôte, le port, la base de données, le nom d'utilisateur et le mot de passe, puis reconvertissez ; seuls les champs modifiés sont transmis, comme des surcharges de source. Les lignes de domaine couvrent chaque schéma, sous-graphe et schéma distant que porte le téléversement ; chacune est un sélecteur parmi les domaines existants de l'organisation qui accepte aussi un nom saisi, marqué « nouveau domaine » quand il ne correspond à aucun. Appliquer fusionne avec ce que l'organisation possède déjà, sauf si la case à cocher de remplacement est activée. (REQ-1687)

Les types proviennent de la source à l'aperçu

Un export Hasura nomme les colonnes sans types, et une table suivie sans autorisation ne nomme aucune colonne. L'aperçu s'exécute avec les connexions de source fournies, donc il lit le information_schema.columns de chaque source SQL accessible : chaque colonne non typée reçoit le type de la source mappé vers le vocabulaire IR, et une table sans colonnes prend toutes les colonnes que la source possède, visibles pour org_admin seul, puisque Hasura ne les exposait à aucun autre rôle. Une source que l'aperçu ne peut pas atteindre est signalée par un avertissement [sources] et ses colonnes restent non typées, à finaliser avant l'application. (REQ-1691, REQ-1684)

Limitations

  • Actions : converties automatiquement — les actions à gestionnaire HTTP deviennent des mutations webhooks[] ; les actions avec un gestionnaire non-HTTP (base de données) deviennent un espace réservé functions[] et émettent un avertissement invitant à réviser le gestionnaire
  • Déclencheurs d'événements : convertis en configuration event_triggers par table (opérations, URL de webhook, politique de nouvelle tentative) et émettent un avertissement signalant une fidélité limitée
  • Schémas distants : convertis en entrées de source graphql_remote et atterris comme tables depuis les SDL de permission de rôle ; un schéma distant sans permissions n'atterrit rien, puisque l'export ne porte aucune autre déclaration de sa forme (REQ-1681)
  • Fonctions SQL personnalisées : nécessitent une révision — les cas simples se convertissent en entrées functions[], les cas complexes nécessitent un travail manuel
  • Déclencheurs cron : convertis en entrées de configuration scheduler, en préservant l'expression cron et l'indicateur d'activation

Hasura DDN (v3)

Localiser le projet HML

Le convertisseur DDN lit directement le répertoire du projet DDN contenant les fichiers .hml — aucune étape de build de supergraphe n'est requise. Le premier composant de répertoire sous la racine du projet est pris comme nom de sous-graphe ; les fichiers sous globals/ sont assignés au sous-graphe globals.

Convertir

python -m provisa.ddn ./my-ddn-project -o config.yaml

Omettez -o pour écrire la configuration sur stdout.

Options :

Option Rôle
-o, --output Chemin YAML de sortie (par défaut : stdout)
--source-overrides Fichier YAML avec des surcharges de connexion par source
--domain-map Correspondances sous-graphe-vers-domaine sous forme de paires SUBGRAPH=DOMAIN
--aggregates-output Chemin de sortie pour le fichier annexe des expressions d'agrégation (par défaut : <output>-aggregates.yaml)
--dry-run Analyse et valide sans écrire de sortie

Les métadonnées AggregateExpression sont préservées dans un fichier annexe *-aggregates.yaml.

Ce qui est converti

Concept DDN Équivalent Provisa
Modèle de sous-graphe tables[] sous une source
Relation relationships[]
Règle d'autorisation Filtre RLS
Commande Mutation webhook ou vue
Connecteur Entrée de source avec détails de connexion

Limitations

  • Connecteurs Lambda (fonctions TypeScript/Python) nécessitent une configuration manuelle de webhook
  • Plugins de cycle de vie n'ont pas d'équivalent direct
  • Modes d'authentification DDN se mappent aux fournisseurs d'authentification Provisa mais les chemins de revendication JWT peuvent nécessiter des ajustements

Après l'import

  1. Révisez le config.yaml généré — portez attention aux warnings du convertisseur
  2. Vérifiez les identifiants de connexion (le convertisseur utilise des valeurs d'espace réservé)
  3. Démarrez Provisa et confirmez que les tables apparaissent dans l'Explorer
  4. Exécutez vos requêtes GraphQL existantes — le schéma est compatible avec les motifs courants
  5. Soumettez les requêtes pour approbation via l'API Admin ou l'UI avant d'activer la gouvernance en production