{"_id":"@anthonyalayo/drizzle-kit","_rev":"9-25a95619557d524d43984ce3ca131a50","name":"@anthonyalayo/drizzle-kit","dist-tags":{"latest":"1.0.7"},"versions":{"1.0.1":{"name":"@anthonyalayo/drizzle-kit","version":"1.0.1","keywords":["drizzle","orm","pg","mysql","singlestore","postgresql","postgres","sqlite","database","sql","typescript","ts","drizzle-kit","migrations","schema"],"author":{"name":"Drizzle Team"},"license":"MIT","_id":"@anthonyalayo/drizzle-kit@1.0.1","maintainers":[{"name":"anthonyalayo","email":"anthony.alayo@gmail.com"}],"homepage":"https://orm.drizzle.team","bugs":{"url":"https://github.com/drizzle-team/drizzle-orm/issues"},"bin":{"drizzle-kit":"bin.cjs"},"dist":{"shasum":"b3b94ac0f2d0b7fa8975521f3d1a7d584966b9ed","tarball":"https://registry.npmjs.org/@anthonyalayo/drizzle-kit/-/drizzle-kit-1.0.1.tgz","fileCount":161,"integrity":"sha512-p5UR2CE4FDvB9OV/X/0xQmrALf06vdxx6rEaMcr+cmhP9NBTg1QgVXa046HjgSEPOpr70VL13iwOkwEE53fpWQ==","signatures":[{"sig":"MEQCIFI7n4cJCHoXojT1dHbWVbNpOptOIn2jmPQNWDYU9zi/AiAsS7ATh6jJfccHZgjvWIzAZ/GlIipkgLkQl/Hnk1iVmw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":2058469},"exports":{".":{"types":"./index.d.mts","import":{"types":"./index.d.mts","default":"./index.mjs"},"default":"./index.mjs","require":{"types":"./index.d.ts","default":"./index.js"}},"./api":{"types":"./api.d.mts","import":{"types":"./api.d.mts","default":"./api.mjs"},"default":"./api.mjs","require":{"types":"./api.d.ts","default":"./api.js"}}},"gitHead":"fb554c4b03535b81983161678b376ae2cf0e3054","scripts":{"api":"tsx ./dev/api.ts","cli":"tsx ./src/cli/index.ts","tsc":"tsc -p tsconfig.build.json --noEmit","pack":"cp package.json README.md dist/ && (cd dist && npm pack --pack-destination ..) && rm -f package.tgz && mv *.tgz package.tgz","test":"pnpm tsc && TEST_CONFIG_PATH_PREFIX=./tests/cli/ vitest","build":"rm -rf ./dist && tsx build.ts && cp package.json dist/ && attw --pack dist","publish":"npm publish package.tgz","build:dev":"rm -rf ./dist && tsx build.dev.ts && tsc -p tsconfig.cli-types.json && chmod +x ./dist/index.cjs","migrate:old":"drizzle-kit generate:mysql"},"_npmUser":{"name":"anthonyalayo","email":"anthony.alayo@gmail.com"},"repository":{"url":"git+https://github.com/drizzle-team/drizzle-orm.git","type":"git"},"_npmVersion":"11.2.0","description":"Drizzle Kit is a CLI migrator tool for Drizzle ORM. It is probably the one and only tool that lets you completely automatically generate SQL migrations and covers ~95% of the common cases like deletions and renames by prompting user input. - is a mirror repository for issues.\n\n## Documentation\n\nCheck the full documentation on [the website](https://orm.drizzle.team/kit-docs/overview).\n\n### How it works\n\nDrizzle Kit traverses a schema module and generates a snapshot to compare with the previous version, if there is one.\nBased on the difference, it will generate all needed SQL migrations. If there are any cases that can't be resolved automatically, such as renames, it will prompt the user for input.\n\nFor example, for this schema module:\n\n```typescript\n// src/db/schema.ts\n\nimport { integer, pgTable, serial, text, varchar } from \"drizzle-orm/pg-core\";\n\nconst users = pgTable(\"users\", {\n id: serial(\"id\").primaryKey(),\n fullName: varchar(\"full_name\", { length: 256 }),\n }, (table) => ({\n nameIdx: index(\"name_idx\", table.fullName),\n })\n);\n\nexport const authOtp = pgTable(\"auth_otp\", {\n id: serial(\"id\").primaryKey(),\n phone: varchar(\"phone\", { length: 256 }),\n userId: integer(\"user_id\").references(() => users.id),\n});\n```\n\nIt will generate:\n\n```SQL\nCREATE TABLE IF NOT EXISTS auth_otp (\n \"id\" SERIAL PRIMARY KEY,\n \"phone\" character varying(256),\n \"user_id\" INT\n);\n\nCREATE TABLE IF NOT EXISTS users (\n \"id\" SERIAL PRIMARY KEY,\n \"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\n```shell\nnpm install -D drizzle-kit\n```\n\nRunning with CLI options:\n\n```jsonc\n// package.json\n{\n \"scripts\": {\n \"generate\": \"drizzle-kit generate --out migrations-folder --schema src/db/schema.ts\"\n }\n}\n```\n\n```shell\nnpm run generate\n```\n","readmeFilename":"README.md"}