---
title: "Référence d'API — @nodefony/drizzle — config"
source: docs/api/drizzle/config.md
url: https://nodefony.github.io/nodefony-core/docs/api/drizzle/config/
---


[Documentation](../../../) › [Référence d'API](../../) › [`@nodefony/drizzle`](../) › config

> Générée depuis les déclarations de types publiées de `@nodefony/drizzle` **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/drizzle`

`import { … } from "@nodefony/drizzle"` — 10 symboles.

### Fonctions (2)

#### `defineDrizzleConfig`

```ts
function defineDrizzleConfig(config?: IDrizzleConfigInput, declared?: IDrizzleConfigInput): IDrizzleConfig
```

Builder type-safe de la configuration de `@nodefony/drizzle`.

#### `drizzleConfigJsonSchema`

```ts
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`

```ts
const DDL_MODES: readonly [ "auto", "migrate", "none" ]
```

Stratégies de fabrication du schéma d'un connecteur.

#### `DIVERGENCE_MODES`

```ts
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`

```ts
const MIGRATION_CHECK_MODES: readonly [ "fail", "warn", "off" ]
```

Conduites de la sonde de disponibilité quand le schéma est en retard.

#### `drizzleConfigSchema`

```ts
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`

```ts
type DdlMode = (typeof DDL_MODES)[number]
```

Stratégie de fabrication du schéma d'un connecteur.

#### `DivergenceMode`

```ts
type DivergenceMode = (typeof DIVERGENCE_MODES)[number]
```

Conduite face à une base qui a divergé du schéma déclaré.

#### `MigrationCheckMode`

```ts
type MigrationCheckMode = (typeof MIGRATION_CHECK_MODES)[number]
```

Conduite de la sonde de disponibilité face à un schéma en retard.

#### `SqlDialect`

```ts
type SqlDialect = (typeof SQL_DIALECTS)[number]
```

Dialecte SQL d'un connecteur Drizzle.

---

[← Toutes les références d'API](../../)