Open-Source Wikis

/

Prisma

/

Reference

/

Data models

prisma/prisma

Data models

Public TypeScript types Prisma exposes. This page lists the most commonly referenced ones and where they live.

PrismaClientOptions

The constructor options for new PrismaClient(...). Validated in packages/client/src/runtime/utils/validatePrismaClientOptions.ts.

Field Type Notes
errorFormat 'pretty' | 'colorless' | 'minimal' Error rendering style
adapter SqlDriverAdapterFactory Required in Prisma 7. Without it, P2038 at instantiation
accelerateUrl string Switches to RemoteExecutor
log LogLevel[] | LogDefinition[] Log subscription
transactionOptions { maxWait, timeout, isolationLevel } Defaults for interactive transactions
omit OmitConfig Per-model field omission
comments SqlCommenterPlugin[] SQL Commenter plugins
__internal unknown Reserved escape hatch for Prisma's own tooling

PrismaConfigInternal

The parsed shape of prisma.config.ts. Loaded by @prisma/config. See PrismaConfigInternal.

Provider

'mysql' | 'postgres' | 'sqlite' | 'sqlserver'. Defined in packages/driver-adapter-utils/src/types.ts. Note this is the adapter-layer spelling — the schema-layer provider names also include mongodb and cockroachdb, which the adapter layer subsumes under postgres.

MappedError

Normalized error shape from a driver adapter. Defined in packages/driver-adapter-utils/src/types.ts. See MappedError.

SqlQuery

The query payload an adapter receives:

  • sql: string
  • args: ArgArray
  • argTypes?: ArgType[]

Defined in packages/driver-adapter-utils/src/types.ts.

SqlQueryable / SqlDriverAdapter / Transaction

Driver adapter contract. Defined in packages/driver-adapter-utils/src/types.ts. See SqlQueryable / SqlDriverAdapter.

DMMF

Datamodel Meta Format types. Defined in packages/dmmf/src/. Internal — no stability guarantees.

SQL Commenter types

SqlCommenterPlugin, SqlCommenterContext, SqlCommenterQueryInfo, SqlCommenterTags. Defined in packages/sqlcommenter/src/.

Generator types

For external generators, see @prisma/generator-helper:

  • DMMF
  • GeneratorConfig
  • GeneratorOptions
  • GeneratorManifest

The generatorHandler({ onManifest, onGenerate }) helper wraps stdio for IPC.

Public client errors

Caught by user code:

  • PrismaClientKnownRequestError — DB-side error mapped to a P2xxx code
  • PrismaClientUnknownRequestError — Engine error without a known code
  • PrismaClientRustPanicError — Schema Engine panic (rare)
  • PrismaClientInitializationError — Constructor / setup failure (e.g., P2038)
  • PrismaClientValidationError — User input validation failed before reaching the engine

The class hierarchy lives in packages/client/src/runtime/core/errors/.

See also

Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.

Data models – Prisma wiki | Factory