Add a callback argument for alterTable.addColumn

kysely-org · May 11, 2022 · a13e678 · a13e678
1 parent 1c78641
commit a13e678
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.19.0",
+  "version": "0.19.1",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",

diff --git a/src/schema/alter-table-builder.ts b/src/schema/alter-table-builder.ts
@@ -13,7 +13,7 @@ import { OnModifyForeignAction } from '../operation-node/references-node.js'
 import { RenameColumnNode } from '../operation-node/rename-column-node.js'
 import { CompiledQuery } from '../query-compiler/compiled-query.js'
 import { Compilable } from '../util/compilable.js'
-import { freeze } from '../util/object-utils.js'
+import { freeze, noop } from '../util/object-utils.js'
 import { preventAwait } from '../util/prevent-await.js'
 import {
   ColumnDefinitionBuilder,
@@ -97,24 +97,23 @@ export class AlterTableBuilder {
 
   /**
    * See {@link CreateTableBuilder.addColumn}
-   *
-   * Unlike {@link CreateTableBuilder.addColumn} this method returns the column builder
-   * and doesn't take a callback as the last argument. This is because you can only
-   * add one column per `ALTER TABLE` query.
    */
   addColumn(
     columnName: string,
-    dataType: DataTypeExpression
+    dataType: DataTypeExpression,
+    build: AlterTableAddColumnBuilderCallback = noop
   ): AlterTableAddColumnBuilder {
-    return new AlterTableAddColumnBuilder({
-      ...this.#props,
-      columnBuilder: new ColumnDefinitionBuilder(
-        ColumnDefinitionNode.create(
-          columnName,
-          parseDataTypeExpression(dataType)
-        )
-      ),
-    })
+    return build(
+      new AlterTableAddColumnBuilder({
+        ...this.#props,
+        columnBuilder: new ColumnDefinitionBuilder(
+          ColumnDefinitionNode.create(
+            columnName,
+            parseDataTypeExpression(dataType)
+          )
+        ),
+      })
+    )
   }
 
   /**
@@ -437,6 +436,10 @@ export interface AlterTableAddColumnBuilderProps
   readonly columnBuilder: ColumnDefinitionBuilder
 }
 
+export type AlterTableAddColumnBuilderCallback = (
+  builder: AlterTableAddColumnBuilder
+) => AlterTableAddColumnBuilder
+
 export class AlterTableModifyColumnBuilder
   implements ColumnDefinitionBuilderInterface, OperationNodeSource, Compilable
 {

diff --git a/test/node/src/schema.test.ts b/test/node/src/schema.test.ts
@@ -1320,6 +1320,40 @@ for (const dialect of BUILT_IN_DIALECTS) {
           })
         })
 
+        it('should add a column using a callback', async () => {
+          const builder = ctx.db.schema
+            .alterTable('test')
+            .addColumn('bool_col', 'boolean', (col) => col.notNull())
+
+          testSql(builder, dialect, {
+            postgres: {
+              sql: 'alter table "test" add column "bool_col" boolean not null',
+              parameters: [],
+            },
+            mysql: {
+              sql: 'alter table `test` add column `bool_col` boolean not null',
+              parameters: [],
+            },
+            sqlite: {
+              sql: 'alter table "test" add column "bool_col" boolean not null',
+              parameters: [],
+            },
+          })
+
+          await builder.execute()
+
+          expect(await getColumnMeta('test.bool_col')).to.eql({
+            name: 'bool_col',
+            isNullable: false,
+            dataType:
+              dialect === 'postgres'
+                ? 'bool'
+                : dialect === 'sqlite'
+                ? 'boolean'
+                : 'tinyint',
+          })
+        })
+
         if (dialect !== 'sqlite') {
           it('should add a unique column', async () => {
             const builder = ctx.db.schema