DB: Added tool to dump DB schema and Hasura metadata for version control

Author: heythisischris

.gitignore

@@ -1,4 +1,6 @@
 node_modules
 dist
 .ds_store
-.vscode
+.vscode
+.env
+.env.*

db/dump.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+set -e
+
+# Export DB schema and Hasura metadata
+# Usage: ./dump.sh staging    or    ./dump.sh production
+
+SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
+ENV="${1:-staging}"
+
+# Load environment-specific .env file
+ENV_FILE="$SCRIPT_DIR/.env.$ENV"
+if [ -f "$ENV_FILE" ]; then
+    set -a
+    source "$ENV_FILE"
+    set +a
+else
+    echo "Error: $ENV_FILE not found"
+    echo "Usage: ./dump.sh [staging|production]"
+    exit 1
+fi
+
+# Validate required env vars
+for var in DB_HOST DB_USER DB_NAME DB_PASSWORD; do
+    if [ -z "${!var}" ]; then
+        echo "Error: $var is not set in $ENV_FILE"
+        exit 1
+    fi
+done
+
+# Determine Hasura endpoint
+if [ "$ENV" = "staging" ]; then
+    HASURA_ENDPOINT="https://graphql-staging.equalifyapp.com"
+else
+    HASURA_ENDPOINT="https://graphql.equalifyapp.com"
+fi
+
+# Add Homebrew PostgreSQL to PATH if needed
+if ! command -v pg_dump &> /dev/null; then
+    PG_PATH=$(find /opt/homebrew/Cellar/postgresql* -name "pg_dump" 2>/dev/null | head -1)
+    if [ -n "$PG_PATH" ]; then
+        export PATH="$(dirname "$PG_PATH"):$PATH"
+    else
+        echo "Error: pg_dump not found. Install with: brew install postgresql"
+        exit 1
+    fi
+fi
+
+OUT_DIR="$SCRIPT_DIR/$ENV"
+mkdir -p "$OUT_DIR"
+
+echo "Dumping $ENV..."
+
+# Export DB schema (no data)
+echo "Dumping database schema..."
+PGPASSWORD="$DB_PASSWORD" pg_dump \
+    --schema-only \
+    --no-owner \
+    --no-privileges \
+    -h "$DB_HOST" \
+    -U "$DB_USER" \
+    "$DB_NAME" > "$OUT_DIR/schema.sql"
+echo "  -> db/$ENV/schema.sql"
+
+# Export Hasura metadata
+echo "Exporting Hasura metadata..."
+curl -s -X POST "$HASURA_ENDPOINT/v1/metadata" \
+    -H "X-Hasura-Admin-Secret: $DB_PASSWORD" \
+    -H "Content-Type: application/json" \
+    -d '{"type":"export_metadata","version":2,"args":{}}' > "$OUT_DIR/hasura-metadata.json"
+echo "  -> db/$ENV/hasura-metadata.json"
+
+echo "Done!"

db/hasura-metadata.json

