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

# Function

Creates a user-defined function.

```hcl
function "now_utc" {
  schema      = "public"
  language    = "sql"
  parameters  = ["arg1 int"]
  returns     = "timestamptz"
  replace     = true
  volatility  = "immutable"
  strict      = true
  security    = "definer"
  cost        = 100
  body        = "SELECT now()"
}
```

## Attributes
- `name` (label): function name.
- `schema` (string, optional): schema for the function. Defaults to `public`.
- `language` (string): implementation language.
- `parameters` (list of strings, optional): function parameters.
- `returns` (string): return type.
- `replace` (bool, optional): use `CREATE OR REPLACE`.
- `volatility` (string, optional): `immutable`, `stable`, or `volatile`.
- `strict` (bool, optional): use `STRICT` (defaults to `CALLED ON NULL INPUT`).
- `security` (string, optional): `definer` or `invoker`.
- `cost` (number, optional): estimated execution cost.
- `body` (string): function body.
- `comment` (string, optional): documentation comment.

## Examples

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

function "add" {
  language = "sql"
  returns  = "int"
  parameters = ["a int", "b int"]
  body = "SELECT a + b"
}
```