mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 04:24:35 +03:00
972caf65f3
GITHUB_PR_NUMBER: 8186 GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/8186 PR-URL: https://github.com/hasura/graphql-engine-mono/pull/3684 Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com> GitOrigin-RevId: 6d08a9c76c008c62f70a2285afcfdde141ae68c3
151 lines
3.8 KiB
ReStructuredText
151 lines
3.8 KiB
ReStructuredText
.. meta::
|
|
:description: Manage computed fields with the Hasura schema/metadata API
|
|
:keywords: hasura, docs, schema/metadata API, API reference, computed field
|
|
|
|
.. _schema_metadata_api_computed_field:
|
|
|
|
Schema/Metadata API Reference: Computed Fields (Deprecated)
|
|
===========================================================
|
|
|
|
.. admonition:: Deprecation
|
|
|
|
In versions ``v2.0.0`` and above, the schema/metadata API is deprecated in favour of the :ref:`schema API <schema_apis>` and the
|
|
:ref:`metadata API <metadata_apis>`.
|
|
|
|
Though for backwards compatibility, the schema/metadata APIs will continue to function.
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
Introduction
|
|
------------
|
|
|
|
**computed field** is an extra field added to a table, its value is
|
|
computed via an SQL function which has the table row type as an input argument.
|
|
Currenty, the Hasura GraphQL engine supports functions returning
|
|
`base types <https://www.postgresql.org/docs/current/extend-type-system.html#id-1.8.3.5.9>`__ or
|
|
`table row types <https://www.postgresql.org/docs/current/rowtypes.html#ROWTYPES-DECLARING>`__
|
|
as computed fields.
|
|
|
|
.. _schema_metadata_add_computed_field:
|
|
|
|
add_computed_field
|
|
------------------
|
|
|
|
``add_computed_field`` is used to define a computed field in a table.
|
|
There cannot be an existing column or relationship or computed field with
|
|
the same name.
|
|
|
|
Create a ``computed field`` called ``full_name`` on an ``author`` *table*, using
|
|
an SQL function called ``author_full_name``:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type":"add_computed_field",
|
|
"args":{
|
|
"table":{
|
|
"name":"author",
|
|
"schema":"public"
|
|
},
|
|
"name":"full_name",
|
|
"definition":{
|
|
"function":{
|
|
"name":"author_full_name",
|
|
"schema":"public"
|
|
},
|
|
"table_argument":"author_row"
|
|
}
|
|
}
|
|
}
|
|
|
|
.. _schema_metadata_add_computed_field_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - table
|
|
- true
|
|
- :ref:`TableName <TableName>`
|
|
- Name of the table
|
|
* - name
|
|
- true
|
|
- :ref:`ComputedFieldName <ComputedFieldName>`
|
|
- Name of the new computed field
|
|
* - definition
|
|
- true
|
|
- :ref:`ComputedFieldDefinition`
|
|
- The computed field definition
|
|
* - comment
|
|
- false
|
|
- text
|
|
- comment
|
|
|
|
.. _schema_metadata_drop_computed_field:
|
|
|
|
drop_computed_field
|
|
-------------------
|
|
|
|
``drop_computed_field`` is used to drop a computed field of a table. If
|
|
there are other objects dependent on this computed field, like permissions, the request will fail and report the
|
|
dependencies unless ``cascade`` is set to ``true``. If ``cascade`` is set to ``true``, the dependent objects
|
|
are also dropped.
|
|
|
|
Drop a computed field ``full_name`` from a table ``author``:
|
|
|
|
.. code-block:: http
|
|
|
|
POST /v1/query HTTP/1.1
|
|
Content-Type: application/json
|
|
X-Hasura-Role: admin
|
|
|
|
{
|
|
"type":"drop_computed_field",
|
|
"args":{
|
|
"table":{
|
|
"name":"author",
|
|
"schema":"public"
|
|
},
|
|
"name":"full_name",
|
|
"cascade": false
|
|
}
|
|
}
|
|
|
|
.. _schema_metadata_drop_computed_field_syntax:
|
|
|
|
Args syntax
|
|
^^^^^^^^^^^
|
|
|
|
.. list-table::
|
|
:header-rows: 1
|
|
|
|
* - Key
|
|
- Required
|
|
- Schema
|
|
- Description
|
|
* - table
|
|
- true
|
|
- :ref:`TableName <TableName>`
|
|
- Name of the table
|
|
* - name
|
|
- true
|
|
- :ref:`ComputedFieldName <ComputedFieldName>`
|
|
- Name of the computed field
|
|
* - cascade
|
|
- false
|
|
- Boolean
|
|
- When set to ``true``, all the dependent items (if any) on this computed fields are also dropped
|