@@ -0,0 +1 @@
+{"resource_version":175,"metadata":{"version":3,"sources":[{"name":"default","kind":"postgres","tables":[{"table":{"name":"audits","schema":"public"},"object_relationships":[{"name":"user","using":{"manual_configuration":{"column_mapping":{"user_id":"id"},"insertion_order":null,"remote_table":{"name":"users","schema":"public"}}}}],"array_relationships":[{"name":"ignored_blockers","using":{"manual_configuration":{"column_mapping":{"id":"audit_id"},"insertion_order":null,"remote_table":{"name":"ignored_blockers","schema":"public"}}}},{"name":"scans","using":{"manual_configuration":{"column_mapping":{"id":"audit_id"},"insertion_order":null,"remote_table":{"name":"scans","schema":"public"}}}},{"name":"urls","using":{"manual_configuration":{"column_mapping":{"id":"audit_id"},"insertion_order":null,"remote_table":{"name":"urls","schema":"public"}}}}],"select_permissions":[{"role":"anonymous","permission":{"columns":["created_at","email_notifications","id","interval","name","payload","processed_at","remote_csv_error","remote_csv_url","response","scheduled_at","status","updated_at","user_id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["created_at","email_notifications","id","interval","name","payload","processed_at","remote_csv_error","remote_csv_url","response","scheduled_at","status","updated_at","user_id"],"filter":{},"allow_aggregations":true},"comment":""}],"update_permissions":[{"role":"user","permission":{"columns":["email_notifications","interval","remote_csv_error","remote_csv_url"],"filter":{},"check":null},"comment":""}]},{"table":{"name":"blocker_messages","schema":"public"},"object_relationships":[{"name":"blocker","using":{"manual_configuration":{"column_mapping":{"blocker_id":"id"},"insertion_order":null,"remote_table":{"name":"blockers","schema":"public"}}}},{"name":"message","using":{"manual_configuration":{"column_mapping":{"message_id":"id"},"insertion_order":null,"remote_table":{"name":"messages","schema":"public"}}}}],"select_permissions":[{"role":"anonymous","permission":{"columns":["created_at","updated_at","blocker_id","id","message_id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["created_at","updated_at","blocker_id","message_id","id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"blockers","schema":"public"},"object_relationships":[{"name":"ignored_blocker","using":{"manual_configuration":{"column_mapping":{"id":"blocker_id"},"insertion_order":null,"remote_table":{"name":"ignored_blockers","schema":"public"}}}},{"name":"url","using":{"manual_configuration":{"column_mapping":{"url_id":"id"},"insertion_order":null,"remote_table":{"name":"urls","schema":"public"}}}}],"array_relationships":[{"name":"blocker_messages","using":{"manual_configuration":{"column_mapping":{"id":"blocker_id"},"insertion_order":null,"remote_table":{"name":"blocker_messages","schema":"public"}}}}],"select_permissions":[{"role":"user","permission":{"columns":["audit_id","content","content_hash_id","content_normalized","created_at","equalified","id","scan_id","short_id","targets","updated_at","url_id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"ignored_blockers","schema":"public"},"object_relationships":[{"name":"blocker","using":{"manual_configuration":{"column_mapping":{"blocker_id":"id"},"insertion_order":null,"remote_table":{"name":"blockers","schema":"public"}}}}],"insert_permissions":[{"role":"user","permission":{"check":{},"columns":["created_at","updated_at","audit_id","blocker_id","id"]},"comment":""}],"select_permissions":[{"role":"anonymous","permission":{"columns":["created_at","updated_at","audit_id","blocker_id","id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["created_at","updated_at","audit_id","blocker_id","id"],"filter":{},"allow_aggregations":true},"comment":""}],"delete_permissions":[{"role":"user","permission":{"filter":{}},"comment":""}]},{"table":{"name":"invites","schema":"public"},"insert_permissions":[{"role":"user","permission":{"check":{},"set":{"user_id":"x-hasura-user-id"},"columns":["email","name","type","created_at","expires_on","updated_at","id","user_id"]},"comment":""}],"select_permissions":[{"role":"user","permission":{"columns":["email","name","type","created_at","expires_on","updated_at","id","user_id"],"filter":{},"allow_aggregations":true},"comment":""}],"delete_permissions":[{"role":"user","permission":{"filter":{}},"comment":""}]},{"table":{"name":"logs","schema":"public"},"object_relationships":[{"name":"LogToAudit","using":{"manual_configuration":{"column_mapping":{"audit_id":"id"},"insertion_order":null,"remote_table":{"name":"audits","schema":"public"}}}},{"name":"LogToUser","using":{"manual_configuration":{"column_mapping":{"user_id":"id"},"insertion_order":null,"remote_table":{"name":"users","schema":"public"}}}}],"insert_permissions":[{"role":"user","permission":{"check":{"user_id":{"_eq":"X-Hasura-User-Id"}},"set":{"user_id":"x-hasura-user-id"},"columns":["data","message","created_at","updated_at","audit_id","id","user_id"]},"comment":""}],"select_permissions":[{"role":"user","permission":{"columns":["data","message","created_at","updated_at","audit_id","id","user_id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"message_tags","schema":"public"},"object_relationships":[{"name":"tag","using":{"manual_configuration":{"column_mapping":{"tag_id":"id"},"insertion_order":null,"remote_table":{"name":"tags","schema":"public"}}}}],"select_permissions":[{"role":"anonymous","permission":{"columns":["created_at","updated_at","id","message_id","tag_id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["created_at","updated_at","tag_id","message_id","id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"messages","schema":"public"},"array_relationships":[{"name":"message_tags","using":{"manual_configuration":{"column_mapping":{"id":"message_id"},"insertion_order":null,"remote_table":{"name":"message_tags","schema":"public"}}}}],"select_permissions":[{"role":"anonymous","permission":{"columns":["category","content","id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["content","category","id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"scans","schema":"public"},"array_relationships":[{"name":"blockers","using":{"manual_configuration":{"column_mapping":{"id":"scan_id"},"insertion_order":null,"remote_table":{"name":"blockers","schema":"public"}}}}],"select_permissions":[{"role":"anonymous","permission":{"columns":["errors","pages","processed_pages","percentage","status","created_at","updated_at","audit_id","id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["errors","pages","processed_pages","percentage","status","created_at","updated_at","audit_id","id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"tags","schema":"public"},"select_permissions":[{"role":"anonymous","permission":{"columns":["content","id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["content","id"],"filter":{},"allow_aggregations":true},"comment":""}]},{"table":{"name":"urls","schema":"public"},"insert_permissions":[{"role":"user","permission":{"check":{"user_id":{"_eq":"X-Hasura-User-Id"}},"set":{"user_id":"x-hasura-user-id"},"columns":["audit_ids","type","url","created_at","updated_at","audit_id","id","user_id"]},"comment":""}],"select_permissions":[{"role":"anonymous","permission":{"columns":["audit_ids","type","url","created_at","updated_at","audit_id","id","user_id"],"filter":{},"allow_aggregations":true},"comment":""},{"role":"user","permission":{"columns":["audit_ids","type","url","created_at","updated_at","audit_id","id","user_id"],"filter":{},"allow_aggregations":true},"comment":""}],"update_permissions":[{"role":"user","permission":{"columns":["type"],"filter":{},"check":null},"comment":""}],"delete_permissions":[{"role":"user","permission":{"filter":{}},"comment":""}]},{"table":{"name":"users","schema":"public"},"select_permissions":[{"role":"user","permission":{"columns":["analytics","email","name","type","created_at","updated_at","apikey","id"],"filter":{},"allow_aggregations":true},"comment":""}],"update_permissions":[{"role":"user","permission":{"columns":["analytics","email","name","type","created_at","updated_at","apikey","id"],"filter":{},"check":{}},"comment":""}],"delete_permissions":[{"role":"user","permission":{"filter":{}},"comment":""}]}],"configuration":{"connection_info":{"database_url":{"from_env":"HASURA_GRAPHQL_DATABASE_URL"},"isolation_level":"read-committed","pool_settings":{"connection_lifetime":600,"idle_timeout":180,"max_connections":50,"retries":1},"use_prepared_statements":true}}}]}}

db/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "equalify-db",
+  "private": true,
+  "scripts": {
+    "dump:staging": "./dump.sh staging",
+    "dump:production": "./dump.sh production"
+  }
+}