Nodefony 10.0.0-beta.5
Framework Node.js fullstack — HTTP & WebSocket, même contexte

Référence d'API — @nodefony/orm-core — interfaces

stable

Documentation › Référence d’API › @nodefony/orm-core › interfaces

Générée depuis les déclarations de types publiées de @nodefony/orm-core 10.0.0-beta.5 : exactement ce que reçoit une application qui l’installe. Cette page n’existe dans aucun dépôt — pour la corriger, on corrige le TSDoc du code.

@nodefony/orm-core#

import { … } from "@nodefony/orm-core" — 43 symboles.

Fonctions (1)#

isMigrationFailure#

function isMigrationFailure(reply: IOrmMigrationReply | IOrmMigrationPlanReply | IOrmMigrationApplyReply): reply is IOrmMigrationFailure

Y a-t-il un empêchement plutôt qu’un état ?

Interfaces (35)#

FieldOperators#

interface FieldOperators<V>

Opérateurs de comparaison riches applicables à un champ, façon MongoDB.

IColumnInfo#

interface IColumnInfo

Colonne/champ normalisé d’une entité (extrait via IOrm.describeEntity).

IConnectionError#

interface IConnectionError

Erreur de connexion horodatée (message redacté — jamais de credential).

IConnectionEvent#

interface IConnectionEvent

Un événement de vie de la connexion : une PERTE ou une REPRISE, constatée par l’adapter (événement du driver) ou par le battement de cœur.

IConnectionHealth#

interface IConnectionHealth

Diagnostic d’un connecteur — réponse de /nodefony/orm/api/connection/health. Combine l’état figé (IConnectionInfo), les compteurs de cycle de vie (connexions, reconnexions, erreurs) du moniteur, et un ping live (round-trip réel mesuré à la requête).

IConnectionInfo#

interface IConnectionInfo

Connexion sous-jacente d’un ORM (extrait via IOrm.describeConnection).

IEntity#

interface IEntity<S = unknown, M = unknown>

IEntityGraphNode#

interface IEntityGraphNode

Nœud du graphe : une entité avec ses colonnes et ses relations.

IEntityIndex#

interface IEntityIndex

Index COMPOSITE déclaré par une entité, pour l’adapter qui ne sait pas l’exprimer dans son schéma (Mongoose : un SchemaDefinition plat n’a d’index que par champ).

IEntityRelation#

interface IEntityRelation

Relation déclarative entre deux entités, indépendante du driver ORM.

ILatencyWindow#

interface ILatencyWindow

Fenêtre glissante de latence de ping — min/avg/max sur les N derniers échantillons (révèle les pics, pas seulement l’instantané). null tant qu’aucun ping n’a été mesuré.

IOrm#

interface IOrm

Contrat d’une instance ORM gérée par le framework (une par connexion logique).

IOrmFlowReport#

interface IOrmFlowReport

Rapport de flux complet — un par instance (cloud-native : per-process). Le débit/s n’y figure pas (dérivé du delta de total entre deux ts).

IOrmGraph#

interface IOrmGraph

Graphe complet du modèle de données — réponse de /nodefony/orm/api/graph.

IOrmMigrationAction#

interface IOrmMigrationAction

Une commande à taper, telle que le produit la propose.

IOrmMigrationApplied#

interface IOrmMigrationApplied

Ce qu’une application a fait — ou l’empêchement qui l’a arrêtée.

IOrmMigrationEntry#

interface IOrmMigrationEntry

Une migration, telle que l’historique et les fichiers la décrivent.

IOrmMigrationFailure#

interface IOrmMigrationFailure

Ce qu’un ORM répond quand il ne PEUT pas rendre d’état.

IOrmMigrationPlan#

interface IOrmMigrationPlan

Ce qui S’APPLIQUERAIT — le plan, avec son SQL.

IOrmMigrationSource#

interface IOrmMigrationSource

Les migrations d’une origine — le framework, l’application, un module.

IOrmMigrationStatus#

interface IOrmMigrationStatus

L’état complet, cœur neutre — la charge utile de l’écran et de --json.

