mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 20:41:49 +03:00
269 lines
5.0 KiB
ReStructuredText
269 lines
5.0 KiB
ReStructuredText
Schema/Metadata API Reference: Query collections
|
|
================================================
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
Group queries using Query collections.
|
|
|
|
Create/Drop query collections and Add/Drop a query to a collection using following query types.
|
|
|
|
.. _create_query_collection:
|
|
|
|
create_query_collection
|
|
-----------------------
|
|
|
|
``create_query_collection`` is used to define a collection.
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "create_query_collection",
|
|
"args": {
|
|
"name": "my_collection",
|
|
"comment": "an optional comment",
|
|
"definition": {
|
|
"queries": [
|
|
{"name": "query_1", "query": "query { test {id name}}"}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
|
|
.. _create_query_collection_syntax:
|
|
|
|
Args Syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - name
|
|
- true
|
|
- :ref:`CollectionName`
|
|
- Name of the query collection
|
|
* - definition
|
|
- true
|
|
- :ref:`CollectionQuery` array
|
|
- List of queries
|
|
* - comment
|
|
- false
|
|
- text
|
|
- Optional comment
|
|
|
|
|
|
.. _drop_query_collection:
|
|
|
|
drop_query_collection
|
|
---------------------
|
|
|
|
``drop_query_collection`` is used to drop a collection
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "drop_query_collection",
|
|
"args": {
|
|
"collection": "my_collection",
|
|
"cascade": false
|
|
}
|
|
}
|
|
|
|
.. _drop_query_collection_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - collection
|
|
- true
|
|
- :ref:`CollectionName`
|
|
- Name of the query collection
|
|
* - cascade
|
|
- true
|
|
- boolean
|
|
- When set to ``true``, the collection (if present) is removed from allowlist
|
|
|
|
.. _add_query_to_collection:
|
|
|
|
add_query_to_collection
|
|
-----------------------
|
|
|
|
``add_query_to_collection`` is used to add a query to given collection
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "add_query_to_collection",
|
|
"args": {
|
|
"collection_name": "my_collection",
|
|
"query_name": "query_2",
|
|
"query": "query {test {name}}"
|
|
}
|
|
}
|
|
|
|
.. _add_query_to_collection_syntax:
|
|
|
|
Args Syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - collection_name
|
|
- true
|
|
- :ref:`CollectionName`
|
|
- Name of the query collection
|
|
* - query_name
|
|
- true
|
|
- :ref:`QueryName`
|
|
- Name of the query
|
|
* - query
|
|
- true
|
|
- text
|
|
- The GraphQL query text
|
|
|
|
.. _drop_query_from_collection:
|
|
|
|
drop_query_from_collection
|
|
--------------------------
|
|
|
|
``drop_query_from_collection`` is used to remove a query from given collection
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "drop_query_from_collection",
|
|
"args": {
|
|
"collection_name": "my_collection",
|
|
"query_name": "query_2"
|
|
}
|
|
}
|
|
|
|
.. _drop_query_from_collection_syntax:
|
|
|
|
Args Syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - collection_name
|
|
- true
|
|
- :ref:`CollectionName`
|
|
- Name of the query collection
|
|
* - query_name
|
|
- true
|
|
- :ref:`QueryName`
|
|
- Name of the query
|
|
|
|
.. _add_collection_to_allowlist:
|
|
|
|
add_collection_to_allowlist
|
|
----------------------------
|
|
|
|
``add_collection_to_allowlist`` is used to add a collection to allow-list
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "add_collection_to_allowlist",
|
|
"args": {
|
|
"collection": "my_collection"
|
|
}
|
|
}
|
|
|
|
.. _add_collection_to_allowlist_syntax:
|
|
|
|
Args Syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - collection
|
|
- true
|
|
- :ref:`CollectionName`
|
|
- Name of a query collection to be added to the allow-list
|
|
|
|
.. _drop_collection_from_allowlist:
|
|
|
|
drop_collection_from_allowlist
|
|
-------------------------------
|
|
|
|
``drop_collection_from_allowlist`` is used to remove a collection from allow-list
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type" : "drop_collection_from_allowlist",
|
|
"args": {
|
|
"collection": "my_collection_1"
|
|
}
|
|
}
|
|
|
|
.. _drop_collection_from_allowlist_syntax:
|
|
|
|
Args Syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - collection
|
|
- true
|
|
- :ref:`CollectionName`
|
|
- Name of a query collection to be removed from the allow-list
|