drizzle-kit 0.17.0-5763371 → 0.17.0-5e8cf70

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-kit",
-  "version": "0.17.0-5763371",
+  "version": "0.17.0-5e8cf70",
   "repository": "https://github.com/drizzle-team/drizzle-kit-mirror",
   "author": "Drizzle Team",
   "license": "MIT",
@@ -9,12 +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/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/migrations-mysql --schema ./dev/migrations-mysql/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",
@@ -55,11 +56,13 @@
     "glob": "^8.1.0",
     "hanji": "^0.0.5",
     "json-diff": "0.9.0",
+    "minimatch": "^7.4.3",
     "zod": "^3.20.2"
   },
   "devDependencies": {
     "@types/dockerode": "^3.3.14",
     "@types/glob": "^8.1.0",
+    "@types/minimatch": "^5.1.2",
     "@types/node": "^18.11.15",
     "@types/pg": "^8.6.5",
     "@typescript-eslint/eslint-plugin": "^5.46.1",

package/readme.md

@@ -1,16 +1,19 @@
 ## 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
 
-import { integer, pgTable, serial, text, varchar } from "drizzle-orm-pg";
+import { integer, pgTable, serial, text, varchar } from "drizzle-orm/pg-core";
 
 const users = pgTable("users", {
     id: serial("id").primaryKey(),
@@ -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
+npx 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/ 
 ```
-
-
-