[BUG]: TypeScript error on optional fields during update (and insert) operation #2654

DavidHavl · 2024-07-18T17:13:37Z

What version of `drizzle-orm` are you using?

0.32.0

What version of `drizzle-kit` are you using?

0.23.0

Describe the Bug

I've encountered a TypeScript error when trying to update an optional field using the set method. The error occurs only for optional fields, while required fields work as expected.

Steps to reproduce:

Define a table with both required and optional fields:

export const TasksTable = sqliteTable(
  'tasks',
  {
    id: text('id')
      .primaryKey()
      .$defaultFn(() => createId()),
    title: text('title').notNull(),
    description: text('description')
  },
);

Attempt to update the table with both required and optional fields:

const result = await db
  .update(TasksTable)
  .set({
    title: 'sdfg',
    description: 'asdf'
  });

Expected behavior:
The update operation should work without any TypeScript errors, as all fields being updated are defined in the table schema.

Actual behavior:
TypeScript throws an error for the optional 'description' field:
"Object literal may only specify known properties, and 'description' does not exist in type"
The error does not occur for the required 'title' field.

Additional notes:

The error only occurs for optional fields (those without .notNull())
Using as any type assertion works as a temporary workaround, but it's not a proper solution

Please let me know if you need any additional information or clarification to investigate this issue.

Expected behavior

The update operation should work without any TypeScript errors, as all fields being updated are defined in the table schema.

Environment & setup

Database: SQLite
Node: 20
Typescript: 5.3.3

The text was updated successfully, but these errors were encountered:

lmcneel · 2024-07-21T01:19:12Z

We encountered this same issue with:

Database: Postgresql
Node: 20
TypeScript: 5.5.3

We attempted to pin to a Drizzle ORM 0.31.0 to wait for a fix and discovered that we can't use Drizzle Kit if we do that.
Drizzle Kit prints that it needs to be updated and won't generate migrations.
The new version of Drizzle Kit requires Drizzle ORM > 0.32.0.

tirth0 · 2024-07-23T12:08:50Z

Experiencing the same issue.

Jean-CharlesTerrillon · 2024-07-24T11:32:30Z

Same here

I suggest to use inferSelect instead of inferInsert, see below

export type PgUpdateSetSource = {
[Key in keyof TTable['$inferSelect']]?: GetColumnData<TTable['_']['columns'][Key]> | SQL;
} & {};

murilo-kendjy · 2024-07-24T11:43:42Z

I was facing the same problem when upgrading to version >0.31.4, there's a post in discord where rphlmr said that you need strict mode on your tsconfig.json. That solved for me.

ps: I needed to remove all other strict tags and let only strict tag true.

eliellis · 2024-07-24T18:24:46Z

I was facing the same problem when upgrading to version >0.31.4, there's a post in discord where rphlmr said that you need strict mode on your tsconfig.json. That solved for me.

ps: I needed to remove all other strict tags and let only strict tag true.

While this does seem to fix the issue, I'd argue that this is an incredibly disruptive change to make to a project when it was not a requirement before now. Hopefully this can be resolved without resorting to flipping strict: true in projects that have been previously successfully using Drizzle without this compiler flag.

mion-kr · 2024-08-01T06:48:36Z

same issue

khanhquocnguyen · 2024-08-10T13:03:53Z

I have the same issue.

Environment:

OS: MacOS
Database: PostgreSQL
drizzle-orm version: 0.32.2
node version: v22.5.1
typescript version: 5.4.5

Temporary workaround:
Add the following comment line above the insert command.
// @ts-ignore: Unreachable code error

Anuolu-2020 · 2024-09-02T08:53:43Z

Has there being any fix to this bug? I don't want to turn on strict mode in my tsconfig.json

anishkumar127 · 2024-09-10T08:15:09Z

Same issue please give me solution. any update to fix this issue ?

sameedahri · 2024-09-18T22:37:31Z

Any solution, I am also facing same issue?

sameedahri · 2024-09-22T16:22:54Z

I found the solution guys. Just go to the tsconfig.json file, in the compiler options object add below line.
"strictNullChecks": true,

anishkumar127 · 2024-09-23T06:53:50Z

I found the solution guys. Just go to the tsconfig.json file, in the compiler options object add below line. "strictNullChecks": true,

this also not working!

sameedahri · 2024-09-23T10:54:06Z

Are you guys sure? Because I got stuck for so many days, and this thing solves the issue, I can also insert nullable values and typescript also auto complete table variable name

sameedahri · 2024-09-23T10:57:18Z

Can you guys share you tsconfig file?

leandromatos · 2024-09-24T16:33:24Z

