ahmido
1fec9c6f9d
Some checks failed
Main Confidence / confidence (push) Failing after 45s
## Summary - introduce surface-aware compressed governance outcomes and reuse the shared truth/explanation seams for operator-first summaries - apply the compressed outcome hierarchy across baseline, evidence, review, review-pack, canonical review/evidence, and artifact-oriented operation-run surfaces - expand spec 214 fixtures and Pest coverage, and fix tenant-panel route assertions by generating explicit tenant-panel URLs in the affected Filament tests ## Validation - `cd apps/platform && ./vendor/bin/sail bin pint --dirty --format agent` - focused governance compression suite from `specs/214-governance-outcome-compression/quickstart.md` passed (`68` tests, `445` assertions) - `cd apps/platform && ./vendor/bin/sail artisan test --compact tests/Feature/Filament/InventoryItemResourceTest.php tests/Feature/Filament/BackupSetUiEnforcementTest.php tests/Feature/Filament/RestoreRunUiEnforcementTest.php` passed (`18` tests, `81` assertions) Co-authored-by: Ahmed Darrazi <ahmed.darrazi@live.de> Reviewed-on: #253
80 lines
2.0 KiB
Plaintext
80 lines
2.0 KiB
Plaintext
## Drizzle Kit
|
|
|
|
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.
|
|
<https://github.com/drizzle-team/drizzle-kit-mirror> - is a mirror repository for issues.
|
|
|
|
## Documentation
|
|
|
|
Check the full documentation on [the website](https://orm.drizzle.team/kit-docs/overview).
|
|
|
|
### How it works
|
|
|
|
Drizzle Kit traverses a schema module and generates a snapshot to compare with the previous version, if there is one.
|
|
Based 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.
|
|
|
|
For example, for this schema module:
|
|
|
|
```typescript
|
|
// src/db/schema.ts
|
|
|
|
import { integer, pgTable, serial, text, varchar } from "drizzle-orm/pg-core";
|
|
|
|
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:
|
|
|
|
```jsonc
|
|
// package.json
|
|
{
|
|
"scripts": {
|
|
"generate": "drizzle-kit generate --out migrations-folder --schema src/db/schema.ts"
|
|
}
|
|
}
|
|
```
|
|
|
|
```shell
|
|
npm run generate
|
|
```
|