aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
blob: 29bde47b82ce0009ad6e58fb83eddc4126171660 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
# Bolt

![Version](https://img.shields.io/badge/version-0.12.0-blue)
[![Build Status](https://builds.sr.ht/~eugenetriguba/bolt/commits/main.svg)](https://builds.sr.ht/~eugenetriguba/bolt/commits/main?)
[![GoDoc](https://godoc.org/git.sr.ht/~eugenetriguba/bolt?status.svg)](https://godoc.org/git.sr.ht/~eugenetriguba/bolt)
[![Go Report Card](https://goreportcard.com/badge/git.sr.ht/~eugenetriguba/bolt)](https://goreportcard.com/report/git.sr.ht/~eugenetriguba/bolt)

Bolt is a command-line tool designed to simplify and streamline your database
migration process.

It is distributed as a standalone binary, making it easy to run anywhere
without having to setup any tooling, and it is language independent. It
doesn't matter what programming language you're using, you can use Bolt
for any project you have.

## Features

- Schema migrations are written in plain SQL
- Migrations can be versioned sequentially or by creation timestamp
- All migrations run in transactions by default
- Supports up and down migrations and jumping to any particular schema version
- Supports PostgreSQL, MySQL, SQL Server, and SQLite3

## Quick Start

### Install Bolt

```bash
go install git.sr.ht/~eugenetriguba/bolt/cmd/bolt@v0.12.0
```

This will install Bolt to your `$GOBIN` directory. Make sure that `$GOBIN` is in your `$PATH`.

### Create your first migration

```bash
bolt new -m "create users table"
```

### Write your migration

Edit the generated SQL file in the `migrations/` directory:

```sql
-- migrate:up
CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL,
    created_at TIMESTAMP NOT NULL DEFAULT NOW(),
    updated_at TIMESTAMP NOT NULL DEFAULT NOW()
);

-- migrate:down
DROP TABLE users;
```

### Configure Bolt

Create a `bolt.toml` file:

```toml
[database]
dsn = "postgresql://user:password@localhost:5432/mydb?sslmode=disable"
driver = "postgresql"
```

### Apply your migration

```bash
bolt up
```

## Next Steps

- Read the [installation guide](./installation.md) for all installation options.
- Follow the [Tutorial](tutorial.md) for a detailed walkthrough.
- Check out [How-To Guides](how-to.md) for specific tasks.
- Browse the [Reference](reference.md) for commands and configuration options.
- Read [Explanations](explanation.md) to understand how Bolt works internally.
- See [Contributing](contributing.md) if you're interesting in contributing to
  Bolt.