@aurelienbbn/oxlint-plugin-drizzle
1 oxlint rule for Drizzle Postgres schemas: every foreign-key column leads an index, before production traffic finds the sequential scan.
[!NOTE] Release candidate. No consumer has calibrated it yet.
pnpm add -D @aurelienbbn/oxlint-plugin-drizzle oxlint # oxlint >=1.82.0 <2.0.0
{
"jsPlugins": ["@aurelienbbn/oxlint-plugin-drizzle"],
"rules": {
"drizzle/fk-column-indexed": "error"
}
}
No preset, no autofix: index shape (single, composite, partial) is a design choice.
What fires
export const posts = pgTable("posts", {
authorId: integer().references(() => users.id), // ❌ fk-column-indexed
});
export const indexedPosts = pgTable(
"indexed_posts",
{ authorId: integer().references(() => users.id) },
(t) => [index().on(t.authorId)], // ✅
);
Postgres only. MySQL InnoDB creates an index for each foreign key when none exists, so mysqlTable is out of scope. Neither drizzle-kit (0.31.11, 1.0.0-rc.4) nor eslint-plugin-drizzle (0.2.3) checks this.
Exact trigger and scope
| ❌ Fires on | Covered by / ⏭️ skipped |
|---|---|
a .references(...) column, or the first column of foreignKey({ columns }), that no covering builder starts with | index / uniqueIndex / unique .on(t.col, ...) or .using(method, t.col, ...), primaryKey({ columns: [t.col, ...] }), column-level .primaryKey() / .unique(). Tables from pgTable or pgSchema(...).table imported from drizzle-orm/pg-core; object or callback columns; array or 0.x object extra config. ⏭️ extra config that isn't an inline arrow returning a literal, or that contains spreads |
Registered contract inventory
Generated from package exports by pnpm catalog. Rule-specific options and limitations are described above and in the source tests.
| Rule/check | Trigger or review scope |
|---|---|
fk-column-indexed | Require each foreign-key column of a Drizzle pgTable (.references() or foreignKey()) to be the first column of an index, unique constraint, or primary key. |
Credited concepts
- https://www.postgresql.org/docs/current/ddl-constraints.html (inspiration; independently implemented)
- planetscale/database-skills skills/postgres/references/schema-design.md by PlanetScale (MIT, concept)