Unfortunately, I decided not to upgrade the drizzle-orm and drizzle-kit packages since I don't want to change the typescript configs, which would cause a lot of other troubles in the project.

Here, I'm using drizzle-kit@^0.22.8 and drizzle-orm@^0.31.4.

jabreland · 2024-09-27T01:01:39Z

Changing it to strict worked for me to. (Postrgres and Drizzle-orm 0.33) I was confused because it was working just fine in another project but I had already turned strict on for Acktypes

mogery · 2024-09-27T11:57:24Z

That's not a fix. I'm not going to rewrite a 20k LoC codebase to work with strict null checking just to make this work.

leandromatos · 2024-09-27T13:22:08Z

The problem with using the strict option on TypeScript is that, depending on the size of your code base, you will be forced to update a lot of things. This is really annoying.

naourass · 2024-10-03T21:56:34Z

I was going crazy after updating Drizzle to the latest version. Fortunately I've found that thread, maybe adding a notice in docs beside installation section would help users that were using Drizzle without ts strict mode.

lcptrs · 2024-10-08T08:46:28Z

It seems to have gotten better with the 0.34 release. In our codebase we only have the issue remaining on the set parameter of the onConflictDoUpdate which can be easily worked around with a cast as Partial<typeof table.$inferInsert>🎉

leandromatos · 2024-10-09T21:18:52Z

Unfortunately, @lcptrs, this workaround will add another problem. The result of an insert operation's inference returns the optional and required fields defined in the database. Your suggestion will make all the properties optional.

I believe this problem won't be fixed in the near future. It seems to be a mix of the natural evolution of TypeScript and its config and the evolution of other dependencies. I'm not sure about that, but if the solution is to use strict: true on the tsconfig.json, I think it is because some dependencies use the strict property, and the types are conflicting.

I will probably give up and put strict: true on my project, fix all the TypeScript problems caused by this config, and finally update the new versions of the Drizzle packages.

0xshc · 2024-11-11T18:24:51Z

is there any update on this? still not fixed.

database: postgres
node: 20
typescript: 5.6.3
drizzle-orm: 0.36.1
drizzle-kit: 0.28.0

NiazMorshed2007 · 2024-11-12T05:02:45Z

same problem :(

drizzle-orm: 0.36.1
drizzle-kit: 0.28.0

AlexBlokh · 2024-11-12T20:35:02Z

well, that's a very tricky one, we've spent half a day with @Sukairo-02 trying to figure out what type in particular is responsible for that

strict: true indeed fixes it, with strict: false there're 2 more ts flags that fix it, yet we will make sure it works out of the box for you

AlexBlokh · 2024-11-13T14:02:42Z

alright, landing in beta today - #3542

…#3542)

ahsankhan201010 · 2024-11-14T09:07:32Z

faced the issue today, love to see that the fix has been merged in beta 🚀

AndriiSherman · 2024-11-14T12:38:14Z

fixed in drizzle-orm@0.36.2

Said-Alisic · 2024-11-24T16:55:27Z

Still facing the issue and have to use // @ts-ignore: Unreachable code error or something like as Partial<typeof table.$inferUpdate>. Setting "strictNullChecks": true, or removing it raises too many errors across the code that need to be fixed or ignored by the compiler. Really enjoying Drizzle ORM, but have to say it is very wonky at times.

Below is additional information of my file, method and schema structures.

❗ Notice that my field cartItemStatus is not even an optional field as others in this thread mention but it still causes the problem.

package.json

{
  "name": "fitbyprince",
  "version": "0.1.0",
  "private": true,
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start",
    "lint": "next lint"
  },
  "dependencies": {
    "@emotion/cache": "^11.13.1",
    "@emotion/react": "^11.13.0",
    "@emotion/styled": "^11.13.0",
    "@mui/icons-material": "^5.16.7",
    "@mui/lab": "6.0.0-beta.14",
    "@mui/material": "^5.16.7",
    "@mui/material-nextjs": "^5.16.6",
    "@stripe/react-stripe-js": "^2.8.1",
    "@stripe/stripe-js": "^4.9.0",
    "@supabase/ssr": "^0.5.1",
    "@types/luxon": "^3.4.2",
    "@vercel/functions": "^1.4.1",
    "@vidstack/react": "^1.12.11",
    "dotenv": "^16.4.5",
    "drizzle-orm": "^0.36.4",
    "embla-carousel": "^8.1.8",
    "embla-carousel-react": "^8.1.8",
    "embla-carousel-wheel-gestures": "^8.0.1",
    "luxon": "^3.5.0",
    "next": "14.2.5",
    "postgres": "^3.4.4",
    "react": "^18",
    "react-dom": "^18",
    "stripe": "^17.3.1",
    "use-debounce": "^10.0.3"
  },
  "devDependencies": {
    "@types/node": "^20",
    "@types/react": "^18",
    "@types/react-dom": "^18",
    "drizzle-kit": "^0.24.2",
    "eslint": "^8",
    "eslint-config-next": "14.2.5",
    "postcss": "^8",
    "tailwindcss": "^3.4.1",
    "typescript": "^5"
  }
}

