@vperms/drizzle-adapter
v0.0.6
Published
Drizzle ORM adapter for VeguiPerms (SQLite, MySQL and Postgres).
Maintainers
Readme
VeguiPerms Drizzle Adapter
@vperms/drizzle-adapter persists VeguiPerms subjects and grants in SQLite, MySQL
or Postgres using an existing Drizzle instance. Each dialect ships its own schema
and migrations.
Drizzle guide · API reference · GitHub
Install (SQLite)
npm install @vperms/drizzle-adapter vperms drizzle-orm better-sqlite3Quick start
import Database from "better-sqlite3";
import { drizzle } from "drizzle-orm/better-sqlite3";
import { sqliteSchema, VeguiPermsSqliteAdapter } from "@vperms/drizzle-adapter/sqlite";
import { createVPerms } from "vperms";
const adapter = new VeguiPermsSqliteAdapter({
db: drizzle(new Database("permissions.sqlite"), { schema: sqliteSchema }),
});
await adapter.migrate();
const perms = createVPerms({ adapter });
await perms.can("alice", "projects.read");Dialect entry points
| Import | Adapter | Driver |
| --- | --- | --- |
| @vperms/drizzle-adapter/sqlite | VeguiPermsSqliteAdapter | better-sqlite3 |
| @vperms/drizzle-adapter/mysql | VeguiPermsMysqlAdapter | mysql2 |
| @vperms/drizzle-adapter/postgres | VeguiPermsPostgresAdapter | pg |
Install the driver for your dialect. Pass an already-created Drizzle instance;
schema setup only happens when you explicitly call migrate(). Override
migrationsFolder when your deployment needs a custom migration location.
Build and coverage badges describe the whole VeguiPerms repository. License: MIT.
