dbschema 0.1.0

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

# Trigger

Attaches a function to table events.

```hcl
trigger "users_updated_at" {
  schema   = "public"
  table    = "users"
  timing   = "BEFORE"
  events   = ["UPDATE"]
  level    = "ROW"
  function = "set_updated_at"
}
```

## Attributes
- `name` (label): trigger name.
- `schema` (string, optional): schema for the trigger. Defaults to `public`.
- `table` (string): table the trigger operates on.
- `timing` (string): `BEFORE` or `AFTER`.
- `events` (array of strings): `INSERT`, `UPDATE`, `DELETE`.
- `level` (string): `ROW` or `STATEMENT`.
- `function` (string): function name to execute.
- `function_schema` (string, optional): schema of the function.
- `when` (string, optional): optional WHEN condition.
- `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 "updatedDate" { type = "timestamp", nullable = true }
  primary_key { columns = ["id"] }
}

function "set_updated_at" {
  language = "plpgsql"
  returns  = "trigger"
  body = <<-SQL
  BEGIN
    NEW."updatedDate" := now();
    RETURN NEW;
  END;
  SQL
}

trigger "users_set_updated_at" {
  table = "users"
  timing = "BEFORE"
  events = ["UPDATE"]
  level  = "ROW"
  function = "set_updated_at"
}
```