drizzle-kit 0.9.46 → 0.9.49

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-kit",
-  "version": "0.9.46",
+  "version": "0.9.49",
   "author": "Alex Blokh <aleksandrblokh@gmail.com>",
   "license": "MIT",
   "bin": {
@@ -28,7 +28,7 @@
     "@types/js-yaml": "^4.0.3",
     "@types/pg": "^8.6.1",
     "@typescript-eslint/eslint-plugin": "4.4.1",
-    "drizzle-orm": "^0.10.25",
+    "drizzle-orm": "^0.11.2",
     "esbuild-register": "^3.3.2",
     "eslint": "^7.2.0",
     "eslint-config-airbnb": "18.2.1",
@@ -46,5 +46,6 @@
     "test": "uvu -r esbuild-register ./tests/",
     "imports": "ts-node ./test.ts",
     "build": "esbuild ./src/cli/index.ts --bundle --platform=node --target=node10.4 --outfile=./dist/index.js --external:esbuild"
-  }
+  },
+  "readme": "## Drizzle Kit\nDrizzleKit - 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.\n\n### How it works\n`drizzle-kit` will traverse `data folder` from configuration file, find all schema .ts files. 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.\n\nFor schema file:\n```typescript\nimport { AbstractTable } from \"drizzle-orm\";\n\nexport class UsersTable extends AbstractTable<UsersTable> {\n  public id = this.serial(\"id\").primaryKey();\n  public fullName = this.varchar(\"full_name\", { size: 256 });\n\n  public fullNameIndex = this.index(this.fullName);\n\n  public tableName(): string {\n    return \"users\";\n  }\n}\n\nexport class AuthOtpTable extends AbstractTable<AuthOtpTable> {\n  public id = this.serial(\"id\").primaryKey();\n  public phone = this.varchar(\"phone\", { size: 256 });\n  public userId = this.int(\"user_id\").foreignKey(UsersTable, (t) => t.id);\n\n  public tableName(): string {\n    return \"auth_otp\";\n  }\n}\n```\nIt will generate:\n```SQL\nCREATE TABLE IF NOT EXISTS auth_otp (\n\t\"id\" SERIAL PRIMARY KEY,\n\t\"phone\" character varying(256),\n\t\"user_id\" INT\n);\n\nCREATE TABLE IF NOT EXISTS users (\n\t\"id\" SERIAL PRIMARY KEY,\n\t\"full_name\" character varying(256)\n);\n\nDO $$ BEGIN\n ALTER TABLE auth_otp ADD CONSTRAINT auth_otp_user_id_fkey FOREIGN KEY (\"user_id\") REFERENCES users(id);\nEXCEPTION\n WHEN duplicate_object THEN null;\nEND $$;\n\nCREATE INDEX IF NOT EXISTS users_full_name_index ON users (full_name);\n```\n\n### Installation & configuration\n```bash\nnpm install -g drizzle-kit\n```\nCreate a `drizzle.config.yml` configuration file:\n```yaml\nmigrationRootFolder: drizzle ## all migrations will live here\ndataFolder: './src/data'     ## where are all schema .ts files\n```\n  \\\nThat's it, you're ready to go 🚀\n```\n> drizzle-kit migrate\n```\n  \\\nYou can also run migrations in project scope\n```js\n// package.json\n{\n  ...\n  scripts: {\n    ...\n    migrate: \"drizzle-kit migrate\"\n  }\n}\n\n> npm run migrate\n```\n    \n\n"
 }

package/readme.md

@@ -0,0 +1,83 @@
+## 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.
+
+### How it works
+`drizzle-kit` will traverse `data folder` from configuration file, find all schema .ts files. 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
+import { AbstractTable } from "drizzle-orm";
+
+export class UsersTable extends AbstractTable<UsersTable> {
+  public id = this.serial("id").primaryKey();
+  public fullName = this.varchar("full_name", { size: 256 });
+
+  public fullNameIndex = this.index(this.fullName);
+
+  public tableName(): string {
+    return "users";
+  }
+}
+
+export class AuthOtpTable extends AbstractTable<AuthOtpTable> {
+  public id = this.serial("id").primaryKey();
+  public phone = this.varchar("phone", { size: 256 });
+  public userId = this.int("user_id").foreignKey(UsersTable, (t) => t.id);
+
+  public tableName(): string {
+    return "auth_otp";
+  }
+}
+```
+It will generate:
+```SQL
+CREATE TABLE IF NOT EXISTS auth_otp (
+	"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)
+);
+
+DO $$ BEGIN
+ ALTER TABLE auth_otp ADD CONSTRAINT auth_otp_user_id_fkey FOREIGN KEY ("user_id") REFERENCES users(id);
+EXCEPTION
+ WHEN duplicate_object THEN null;
+END $$;
+
+CREATE INDEX IF NOT EXISTS users_full_name_index ON users (full_name);
+```
+
+### Installation & configuration
+```bash
+npm install -g drizzle-kit
+```
+Create a `drizzle.config.yml` configuration file:
+```yaml
+migrationRootFolder: drizzle ## all migrations will live here
+dataFolder: './src/data'     ## where are all schema .ts files
+```
+  \
+That's it, you're ready to go 🚀
+```
+> drizzle-kit migrate
+```
+  \
+You can also run migrations in project scope
+```js
+// package.json
+{
+  ...
+  scripts: {
+    ...
+    migrate: "drizzle-kit migrate"
+  }
+}
+
+> npm run migrate
+```
+    
+