graphql-engine/docs/graphql/manual/hasura-cli/hasura_metadata_export.rst

54 lines
1.3 KiB
ReStructuredText
Raw Normal View History

.. _hasura_metadata_export:
Hasura CLI: hasura metadata export
----------------------------------
Export Hasura GraphQL Engine metadata from the database
Synopsis
~~~~~~~~
2018-12-07 15:08:39 +03:00
Export Hasura metadata and save it in migrations/metadata.yaml file.
The output is a yaml file which captures all the metadata required
2018-12-07 15:08:39 +03:00
by GraphQL Engine. This includes info about tables that are tracked,
permission rules, relationships and event triggers that are defined
2018-12-07 15:08:39 +03:00
on those tables.
::
hasura metadata export [flags]
Examples
~~~~~~~~
::
2018-12-07 15:08:39 +03:00
# Export metadata and save it in migrations/metadata.yaml file:
hasura metadata export
Options
~~~~~~~
::
--admin-secret string admin secret for Hasura GraphQL Engine
--endpoint string http(s) endpoint for Hasura GraphQL Engine
-h, --help help for export
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
--project string directory where commands are executed (default: current dir)
--skip-update-check Skip automatic update check on command execution
SEE ALSO
~~~~~~~~
2018-12-07 15:08:39 +03:00
* :ref:`hasura metadata <hasura_metadata>` - Manage Hasura GraphQL Engine metadata saved in the database
*Auto generated by spf13/cobra*