implement generated

Author: taylorgoolsby

README.md

@@ -139,6 +139,9 @@ ON FIELD_DEFINITION:
   * If any column is marked with "unicode", then the table will have `CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci`.
 * unique
   * Marks a column with the UNIQUE keyword.
+* generated
+  * Marks a generated column.
+  * Example: `@sql(generated: "(data->>'$.test')")`. See [main-test.ts](__tests__/main-test.ts#L137) for more examples.
 
 ## SQL Features Supported<sup>1</sup>:
 - [x] Auto Increment
@@ -151,6 +154,6 @@ ON FIELD_DEFINITION:
 - [ ] Check
 - [X] Constraints
 - [X] Foreign Key (via @constraints)
-- [ ] Generated Columns
+- [x] Generated Columns
 
 <sup>1</sup>Only MySQL is supported at the moment.

__tests__/main-test.ts

@@ -18,6 +18,7 @@ test('main test', () => {
       primary: Boolean
       type: String
       unique: Boolean
+      generated: String
     ) on OBJECT | FIELD_DEFINITION
 
     # See graphql-directive-private
@@ -117,8 +118,8 @@ test('error multiple primary index', () => {
     ${sqlDirectiveDeclaration}
   
     type User @sql(unicode: true) {
-      userId: String @sql(primary: true)
-      postId: String @sql(primary: true)
+      userId: String @sql(type: "BINARY(16)", primary: true)
+      postId: String @sql(type: "BINARY(16)", primary: true)
     }
   `
 
@@ -132,3 +133,49 @@ test('error multiple primary index', () => {
     })
   }).toThrow()
 })
+
+test('generated', () => {
+  const typeDefs = gql`
+    ${sqlDirectiveDeclaration}
+
+    scalar JSON
+
+    type GeneratedTest {
+      userId: String @sql(type: "BINARY(16)", primary: true)
+      data: JSON @sql
+      test1: String
+        @sql(
+          type: "VARCHAR(30)"
+          generated: "GENERATED ALWAYS AS (data->>'$.test') VIRTUAL"
+        )
+      test2: String
+        @sql(type: "VARCHAR(30)", generated: "ALWAYS AS (data->>'$.test')")
+      test3: String @sql(type: "VARCHAR(30)", generated: "AS (data->>'$.test')")
+      test4: String
+        @sql(type: "VARCHAR(30)", generated: "(data->>'$.test')", index: true)
+    }
+  `
+
+  const outputFilepath = '__tests__/testOutput.sql'
+  const directives = getSchemaDirectives()
+  makeSqlSchema({
+    typeDefs,
+    schemaDirectives: directives,
+    outputFilepath,
+    databaseName: 'dbname',
+    tablePrefix: 'test_',
+  })
+
+  const testOutput = fs.readFileSync(outputFilepath, { encoding: 'utf8' })
+  console.log('testOutput', testOutput)
+  expect(testOutput).toEqual(`CREATE TABLE \`dbname\`.\`test_GeneratedTest\` (
+  \`userId\` BINARY(16) NOT NULL,
+  \`data\` JSON NOT NULL,
+  \`test1\` VARCHAR(30) GENERATED ALWAYS AS (data->>'$.test') VIRTUAL NOT NULL,
+  \`test2\` VARCHAR(30) GENERATED ALWAYS AS (data->>'$.test') NOT NULL,
+  \`test3\` VARCHAR(30) AS (data->>'$.test') NOT NULL,
+  \`test4\` VARCHAR(30) AS (data->>'$.test') NOT NULL,
+  PRIMARY KEY (\`userId\`),
+  INDEX \`TEST4INDEX\` (\`test4\` ASC)
+);`)
+})

__tests__/testOutput.sql

@@ -1,27 +1,10 @@
-CREATE TABLE `dbname`.`test_User` (
+CREATE TABLE `dbname`.`test_GeneratedTest` (
   `userId` BINARY(16) NOT NULL,
-  `uniqueColumn` INT NOT NULL UNIQUE,
-  `databaseOnlyField` INT NOT NULL,
-  PRIMARY KEY (`userId`)
-) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
-
-CREATE TABLE `dbname`.`test_Post` (
-  `postId` INT NOT NULL AUTO_INCREMENT,
-  `userId` BINARY(16) NOT NULL,
-  `content` VARCHAR(300) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci NULL,
-  `likes` INT NOT NULL,
-  `dateCreated` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
-  PRIMARY KEY (`postId`),
-  INDEX `USERIDINDEX` (`userId` ASC)
-) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
-
-CREATE TABLE `dbname`.`test_UserPair` (
-  `userPairId` BINARY(16) NOT NULL,
-  `parentUserId` BINARY(16) NOT NULL,
-  `childUserId` BINARY(16) NOT NULL,
-  PRIMARY KEY (`userPairId`),
-  INDEX `PARENTUSERIDINDEX` (`parentUserId` ASC),
-  INDEX `CHILDUSERIDINDEX` (`childUserId` ASC),
-  UNIQUE(parentUserId, childUserId),
-  FOREIGN KEY (parentUserId) REFERENCES User(userId)
+  `data` JSON NOT NULL,
+  `test1` VARCHAR(30) GENERATED ALWAYS AS (data->>'$.test') VIRTUAL NOT NULL,
+  `test2` VARCHAR(30) GENERATED ALWAYS AS (data->>'$.test') NOT NULL,
+  `test3` VARCHAR(30) AS (data->>'$.test') NOT NULL,
+  `test4` VARCHAR(30) AS (data->>'$.test') NOT NULL,
+  PRIMARY KEY (`userId`),
+  INDEX `TEST4INDEX` (`test4` ASC)
 );

package.json

@@ -33,13 +33,13 @@
     "graphql-tag": "^2.10.1",
     "graphql-tools": "^4.0.0",
     "husky": "^1.1.1",
-    "jest": "^23.6.0",
+    "jest": "^25.1.0",
     "lint-staged": "^7.3.0",
     "prettier": "^1.14.3",
-    "ts-jest": "^23.10.4",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.15.0",
-    "typescript": "^3.1.1"
+    "ts-jest": "^25.2.0",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.7.5"
   },
   "keywords": [
     "graphql",

src/getSchemaDirectives.ts

@@ -63,6 +63,9 @@ export function getSchemaDirectives({
           unique: {
             type: GraphQLBoolean,
           },
+          generated: {
+            type: GraphQLString,
+          },
         },
       })
     }
