dbschema 0.1.4

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
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

set shell := ["bash", "-cu"]

# Format HCL files in place
fmt *paths:
  cargo run -- fmt {{paths}}

###############################################
# Run examples against local Postgres (Docker)
###############################################

# Start Docker Postgres via compose and wait for readiness
docker-up:
  #!/usr/bin/env bash
  set -euo pipefail
  echo "[dbschema] Starting Postgres (Docker Compose)..."
  docker compose up -d
  echo "[dbschema] Waiting for Postgres to become ready..."
  for i in $(seq 1 60); do
    if docker compose exec -T db pg_isready -U postgres -d postgres >/dev/null 2>&1; then
      echo "[dbschema] Postgres is ready."
      exit 0
    fi
    sleep 1
  done
  echo "[dbschema] Postgres did not become ready in time" >&2
  exit 1

# Run end-to-end for a single example: create DB, apply migration, run tests, drop DB
# Usage:
#   just example-test file=examples/table.hcl
#   just example-test file=examples/trigger.hcl dsn=postgres://...

example-test hcl='examples/table.hcl' dsn_prefix='postgres://postgres:postgres@localhost:5432':
  #!/usr/bin/env bash
  set -euo pipefail
  # Normalize parameter in case it was passed as `hcl=...`
  hcl_param="{{hcl}}"; hcl_file="${hcl_param#hcl=}"
  name=$(basename "$hcl_file" .hcl)
  db="dbschema_ex_${name}"
  # Normalize dsn_prefix in case it was passed incorrectly
  dsn_prefix_raw="{{dsn_prefix}}"; dsn_prefix_val="${dsn_prefix_raw#dsn_prefix=}"
  if [[ "$dsn_prefix_val" != postgres://* && "$dsn_prefix_val" != postgresql://* ]]; then
    dsn_prefix_val='postgres://postgres:postgres@localhost:5432'
  fi
  dsn="${dsn_prefix_val}/${db}"
  GREEN='\033[0;32m'; RED='\033[0;31m'; YELLOW='\033[0;33m'; BLUE='\033[0;34m'; NC='\033[0m'
  echo -e "${BLUE}⏳ Running example: ${name}${NC}"
  # Ensure Docker is up
  just docker-up
  if cargo run -q -- --input "$hcl_file" test --dsn "$dsn" --apply --create-db "$db"; then
    echo -e "${GREEN}✅ ${name} ok${NC}"
    rc=0
  else
    echo -e "${RED}❌ ${name} failed${NC}"
    rc=1
  fi
  exit $rc

# Run create-migration for all example HCL files
examples-create-migration:
  #!/usr/bin/env bash
  set -euo pipefail
  for example in examples/*.hcl; do
    name=$(basename "$example" .hcl)
    outdir="tmp_mig_${name}"
    rm -rf "$outdir"
    mkdir -p "$outdir"
    cargo run -- --input "$example" create-migration --out-dir "$outdir" --name "$name"
    rm -rf "$outdir"
  done

# Run tests for all example HCL files against local Postgres (Docker)
examples-test dsn_prefix='postgres://postgres:postgres@localhost:5432':
  #!/usr/bin/env bash
  set -euo pipefail
  just docker-up
  GREEN='\033[0;32m'; RED='\033[0;31m'; YELLOW='\033[0;33m'; BLUE='\033[0;34m'; NC='\033[0m'
  passed=0; failed=0
  for example in examples/*.hcl; do
    name=$(basename "$example" .hcl)
    db="dbschema_ex_${name}"
    dsn_prefix_raw="{{dsn_prefix}}"; dsn_prefix_val="${dsn_prefix_raw#dsn_prefix=}"
    if [[ "$dsn_prefix_val" != postgres://* && "$dsn_prefix_val" != postgresql://* ]]; then
      dsn_prefix_val='postgres://postgres:postgres@localhost:5432'
    fi
    dsn="${dsn_prefix_val}/${db}"
    echo -e "${BLUE}⏳ Running example: ${name}${NC}"
    if cargo run -q -- --input "$example" test --dsn "$dsn" --apply --create-db "$db"; then
      echo -e "${GREEN}✅ ${name} ok${NC}"; passed=$((passed+1))
    else
      echo -e "${RED}❌ ${name} failed (tests)${NC}"; failed=$((failed+1))
    fi
  done
  echo -e "${YELLOW}Summary: ${passed} passed, ${failed} failed${NC}"

# Validate all example HCL files
examples-validate:
  #!/usr/bin/env bash
  set -euo pipefail
  for example in examples/*.hcl; do
    cargo run -- --input "$example" validate
  done