drizzle-kit 0.17.0-6323eb6 → 0.17.0-8c0281d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-kit",
-  "version": "0.17.0-6323eb6",
+  "version": "0.17.0-8c0281d",
   "repository": "https://github.com/drizzle-team/drizzle-kit-mirror",
   "author": "Drizzle Team",
   "license": "MIT",
@@ -9,11 +9,13 @@
   },
   "scripts": {
     "migrate:old": "drizzle-kit generate:pg --out ./dev/migrations-pg --schema ./dev/migrations-pg/schema.ts",
+    "push": "node -r esbuild-register ./src/cli/index.ts push:mysql",
     "migrate:old:mysql": "drizzle-kit generate:mysql --out ./dev/migrations-mysql --schema ./dev/migrations-mysql/schema.ts",
-    "start:pg": "node -r esbuild-register ./src/cli/index.ts generate:pg --out ./dev/introspect-pg --schema ./dev/introspect-pg/schema.ts",
+    "start:pg": "node -r esbuild-register ./src/cli/index.ts generate:pg --out ./dev/migrations-pg --schema ./dev/migrations-pg/schema.ts",
+    "start:sqlite": "node -r esbuild-register ./src/cli/index.ts generate:sqlite --out ./dev/migrations-sqlite --schema ./dev/migrations-sqlite/schema.ts",
     "start:mysql": "node -r esbuild-register ./src/cli/index.ts generate:mysql --out ./dev/introspect-mysql --schema ./dev/introspect-mysql/schema.ts",
     "check:pg": "node -r esbuild-register ./src/cli/index.ts check --out ./dev/migrations --dialect pg",
-    "introspect:mysql": "node -r esbuild-register ./src/cli/index.ts introspect:mysql --out ./dev/introspect-mysql --connectionString",
+    "introspect:mysql": "node -r esbuild-register ./src/cli/index.ts introspect:mysql",
     "introspect:pg": "node -r esbuild-register ./src/cli/index.ts introspect:pg --out ./dev/introspect-pg --connectionString=postgresql://postgres@localhost:5432/introspect",
     "up:pg": "node -r esbuild-register ./src/cli/index.ts up:pg --out ./dev/migrations-pg",
     "up:mysql": "node -r esbuild-register ./src/cli/index.ts up:mysql --out ./dev/migrations-mysql",

package/readme.md

@@ -1,12 +1,15 @@
 ## Drizzle Kit
+
 DrizzleKit - is a CLI migrator tool for DrizzleORM. It is probably one and only tool that lets you completely automatically generate SQL migrations and covers ~95% of the common cases like delitions and renames by prompting user input.\
-https://github.com/drizzle-team/drizzle-kit-mirror - is a mirror repository for issues.
+<https://github.com/drizzle-team/drizzle-kit-mirror> - is a mirror repository for issues.
 
 ### How it works
+
 `drizzle-kit` will traverse `schema folder` or `schema file`, generate schema snapshot and compare it to the previous version(if there's one).\
  Based on the difference it will generate all needed SQL migrations and if there're any `automatically unresolvable` cases like `renames` it will prompt user for input.
 
 For schema file:
+
 ```typescript
 // ./src/db/schema.ts
 
@@ -26,17 +29,19 @@ export const authOtp = pgTable("auth_otp", {
   userId: integer("user_id").references(() => users.id),
 });
 ```
+
 It will generate:
+
 ```SQL
 CREATE TABLE IF NOT EXISTS auth_otp (
-	"id" SERIAL PRIMARY KEY,
-	"phone" character varying(256),
-	"user_id" INT
+ "id" SERIAL PRIMARY KEY,
+ "phone" character varying(256),
+ "user_id" INT
 );
 
 CREATE TABLE IF NOT EXISTS users (
-	"id" SERIAL PRIMARY KEY,
-	"full_name" character varying(256)
+ "id" SERIAL PRIMARY KEY,
+ "full_name" character varying(256)
 );
 
 DO $$ BEGIN
@@ -49,26 +54,69 @@ CREATE INDEX IF NOT EXISTS users_full_name_index ON users (full_name);
 ```
 
 ### Installation & configuration
+
 ```shell
-$ npm install -D drizzle-kit
+npm install -D drizzle-kit
 ```
 
 Running with CLI options
+
 ```shell
-$ npm exec drizzle-kit generate --out migrations-folder --dialect pg --schema src/db/schema.ts
+npm exec drizzle-kit generate:pg --out migrations-folder --schema src/db/schema.ts
 ```
 
 Or put your file to `drizzle.config.json` configuration file:
+
 ```json
 {
   "out": "./migrations-folder",
   "schema": "./src/db"
 }
 ```
+
 ---
+
+## Upgrading to 0.17.0
+
+Before running any new migrations `drizzle-kit` will ask you to upgrade in a first place
+
+Migration file structure < 0.17.0
+
+```plaintext
+📦 <project root>
+ └ 📂 migrations
+    └ 📂 20221207174503
+       ├ 📜 migration.sql
+       ├ 📜 snapshot.json
+    └ 📂 20230101104503
+       ├ 📜 migration.sql
+       ├ 📜 snapshot.json
+```
+
+Migration file structure >= 0.17.0
+
+```plaintext
+📦 <project root>
+ └ 📂 migrations
+    └ 📂 meta
+      ├ 📜 _journal.json
+      ├ 📜 0000_snapshot.json
+      ├ 📜 0001_snapshot.json
+    └ 📜 0000_icy_stranger.sql
+    └ 📜 0001_strange_avengers.sql
+```
+
+To easily migrate from previous folder structure to new you need to run `up` command in drizzle kit. It's a great helper to upgrade your migrations to new format on each drizzle kit major update
+
+![](media/up_mysql.gif)
+---
+
 ## List of commands
 
 ### Generate SQL migrations based on current .ts schema\
+
+---
+
 **`$ drizzle-kit generate:pg`** \
 **`$ drizzle-kit generate:mysql`** \
 **`$ drizzle-kit generate:sqlite`** \
@@ -76,6 +124,7 @@ Or put your file to `drizzle.config.json` configuration file:
 `--config` [optional defalut=drizzle.config.json] config file path\
 `--schema` path to typescript schema file or folder with multiple schema files\
 `--out` [optional default=drizzle/] migrations folder
+
 ```shell
 $ drizzle-kit generate:pg 
 ## runs generate command with drizzle.config.json 
@@ -91,40 +140,65 @@ $ drizzle-kit generate:pg --schema=./src/schema.ts --out=./migrations/
 ```  
 
 ### Introspect existing database and generate typescript schema
-**`$ drizzle-kit introspect:pg`**
+
+---
+
+**`$ drizzle-kit introspect:pg`** \
+**`$ drizzle-kit introspect:mysql`**
+
 ```shell
 drizzle-kit introspect:pg --out=migrations/ --connectionString=postgresql://user:pass@host:port/db_name
 
 drizzle-kit introspect:pg --out=migrations/ --host=0.0.0.0 --port=5432 --user=postgres --password=pass --database=db_name --ssl
 ```
 
+![](media/introspect_mysql.gif)
+
 ### Update stale snapshots
+
+---
+
 **`$ drizzle-kit up:pg`** \
 **`$ drizzle-kit up:mysql`**\
 **`$ drizzle-kit up:sqlite`**
 
 `--out` [optional] migrations folder\
 `--config` [optional defalut=drizzle.config.json] config file path
+
 ```shell
 ## migrations folder is taken from drizzle.config.json
-drizzle-kit up:pg
+drizzle-kit up:mysql
 
-drizzle-kit up:pg --out=migrations/ 
+drizzle-kit up:mysql --out=migrations/ 
 ```
 
+![](media/up_mysql.gif)
+
+### Drop migration
+
+---
+
+**`$ drizzle-kit drop`** \
+
+`--out` [optional] migrations folder\
+`--config` [optional defalut=drizzle.config.json] config file path
+
+![](media/drop.gif)
+
 ### Migrations collisions check
+
+---
+
 **`$ drizzle-kit check:pg`**\
 **`$ drizzle-kit check:mysql`**\
 **`$ drizzle-kit check:sqlite`**
 
 `--out` [optional] migration folder\
 `--config` [optional defalut=drizzle.config.json] config file path
+
 ```shell
 ## migrations folder is taken from drizzle.config.json
 drizzle-kit check:pg
 
 drizzle-kit check:pg --out=migrations/ 
 ```
-
-
-

package/utils.js

@@ -1,4 +1,3 @@
-"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -10358,6 +10357,13 @@ var compositePK = objectType({
   name: stringType(),
   columns: stringType().array()
 }).strict();
