drizzle-kit 0.17.4 → 0.17.5-e5944eb

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "drizzle-kit",
-  "version": "0.17.4",
+  "version": "0.17.5-e5944eb",
   "repository": "https://github.com/drizzle-team/drizzle-kit-mirror",
   "author": "Drizzle Team",
   "license": "MIT",
   "bin": {
-    "drizzle-kit": "./index.js"
+    "drizzle-kit": "./index.mjs"
   },
   "scripts": {
     "migrate:old": "drizzle-kit generate:pg --out ./dev/migrations-pg --schema ./dev/migrations-pg/schema.ts",
@@ -16,6 +16,7 @@
     "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:pg": "node -r esbuild-register ./src/cli/index.ts introspect:pg --out ./dev/introspect-pg --connectionString=postgresql://postgres@localhost:5432/introspect",
+    "drop": "node -r esbuild-register ./src/cli/index.ts drop --out ./dev/migrations-pg",
     "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",
     "check:equedi": "node -r esbuild-register ./src/cli/index.ts check --out ./dev/equedi --dialect pg",
@@ -28,9 +29,7 @@
     "sim": "node -r esbuild-register ./dev/simulate.ts",
     "sim:sqlite": "node -r esbuild-register ./dev/sqlite/index.ts",
     "test": "ava test --timeout=60s",
-    "build": "pnpm build:cli && pnpm build:utils",
-    "build:cli": "esbuild ./src/cli/index.ts --bundle --platform=node --target=node10.4 --outfile=./dist/index.js --external:esbuild --external:drizzle-orm-pg --external:drizzle-orm-sqlite --external:drizzle-orm-mysql --external:drizzle-orm --external:pg-native",
-    "build:utils": "esbuild ./src/utils.ts --bundle --platform=node --target=node10.4 --outfile=./dist/utils.js",
+    "build": "tsx build.ts",
     "pack": "build && package",
     "tsc": "tsc -p tsconfig.build.json",
     "pub": "cp package.json readme.md dist/ && cd dist && npm publish"
@@ -47,11 +46,11 @@
     ]
   },
   "dependencies": {
+    "@esbuild-kit/esm-loader": "^2.5.5",
     "camelcase": "^7.0.1",
     "chalk": "^5.2.0",
     "commander": "^9.4.1",
     "esbuild": "^0.15.18",
-    "esbuild-register": "^3.4.2",
     "glob": "^8.1.0",
     "hanji": "^0.0.5",
     "json-diff": "0.9.0",
@@ -70,7 +69,6 @@
     "drizzle-kit": "^0.16.8",
     "drizzle-orm": "0.23.2-e17a5ba",
     "esbuild": "^0.15.7",
-    "esbuild-register": "^3.3.3",
     "eslint": "^8.29.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",

package/readme.md

@@ -65,15 +65,22 @@ Running with CLI options
 npx drizzle-kit generate:pg --out migrations-folder --schema src/db/schema.ts
 ```
 
-Or put your file to `drizzle.config.json` configuration file:
+### Configuration
+
+Instead of passing arguments to the CLI commands, you can also create a `drizzle.config.json` configuration file:
 
 ```json
 {
   "out": "./migrations-folder",
-  "schema": "./src/db"
+  "schema": "./src/db",
+  "breakpoints": false
 }
 ```
 
+* `out` - path to the output directory where migrations will be saved,
+* `schema` - path to TypeScript schema file or folder with multiple schema files,
+* `breakpoints` - whether to execute each statement in the migrations individually. Set to `true` if you are using SQLite or MySQL (as they don't support multiple DDL statements in a transaction).
+
 ---
 
 ## Upgrading to 0.17.0
@@ -124,13 +131,14 @@ To easily migrate from previous folder structure to new you need to run `up` com
 `--config` [optional default=drizzle.config.json] config file path\
 `--schema` path to typescript schema file or folder with multiple schema files\
 `--out` [optional default=drizzle/] migrations folder\
+`--breakpoints` [optional default=false] whether to execute each statement in the migrations individually\
 
 ```shell
-$ drizzle-kit generate:pg 
-## runs generate command with drizzle.config.json 
+$ drizzle-kit generate:pg
+## runs generate command with drizzle.config.json
 
 $ drizzle-kit generate:pg --config=./custom.config.json
-## runs generate command with custom.config.json 
+## runs generate command with custom.config.json
 
 $ drizzle-kit generate:pg --schema=./src/schema.ts
 ## runs generate command and outputs results to ./drizzle
@@ -143,14 +151,14 @@ $ drizzle-kit generate:pg --schema=./src/schema.ts --out=./migrations/
 
 ```shell
 $ drizzle-kit generate:pg --custom
-## runs generate command and outputs an empty migration for custom SQL 
-```  
+## runs generate command and outputs an empty migration for custom SQL
+```
 
 ### Introspect existing database and generate typescript schema
 
 ---
 
-**`$ drizzle-kit introspect:pg`**
+**`$ drizzle-kit introspect:pg`** \
 **`$ drizzle-kit introspect:mysql`**
 
 ```shell
@@ -166,7 +174,7 @@ drizzle-kit introspect:pg --out=migrations/ --host=0.0.0.0 --port=5432 --user=po
 ---
 
 **`$ drizzle-kit up:pg`** \
-**`$ drizzle-kit up:mysql`**\
+**`$ drizzle-kit up:mysql`** \
 **`$ drizzle-kit up:sqlite`**
 
 `--out` [optional] migrations folder\
@@ -176,7 +184,7 @@ drizzle-kit introspect:pg --out=migrations/ --host=0.0.0.0 --port=5432 --user=po
 ## migrations folder is taken from drizzle.config.json
 drizzle-kit up:mysql
 
-drizzle-kit up:mysql --out=migrations/ 
+drizzle-kit up:mysql --out=migrations/
 ```
 
 ![](media/up_mysql.gif)
@@ -185,7 +193,7 @@ drizzle-kit up:mysql --out=migrations/
 
 ---
 
-**`$ drizzle-kit drop`** \
+**`$ drizzle-kit drop`**
 
 `--out` [optional] migrations folder\
 `--config` [optional default=drizzle.config.json] config file path
@@ -196,8 +204,8 @@ drizzle-kit up:mysql --out=migrations/
 
 ---
 
-**`$ drizzle-kit check:pg`**\
-**`$ drizzle-kit check:mysql`**\
+**`$ drizzle-kit check:pg`** \
+**`$ drizzle-kit check:mysql`** \
 **`$ drizzle-kit check:sqlite`**
 
 `--out` [optional] migration folder\
@@ -207,5 +215,5 @@ drizzle-kit up:mysql --out=migrations/
 ## migrations folder is taken from drizzle.config.json
 drizzle-kit check:pg
 
-drizzle-kit check:pg --out=migrations/ 
+drizzle-kit check:pg --out=migrations/
 ```