feat(column-definition): add column defintion to table fields

marcjulian · marcjulian · commit cdf38aaa0082 · 2020-08-20T20:28:53.000+02:00
* pk
* unique
* defaults: increment, now, string, boolean, number, not null
* note
diff --git a/prisma/dbml/schema.dbml b/prisma/dbml/schema.dbml
@@ -1,24 +1,26 @@
 Table User {
-	id Int
-	email String
+	id Int [pk, increment]
+	createdAt DateTime [default: `now()`, not null]
+	updatedAt DateTime [not null]
+	email String [unique, not null]
 	name String
 	posts Post
 	profile Profile
-	role Role
+	role Role [not null, note: 'user role']
 }
 
 Table Profile {
-	id Int
+	id Int [pk, increment]
 	bio String
-	user User
-	userId Int
+	user User [not null]
+	userId Int [unique, not null]
 }
 
 Table Post {
-	id Int
-	title String
+	id Int [pk, increment]
+	title String [not null]
 	content String
-	published Boolean
+	published Boolean [not null, default: false]
 	author User
 	authorId Int
 }
diff --git a/prisma/migrations/20200820181412-init/README.md b/prisma/migrations/20200820181412-init/README.md
@@ -1,6 +1,6 @@
-# Migration `20200818212722-init`
+# Migration `20200820181412-init`
 
-This migration has been generated by Marc Stammerjohann at 8/18/2020, 11:27:22 PM.
+This migration has been generated by Marc Stammerjohann at 8/20/2020, 8:14:12 PM.
 You can check out the [state of the schema](./schema.prisma) after the migration.
 
 ## Database Steps