tsconfig.json

{
  "compilerOptions": {
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "strict": true,
    "strictNullChecks": false,
    "noEmit": true,
    "esModuleInterop": true,
    "module": "esnext",
    "moduleResolution": "bundler",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "jsx": "preserve",
    "incremental": true,
    "plugins": [
      {
        "name": "next"
      }
    ],
    "paths": {
      "@/*": ["./src/*"],
      "@/app/*": ["./src/app/*"],
      "@/enums/*": ["./src/lib/enums/*"],
      "@/interfaces/*": ["./src/libs/interfaces/*"],
      "@/types/*": ["./src/libs/types/*"],
      "@/utils/*": ["./src/libs/utils/*"],
      "@/ui/*": ["./src/libs/ui/*"],
      "@/styles/*": ["./src/libs/styles/*"],
      "@/server/*": ["./src/libs/server/*"],
      "@/client/*": ["./src/libs/client/*"],
      "@/drizzle/*": ["./src/libs/server/drizzle/*"],
      "@/supabase/*": ["./src/libs/server/supabase/index.ts"],
      "@/actions/*": ["./src/libs/server/actions/*"],
      "@/libs/*": ["./src/libs/*"]
    }
  },
  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
  "exclude": ["node_modules"]
}

Drizzle Schema

// CartItem Table
export const cartItems = pgTable("cartItems", {
  ...baseSchema,
  ...timestampedSchema,
  itemId: uuid("itemId").notNull(),
  quantity: integer("quantity").notNull().default(1),
  productType: productTypesEnum("productType").notNull(),
  profileId: uuid("profileId")
    .notNull()
    .references(() => profiles.id, { onDelete: "cascade" }),
  cartItemStatus: cartItemStatusesEnum("cartItemStatus")
    .notNull()
    .default("PENDING"),
});

My method

  async updateCartItemsStatusByProfileId(params: { profileId: string, newCartItemStatus: CartItemStatus, options?: { cartItemStatus?: CartItemStatus } }): Promise<CartItemsUpdate> {
    const { profileId, newCartItemStatus, options } = params;

    // NOTE: Temporary fix for false fix at -> https://github.com/drizzle-team/drizzle-orm/issues/2654#issuecomment-2475787921
    // @ts-ignore: Unreachable code error
    const query = db.update(cartItems).set({ cartItemStatus: newCartItemStatus });

    if (options?.cartItemStatus) {
      query.where(eq(cartItems.cartItemStatus, options?.cartItemStatus));
    }

    query.where(eq(cartItems.profileId, profileId));

    return await query;

  }

leandromatos · 2024-11-25T18:02:40Z

I'm experiencing the same here, @Said-Alisic 😢

andyngdz · 2024-11-30T08:13:18Z

I'm also facing the same issue: when using insert, it doesn't recognize optional fields.

 "drizzle-orm": "^0.36.4"

kylesloper · 2024-12-01T22:26:06Z

This is still an issue at 0.36.4

dancalderon · 2024-12-08T00:56:26Z

This is still an issue at 0.36.4we should not close this issue yet.

dexxiez · 2024-12-15T23:35:57Z

still got it in 0.38.2. if anyone here just wants the issue to go away at some expense of elegency and probs some type safety of sorts and just move on with your life, I made this and it's getting me by so far. Probs can make it better but wasted enough time on the issue tbh.

// yeah
export const df = <T>(value: Partial<T>): T => value as T;


// Usage
export type User = InferSelectModel<typeof users>; // Just put these in your schema anyway if you don't have it.

await this.drizzle
  .update(users)
  .set(
    df<User>({
      verification_code: verificationCode,
      verification_code_expires: expiryDate,
    })
  )
  .where(eq(users.email, email));

ivawzh · 2024-12-16T21:57:33Z

Can we reopen this issue? It is still happening with drizzle-orm 0.38.2

DavidHavl added the bug Something isn't working label Jul 18, 2024

PhilipAngelinNE mentioned this issue Jul 26, 2024

[BUG]: Nullable columns do not exist in insert(table).values() #2694

Open

L-Mario564 added the priority Will be worked on next label Oct 23, 2024

Sukairo-02 added a commit that referenced this issue Nov 13, 2024

