hasura/graphql-engine

Blazing fast, instant realtime GraphQL APIs on all your data with fine grained access control, also trigger webhooks on database events.

Structural Verdict

How Data Flows Through the System

GraphQL queries flow through the engine's parser, validator, and executor, with metadata controlling schema generation and permissions, while CLI tools manage database migrations and deployments

1. Schema Introspection — Engine reads database schema and generates GraphQL types (config: services.postgres.environment.POSTGRES_DB)
2. Query Processing — Incoming GraphQL queries are parsed, validated, and planned for execution
3. Permission Enforcement — Role-based access control filters queries based on metadata configuration
4. Database Execution — Optimized SQL queries are executed against connected databases (config: services.postgres.ports)
5. Response Assembly — Results are formatted as GraphQL responses with real-time subscription support

System Behavior

How the system actually operates at runtime — where data accumulates, what loops, what waits, and what controls what.

Data Pools

Feedback Loops

• Migration Retry Loop (retry, balancing) — Trigger: Failed migration operation. Action: Retry with exponential backoff. Exit: Success or max retries reached.
• Schema Refresh Loop (polling, balancing) — Trigger: Database schema changes. Action: Reload GraphQL schema from database introspection. Exit: Schema stabilizes.
• Configuration Validation (circuit-breaker, balancing) — Trigger: Invalid configuration detected. Action: Reject requests until config is fixed. Exit: Valid configuration provided.

Delays & Async Processing

• Migration Execution Window (async-processing, ~variable) — Database unavailable during schema changes
• Console Asset Loading (cache-ttl, ~browser-dependent) — Initial console load time
• Data Connector Response (async-processing, ~database-dependent) — Query response time varies by connector performance

Control Points

• Migration Mode (env-var) — Controls: Whether migrations run automatically or require manual approval. Default: migration_mode setting
• Console Mode (env-var) — Controls: OSS, Pro, or Cloud console features and endpoints. Default: consoleMode
• Telemetry Toggle (env-var) — Controls: Whether usage analytics are collected. Default: enableTelemetry
• Database Connection (env-var) — Controls: PostgreSQL connection parameters and credentials. Default: POSTGRES_DB=hasura

Technology Stack

Key Components

• migrate.Migrate (service) — Handles database migration operations through HTTP API endpoints cli/migrate/api/migrate.go
• projectmetadata.Handler (service) — Manages metadata import/export operations for GraphQL schema definitions cli/migrate/api/metadata.go
• Config (config) — Defines configuration schema for SQLite data connector with database path and table filtering dc-agents/sqlite/src/config.ts
• StaticData (model) — Loads and processes XML data files with corresponding JSON schemas for reference implementation dc-agents/reference/src/data/index.ts
• RequestTransformState (utility) — Manages transformation configurations for HTTP requests and responses in webhooks frontend/libs/console/legacy-ce/src/lib/components/Common/ConfigureTransformation/utils.ts
• Globals (config) — Central configuration object containing environment-specific settings for console modes frontend/libs/console/legacy-ce/src/lib/Globals.ts
• Expression (type-def) — Union type defining all possible GraphQL query expression types for filtering dc-agents/dc-api-types/src/models/Expression.ts
• cli-ext command handler (cli-command) — Routes CLI extension commands to appropriate service handlers for SDL and Actions codegen cli-ext/src/command.ts
• BaseEditor (component) — React wrapper around Ace Editor with Hasura-specific configuration and theming frontend/libs/console/legacy-ce/src/lib/components/Common/AceEditor/BaseEditor.tsx
• endpoints (config) — Centralizes all API endpoint URLs for GraphQL, metadata, migrations, and external services frontend/libs/console/legacy-ce/src/lib/Endpoints.ts

Sub-Modules

Configuration

docker-compose.yaml (yaml)

• name (string, unknown) — default: hge-manual-tests
• services.postgres.extends.file (string, unknown) — default: docker-compose/databases.yaml
• services.postgres.extends.service (string, unknown) — default: postgres
• services.postgres.ports (array, unknown) — default: 65002:5432
• services.postgres.environment.POSTGRES_USER (string, unknown) — default: hasura
• services.postgres.environment.POSTGRES_PASSWORD (string, unknown) — default: hasura
• services.postgres.environment.POSTGRES_DB (string, unknown) — default: hasura
• services.postgres.volumes (array, unknown) — default: postgres-data:/var/lib/postgresql,./docker-compose/postgres/init.sh:/docker-entrypoint-initdb.d/init-hasura.sh:ro
• +25 more parameters

sample.hie.yaml (yaml)

• cradle.cabal (array, unknown) — default: [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

contrib/metadata-types/generated/HasuraMetadataV2.py (python-dataclass)

• name (str, unknown)
• value (str, unknown)

contrib/metadata-types/generated/HasuraMetadataV2.py (python-dataclass)

• name (str, unknown)
• value_from_env (str, unknown)

Related Fullstack Repositories

Frequently Asked Questions

Analyzed on March 31, 2026 by CodeSea. Written by Karolina Sarna.