feat: default to current timestamp

kysely-org · Dec 17, 2024 · d2f0a27 · d2f0a27
1 parent 6be09d8
commit d2f0a27
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 0 deletions.
diff --git a/src/schema/column-definition-builder.ts b/src/schema/column-definition-builder.ts
@@ -15,6 +15,7 @@ import { GeneratedNode } from '../operation-node/generated-node.js'
 import { DefaultValueNode } from '../operation-node/default-value-node.js'
 import { parseOnModifyForeignAction } from '../parser/on-modify-action-parser.js'
 import { Expression } from '../expression/expression.js'
+import { RawNode } from '../operation-node/raw-node.js'
 
 export class ColumnDefinitionBuilder implements OperationNodeSource {
   readonly #node: ColumnDefinitionNode
@@ -371,6 +372,29 @@ export class ColumnDefinitionBuilder implements OperationNodeSource {
     )
   }
 
+  /**
+   * Adds `DEFAULT CURRENT_TIMESTAMP` for the column.
+   *
+   * ### Examples
+   *
+   * ```ts
+   *  db.schema.createTable('test')
+   *    .addColumn('created_at', 'datetime', (col) =>
+   *      col.defaultToCurrentTimestamp(),
+   *     )
+   *    .execute()
+   * ```
+   */
+  defaultToCurrentTimestamp(): ColumnDefinitionBuilder {
+    return new ColumnDefinitionBuilder(
+      ColumnDefinitionNode.cloneWith(this.#node, {
+        defaultTo: DefaultValueNode.create(
+          RawNode.createWithSql('current_timestamp'),
+        ),
+      }),
+    )
+  }
+
   /**
    * Adds a check constraint for the column.
    *

diff --git a/test/node/src/schema.test.ts b/test/node/src/schema.test.ts
@@ -484,6 +484,53 @@ for (const dialect of DIALECTS) {
         throw new Error(`Unknown dialect: ${dialect}`)
       }
 
+      it('should create table with default timestamp column', async () => {
+        if (dialect !== 'postgres') {
+          const builder = ctx.db.schema
+            .createTable('test')
+            .addColumn('created_at', 'datetime', (col) =>
+              col.defaultToCurrentTimestamp(),
+            )
+
+          testSql(builder, dialect, {
+            postgres: NOT_SUPPORTED,
+            mysql: {
+              sql: 'create table `test` (`created_at` datetime default current_timestamp)',
+              parameters: [],
+            },
+            mssql: {
+              sql: 'create table "test" ("created_at" datetime default current_timestamp)',
+              parameters: [],
+            },
+            sqlite: {
+              sql: 'create table "test" ("created_at" datetime default current_timestamp)',
+              parameters: [],
+            },
+          })
+
+          await builder.execute()
+        } else {
+          const builder = ctx.db.schema
+            .createTable('test')
+            .addColumn('created_at', 'timestamptz', (col) =>
+              col.defaultToCurrentTimestamp(),
+            )
+            .addColumn('data', 'varchar')
+
+          testSql(builder, dialect, {
+            postgres: {
+              sql: 'create table "test" ("created_at" timestamptz default current_timestamp, "data" varchar)',
+              parameters: [],
+            },
+            mysql: NOT_SUPPORTED,
+            mssql: NOT_SUPPORTED,
+            sqlite: NOT_SUPPORTED,
+          })
+
+          await builder.execute()
+        }
+      })
+
       it('should create a table with a unique constraints', async () => {
         const builder = ctx.db.schema
           .createTable('test')