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

# Index

Defines an index on an existing table.

```hcl
index "users_email_key" {
  table       = "users"
  columns     = ["email"]
  expressions = ["lower(name)"]
  orders      = ["ASC", "DESC"]
  operator_classes = ["text_pattern_ops"]
  where       = "email IS NOT NULL"
  unique      = true
}
```

## Attributes
- `name` (label): index name.
- `table` (string): table to index.
- `schema` (string, optional): schema of the table. Defaults to `public`.
- `columns` (array of strings): columns to include.
- `expressions` (array of strings, optional): expression items to include.
- `orders` (array of strings, optional): per-item sort order such as `ASC`, `DESC`, `NULLS FIRST`, or `NULLS LAST`.
- `operator_classes` (array of strings, optional): per-item operator class.
- `where` (string, optional): partial index predicate.
- `unique` (bool, optional): create a unique index.

## Examples

```hcl
index "users_email_key" { table = "users" columns = ["email"] unique = true }

index "posts_title_trgm" {
  table = "posts"
  method = "gin"
  expressions = ["title gin_trgm_ops"]
}

index "active_users_idx" {
  table = "users"
  columns = ["role"]
  where = "role <> 'suspended'"
}
```