Type insert-service inputs
Define a reusable type for objects passed to an insert function.
Drizzle ORM · Type Alias
InferInsertModel
InferInsertModel derives the TypeScript shape for inserting rows from a Drizzle table schema. It is used as InferInsertModel<typeof users> and has a table-property equivalent, $inferInsert.
How it works
InferInsertModel receives a Drizzle table type and produces the TypeScript shape accepted when inserting into that table. In the documented example, the inferred insert type permits omitting an auto-incremented primary key while retaining the required name field.
Syntax
InferInsertModel<typeof table>Parameters
| Name | Type | Description |
|---|---|---|
TTable | typeof users | The Drizzle table type whose insert-row shape should be inferred. |
Returns
The insert model type inferred from the supplied Drizzle table schema.
Key points
- InferInsertModel derives an insert model directly from a SQLite table definition.
- Import InferInsertModel as a type from the main
drizzle-ormpackage. - Apply the helper to
typeofthe table to create a named insert-row type. - The table exposes
$inferInsertas a concise alternative to the standalone helper. - An auto-incrementing primary key is part of the schema used to demonstrate inference.
- The inferred alias is compile-time TypeScript information and does not execute a database query.
Common mistakes
- The table's
$inferInsertproperty is an alternative to the InferInsertModel helper; choose either form consistently.
Example: Infer an insert model from a SQLite table
import { integer, text, sqliteTable } from 'drizzle-orm/sqlite-core';
import { type InferInsertModel } from 'drizzle-orm';
const users = sqliteTable('users', {
id: integer().primaryKey({ autoIncrement: true }),
name: text().notNull(),
});
type NewUser = InferInsertModel<typeof users>;
const newUser: NewUser = { name: 'Alef' };Infer an insert model from the table schema, then use it to type a new row; the auto-incremented id is omitted.
When to use it
Keep input types aligned
Avoid manually duplicating fields and optionality from a table schema.
Share schema-derived typing
Use the same inference pattern across Drizzle-supported table schemas.
Interview questions
QWhat does InferInsertModel do?
InferInsertModel is a Drizzle type helper that derives an insert-row type from a table schema. It is used as InferInsertModel<typeof users> and is shown alongside the table's $inferInsert type.
Follow-up: How can the same type be obtained without the helper? Use typeof users.$inferInsert.
QHow is InferInsertModel written?
Pass the table object as the helper's generic argument: InferInsertModel<typeof users>. The resulting alias can type an object passed to an insert operation.
Follow-up: What must the generic argument represent? It must be the Drizzle table value's type, obtained with typeof.
QHow does an insert model differ from a select model?
It describes data for inserting rows, rather than the selected-row model. In the documented schema, the generated id can be omitted from the insert object while name remains available as a field.
Follow-up: What alternative is documented for the same purpose? The table-level .$inferInsert property.
Related
InferSelectModel$inferInsert$inferSelect