dbschema 0.1.3

Define database schema's as HCL files, and generate idempotent SQL migrations
Documentation 
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

# Table

Creates a table with columns and constraints.

```hcl
table "users" {
  schema       = "public"
  if_not_exists = true

  column "id" {
    type     = "serial"
    nullable = false
  }

  column "email" {
    type     = "text"
    nullable = false
  }

  partition_by {
    strategy = "RANGE"
    columns  = ["id"]
  }
  partition "users_1" { values = "FROM (1) TO (100)" }

  primary_key { columns = ["id"] }
  check "email_not_empty" { expression = "email <> ''" }
}
```

## Attributes
- `name` (label): table name.
- `schema` (string, optional): schema for the table. Defaults to `public`.
- `if_not_exists` (bool, optional): emit `IF NOT EXISTS`.
- `column` blocks: define columns with `type`, `nullable`, optional `default`, `db_type`, `lint_ignore`, `comment`.
- `primary_key` block: list of column names and optional constraint name.
- `check` blocks: named check constraints with an `expression`.
- `index` blocks: inline index definitions (`columns`, `unique`).
- `foreign_key` blocks: reference other tables with `columns`, `ref_schema`, `ref_table`, `ref_columns`, `on_delete`, `on_update`.
- `partition_by` block: define partitioning `strategy` (`RANGE`, `LIST`, `HASH`) and `columns`.
- `partition` blocks: create child partitions with a name and `values` bounds string.
- `back_reference` blocks: create foreign keys on another table.
- `lint_ignore` (array of strings, optional): suppress lint rules.
- `comment` (string, optional): documentation comment.

## Examples

```hcl
table "users" {
  column "id"    { type = "uuid", nullable = false, default = "gen_random_uuid()" }
  column "email" { type = "text", nullable = false }
  column "role"  { type = "text", nullable = false, default = "user" }
  primary_key { columns = ["id"] }
  index "users_email_key" { columns = ["email"], unique = true }
}

table "posts" {
  column "id"       { type = "uuid", nullable = false, default = "gen_random_uuid()" }
  column "authorId" { type = "uuid", nullable = false }
  column "title"    { type = "text", nullable = false }
  column "body"     { type = "text", nullable = true }
  primary_key { columns = ["id"] }
  foreign_key {
    columns = ["authorId"]
    ref { table = "users" columns = ["id"] }
    on_delete = "CASCADE"
  }
}
```