drizzle-team / drizzle-team/drizzle-orm

[DOCS]: Update documentation for `drizzle.config.ts > migrations` section to include allowed prefix attribute values

Open
#5,325 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
TypeScript
Stars
35.8k
Forks
1.6k
Avg merge
2d 7h
Merged PRs (30d)
4

Description

### Enhancement hasn't been filed before.

- [x] I have verified this enhancement I'm about to request hasn't been suggested before.

### Describe the enhancement you want to request

The documentation for the [`drizzle.config.ts > migrations`](https://orm.drizzle.team/docs/drizzle-config-file#migrations) section is missing the allowed values for the `prefix` attribute in the migrations object type definition. The structure should be documented as:

```ts
{ table: string, schema: string; prefix: "index" | "timestamp" | "supabase" | "unix" | "none" }
```

The default value remains `{ table: "__drizzle_migrations", schema: "drizzle", prefix: "index" }`.

Please update the documentation to reflect the allowed values for the `prefix` attribute for better clarity on migrations configuration.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.