graphql-engine/server/src-rsr/catalog_metadata.sql
Vamshi Surabhi b84db36ebb
allow custom mutations through actions (#3042)
* basic doc for actions

* custom_types, sync and async actions

* switch to graphql-parser-hs on github

* update docs

* metadata import/export

* webhook calls are now supported

* relationships in sync actions

* initialise.sql is now in sync with the migration file

* fix metadata tests

* allow specifying arguments of actions

* fix blacklist check on check_build_worthiness job

* track custom_types and actions related tables

* handlers are now triggered on async actions

* default to pgjson unless a field is involved in relationships, for generating definition list

* use 'true' for action filter for non admin role

* fix create_action_permission sql query

* drop permissions when dropping an action

* add a hdb_role view (and relationships) to fetch all roles in the system

* rename 'webhook' key in action definition to 'handler'

* allow templating actions wehook URLs with env vars

* add 'update_action' /v1/query type

* allow forwarding client headers by setting `forward_client_headers` in action definition

* add 'headers' configuration in action definition

* handle webhook error response based on status codes

* support array relationships for custom types

* implement single row mutation, see https://github.com/hasura/graphql-engine/issues/3731

* single row mutation: rename 'pk_columns' -> 'columns' and no-op refactor

* use top level primary key inputs for delete_by_pk & account select permissions for single row mutations

* use only REST semantics to resolve the webhook response

* use 'pk_columns' instead of 'columns' for update_by_pk input

* add python basic tests for single row mutations

* add action context (name) in webhook payload

* Async action response is accessible for non admin roles only if
  the request session vars equals to action's

* clean nulls, empty arrays for actions, custom types in export metadata

* async action mutation returns only the UUID of the action

* unit tests for URL template parser

* Basic sync actions python tests

* fix output in async query & add async tests

* add admin secret header in async actions python test

* document async action architecture in Resolve/Action.hs file

* support actions returning array of objects

* tests for list type response actions

* update docs with actions and custom types metadata API reference

* update actions python tests as per #f8e1330

Co-authored-by: Tirumarai Selvan <tirumarai.selvan@gmail.com>
Co-authored-by: Aravind Shankar <face11301@gmail.com>
Co-authored-by: Rakesh Emmadi <12475069+rakeshkky@users.noreply.github.com>
2020-02-13 23:08:23 +05:30

209 lines
5.6 KiB
SQL

select
json_build_object(
'tables', tables.items :: json,
'relations', relations.items,
'permissions', permissions.items,
'event_triggers', event_triggers.items,
'remote_schemas', remote_schemas.items,
'functions', functions.items,
'allowlist_collections', allowlist.item,
'computed_fields', computed_field.items,
'custom_types', coalesce((select custom_types from hdb_catalog.hdb_custom_types), '{}'),
'actions', actions.items
)
from
(
select
coalesce(jsonb_agg(
jsonb_build_object(
'name', jsonb_build_object(
'name', ht.table_name,
'schema', ht.table_schema
),
'is_enum', ht.is_enum,
'is_system_defined', ht.is_system_defined,
'configuration', ht.configuration,
'info', t.info
)
), '[]') as items
from hdb_catalog.hdb_table ht
left join hdb_catalog.hdb_table_info_agg t using (table_schema, table_name)
) as tables,
(
select
coalesce(
json_agg(
json_build_object(
'table',
json_build_object(
'schema', table_schema,
'name', table_name
),
'rel_name', rel_name,
'rel_type', rel_type,
'def', rel_def :: json,
'comment', comment
)
),
'[]'
) as items
from
hdb_catalog.hdb_relationship
) as relations,
(
select
coalesce(
json_agg(
json_build_object(
'table',
json_build_object(
'schema', table_schema,
'name', table_name
),
'role', role_name,
'perm_type', perm_type,
'def', perm_def :: json,
'comment', comment
)
),
'[]'
) as items
from
hdb_catalog.hdb_permission
) as permissions,
(
select
coalesce(
json_agg(
json_build_object(
'table',
json_build_object(
'schema', schema_name,
'name', table_name
),
'name', name,
'def', configuration :: json
)
),
'[]'
) as items
from
hdb_catalog.event_triggers
) as event_triggers,
(
select
coalesce(
json_agg(
json_build_object(
'name',
name,
'definition', definition :: json,
'comment', comment
)
),
'[]'
) as items
from
hdb_catalog.remote_schemas
) as remote_schemas,
(
select
coalesce(json_agg(q.info), '[]') as items
from
(
select
json_build_object(
'function',
json_build_object(
'schema', hf.function_schema,
'name', hf.function_name
),
'configuration', hf.configuration,
'is_system_defined', hf.is_system_defined,
'info', hf_agg.function_info
) as info
from
hdb_catalog.hdb_function hf
left join lateral
(
select coalesce(json_agg(function_info), '[]') as function_info
from hdb_catalog.hdb_function_info_agg
where function_name = hf.function_name
and function_schema = hf.function_schema
) hf_agg on 'true'
) as q
) as functions,
(
select
coalesce(json_agg(hqc.collection_defn), '[]') as item
from hdb_catalog.hdb_allowlist ha
left outer join
hdb_catalog.hdb_query_collection hqc
on (hqc.collection_name = ha.collection_name)
) as allowlist,
(
select
coalesce(json_agg(
json_build_object('computed_field', cc.computed_field,
'function_info', fi.function_info
)
), '[]') as items
from
(
select json_build_object(
'table', jsonb_build_object('name', hcc.table_name,'schema', hcc.table_schema),
'name', hcc.computed_field_name,
'definition', hcc.definition,
'comment', hcc.comment
) as computed_field,
hccf.function_name,
hccf.function_schema
from hdb_catalog.hdb_computed_field hcc
left outer join
hdb_catalog.hdb_computed_field_function hccf
on ( hcc.table_name = hccf.table_name
and hcc.table_schema = hccf.table_schema
and hcc.computed_field_name = hccf.computed_field_name
)
) cc
left join lateral
(
select coalesce(json_agg(function_info), '[]') as function_info
from hdb_catalog.hdb_function_info_agg
where function_name = cc.function_name and function_schema = cc.function_schema
) fi on 'true'
) as computed_field,
(
select
coalesce(
json_agg(
json_build_object(
'name', ha.action_name,
'definition', ha.action_defn :: json,
'comment', ha.comment,
'permissions', p.items
)
),
'[]'
) as items
from
hdb_catalog.hdb_action ha
left join lateral
(
select
coalesce(
json_agg(
json_build_object(
'action', hap.action_name,
'role', hap.role_name,
'comment', hap.comment
)
),
'[]'
) as items
from
hdb_catalog.hdb_action_permission hap
where hap.action_name = ha.action_name
) p on 'true'
) as actions