graphql-engine/docs/graphql/manual/hasura-cli/hasura_metadata_export.rst
nizar-m f83a8e591f rename access-key to admin-secret (close #1347) (#1540)
Rename the admin secret key header used to access GraphQL engine from X-Hasura-Access-Key to X-Hasura-Admin-Secret.

Server CLI and console all support the older flag but marks it as deprecated.
2019-02-14 15:07:47 +05:30

53 lines
1.2 KiB
ReStructuredText

.. _hasura_metadata_export:
Hasura CLI: hasura metadata export
----------------------------------
Export Hasura GraphQL Engine metadata from the database
Synopsis
~~~~~~~~
Export Hasura metadata and save it in migrations/metadata.yaml file.
The output is a yaml file which captures all the metadata required
by GraphQL Engine. This includes info about tables that are tracked,
permission rules, relationships and event triggers that are defined
on those tables.
::
hasura metadata export [flags]
Examples
~~~~~~~~
::
# Export metadata and save it in migrations/metadata.yaml file:
hasura metadata export
Options
~~~~~~~
::
--admin-secret string admin secret key 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)
SEE ALSO
~~~~~~~~
* :ref:`hasura metadata <hasura_metadata>` - Manage Hasura GraphQL Engine metadata saved in the database
*Auto generated by spf13/cobra*