+var tableV4 = objectType({
+  name: stringType(),
+  schema: stringType().optional(),
+  columns: recordType(stringType(), column),
+  indexes: recordType(stringType(), index),
+  foreignKeys: recordType(stringType(), fk)
+}).strict();
 var table = objectType({
   name: stringType(),
   schema: stringType().optional(),
@@ -10379,7 +10385,7 @@ var schemaInternalV3 = objectType({
 var schemaInternalV4 = objectType({
   version: literalType("4"),
   dialect,
-  tables: recordType(stringType(), table),
+  tables: recordType(stringType(), tableV4),
   schemas: recordType(stringType(), stringType())
 }).strict();
 var schemaInternal = objectType({
@@ -10396,6 +10402,13 @@ var schemaInternal = objectType({
 var schemaV3 = schemaInternalV3.merge(schemaHash);
 var schemaV4 = schemaInternalV4.merge(schemaHash);
 var schema = schemaInternal.merge(schemaHash);
+var tableSquashedV4 = objectType({
+  name: stringType(),
+  schema: stringType().optional(),
+  columns: recordType(stringType(), column),
+  indexes: recordType(stringType(), stringType()),
+  foreignKeys: recordType(stringType(), stringType())
+}).strict();
 var tableSquashed = objectType({
   name: stringType(),
   schema: stringType().optional(),
@@ -10410,6 +10423,12 @@ var schemaSquashed = objectType({
   tables: recordType(stringType(), tableSquashed),
   schemas: recordType(stringType(), stringType())
 }).strict();
+var schemaSquashedV4 = objectType({
+  version: literalType("4"),
+  dialect,
+  tables: recordType(stringType(), tableSquashedV4),
+  schemas: recordType(stringType(), stringType())
+}).strict();
 var MySqlSquasher = {
   squashIdx: (idx) => {
     var _a, _b, _c;
@@ -10566,6 +10585,13 @@ var compositePK2 = objectType({
   name: stringType(),
   columns: stringType().array()
 }).strict();
+var tableV42 = objectType({
+  name: stringType(),
+  schema: stringType(),
+  columns: recordType(stringType(), column2),
+  indexes: recordType(stringType(), index2),
+  foreignKeys: recordType(stringType(), fk2)
+}).strict();
 var table2 = objectType({
   name: stringType(),
   schema: stringType(),
@@ -10587,7 +10613,7 @@ var pgSchemaInternalV3 = objectType({
 var pgSchemaInternalV4 = objectType({
   version: literalType("4"),
   dialect: literalType("pg"),
-  tables: recordType(stringType(), table2),
+  tables: recordType(stringType(), tableV42),
   enums: recordType(stringType(), enumSchema),
   schemas: recordType(stringType(), stringType())
 }).strict();
@@ -10611,6 +10637,20 @@ var tableSquashed2 = objectType({
   foreignKeys: recordType(stringType(), stringType()),
   compositePrimaryKeys: recordType(stringType(), stringType())
 }).strict();
+var tableSquashedV42 = objectType({
+  name: stringType(),
+  schema: stringType(),
+  columns: recordType(stringType(), column2),
+  indexes: recordType(stringType(), stringType()),
+  foreignKeys: recordType(stringType(), stringType())
+}).strict();
+var pgSchemaSquashedV4 = objectType({
+  version: literalType("4"),
+  dialect: enumType(["pg"]),
+  tables: recordType(stringType(), tableSquashedV42),
+  enums: recordType(stringType(), enumSchema),
+  schemas: recordType(stringType(), stringType())
+}).strict();
 var pgSchemaSquashed = objectType({
   version: literalType("5"),
   dialect: enumType(["pg"]),
@@ -11191,7 +11231,9 @@ var MySqlCreateTableConvertor = class extends Convertor {
 `;
     if (typeof compositePKs !== "undefined" && compositePKs.length > 0) {
       const compositePK4 = MySqlSquasher.unsquashPK(compositePKs[0]);
-      statement += `ALTER TABLE ${tName} ADD PRIMARY KEY(\`${compositePK4.columns.join("`,`")}\`);`;
+      statement += `ALTER TABLE ${tName} ADD PRIMARY KEY(\`${compositePK4.columns.join(
+        "`,`"
+      )}\`);`;
       statement += `
 `;
     }
@@ -11285,7 +11327,7 @@ var DropTableConvertor = class extends Convertor {
   }
   convert(statement) {
     const { tableName } = statement;
-    return `DROP TABLE ${tableName};`;
+    return `DROP TABLE \`${tableName}\`;`;
   }
 };
 var PgRenameTableConvertor = class extends Convertor {
@@ -11393,12 +11435,13 @@ var MySqlAlterTableAddColumnConvertor = class extends Convertor {
   }
   convert(statement) {
     const { tableName, column: column4 } = statement;
-    const { name, type, notNull, primaryKey, autoincrement } = column4;
-    const defaultStatement = `${column4.default !== void 0 ? `DEFAULT ${column4.default}` : ""}`;
-    const notNullStatement = `${notNull ? "NOT NULL" : ""}`;
-    const primaryKeyStatement = `${primaryKey ? "PRIMARY KEY" : ""}`;
-    const autoincrementStatement = `${autoincrement ? "AUTO_INCREMENT" : ""}`;
-    return `ALTER TABLE ${tableName} ADD \`${name}\` ${type} ${primaryKeyStatement} ${autoincrementStatement} ${defaultStatement} ${notNullStatement}`.replace(/  +/g, " ").trim() + ";";
+    const { name, type, notNull, primaryKey, autoincrement, onUpdate } = column4;
+    const defaultStatement = `${column4.default !== void 0 ? ` DEFAULT ${column4.default}` : ""}`;
+    const notNullStatement = `${notNull ? " NOT NULL" : ""}`;
+    const primaryKeyStatement = `${primaryKey ? " PRIMARY KEY" : ""}`;
+    const autoincrementStatement = `${autoincrement ? " AUTO_INCREMENT" : ""}`;
+    const onUpdateStatement = `${onUpdate ? " ON UPDATE CURRENT_TIMESTAMP" : ""}`;
+    return `ALTER TABLE ${tableName} ADD \`${name}\` ${type}${primaryKeyStatement}${autoincrementStatement}${defaultStatement}${notNullStatement}${onUpdateStatement};`;
   }
 };
 var SQLiteAlterTableAddColumnConvertor = class extends Convertor {
@@ -11473,27 +11516,9 @@ var PgAlterTableAlterColumnDropDefaultConvertor = class extends Convertor {
     return `ALTER TABLE ${tableName} ALTER COLUMN "${columnName}" DROP DEFAULT;`;
   }
 };
-var MySqlAlterTableAlterColumnSetDefaultConvertor = class extends Convertor {
-  can(statement, dialect3) {
-    return statement.type === "alter_table_alter_column_set_default" && dialect3 === "mysql";
-  }
-  convert(statement) {
-    const { tableName, columnName } = statement;
-    return `ALTER TABLE ${tableName} ALTER COLUMN \`${columnName}\` SET DEFAULT ${statement.newDefaultValue};`;
-  }
-};
-var MySqlAlterTableAlterColumnDropDefaultConvertor = class extends Convertor {
-  can(statement, dialect3) {
-    return statement.type === "alter_table_alter_column_drop_default" && dialect3 === "mysql";
-  }
-  convert(statement) {
-    const { tableName, columnName } = statement;
-    return `ALTER TABLE ${tableName} ALTER COLUMN \`${columnName}\` DROP DEFAULT;`;
-  }
-};
 var MySqlModifyColumn = class extends Convertor {
   can(statement, dialect3) {
-    return (statement.type === "alter_table_alter_column_set_type" || statement.type === "alter_table_alter_column_set_notnull" || statement.type === "alter_table_alter_column_drop_notnull" || statement.type === "alter_table_alter_column_drop_on_update" || statement.type === "alter_table_alter_column_set_on_update" || statement.type === "alter_table_alter_column_set_autoincrement" || statement.type === "alter_table_alter_column_drop_autoincrement") && dialect3 === "mysql";
+    return (statement.type === "alter_table_alter_column_set_type" || statement.type === "alter_table_alter_column_set_notnull" || statement.type === "alter_table_alter_column_drop_notnull" || statement.type === "alter_table_alter_column_drop_on_update" || statement.type === "alter_table_alter_column_set_on_update" || statement.type === "alter_table_alter_column_set_autoincrement" || statement.type === "alter_table_alter_column_drop_autoincrement" || statement.type === "alter_table_alter_column_set_default" || statement.type === "alter_table_alter_column_drop_default") && dialect3 === "mysql";
   }
   convert(statement) {
     const { tableName, columnName } = statement;
@@ -11538,6 +11563,18 @@ var MySqlModifyColumn = class extends Convertor {
       columnType = ` ${statement.newDataType}`;
       columnDefault = statement.columnDefault ? ` DEFAULT ${statement.columnDefault}` : "";
       columnAutoincrement = "";
+    } else if (statement.type === "alter_table_alter_column_set_default") {
+      columnNotNull = statement.columnNotNull ? ` NOT NULL` : "";
+      columnOnUpdate = columnOnUpdate = statement.columnOnUpdate ? ` ON UPDATE CURRENT_TIMESTAMP` : "";
+      columnType = ` ${statement.newDataType}`;
+      columnDefault = ` DEFAULT ${statement.newDefaultValue}`;
+      columnAutoincrement = statement.columnAutoIncrement ? " AUTO_INCREMENT" : "";
+    } else if (statement.type === "alter_table_alter_column_drop_default") {
+      columnNotNull = statement.columnNotNull ? ` NOT NULL` : "";
+      columnOnUpdate = columnOnUpdate = statement.columnOnUpdate ? ` ON UPDATE CURRENT_TIMESTAMP` : "";
+      columnType = ` ${statement.newDataType}`;
+      columnDefault = "";
+      columnAutoincrement = statement.columnAutoIncrement ? " AUTO_INCREMENT" : "";
     } else {
       columnType = ` ${statement.newDataType}`;
       columnNotNull = statement.columnNotNull ? ` NOT NULL` : "";
@@ -12102,8 +12139,6 @@ convertors.push(new PgAlterTableAlterColumnDropNotNullConvertor());
 convertors.push(new PgAlterTableAlterColumnSetDefaultConvertor());
 convertors.push(new PgAlterTableAlterColumnDropDefaultConvertor());
 convertors.push(new MySqlModifyColumn());
-convertors.push(new MySqlAlterTableAlterColumnSetDefaultConvertor());
-convertors.push(new MySqlAlterTableAlterColumnDropDefaultConvertor());
 convertors.push(new PgCreateForeignKeyConvertor());
 convertors.push(new MySqlCreateForeignKeyConvertor());
 convertors.push(new PgAlterForeignKeyConvertor());
@@ -12376,7 +12411,11 @@ var _prepareAlterColumns = (tableName, schema3, columns, json2) => {
         tableName,
         columnName,
         newDefaultValue: column4.default.value,
-        schema: schema3
+        schema: schema3,
+        columnOnUpdate,
+        columnNotNull,
+        columnAutoIncrement,
+        newDataType: columnType
       });
     }
     if (((_c = column4.default) == null ? void 0 : _c.type) === "changed") {
@@ -12385,7 +12424,11 @@ var _prepareAlterColumns = (tableName, schema3, columns, json2) => {
         tableName,
         columnName,
         newDefaultValue: column4.default.new,
-        schema: schema3
+        schema: schema3,
+        columnOnUpdate,
+        columnNotNull,
+        columnAutoIncrement,
+        newDataType: columnType
       });
     }
     if (((_d = column4.default) == null ? void 0 : _d.type) === "deleted") {
@@ -12393,7 +12436,12 @@ var _prepareAlterColumns = (tableName, schema3, columns, json2) => {
         type: "alter_table_alter_column_drop_default",
         tableName,
         columnName,
-        schema: schema3
+        schema: schema3,
+        columnDefault,
+        columnOnUpdate,
+        columnNotNull,
+        columnAutoIncrement,
+        newDataType: columnType
       });
     }
     if (((_e = column4.notNull) == null ? void 0 : _e.type) === "added") {