mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-18 21:12:09 +03:00
fd6535b861
* option to reload remote schemas in 'reload_metadata' API, fix #3792, #4117 * add tests * update changelog * update docs api reference for 'reload_metadata' * send reload_remote_schemas: true with the reload_metadata query * add reload remote schemas checkbox; minor refactor * Add a Note about cache invalidation and inconsistent metadata objects * Small pluralization agreement tweak in docs * Remove duplicated line in CHANGELOG * no-op refactor Suggested by Alexis @lexi-lambda * Update server/src-lib/Hasura/RQL/DDL/RemoteSchema.hs As suggested by @lexi-lambda Co-Authored-By: Alexis King <lexi.lambda@gmail.com> * fix tests * requested changes * comment 'replaceMetadataToOrdJson' unit tests Co-authored-by: Rishichandra Wawhal <rishi@hasura.io> Co-authored-by: Alexis King <lexi.lambda@gmail.com> Co-authored-by: Tirumarai Selvan <tiru@hasura.io>
196 lines
4.2 KiB
ReStructuredText
196 lines
4.2 KiB
ReStructuredText
.. meta::
|
|
:description: Manage metadata with the Hasura schema/metadata API
|
|
:keywords: hasura, docs, schema/metadata API, API reference, metadata
|
|
|
|
.. _api_manage_metadata:
|
|
|
|
Schema/Metadata API Reference: Manage metadata
|
|
==============================================
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
APIs to manage Hasura metadata which is stored in ``hdb_catalog`` schema.
|
|
|
|
.. _export_metadata:
|
|
|
|
export_metadata
|
|
---------------
|
|
|
|
``export_metadata`` is used to export the current metadata from the server as a JSON
|
|
file. The response JSON will be the metadata object.
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "export_metadata",
|
|
"args": {}
|
|
}
|
|
|
|
.. _replace_metadata:
|
|
|
|
replace_metadata
|
|
----------------
|
|
|
|
``replace_metadata`` is used to replace/import metadata into Hasura. Existing
|
|
metadata will be replaced with the new one.
|
|
|
|
.. code-block:: none
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "replace_metadata",
|
|
"args": <metadata-as-json-object>
|
|
}
|
|
|
|
.. _replace_metadata_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
Args should be the JSON object which is same as the output of
|
|
:ref:`export_metadata`.
|
|
|
|
.. _reload_metadata:
|
|
|
|
reload_metadata
|
|
---------------
|
|
|
|
``reload_metadata`` should be used when there is a change in underlying Postgres
|
|
database that Hasura should be aware of. Example: a new column is added to a
|
|
table using ``psql`` and this column should now be added to the GraphQL schema.
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "reload_metadata",
|
|
"args": {
|
|
"reload_remote_schemas": true
|
|
}
|
|
}
|
|
|
|
.. _reload_metadata_args_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - reload_remote_schemas
|
|
- false
|
|
- Boolean
|
|
- If set to ``true``, all remote schemas' (including inconsistent ones) cached GraphQL schemas are refreshed (default: ``false``)
|
|
|
|
.. _clear_metadata:
|
|
|
|
clear_metadata
|
|
--------------
|
|
|
|
``clear_metadata`` can be used to reset the state of Hasura -- clean the current
|
|
state by forgetting the tables tracked, relationships, permissions, event
|
|
triggers etc.
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "clear_metadata",
|
|
"args": {}
|
|
}
|
|
|
|
.. _get_inconsistent_metadata:
|
|
|
|
get_inconsistent_metadata
|
|
-------------------------
|
|
|
|
``get_inconsistent_metadata`` can be used to fetch all inconsistent metadata objects.
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type": "get_inconsistent_metadata",
|
|
"args": {}
|
|
}
|
|
|
|
Response:-
|
|
|
|
.. code-block:: json
|
|
|
|
[
|
|
{
|
|
"definition": {
|
|
"using": {
|
|
"foreign_key_constraint_on": {
|
|
"column": "author_id",
|
|
"table": "article"
|
|
}
|
|
},
|
|
"name": "articles",
|
|
"comment": null,
|
|
"table": "author"
|
|
},
|
|
"reason": "table \"article\" does not exist",
|
|
"type": "array_relation"
|
|
},
|
|
{
|
|
"definition": {
|
|
"using": {
|
|
"foreign_key_constraint_on": "author_id"
|
|
},
|
|
"name": "author",
|
|
"comment": null,
|
|
"table": "article"
|
|
},
|
|
"reason": "table \"article\" does not exist",
|
|
"type": "object_relation"
|
|
},
|
|
{
|
|
"definition": "article",
|
|
"reason": "no such table/view exists in postgres : \"article\"",
|
|
"type": "table"
|
|
}
|
|
]
|
|
|
|
.. _drop_inconsistent_metadata:
|
|
|
|
drop_inconsistent_metadata
|
|
--------------------------
|
|
|
|
``drop_inconsistent_metadata`` can be used to purge all inconsistent objects from the metadata.
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type": "drop_inconsistent_metadata",
|
|
"args": {}
|
|
}
|