dbnest 0.1.2

dbnest CLI – cozy local databases in seconds
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

# dbnest CLI

Cozy local databases in seconds.

## Quickstart

1. Create a database

SQLite:

```bash
dbnest up sqlite --path ./dev.sqlite
```

PostgreSQL:

```bash
dbnest up postgres --user dev --password dev --db appdb
```

List instances

```bash
dbnest ls
```

Check status:

```bash
dbnest status <INSTANCE_ID>
dbnest status --all
```

Lifecycle:

```bash
dbnest stop <INSTANCE_ID>
dbnest start <INSTANCE_ID>
dbnest restart <INSTANCE_ID>
dbnest rm <INSTANCE_ID> --force
dbnest rm <INSTANCE_ID> --force --volumes
```

2. Define schema
   Create a schema file or directory layout

###### schema.json:

```bash
{
  "tables": [
    {
      "name": "users",
      "columns": [
        { "name": "id", "type": "uuid", "primary_key": true },
        { "name": "email", "type": "string", "unique": true, "nullable": false },
        { "name": "created_at", "type": "timestamp", "default": "now" }
      ],
      "indexes": [
        { "name": "idx_users_email", "columns": ["email"], "unique": true }
      ]
    }
  ]
}
```

Or a directory layout:

```bash
schema/
  users/
    columns.json
    indexes.json
```

with `columns.json` and `indexes.json` containing the respective table schema.

```bash
[
  { "name": "id", "type": "uuid", "primary_key": true },
  {
    "name": "email",
    "type": "string",
    "unique": true,
    "nullable": false
  },
  { "name": "created_at", "type": "timestamp", "default": "now" }
]
```

3. Generate SQL from schema (plan)

SQLite:

```bash
dbnest plan sqlite --schema ./schema.json               # from single json schema
dbnest plan sqlite --schema ./schema/                   # from directory based schema
```

Postgres:

```bash
dbnest plan postgres --schema ./examples/schema.json    # from single json schema
dbnest plan postgres --schema ./schema/                 # from directory based schema
```

4. Apply schema to database (apply)

```bash
dbnest apply --id <INSTANCE_ID> --schema ./schema.json
# or
dbnest apply --id <INSTANCE_ID> --schema ./schema/
```

Provision and apply schema in one command:

```bash
dbnest up sqlite --path ./dev.sqlite --schema ./schema.json
dbnest up sqlite --path ./dev.sqlite --schema ./schema.json --keep-on-failure
```

## Output And Secrets

Human and JSON output redact passwords by default. Commands that print instance data may support `--show-secrets`.

## Development Docs

See the workspace `docs/` directory for schema, lifecycle, security, testing, and implementation notes.

---

## License

MIT