aboutsummaryrefslogtreecommitdiffstats
path: root/man/bolt.1
blob: 74d65d9f8797f8e92fb9bb012ab369a6eff10e91 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
.Dd February 12, 2026
.Dt BOLT 1
.Os
.Sh NAME
.Nm bolt
.Nd database migration tool
.Sh SYNOPSIS
.Nm
.Ar command
.Op Ar options
.Sh DESCRIPTION
.Nm
is a command-line tool for database migrations.
.Pp
.Bl -bullet
.It
Schema migrations are written in plain SQL.
.It
Migrations can be versioned sequentially or by creation timestamp.
.It
All migrations run in transactions by default.
.It
Supports up and down migrations and jumping to any particular schema version.
.It
Supports PostgreSQL 13+, MySQL 5.7+, SQL Server 2017+, and SQLite3.
.El
.Sh COMMANDS
.Bl -tag -width Ds
.It Xr bolt-new 1
Create a new database migration.
.It Xr bolt-up 1
Apply migrations against the database.
.It Xr bolt-down 1
Revert migrations against the database.
.It Xr bolt-status 1
List migrations and their statuses.
.It Xr bolt-version 1
Print the version.
.It Xr bolt-help 1
Show the manual for a command.
.El
.Sh FILES
.Bl -tag -width Ds
.It Pa bolt.toml
Configuration file. See
.Xr bolt.toml 5 .
.It Pa migrations/
Default directory for migration scripts. See
.Xr bolt-migration 5 .
.El
.Sh EXIT STATUS
.Nm
exits 0 on success, and >0 if an error occurs.
.Sh SEE ALSO
.Xr bolt-migration 5 ,
.Xr bolt.toml 5 ,
.Xr bolt-databases 7 ,
.Xr bolt-execution 7 ,
.Xr bolt-tutorial 7
.Sh AUTHOR
.Nm
is maintained by
.An Eugene Triguba ,
.Mt hello@eugenetriguba.com .
.Pp
Up-to-date sources can be found at
.Lk https://git.sr.ht/~eugenetriguba/bolt
and bugs/patches can be submitted by email to
.Mt ~eugenetriguba/public-inbox@lists.sr.ht .