Skip to content

Commit 5088dea

Browse files
committed
Update migration docs
1 parent 90f487d commit 5088dea

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/pages/migrations.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Having this code inside the constructor will automatically apply new migrations
3636

3737
## Methods
3838

39-
#### `migrations()`
39+
### `migrations()`
4040

4141
```typescript
4242
qb.migrations(options: MigrationOptions): Migrations
@@ -49,7 +49,7 @@ qb.migrations(options: MigrationOptions): Migrations
4949

5050
- `tableName?: string` - The name of the table to store migration records, defaults to 'migrations'.
5151

52-
#### `initialize()`
52+
### `initialize()`
5353

5454
```typescript
5555
initialize(): void
@@ -58,7 +58,7 @@ initialize(): void
5858

5959
- Initializes the migration table if it doesn't exist. Creates a table named according to `_tableName` or `migrations` if non is set, with columns for `id`, `name`, and `applied_at`.
6060

61-
#### `getApplied()`
61+
### `getApplied()`
6262

6363
```typescript
6464
getApplied(): Array<MigrationEntry>
@@ -69,7 +69,7 @@ getApplied(): Array<MigrationEntry>
6969

7070
- **Returns:** An array of `MigrationEntry` objects representing applied migrations.
7171

72-
#### `getUnapplied()`
72+
### `getUnapplied()`
7373

7474
```typescript
7575
getUnapplied(): Array<Migration>
@@ -80,7 +80,7 @@ getUnapplied(): Array<Migration>
8080

8181
- **Returns:** An array of `Migration` objects that have not yet been applied.
8282

83-
#### `apply()`
83+
### `apply()`
8484

8585
```typescript
8686
apply(): Array<Migration>
@@ -91,9 +91,9 @@ apply(): Array<Migration>
9191

9292
- **Returns:** An array of `Migration` objects that were applied during this call.
9393

94-
### Type Definitions
94+
## Type Definitions
9595

96-
#### MigrationEntry
96+
### MigrationEntry
9797

9898
```typescript
9999
type MigrationEntry = {
@@ -110,7 +110,7 @@ type MigrationEntry = {
110110
111111
- `applied_at`: The timestamp when the migration was applied.
112112
113-
#### Migration
113+
### Migration
114114
115115
```typescript
116116
type Migration = {
@@ -124,7 +124,7 @@ type Migration = {
124124
125125
- `sql`: The SQL command to execute for this migration.
126126
127-
#### MigrationOptions
127+
### MigrationOptions
128128
129129
```typescript
130130
type MigrationOptions = {

0 commit comments

Comments
 (0)