Deprecated. nself hasura has moved to nself db hasura.

# Old (deprecated — removed in v1.0.0)
nself hasura console
nself hasura metadata apply

# New
nself db hasura console
nself db hasura metadata apply

Version: v0.9.9 Status: Deprecated — use nself db hasura

Hasura GraphQL management commands for metadata operations and console access. These commands are now part of nself db hasura since Hasura management is database-adjacent (metadata tracks schema, permissions, and relationships). This page is kept for reference — see DB.md for the current documentation.

nself db hasura <subcommand> [options]

For metadata apply, metadata export, and console commands with CLI features:

# Install globally
npm install -g hasura-cli

# Verify installation
hasura version

Note: The metadata reload command uses curl and doesn't require Hasura CLI.

Apply local metadata to Hasura instance.

nself db hasura metadata apply

Requirements:

• Hasura CLI installed
• HASURA_GRAPHQL_ADMIN_SECRET set in environment
• Metadata files in hasura/metadata/ directory

What it does:

1. Reads HASURA_GRAPHQL_ADMIN_SECRET from environment
2. Determines Hasura endpoint from config
3. Auto-generates hasura/config.yaml if missing (see Config File Auto-Generation below)
4. Applies metadata from local directory using --project and --endpoint flags

Example:

nself db hasura metadata apply

Export metadata from Hasura instance to local files.

nself db hasura metadata export

Requirements:

• Hasura CLI installed
• HASURA_GRAPHQL_ADMIN_SECRET set in environment

What it does:

1. Connects to Hasura instance
2. Exports all metadata (tables, relationships, permissions, etc.)
3. Saves to hasura/metadata/ directory

Example:

nself db hasura metadata export

Reload Hasura metadata cache without restarting.

nself db hasura metadata reload

Requirements:

• HASURA_GRAPHQL_ADMIN_SECRET set in environment
• Hasura service running

What it does:

1. Sends API request to Hasura
2. Triggers metadata cache reload
3. No service restart required

Example:

nself db hasura metadata reload

Use cases:

• After database schema changes
• After modifying tracked tables
• To refresh stale metadata cache

Open Hasura Console in browser.

nself db hasura console

With Hasura CLI:

• Opens Hasura CLI console (with migration tracking)
• Automatically authenticates with admin secret
• Changes are tracked in metadata files

Without Hasura CLI:

• Prints URL to web console
• Manual navigation required

Examples:

# Open console
nself db hasura console

# Or access directly at
# http://localhost:8080/console

The Hasura CLI v2 requires a config.yaml file even when --endpoint and --admin-secret are passed as flags. It uses config.yaml to locate the metadata_directory.

nself db hasura metadata apply, metadata export, and console all call ensure_hasura_config before running any Hasura CLI command. This function:

1. Checks for HASURA_PROJECT_DIR env var, then falls back to looking for hasura/ in the current directory
2. Creates hasura/config.yaml if the directory exists but the file is missing
3. Never overwrites an existing config.yaml

The generated file sets metadata_directory: metadata and the Hasura endpoint. The admin secret is intentionally NOT written to the file — it is passed as --admin-secret on the CLI invocation so no secret lands on disk.

If your hasura directory is not at hasura/ relative to where you run nself commands, set HASURA_PROJECT_DIR=<path> in your .env.

nself build also runs this step, so after a build the file will always be present before you run any hasura commands.

The command automatically reads:

HASURA_PORT=8080
HASURA_GRAPHQL_ADMIN_SECRET=your-secret-key-here
HASURA_GRAPHQL_ENDPOINT=http://localhost:8080

# 1. Make changes in Hasura Console
nself db hasura console

# 2. Export metadata after changes
nself db hasura metadata export

# 3. Commit metadata to git
git add hasura/metadata/
git commit -m "Add users table and permissions"

# 4. Apply to another environment
nself db hasura metadata apply

# After running database migration
nself db migrate

# Reload Hasura metadata
nself db hasura metadata reload

# Export current state
nself db hasura metadata export

# Clear and reapply
nself db hasura metadata apply

hasura/
└── metadata/
    ├── actions.graphql
    ├── actions.yaml
    ├── allow_list.yaml
    ├── cron_triggers.yaml
    ├── databases/
    │   └── default/
    │       └── tables/
    │           ├── public_users.yaml
    │           └── public_posts.yaml
    ├── query_collections.yaml
    ├── remote_schemas.yaml
    └── version.yaml

• Metadata commands read from cascading environment files
• Admin secret is required for all operations
• Console access requires Hasura service to be running
• Metadata files should be version controlled
• Always test metadata changes in staging first

# Error: HASURA_GRAPHQL_ADMIN_SECRET not set

# Solution: Set in environment
echo "HASURA_GRAPHQL_ADMIN_SECRET=your-secret" >> .env
nself restart hasura

# Error: Hasura CLI not found

# Solution: Install CLI
npm install -g hasura-cli

# Or access console directly
nself urls | grep hasura
# Open console URL in browser

# Check Hasura is running
nself status hasura

# Check endpoint
nself config env | grep HASURA

# Restart service
nself restart hasura

# Export current metadata first
nself db hasura metadata export

# Check for conflicts
diff -r hasura/metadata/ /path/to/backup/

# Apply with verbose output
hasura metadata apply --endpoint http://localhost:8080 --admin-secret $HASURA_GRAPHQL_ADMIN_SECRET

• db - Database operations
• status - Service status
• logs - View logs
• urls - Service URLs

Documentation: https://hasura.io/docs/latest/graphql/core/migrations/index.html
Category: Core Services