@@ -113,6 +116,7 @@ export function customDirectiveDeclaration(
     primary: Boolean
     type: String
     unique: Boolean
+    generated: String
   ) on OBJECT | FIELD_DEFINITION`
 }
 export const sqlDirectiveDeclaration = customDirectiveDeclaration('sql')

src/makeSqlSchema.ts

@@ -45,6 +45,7 @@ export interface IColumn {
   graphQLType: string
   unicode?: boolean
   unique?: boolean
+  generated?: string
 }
 
 export interface ISQLAST {
@@ -110,9 +111,7 @@ function setDefaults() {
           emitError(
             table.name,
             column.name,
-            `A default SQL type cannot be generated for GraphQL type ${
-              column.graphQLType
-            }`
+            `A default SQL type cannot be generated for GraphQL type ${column.graphQLType}`
           )
         }
       }
@@ -142,6 +141,13 @@ function setDefaults() {
             '"unicode" is not allowed with "auto".'
           )
         }
+        if (column.generated) {
+          emitError(
+            table.name,
+            column.name,
+            '"generated" is not allowed with "auto".'
+          )
+        }
       }
 
       if (column.unicode) {
@@ -157,6 +163,26 @@ function setDefaults() {
           table.unicode = true
         }
       }
+
+      if (column.generated && column.default) {
+        emitError(
+          table.name,
+          column.name,
+          '"default" is not allowed with "generated".'
+        )
+      }
+
+      if (column.generated && column.generated.startsWith('ALWAYS AS')) {
+        column.generated = `GENERATED ${column.generated}`
+      }
+
+      if (
+        column.generated &&
+        !column.generated.startsWith('GENERATED') &&
+        !column.generated.startsWith('AS')
+      ) {
+        column.generated = `AS ${column.generated}`
+      }
     })
   })
 }
@@ -200,17 +226,17 @@ function renderCreateSchemaScript(
   forEachTableDo(table => {
     const columnDefinitions: string[] = []
     forEachColumnDo(table, column => {
-      const nullClause = !!column.nullable ? 'NULL ' : 'NOT NULL '
       const unicodeClause = !!column.unicode
         ? 'CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci '
         : ''
+      const generatedClause = !!column.generated ? `${column.generated} ` : ''
+      const nullClause = !!column.nullable ? 'NULL ' : 'NOT NULL '
       const defaultClause = !!column.default ? `DEFAULT ${column.default} ` : ''
-      const autoClause = !!column.auto ? 'AUTO_INCREMENT ' : ''
+      const autoClause =
+        !!column.auto && column.type !== 'SERIAL' ? 'AUTO_INCREMENT ' : ''
       const uniqueClause = !!column.unique ? `UNIQUE ` : ''
       columnDefinitions.push(
-        `\`${column.name}\` ${
-          column.type
-        } ${unicodeClause}${nullClause}${defaultClause}${autoClause}${uniqueClause}`.trim()
+        `\`${column.name}\` ${column.type} ${unicodeClause}${generatedClause}${nullClause}${defaultClause}${autoClause}${uniqueClause}`.trim()
       )
     })