Skip to main content
Version: v2.x

Hasura CLI: hasura metadata export

Export Hasura GraphQL Engine Metadata from the database.


Export Hasura Metadata and save it in the /metadata directory. The output is a collection of yaml files which captures all the Metadata required by the GraphQL Engine. This includes info about tables that are tracked, permission rules, relationships, and event triggers that are defined on those tables.

Further reading:

hasura metadata export [flags]


# Export metadata and save it in migrations/metadata.yaml file:
hasura metadata export

# Use with admin secret:
hasura metadata export --admin-secret "<admin-secret>"

# Export metadata from another instance specified by the flag:
hasura metadata export --endpoint "<endpoint>"


-h, --help            help for export
-o, --output string write metadata to standard output in given format for exported metadata (note: this won't modify project metadata) Allowed values: json, yaml")

Options inherited from parent commands

--admin-secret string            admin secret for Hasura GraphQL Engine (env "HASURA_GRAPHQL_ADMIN_SECRET")
--certificate-authority string path to a cert file for the certificate authority (env "HASURA_GRAPHQL_CERTIFICATE_AUTHORITY")
--endpoint string http(s) endpoint for Hasura GraphQL Engine (env "HASURA_GRAPHQL_ENDPOINT")
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false) (env "HASURA_GRAPHQL_INSECURE_SKIP_TLS_VERIFY")
--log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
--no-color do not colorize output (default: false)
--project string directory where commands are executed (default: current dir)
--skip-update-check skip automatic update check on command execution


  • hasura metadata - Manage Hasura GraphQL Engine Metadata saved in the database

Auto generated by spf13/cobra