add support for partial indexes based on the Prisma syntax

Author: lsmith77

packages/language/res/stdlib.zmodel

@@ -250,7 +250,7 @@ attribute @@id(_ fields: FieldReference[], name: String?, map: String?, length:
  * @param sort: Allows you to specify in what order the entries of the constraint are stored in the database. The available options are Asc and Desc.
  * @param clustered: Boolean	Defines whether the constraint is clustered or non-clustered. Defaults to false.
  */
-attribute @@unique(_ fields: FieldReference[], name: String?, map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?) @@@prisma
+attribute @@unique(_ fields: FieldReference[], name: String?, map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?, where: Any?) @@@prisma
 
 /**
  * Index types
@@ -353,7 +353,7 @@ enum SortOrder {
  * @params clustered: Defines whether the index is clustered or non-clustered. Defaults to false.
  * @params type: Allows you to specify an index access method. Defaults to BTree.
  */
-attribute @@index(_ fields: FieldReference[], name: String?, map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?, type: IndexType?) @@@prisma
+attribute @@index(_ fields: FieldReference[], name: String?, map: String?, length: Int?, sort: SortOrder?, clustered: Boolean?, type: IndexType?, where: Any?) @@@prisma
 
 /**
  * Defines meta information about the relation.

packages/sdk/src/prisma/prisma-builder.ts

@@ -258,7 +258,7 @@ export class AttributeArg {
 
 export class AttributeArgValue {
     constructor(
-        public type: 'String' | 'FieldReference' | 'Number' | 'Boolean' | 'Array' | 'FunctionCall',
+        public type: 'String' | 'FieldReference' | 'Number' | 'Boolean' | 'Array' | 'FunctionCall' | 'Raw',
         public value: string | number | boolean | FieldReference | FunctionCall | AttributeArgValue[],
     ) {
         switch (type) {
@@ -282,6 +282,9 @@ export class AttributeArgValue {
             case 'FunctionCall':
                 if (!(value instanceof FunctionCall)) throw new Error('Value must be FunctionCall');
                 break;
+            case 'Raw':
+                if (typeof value !== 'string') throw new Error('Value must be string');
+                break;
         }
     }
 
@@ -310,6 +313,8 @@ export class AttributeArgValue {
                 return this.value ? 'true' : 'false';
             case 'Array':
                 return '[' + (this.value as AttributeArgValue[]).map((v) => v.toString()).join(', ') + ']';
+            case 'Raw':
+                return this.value as string;
             default:
                 throw new Error(`Unknown attribute value type ${this.type}`);
         }

packages/sdk/src/prisma/prisma-schema-generator.ts

@@ -24,6 +24,7 @@ import {
     isInvocationExpr,
     isLiteralExpr,
     isNullExpr,
+    isObjectExpr,
     isReferenceExpr,
     isStringLiteral,
     isTypeDef,
@@ -368,6 +369,8 @@ export class PrismaSchemaGenerator {
                     node.args.map((arg) => new PrismaFieldReferenceArg(arg.name, this.exprToText(arg.value))),
                 ),
             );
+        } else if (isObjectExpr(node)) {
+            return new PrismaAttributeArgValue('Raw', this.exprToText(node));
         } else if (isInvocationExpr(node)) {
             // invocation
             return new PrismaAttributeArgValue('FunctionCall', this.makeFunctionCall(node));

tests/e2e/orm/partial-index.e2e.test.ts

@@ -0,0 +1,21 @@
+import { describe, it, expect } from 'vitest';
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+
+const SCHEMA_DIR = path.join(__dirname, 'schemas/partial-index');
+const SCHEMA_FILE = path.join(SCHEMA_DIR, 'schema.zmodel');
+const GENERATED_PRISMA = path.join(SCHEMA_DIR, 'schema.prisma');
+
+function runGenerate() {
+    execSync(`npx zenstack generate --schema ${SCHEMA_FILE} --output ${SCHEMA_DIR}`, { stdio: 'inherit' });
+}
+
+describe('e2e: partial index in ZModel', () => {
+    it('should generate Prisma schema with partial index (object literal)', () => {
+        runGenerate();
+        const prismaSchema = fs.readFileSync(GENERATED_PRISMA, 'utf-8');
+        expect(prismaSchema).toContain('@@index([title], where: { published: true })');
+        expect(prismaSchema).toContain('@@unique([title], where: { published: true })');
+    });
+});

tests/e2e/orm/schemas/partial-index/schema.zmodel

@@ -0,0 +1,13 @@
+datasource db {
+    provider = "sqlite"
+    url = "file:./dev.db"
+}
+
+model Post {
+    id        Int      @id @default(autoincrement())
+    title     String
+    published Boolean
+
+    @@index([title], where: { published: true })
+    @@unique([title], where: { published: true })
+}

tests/regression/test/prisma-schema-generator.test.ts

@@ -0,0 +1,61 @@
+import { PrismaSchemaGenerator } from '@zenstackhq/sdk';
+import { loadSchema } from '@zenstackhq/testtools';
+import { describe, expect, it } from 'vitest';
+
+describe('PrismaSchemaGenerator partial index', () => {
+    it('should pass @@index where string argument through to Prisma schema', async () => {
+        const model = await loadSchema(`
+datasource db {
+    provider = 'postgresql'
+    url = 'env("DATABASE_URL")'
+}
+
+model Foo {
+    id Int @id
+    @@index([id], where: "id > 0")
+}
+        `);
+
+        const generator = new PrismaSchemaGenerator(model);
+        const schema = await generator.generate();
+        expect(schema).toContain('@@index([id], where: "id > 0")');
+    });
+
+    it('should pass @@index where object argument through to Prisma schema', async () => {
+        const model = await loadSchema(`
+datasource db {
+    provider = 'postgresql'
+    url = 'env("DATABASE_URL")'
+}
+
+model Foo {
+    id        Int     @id
+    published Boolean
+    @@index([id], where: { published: true })
+}
+        `);
+
+        const generator = new PrismaSchemaGenerator(model);
+        const schema = await generator.generate();
+        expect(schema).toContain('@@index([id], where: { published: true })');
+    });
+
+    it('should pass @@unique where argument through to Prisma schema', async () => {
+        const model = await loadSchema(`
+datasource db {
+    provider = 'postgresql'
+    url = 'env("DATABASE_URL")'
+}
+
+model Foo {
+    id    Int    @id
+    email String
+    @@unique([email], where: "email IS NOT NULL")
+}
+        `);
+
+        const generator = new PrismaSchemaGenerator(model);
+        const schema = await generator.generate();
+        expect(schema).toContain('@@unique([email], where: "email IS NOT NULL")');
+    });
+});