[BUG]: Partial Insert returning expected 0 arguments

[josepdecid]

What version of drizzle-orm are you using?

0.30.10

What version of drizzle-kit are you using?

0.21.4

Describe the Bug

I have the following code snippet:

const recordId = await db
    .insert(organizationsTable)
    .values({ clerkId: 'whatever-id' })
    .returning({ id: organizationsTable.id });

After an insert, I'm trying to return a value with partial insert returning. However, TS is complaining that returning "Expected 0 arguments, but got 1.":

Removing the partial return and simply returning the whole thing does not complain at all and works as expected:

const recordId = await db
    .insert(organizationsTable)
    .values({ clerkId: 'whatever-id' })
    .returning();

I initially thought it was a problem with VSCode so I tried to restart TS server, make sure that it matches the project's TS version and so on, but it also fails when I do the build step.

Navigating to source I can see that both function definitions exist:

returning(): PgInsertWithout<PgInsertReturningAll<this, TDynamic>, TDynamic, 'returning'>;
returning<TSelectedFields extends SelectedFieldsFlat>(fields: TSelectedFields): PgInsert...

Expected behavior

It should allow me to pass an argument to select the fields I want to return.

Environment & setup

No response

[chrisandrewcl]

I have a similar problem when using drizzle-orm/aws-data-api/pg, regardless if the operation is partial or not. drizzle-orm/node-postgres works fine.

[musjj]

I'm also having this issue with drizzle-orm/postgres-js and drizzle-orm/vercel-postgres. Any workarounds? Even simple updates like the one in the documentation:

await db
  .update(users)
  .set(data)
  .where(eq(users.id, data.id))
  .returning({
      // Expected 0 arguments, but got 1.
  });

EDIT: It looks like that my issue was caused by: https://github.com/drizzle-team/drizzle-orm/issues/1966

[L-Mario564]

This shouldn't be an issue in the latest version. Feel free to reopen this issue if the bug persists.

[andrewjmcgehee]

i still have this issue with drizzle-orm 0.35.3 and drizzle-kit 0.26.2. using "pg" package for local dev db and "aws-data-api" for prod db.

[di-sukharev]

i still have this issue with drizzle-orm 0.35.3 and drizzle-kit 0.26.2.

same

[di-sukharev]

i wonder if im experiencing this due to wrong type inference of the db object?

do i do it right?

import { neon } from "@neondatabase/serverless";
import { DrizzleConfig } from "drizzle-orm";
import { drizzle as drizzleNeon } from "drizzle-orm/neon-http";
import { drizzle as drizzleNode } from "drizzle-orm/postgres-js";

import * as schema from "./schema";

export type Schema = typeof schema;
type DrizzleNode = typeof drizzleNode<Schema>;
type DrizzleNeon = typeof drizzleNeon<Schema>;

export type Database = ReturnType<DrizzleNode | DrizzleNeon>;

const drizzleConfig: DrizzleConfig<Schema> = {
  schema,
  casing: "snake_case",
};

function initDB(
  url: string,
  env: "development" | "production" | "test",
): {
  db: Database;
  schema: Schema;
} {
  let db = null;

  if (env === "development" || env === "test") {
    db = drizzleNode<Schema>(url, drizzleConfig);
  } else {
    const sql = neon(url);
    db = drizzleNeon<Schema>(sql, drizzleConfig);
  }

  return { db, schema };
}

export { initDB };

maybe bc i do export type Database = ReturnType<DrizzleNode | DrizzleNeon>; the types are lost somewhere? anyway this is a very annoying setup and DX. and the returning() thing not working makes me cast types all over the place. mb you could guide me to where to look at so i can prepare a fix PR?

[di-sukharev]

@L-Mario564 @AndriiSherman

[L-Mario564]

Just to rule this out, are any of you who are experiencing this issue developing in a monorepo?

[Ciantic]

I still have this issue, and yes I do have monorepo.

Edit The error is probably related to what is above:

export type Database = ReturnType<DrizzleNode | DrizzleNeon>;

In my case this was NodePgDatabase<typeof schema> | PgLiteDatabase<typeof schema>

If I force the DB type to be just NodePgDatabase<typeof schema> everywhere, it works. In my case, it works fine like that.

[AndriiSherman]

Hey everyone!

I've created this message to send in a batch to all opened issues we have, just because there are a lot of them and I want to update all of you with our current work, why issues are not responded to, and the amount of work that has been done by our team over ~8 months.

I saw a lot of issues with suggestions on how to fix something while we were not responding – so thanks everyone. Also, thanks to everyone patiently waiting for a response from us and continuing to use Drizzle!

We currently have 4 major branches with a lot of work done. Each branch was handled by different devs and teams to make sure we could make all the changes in parallel.

---

First branch is drizzle-kit rewrite

All of the work can be found on the alternation-engine branch. Here is a PR with the work done: https://github.com/drizzle-team/drizzle-orm/pull/4439

As you can see, it has 167k added lines of code and 67k removed, which means we've completely rewritten the drizzle-kit alternation engine, the way we handle diffs for each dialect, together with expanding our test suite from 600 tests to ~9k test units for all different types of actions you can do with kit. More importantly, we changed the migration folder structure and made commutative migrations, so you won't face complex conflicts on migrations when working in a team.

What's left here:

• We are finishing handling defaults for Postgres, the last being geometry (yes, we fixed the srid issue here as well).
• We are finishing commutative migrations for all dialects.
• We are finishing up the command, so the migration flow will be as simple as drizzle-kit up for you.

Where it brings us:

• We are getting drizzle-kit into a new good shape where we can call it [email protected]!

Timeline:

• We need ~2 weeks to finish all of the above and send this branch to beta for testing.

Second big branch is a complex one with several HUGE updates

• Bringing Relational Queries v2 finally live. We've done a lot of work here to actually make it faster than RQBv1 and much better from a DX point of view. But in implementing it, we had to make another big rewrite, so we completely rewrote the drizzle-orm type system, which made it much simpler and improved type performance by ~21.4x:

(types instantiations for 3300 lines production drizzle schema + 990 lines relations)

TS v5.8.3: 728.8k -> 34.1k
TS v5.9.2: 553.7k -> 25.4k

You can read more about it here.

What's left here:

• We have 1 issue with TS that is already in progress of being fixed. The issue and Post about fixing.

Where it brings us:

• We are getting drizzle-orm into a new good shape where we can call it [email protected]!

Breaking changes:

• We will have them, but we will have open channels for everyone building on top of drizzle types, so we can guide you through all the changes.

Third branch is adding support for CockroachDB and MSSQL dialects

Support for them is already in the alternation-engine branch and will be available together with the drizzle-kit rewrite.

Summary

All of the work we are doing is crucial and should be done sooner rather than later. We've received a lot of feedback and worked really hard to find the best strategies and decisions for API, DX, architecture, etc., so we can confidently mark it as v1 and be sure we can improve it and remain flexible for all the features you are asking for, while becoming even better for everyone building on top of the drizzle API as well.

We didn't want to stay with some legacy decisions and solutions we had, and instead wanted to shape Drizzle in a way that will be best looking ahead to 2025–2026 trends (v1 will get proper effect support, etc.).

We believe that all of the effort we've put in will boost Drizzle and benefit everyone using it.

Thanks everyone, as we said, we are here to stay for a long time to build a great tool together!

Timelines

We are hoping to get v1 for drizzle in beta this fall and same timeline for latest. Right after that we can go through all of the issues and PRs and resond everyone. v1 for drizzle should close ~70% of all the bug tickets we have, so on beta release we will start marking them as closed!