Fixed .generated behaviour with non-strict tsconfig (fixes #2654)

cc4f208

AndriiSherman pushed a commit that referenced this issue Nov 13, 2024

Fixed .generated behaviour with non-strict tsconfig (fixes #2654) (…

3019616

…#3542)

Sukairo-02 mentioned this issue Nov 13, 2024

Fixed .generated behaviour with non-strict tsconfig (fixes #2654) #3542

Merged

AndriiSherman closed this as completed in 2677718 Nov 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG]: TypeScript error on optional fields during update (and insert) operation #2654

[BUG]: TypeScript error on optional fields during update (and insert) operation #2654

DavidHavl commented Jul 18, 2024 •

edited

Loading

lmcneel commented Jul 21, 2024

tirth0 commented Jul 23, 2024

Jean-CharlesTerrillon commented Jul 24, 2024

murilo-kendjy commented Jul 24, 2024

eliellis commented Jul 24, 2024 •

edited

Loading

mion-kr commented Aug 1, 2024

khanhquocnguyen commented Aug 10, 2024

Anuolu-2020 commented Sep 2, 2024

anishkumar127 commented Sep 10, 2024

sameedahri commented Sep 18, 2024 •

edited

Loading

sameedahri commented Sep 22, 2024

anishkumar127 commented Sep 23, 2024

sameedahri commented Sep 23, 2024 •

edited

Loading

sameedahri commented Sep 23, 2024

leandromatos commented Sep 24, 2024

jabreland commented Sep 27, 2024

mogery commented Sep 27, 2024

leandromatos commented Sep 27, 2024

naourass commented Oct 3, 2024

lcptrs commented Oct 8, 2024 •

edited

Loading

leandromatos commented Oct 9, 2024

0xshc commented Nov 11, 2024

NiazMorshed2007 commented Nov 12, 2024

AlexBlokh commented Nov 12, 2024

AlexBlokh commented Nov 13, 2024

ahsankhan201010 commented Nov 14, 2024

AndriiSherman commented Nov 14, 2024

Said-Alisic commented Nov 24, 2024

leandromatos commented Nov 25, 2024

andyngdz commented Nov 30, 2024

kylesloper commented Dec 1, 2024

dancalderon commented Dec 8, 2024

dexxiez commented Dec 15, 2024

ivawzh commented Dec 16, 2024

[BUG]: TypeScript error on optional fields during update (and insert) operation #2654

[BUG]: TypeScript error on optional fields during update (and insert) operation #2654

Comments

DavidHavl commented Jul 18, 2024 • edited Loading

What version of drizzle-orm are you using?

What version of drizzle-kit are you using?

Describe the Bug

Expected behavior

Environment & setup

lmcneel commented Jul 21, 2024

tirth0 commented Jul 23, 2024

Jean-CharlesTerrillon commented Jul 24, 2024

murilo-kendjy commented Jul 24, 2024

eliellis commented Jul 24, 2024 • edited Loading

mion-kr commented Aug 1, 2024

khanhquocnguyen commented Aug 10, 2024

Anuolu-2020 commented Sep 2, 2024

anishkumar127 commented Sep 10, 2024

sameedahri commented Sep 18, 2024 • edited Loading

sameedahri commented Sep 22, 2024

anishkumar127 commented Sep 23, 2024

sameedahri commented Sep 23, 2024 • edited Loading

sameedahri commented Sep 23, 2024

leandromatos commented Sep 24, 2024

jabreland commented Sep 27, 2024

mogery commented Sep 27, 2024

leandromatos commented Sep 27, 2024

naourass commented Oct 3, 2024

lcptrs commented Oct 8, 2024 • edited Loading

leandromatos commented Oct 9, 2024

0xshc commented Nov 11, 2024

NiazMorshed2007 commented Nov 12, 2024

AlexBlokh commented Nov 12, 2024

AlexBlokh commented Nov 13, 2024

ahsankhan201010 commented Nov 14, 2024

AndriiSherman commented Nov 14, 2024

Said-Alisic commented Nov 24, 2024

leandromatos commented Nov 25, 2024

andyngdz commented Nov 30, 2024

kylesloper commented Dec 1, 2024

dancalderon commented Dec 8, 2024

dexxiez commented Dec 15, 2024

ivawzh commented Dec 16, 2024

DavidHavl commented Jul 18, 2024 •

edited

Loading

What version of `drizzle-orm` are you using?

What version of `drizzle-kit` are you using?

eliellis commented Jul 24, 2024 •

edited

Loading

sameedahri commented Sep 18, 2024 •

edited

Loading

sameedahri commented Sep 23, 2024 •

edited

Loading

lcptrs commented Oct 8, 2024 •

edited

Loading