IOrmPendingMigration#

interface IOrmPendingMigration

Une migration en attente, avec le SQL qu’elle exécuterait.

IOrmPoolProbe#

interface IOrmPoolProbe

Sonde de pool de connexions — pertinente pour les bases serveur (Mongo, Postgres, MySQL). SQLite (better-sqlite3) = mono-connexion → non renseigné.

IOrmProbe#

interface IOrmProbe

Sonde profonde driver-spécifique retournée par IOrm.probe. Tous les champs sont optionnels : un adapter ne rapporte que ce qu’il sait mesurer.

IOrmResilience#

interface IOrmResilience

Le mécanisme de résilience d’un connecteur, TEL QU’IL TOURNE dans ce process.

IOrmStorageProbe#

interface IOrmStorageProbe

Sonde de stockage — driver-spécifique. Pour SQLite : dérivée des PRAGMA (page_count, page_size, journal_mode, freelist_count). Pour un serveur : taille logique de la base si l’adapter sait l’obtenir.

IOrmSummary#

interface IOrmSummary

Résumé d’un ORM/connecteur enregistré.

IQueryFlow#

interface IQueryFlow

Compteurs de flux d’UN connecteur ORM. Cumuls depuis le boot (le débit/s se dérive du delta de total). Latence en deux vues : moyenne sur la vie du process (avgMs) et EWMA lissée (ewmaMs, suit les variations récentes).

IRelationInfo#

interface IRelationInfo

Relation projetée pour le graphe (sous-ensemble sérialisable de IEntityRelation).

IRepository#

interface IRepository<T = unknown>

Contrat CRUD minimal exposé par un repository, indépendant de l’ORM sous-jacent.

ISlowQuery#

interface ISlowQuery

Une requête « lente » capturée (au-delà du seuil). Le SQL est paramétré (placeholders, jamais les valeurs) et redacté → 0 credential. Capturé uniquement sur le chemin lent (rare) pour ne rien coûter au cas nominal.

ITransaction#

interface ITransaction

Unité de travail transactionnelle abstraite (commit / rollback / savepoint).

PageQuery#

interface PageQuery<T = unknown> extends IPageQuery

Requête de page pour un IRepository — le contrat de page core (IPageQuery) enrichi du criteria typé de l’ORM. C’est la forme que paginate consomme.

RepositoryReadOptions#

interface RepositoryReadOptions

Options de lecture (find/findOne) portables cross-ORM.

UpdateOperators#

interface UpdateOperators<V>

Opérateurs d’écriture applicables à un champ dans le update d’un IRepository.upsert — par opposition aux FieldOperators, qui filtrent en lecture.

Types (7)#

Criteria#

type Criteria<T> = { [K in keyof T]?: FieldCriteria<T[K]>; } & { $or?: ReadonlyArray<Criteria<T>>; } & OrmCriteria

Critère typé par champ d’une entité T.

FieldCriteria#

type FieldCriteria<V> = V | FieldOperators<NonNullable<V>>

Valeur de critère pour un champ : soit l’égalité directe (valeur nue), soit un objet d’FieldOperators riche.

IOrmMigrationApplyReply#

type IOrmMigrationApplyReply = IOrmMigrationApplied | IOrmMigrationFailure

Le compte rendu d’application, ou l’empêchement.

IOrmMigrationPlanReply#

type IOrmMigrationPlanReply = IOrmMigrationPlan | IOrmMigrationFailure

Le plan, ou l’empêchement.

IOrmMigrationReply#

type IOrmMigrationReply = IOrmMigrationStatus | IOrmMigrationFailure

L’état, ou l’empêchement — jamais les deux.

OrmCriteria#

type OrmCriteria = Record<string, unknown>

Critère de filtre brut passé aux opérations d’un repository.

UpdateData#

type UpdateData<T> = { [K in keyof T]?: T[K] | UpdateOperators<NonNullable<T[K]>>; }

Données d’écriture d’un IRepository.upsert : chaque champ accepte soit sa valeur nue (écriture directe), soit un objet d’UpdateOperators.


← Toutes les références d’API