Preview feature feedback: omitApi, exclude fields from Prisma Client query results

[janpio]

Support for excluding fields from Prisma Client query results via omit is in preview behind the omitApi preview feature since release of 5.13.0 on April 23rd:

• Documentation: https://www.prisma.io/docs/orm/reference/prisma-client-reference#omit-preview

Please share your feedback about this new functionality in this discussion.

• If you encounter a bug, please open a bug report in this repo.
• If the feature is working well for you, please share this in a comment below or leave a 👍 on this discussion.
• If you have any questions, don't hesitate to ask them in the Prisma Discord community

[Cat7373]

Hello, I encountered some problems. It seems that Result does not support the new omit feature for the time being:

#23947

[janpio]

This could be reproduced and was turned into a bug report issue: #23990

[khalilsarwari]

The typings when using omit do not reflect what columns are being omitted (or maybe its just a local issue for me).

If I do

const prisma = new PrismaClient({
  omit: {
    user: { 
	    // make sure that password and internalId are never queried.
	    password: true,
	    internalId: true,
	  },
  },
});

const myuser = await prisma.user.findFirst({});

Typescript still autocompletes myuser.internalId, whereas if i didnt select this column, it would not show it as a property and underline in red. This would be helpful to make sure adding omit at the client level does not break our code.

Also can it be possible to add omit via a client extension? I dont want to add for all my clients, which is the only way currently unless i setup a new PrismaClient with its own connection.

[jdhenry08]

I've also noticed this. It makes the omitApi feature nearly pointless to use, since typesafety is a big part of Prisma's draw for our codebase.

[SevInf]

@khalilsarwari @jdhenry08 please open an issue and provide a reproduction. I was not able to reproduce this issue:

(password field exists on the model)

[khalilsarwari]

@SevInf I am unable to reproduce the issue; I think it might have just been a bad type cast actually that I had done from this side for PrismaClient.

[khalilsarwari]

@SevInf I was able to reproduce the original issue: #24717
I also faced another issue with omitApi and createMany: #24716

Your help would be greatly appreciated!

[SevInf]

Thank you @khalilsarwari.
For original issue, I provided the solution (using as const on config variable).
And I can confirm createMany problem, will work on a fix soon.

[achego]

After adding the omitApi preview feature, i still cannot use it globally, it throws a typescript warning however, it is enabled locally, what could the issue be

[SevInf]

Couple of things to check:

1. Are you on the latest prisma version? Global omit is available only starting from 5.16.0, while local one can be used starting with 5.13.0
2. Did you re-ran prisma generate after updating?
3. Have you tried restarting VSCode after update?

[achego]

Yes, @SevInf

1. My prisma version "prisma": "^5.15.0"
2. yes i did
3. yes ive done that multiple times

[SevInf]

@achego latest prisma version is 5.16.1 and global omit is not available in 5.15.0

[achego]

oh, ok.. thank you very much

[juanmdpc]

There is an issue when I'm trying to use the latest available version of the Prisma plugin inside the newest version of Webstorm IDE

[jacob-hutchings]

I might have found a bug with the global omit feature.

Specifying a single model generates the correct types with the omitted field gone:

new PrismaClient({
    omit: {
        firstModel: {
            secret: true,
        },
    },
});

Specifying multiple models generates incorrect types with all fields included:

new PrismaClient({
    omit: {
        firstModel: {
            secret: true,
        },
        secondModel: {
            secret: true,
        },
    },
});

"prisma": "^5.17.0",
"@prisma/client": "^5.17.0",

[AdarshHatkar]

me facing same issue

[demetrius-mp]

facing the same issue with prisma and prisma client version ^5.17.0

[bchurlinov]

I am using "prisma":"5.19.1 and I can confirm that doesn't work at all. Is there any specific version that this works ?

[giftlion]

We are using the new omitApi in our project to global omit the password from the user.
We also use the generated User type from the Prisma type exports.
That causes issues because the type is generated before creating the client, so it still includes the password field.
Is there any way to get the type of the model after omitting, i.e. as if calling the findFirst method of the user, without resorting to workarounds like ReturnType?

THX!