drizzle-kit 0.12.1 → 0.12.4

package/index.js

@@ -17969,7 +17969,7 @@ var PgSquasher = {
     const result = index.parse({
       name,
       columns: columnsString.split(","),
-      isUnique: Boolean(isUnique)
+      isUnique: isUnique === "true"
     });
     return result;
   },
@@ -18032,7 +18032,7 @@ var generatePgSnapshot = (tables, enums) => {
         if (column3.default instanceof import_sql.SQL) {
           columnToSet.default = column3.default.queryChunks.map((it) => {
             if (typeof it === "string") {
-              return `"${it}"`;
+              return `${it}`;
             }
             throw new Error();
           }).join();
@@ -18119,7 +18119,7 @@ var generateMySqlSnapshot = (tables, enums) => {
         if (column3.default instanceof import_sql2.SQL) {
           columnToSet.default = column3.default.queryChunks.map((it) => {
             if (typeof it === "string") {
-              return `"${it}"`;
+              return `${it}`;
             }
             throw new Error();
           }).join();
@@ -18460,8 +18460,8 @@ var PgCreateForeignKeyConvertor = class extends Convertor {
   }
   convert(statement) {
     const { name, tableFrom, tableTo, columnsFrom, columnsTo, onDelete, onUpdate } = PgSquasher.unsquashFK(statement.data);
-    const onDeleteStatement = onDelete || "";
-    const onUpdateStatement = onUpdate || "";
+    const onDeleteStatement = `ON DELETE ${onDelete}` || "";
+    const onUpdateStatement = `ON UPDATE ${onUpdate}` || "";
     const fromColumnsString = columnsFrom.map((it) => `"${it}"`).join(",");
     const toColumnsString = columnsTo.map((it) => `"${it}"`).join(",");
     const alterStatement = `ALTER TABLE ${tableFrom} ADD CONSTRAINT ${name} FOREIGN KEY (${fromColumnsString}) REFERENCES ${tableTo}(${toColumnsString}) ${onDeleteStatement} ${onUpdateStatement}`.replace(/  +/g, " ").trim();
@@ -18479,8 +18479,8 @@ var MySqlCreateForeignKeyConvertor = class extends Convertor {
   }
   convert(statement) {
     const { name, tableFrom, tableTo, columnsFrom, columnsTo, onDelete, onUpdate } = PgSquasher.unsquashFK(statement.data);
-    const onDeleteStatement = onDelete || "";
-    const onUpdateStatement = onUpdate || "";
+    const onDeleteStatement = `ON DELETE ${onDelete}` || "";
+    const onUpdateStatement = `ON UPDATE ${onUpdate}` || "";
     const fromColumnsString = columnsFrom.map((it) => `\`${it}\``).join(",");
     const toColumnsString = columnsTo.map((it) => `\`${it}\``).join(",");
     return `ALTER TABLE ${tableFrom} ADD CONSTRAINT ${name} FOREIGN KEY (${fromColumnsString}) REFERENCES ${tableTo}(${toColumnsString}) ${onDeleteStatement} ${onUpdateStatement};`.replace(/  +/g, " ").trim();
@@ -19008,7 +19008,7 @@ var MySqlSquasher = {
     const result = index2.parse({
       name,
       columns: columnsString.split(","),
-      isUnique: Boolean(isUnique),
+      isUnique: isUnique === "true",
       using,
       algorithm,
       lock

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drizzle-kit",
-  "version": "0.12.1",
+  "version": "0.12.4",
   "repository": "https://github.com/lambda-direct/drizzle-kit",
   "author": "Alex Blokh <aleksandrblokh@gmail.com>",
   "license": "MIT",

package/readme.md

@@ -0,0 +1,100 @@
+## 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.
+
+### 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";
+
+const users = pgTable("users", {
+    id: serial("id").primaryKey(),
+    fullName: varchar("full_name", { length: 256 }),
+  }, (table) => ({
+    nameIdx: index("name_idx", table.fullName),
+  })
+);
+
+export const authOtp = pgTable("auth_otp", {
+  id: serial("id").primaryKey(),
+  phone: varchar("phone", { length: 256 }),
+  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
+);
+
+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
+```shell
+$ 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
+```
+
+Or put your file to `drizzle.config.json` configuration file:
+```json
+{
+  "dialect": "pg",
+  "out": "./migrations-folder",
+  "schema": "./src/db"
+}
+```
+---
+### List of commands
+**`$ drizzle-kit generate`** - generates SQL migrations based on .ts schema\
+`--config` [optional defalut=drizzle.config.json] path to an optional config file\
+`--dialect` [optional default=pg] database dialect, one of -> pg, mysql, sqlite\
+`--schema` path to a schema file or folder with multiple schema files\
+`--out` [optional default=drizzle/] place where to store migration files\
+```shell
+$ drizzle-kit generate 
+## runs generate command with drizzle.config.json 
+
+$ drizzle-kit generate --config custom.config.json
+## runs generate command with custom.config.json 
+
+$ drizzle-kit generate --dialect pg --schema src/schema.ts
+## runs generate command and outputs results to ./drizzle
+
+$ drizzle-kit generate --dialect .. --schema .. --out ./migration-folder
+## runs generate command and outputs results to ./migration-folder
+```  
+**`$ drizzle-kit up`** - updates stale snapshots
+`--config` [optional defalut=drizzle.config.json] path to an optional config file\
+`--dialect` [optional default=pg] database dialect, one of -> pg, mysql, sqlite\
+`--schema` path to a schema file or folder with multiple schema files\
+
+**`$ drizzle-kit check`** - checks for collisions
+`--config` [optional defalut=drizzle.config.json] path to an optional config file\
+`--dialect` [optional default=pg] database dialect, one of -> pg, mysql, sqlite\
+`--schema` path to a schema file or folder with multiple schema files\
+
+
+