Référence d'API — @nodefony/drizzle — config
stable
Documentation › Référence d’API › @nodefony/drizzle › config
Générée depuis les déclarations de types publiées de
@nodefony/drizzle10.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/drizzle#
import { … } from "@nodefony/drizzle" — 10 symboles.
Fonctions (2)#
defineDrizzleConfig#
function defineDrizzleConfig(config?: IDrizzleConfigInput, declared?: IDrizzleConfigInput): IDrizzleConfig
Builder type-safe de la configuration de @nodefony/drizzle.
drizzleConfigJsonSchema#
function drizzleConfigJsonSchema(): unknown
JSON Schema introspectable de la config Drizzle — destiné au formulaire d’édition Studio (futur) et à la documentation générée.
Constantes (4)#
DDL_MODES#
const DDL_MODES: readonly [ "auto", "migrate", "none" ]
Stratégies de fabrication du schéma d’un connecteur.
DIVERGENCE_MODES#
const DIVERGENCE_MODES: readonly [ "report", "fail", "off" ]
Conduites face à une base qui ne correspond plus au code alors que l’historique est complet.
MIGRATION_CHECK_MODES#
const MIGRATION_CHECK_MODES: readonly [ "fail", "warn", "off" ]
Conduites de la sonde de disponibilité quand le schéma est en retard.
drizzleConfigSchema#
const drizzleConfigSchema: z.ZodObject<{ connectors: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{ dialect: z.ZodDefault<z.ZodEnum<{ mysql: "mysql"; postgres: "postgres"; sqlite: "sqlite"; }>>; filename: z.ZodOptional<z.ZodString>; url: z.ZodOptional<z.ZodString>; ddl: z.ZodOptional<z.ZodEnum<{ auto: "auto"; migrate: "migrate"; none: "none"; }>>; }, z.core.$strict>>>; migrations: z.ZodDefaul …
Types (4)#
DdlMode#
type DdlMode = (typeof DDL_MODES)[number]
Stratégie de fabrication du schéma d’un connecteur.
DivergenceMode#
type DivergenceMode = (typeof DIVERGENCE_MODES)[number]
Conduite face à une base qui a divergé du schéma déclaré.
MigrationCheckMode#
type MigrationCheckMode = (typeof MIGRATION_CHECK_MODES)[number]
Conduite de la sonde de disponibilité face à un schéma en retard.
SqlDialect#
type SqlDialect = (typeof SQL_DIALECTS)[number]
Dialecte SQL d’un connecteur Drizzle.