@@ -10,6 +10,8 @@ CREATE TYPE "Role" AS ENUM ('ADMIN', 'USER')
 
 CREATE TABLE "blog"."User" (
 "id" SERIAL,
+"createdAt" timestamp(3)   NOT NULL DEFAULT CURRENT_TIMESTAMP,
+"updatedAt" timestamp(3)   NOT NULL ,
 "email" text   NOT NULL ,
 "name" text   ,
 "role" "Role"  NOT NULL ,
@@ -45,10 +47,10 @@ ALTER TABLE "blog"."Post" ADD FOREIGN KEY ("authorId")REFERENCES "blog"."User"("
 
 ```diff
 diff --git schema.prisma schema.prisma
-migration ..20200818212722-init
+migration ..20200820181412-init
 --- datamodel.dml
 +++ datamodel.dml
-@@ -1,0 +1,45 @@
+@@ -1,0 +1,50 @@
 +// This is your Prisma schema file,
 +// learn more about it in the docs: https://pris.ly/d/prisma-schema
 +
@@ -66,14 +68,18 @@ migration ..20200818212722-init
 +}
 +
 +model User {
-+  id      Int      @id @default(autoincrement())
-+  email   String   @unique
-+  name    String?
-+  posts   Post[]
-+  profile Profile?
-+  role    Role
++  id        Int      @id @default(autoincrement())
++  createdAt DateTime @default(now())
++  updatedAt DateTime @updatedAt
++  email     String   @unique
++  name      String?
++  posts     Post[]
++  profile   Profile?
++  /// user role
++  role      Role
 +}
 +
++/// User profile
 +model Profile {
 +  id     Int     @default(autoincrement()) @id
 +  bio    String?
@@ -90,8 +96,9 @@ migration ..20200818212722-init
 +  authorId  Int?
 +}
 +
++/// user role
 +enum Role {
-+  ADMIN
++  ADMIN /// allowed to do everything
 +  USER
 +}
 ```
diff --git a/prisma/migrations/20200820181412-init/schema.prisma b/prisma/migrations/20200820181412-init/schema.prisma
@@ -15,14 +15,18 @@ generator dbml {
 }
 
 model User {
-  id      Int      @id @default(autoincrement())
-  email   String   @unique
-  name    String?
-  posts   Post[]
-  profile Profile?
-  role    Role
+  id        Int      @id @default(autoincrement())
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+  email     String   @unique
+  name      String?
+  posts     Post[]
+  profile   Profile?
+  /// user role
+  role      Role
 }
 
+/// User profile
 model Profile {
   id     Int     @default(autoincrement()) @id
   bio    String?
@@ -39,7 +43,8 @@ model Post {
   authorId  Int?
 }
 
+/// user role
 enum Role {
-  ADMIN
+  ADMIN /// allowed to do everything
   USER
 }
diff --git a/prisma/migrations/20200820181412-init/steps.json b/prisma/migrations/20200820181412-init/steps.json
@@ -78,6 +78,56 @@
       "argument": "",
       "value": "autoincrement()"
     },
+    {
+      "tag": "CreateField",
+      "model": "User",
+      "field": "createdAt",
+      "type": "DateTime",
+      "arity": "Required"
+    },
+    {
+      "tag": "CreateDirective",
+      "location": {
+        "path": {
+          "tag": "Field",
+          "model": "User",
+          "field": "createdAt"
+        },
+        "directive": "default"
+      }
+    },
+    {
+      "tag": "CreateArgument",
+      "location": {
+        "tag": "Directive",
+        "path": {
+          "tag": "Field",
+          "model": "User",
+          "field": "createdAt"
+        },
+        "directive": "default"
+      },
+      "argument": "",
+      "value": "now()"
+    },
+    {
+      "tag": "CreateField",
+      "model": "User",
+      "field": "updatedAt",
+      "type": "DateTime",
+      "arity": "Required"
+    },
+    {
+      "tag": "CreateDirective",
+      "location": {
+        "path": {
+          "tag": "Field",
+          "model": "User",
+          "field": "updatedAt"
+        },
+        "directive": "updatedAt"
+      }
+    },
     {
       "tag": "CreateField",
       "model": "User",
diff --git a/prisma/migrations/migrate.lock b/prisma/migrations/migrate.lock
@@ -1,3 +1,3 @@
 # Prisma Migrate lockfile v1
 
-20200818212722-init
+20200820181412-init
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -15,14 +15,18 @@ generator dbml {
 }
 
 model User {
-  id      Int      @id @default(autoincrement())
-  email   String   @unique
-  name    String?
-  posts   Post[]
-  profile Profile?
-  role    Role
+  id        Int      @id @default(autoincrement())
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
+  email     String   @unique
+  name      String?
+  posts     Post[]
+  profile   Profile?
+  /// user role
+  role      Role
 }
 
+/// User profile
 model Profile {
   id     Int     @default(autoincrement()) @id
   bio    String?
@@ -39,7 +43,8 @@ model Post {
   authorId  Int?
 }
 
+/// user role
 enum Role {
-  ADMIN
+  ADMIN /// allowed to do everything
   USER
 }
diff --git a/src/index.ts b/src/index.ts
@@ -21,6 +21,7 @@ generatorHandler({
       try {
         await mkdir(options.generator.output, { recursive: true });
 
+        // await writeFile('./test.json', JSON.stringify(options.dmmf.datamodel));
         const tables = generateTables(options.dmmf.datamodel.models);
         const enums = generateEnums(options.dmmf.datamodel.enums);
         const refs = generateRefs(options.dmmf.datamodel.models);
@@ -48,7 +49,52 @@ const generateTables = (models: DMMF.Model[]): string[] => {
 };
 
 const generateFields = (fields: DMMF.Field[]): string => {
-  return fields.map((field) => `\t${field.name} ${field.type}`).join('\n');
+  return fields
+    .map(
+      (field) =>
+        `\t${field.name} ${field.type}${generateColumnDefinition(field)}`
+    )
+    .join('\n');
+};
+
+const generateColumnDefinition = (field: DMMF.Field): string => {
+  const columnDefinition = [];
+  if (field.isId) {
+    columnDefinition.push('pk');
+  }
+
+  if ((field.default as DMMF.FieldDefault)?.name === 'autoincrement') {
+    columnDefinition.push('increment');
+  }
+
+  if ((field.default as DMMF.FieldDefault)?.name === 'now') {
+    columnDefinition.push('default: `now()`');
+  }
+
+  if (field.isUnique) {
+    columnDefinition.push('unique');
+  }
+
+  if (field.isRequired && !field.isId) {
+    columnDefinition.push('not null');
+  }
+
+  if (
+    typeof field.default === 'string' ||
+    typeof field.default === 'boolean' ||
+    typeof field.default === 'number'
+  ) {
+    columnDefinition.push(`default: ${field.default}`);
+  }
+
+  if ((field as any).documentation) {
+    columnDefinition.push(`note: '${(field as any).documentation}'`);
+  }
+
+  if (columnDefinition.length) {
+    return ' [' + columnDefinition.join(', ') + ']';
+  }
+  return '';
 };
 
 const generateEnums = (enums: DMMF.DatamodelEnum[]): string[] => {
diff --git a/test.json b/test.json

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# Prisma Migrate lockfile v1`
`2`	`2`
`3`		`-20200818212722-init`
	`3`	`+20200820181412-init`