Skip to content

SchemaConfigInput

Defined in: packages/core/src/config/types.ts:101

User-facing schema generation configuration for defineConfig().

Controls where generated files are written and whether automatic database migrations run when the schema changes. All properties are optional; omitted properties fall back to the defaults listed below.

Defaults applied by defineConfig():

{
outputPath: "/convex/vex.schema.ts", // vex.schema.ts output location
typesOutputPath: "/convex/vex.types.ts", // vex.types.ts output location
autoMigrate: false, // no auto-migration on schema change
autoRemove: false, // removed tables stay in schema.ts
}
@see {@link SchemaConfig} for the resolved type after defaults are applied
## Properties
### outputPath?
> `optional` **outputPath?**: `string`
Defined in: packages/core/src/config/types.ts:107
Path (relative to project root) where `vex.schema.ts` is written.
Default: `"/convex/vex.schema.ts"`