mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-14 08:02:15 +03:00
docs: move metadata api deprecation notes + update changelog + nitpicks
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
This commit is contained in:
parent
c655fadc35
commit
972caf65f3
12
CHANGELOG.md
12
CHANGELOG.md
@ -33,18 +33,18 @@ The optimization can be enabled using the
|
||||
- server: (Postgres, Citus, and MSSQL backends) Identity columns and computed
|
||||
columns are now marked immutable, removing them from the schema of insert and
|
||||
update mutations.
|
||||
- server: Fix graphql-engine/issues/4633: We can now insert multiple objects
|
||||
- server: allow inserting more than 1 row simultaneously into table with generated columns (fix #4633)
|
||||
that have generated columns in Postgres.
|
||||
- server: postgres: return a single entry per row (selected randomly) when an object relationship is misconfigured one-to-many
|
||||
- server: Updates Kriti to v0.3.0
|
||||
- server: add operation name in the request sent to remote schemas
|
||||
- server: add support for scalar response types for actions (issue #7805)
|
||||
- server: fix nullable action response (issue #4405)
|
||||
- server: add support for customization of table & computed field GraphQL schema descriptions (#7496)
|
||||
- server: add support for scalar response types for actions (fix #7805)
|
||||
- server: fix nullable action response (fix #4405)
|
||||
- server: add support for customization of table & computed field GraphQL schema descriptions (fix #7496)
|
||||
- server: classify MSSQL exceptions and improve API error responses
|
||||
- console: add support for remote database relationships
|
||||
- console: enable support for update permissions for mssql #3591
|
||||
- cli: skip tls verfication for all API requests when `insecure-skip-tls-verify` flag is set (#4926)
|
||||
- console: enable support for update permissions for mssql
|
||||
- cli: skip tls verfication for all API requests when `insecure-skip-tls-verify` flag is set (fix #4926)
|
||||
|
||||
## v2.2.0
|
||||
|
||||
|
@ -20,18 +20,18 @@ You can edit the email address on your Hasura Cloud account to another email fro
|
||||
Changing email for users logged in using email
|
||||
----------------------------------------------
|
||||
|
||||
`Sign in <https://cloud.hasura.io/login?redirect_url=/>`__ to your Hasura Cloud account using email and click **My Account**.
|
||||
On the **Account Settings** page, select the **Edit** button.
|
||||
`Sign in <https://cloud.hasura.io/login?redirect_url=/>`__ to your Hasura Cloud account using email and click ``My Account``.
|
||||
On the ``Account Settings`` page, select the ``Edit`` button.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/account-settings/account-settings-tab.png
|
||||
:alt: Account Management
|
||||
:width: 750px
|
||||
:width: 1100px
|
||||
|
||||
Enter the email you want to transfer the account to and click the ``Change`` button to send a transfer request.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/account-settings/edit-email-input.png
|
||||
:alt: edit email section
|
||||
:width: 700px
|
||||
:width: 800px
|
||||
|
||||
The invitee receives an email verification mail. Once the invitee clicks the link, it logs out the existing user and redirects the invitee to the Hasura Cloud login page.
|
||||
|
||||
@ -41,15 +41,15 @@ Changing email for users with social logins
|
||||
-------------------------------------------
|
||||
|
||||
If you logged in to Hasura Cloud with your social login, you must reset your password to initiate the email change process.
|
||||
On the `_Sign in <https://cloud.hasura.io/login?redirect_url=/>`__ page, select ``Forgot?``.
|
||||
On the `Sign in <https://cloud.hasura.io/login?redirect_url=/>`__ page, select ``Forgot?``.
|
||||
|
||||
.. thumbnail:: /img/graphql/cloud/account-settings/forgot-password.png
|
||||
:alt: Forgot password
|
||||
:width: 350px
|
||||
:width: 450px
|
||||
|
||||
Next, enter the new email id and click **Recover Password**.
|
||||
Next, enter the new email id and click ``Recover Password``.
|
||||
Set a new password by clicking on the reset password link sent to your email address.
|
||||
|
||||
You can now log in with the email and this new password and follow the steps mentioned above in the :ref:`change email <email_change>` section.
|
||||
You can now log in with the email and this new password and follow the steps mentioned in the :ref:`above section <email_change>` to change the email.
|
||||
|
||||
You can also use the social login associated with the new email to log in to Hasura Cloud!
|
||||
|
@ -21,4 +21,4 @@ On your Hasura Cloud ``My Account`` page, you can manage account-related setting
|
||||
:maxdepth: 1
|
||||
:titlesonly:
|
||||
|
||||
email-change
|
||||
Change email <email-change>
|
@ -77,16 +77,16 @@ realtime monitoring, caching, tracing, and rate-limiting. It supports both new a
|
||||
Getting Started <getting-started/index>
|
||||
projects/index
|
||||
metrics/index
|
||||
API Security <security/index>
|
||||
API security <security/index>
|
||||
regression-tests
|
||||
read-replicas
|
||||
response-caching
|
||||
tracing
|
||||
query-tags
|
||||
Preview Apps <preview-apps>
|
||||
Preview apps <preview-apps>
|
||||
dedicated-vpc
|
||||
Billing <billing/index>
|
||||
Account Management <account-management/index>
|
||||
Account management <account-management/index>
|
||||
hasurapro-cli/index
|
||||
api-reference
|
||||
glossary
|
||||
|
@ -52,16 +52,16 @@ Dig deeper
|
||||
:titlesonly:
|
||||
|
||||
Creating projects <create>
|
||||
Project Details <details>
|
||||
Project Collaborators <collaborators>
|
||||
Transfer Ownership <ownership>
|
||||
Project details <details>
|
||||
Project collaborators <collaborators>
|
||||
Transfer ownership <ownership>
|
||||
Project Env vars <env-vars>
|
||||
Project Domains <domains>
|
||||
Securing projects <secure>
|
||||
Switching pricing plans <pricing>
|
||||
Deployment regions <regions>
|
||||
Managing development environments <environments>
|
||||
GitHub Deployment <github-integration>
|
||||
GitHub deployment <github-integration>
|
||||
Heroku database URL Sync <heroku-url-sync>
|
||||
Vercel Integration <vercel-integration>
|
||||
Maintenance mode <maintenance-mode>
|
||||
|
@ -30,5 +30,3 @@ Features
|
||||
allow-lists
|
||||
api-limits
|
||||
disable-graphql-introspection
|
||||
rotating-admin-secrets
|
||||
multiple-jwt-secrets
|
||||
|
@ -15,9 +15,10 @@ Cleaning up async action logs
|
||||
Introduction
|
||||
------------
|
||||
|
||||
Hasura stores action logs of :ref:`async actions <async_actions>` in a table in the metadata schema. As the table gets larger, you may want to prune it.
|
||||
Hasura stores action logs of :ref:`async actions <async_actions>` in a table in **the "hdb_catalog" schema of the Hasura metadata
|
||||
database**.
|
||||
|
||||
You can use any of the following options to prune your logs depending on your need.
|
||||
As the table gets larger, you may want to prune it. You can use any of the following options to prune your logs depending on your need.
|
||||
|
||||
.. admonition:: Warning
|
||||
|
||||
@ -44,18 +45,33 @@ Option 2: Delete all logs of a specific action
|
||||
|
||||
DELETE FROM hdb_catalog.hdb_action_log WHERE action_name = '<action-name>';
|
||||
|
||||
Option 3: Delete all logs older than a time period
|
||||
--------------------------------------------------
|
||||
.. code-block:: SQL
|
||||
|
||||
DELETE FROM hdb_catalog.hdb_action_log WHERE created_at < NOW() - INTERVAL '3 months';
|
||||
|
||||
Option 4: Delete all logs
|
||||
Option 3: Delete all logs
|
||||
-------------------------
|
||||
.. code-block:: SQL
|
||||
|
||||
DELETE FROM hdb_catalog.hdb_action_log;
|
||||
|
||||
Clearing data before a particular time period
|
||||
---------------------------------------------
|
||||
|
||||
If you wish to keep recent data and only clear data before a particular time period
|
||||
you can add the following time clause to your query's where clause:
|
||||
|
||||
.. code-block:: SQL
|
||||
|
||||
-- units can be 'minutes', 'hours', 'days', 'months', 'years'
|
||||
created_at < now() - interval '<x> <units>'
|
||||
|
||||
For example: to delete all logs older than 3 months:
|
||||
|
||||
.. code-block:: SQL
|
||||
|
||||
DELETE FROM hdb_catalog.hdb_action_log WHERE created_at < NOW() - INTERVAL '3 months';
|
||||
|
||||
See the `Postgres date/time functions <https://www.postgresql.org/docs/current/functions-datetime.html>`__
|
||||
for more details.
|
||||
|
||||
|
||||
.. admonition:: Additional Resources
|
||||
|
||||
Introduction to Hasura Actions - `View Recording <https://hasura.io/events/webinar/hasura-actions/?pg=docs&plcmt=body&cta=view-recording&tech=>`__.
|
@ -43,7 +43,9 @@ This is an object type called ``UserInfo`` that has two fields:
|
||||
* ``accessToken``: This field is of type ``String!`` (non-nullable ``String``)
|
||||
* ``userId``: This field is of type ``Int!`` (non-nullable ``Int``)
|
||||
|
||||
Hasura supports nested objects. For example, you can define a type like the following:
|
||||
From version ``v2.2.0`` onwards, Hasura GraphQL engine supports nested objects.
|
||||
|
||||
For example, you can define a type like the following:
|
||||
|
||||
.. code-block:: graphql
|
||||
|
||||
@ -59,7 +61,9 @@ Hasura supports nested objects. For example, you can define a type like the foll
|
||||
isAdmin: Boolean!
|
||||
}
|
||||
|
||||
Recursive nested objects are also supported. For example, you can use the following type:
|
||||
Recursive nested objects are also supported.
|
||||
|
||||
For example, you can use the following type:
|
||||
|
||||
.. code-block:: graphql
|
||||
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Actions (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
|
||||
@ -17,13 +24,6 @@ Introduction
|
||||
|
||||
**actions** are user defined mutations with custom business logic.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_action:
|
||||
|
||||
create_action
|
||||
|
@ -7,6 +7,13 @@
|
||||
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
|
||||
@ -22,13 +29,6 @@ Currenty, the Hasura GraphQL engine supports functions returning
|
||||
`table row types <https://www.postgresql.org/docs/current/rowtypes.html#ROWTYPES-DECLARING>`__
|
||||
as computed fields.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_add_computed_field:
|
||||
|
||||
add_computed_field
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Custom Functions (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
|
||||
@ -19,13 +26,6 @@ Track/untrack a custom SQL function in the Hasura GraphQL engine.
|
||||
|
||||
Only tracked custom functions are available for querying/mutating/subscribing data over the GraphQL API.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_track_function:
|
||||
|
||||
track_function
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Custom Types (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
|
||||
@ -17,13 +24,6 @@ Introduction
|
||||
|
||||
**Custom Types** are user-defined GraphQL types which help to define :ref:`Actions <schema_metadata_api_actions>`.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_set_custom_types:
|
||||
|
||||
set_custom_types
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Event Triggers (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
|
||||
@ -17,13 +24,6 @@ Introduction
|
||||
|
||||
Event triggers are used to capture database changes and send them to a configured webhook.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_event_trigger:
|
||||
|
||||
create_event_trigger
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema / Metadata API Reference (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
|
||||
@ -22,13 +29,6 @@ The schema / metadata API provides the following features:
|
||||
|
||||
This is primarily intended to be used as an ``admin`` API to manage the Hasura schema and metadata.
|
||||
|
||||
.. 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.
|
||||
|
||||
Endpoint
|
||||
--------
|
||||
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Manage metadata (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
|
||||
@ -17,13 +24,6 @@ Introduction
|
||||
|
||||
APIs to manage Hasura metadata which is stored in ``hdb_catalog`` schema.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_export_metadata:
|
||||
|
||||
export_metadata
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Permissions (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
|
||||
@ -26,13 +33,6 @@ role has unrestricted access to all operations.
|
||||
values can come with the request and can be validated using webhook or can be
|
||||
sent with the JWT token.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_insert_permission:
|
||||
|
||||
create_insert_permission
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Query collections (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
|
||||
@ -19,13 +26,6 @@ Group queries using query collections.
|
||||
|
||||
Create/drop query collections and add/drop a query to a collection using the following query types.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_query_collection:
|
||||
|
||||
create_query_collection
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Relationships (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
|
||||
@ -40,13 +47,6 @@ table has a primary key ``author_id`` which is a foreign key to the
|
||||
``author`` table's primary key ``id``. In this case there will be a single ``author``
|
||||
for every ``author_details`` and a single ``details`` for every ``author``
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_object_relationship:
|
||||
|
||||
create_object_relationship
|
||||
|
@ -5,6 +5,13 @@
|
||||
Schema/Metadata API Reference: Remote Relationships (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
|
||||
@ -15,13 +22,6 @@ Introduction
|
||||
|
||||
Remote Relationships allow you to join tables with remote schemas.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_remote_relationship:
|
||||
|
||||
create_remote_relationship
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Remote Schema Permissions (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
|
||||
@ -23,13 +30,6 @@ Remote schema permissions can be defined to:
|
||||
By default, the ``admin`` role has unrestricted access to
|
||||
the remote schema.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_add_remote_schema_permissions:
|
||||
|
||||
add_remote_schema_permissions
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Remote schemas (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
|
||||
@ -17,13 +24,6 @@ Introduction
|
||||
|
||||
Add/Remove a remote GraphQL server as remote schema in Hasura GraphQL engine.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_add_remote_schema:
|
||||
|
||||
add_remote_schema
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: RESTified GraphQL Endpoints (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
|
||||
@ -17,13 +24,6 @@ Introduction
|
||||
|
||||
Add/Remove a RESTified GraphQL endpoint to Hasura GraphQL engine.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_rest_endpoint:
|
||||
|
||||
create_rest_endpoint
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Run SQL (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: 2
|
||||
@ -33,13 +40,6 @@ returned.
|
||||
consider creating a view. You can now define permissions on that particular view
|
||||
for various roles.
|
||||
|
||||
.. 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.
|
||||
|
||||
Use cases
|
||||
^^^^^^^^^
|
||||
|
||||
|
@ -5,6 +5,13 @@
|
||||
Schema/Metadata API Reference: Scheduled Triggers (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
|
||||
@ -15,17 +22,6 @@ Introduction
|
||||
|
||||
Scheduled triggers are used to invoke webhooks based on a timestamp or cron.
|
||||
|
||||
.. admonition:: Supported from
|
||||
|
||||
Scheduled triggers are supported from versions ``v1.3.0`` and above.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_create_cron_trigger:
|
||||
|
||||
create_cron_trigger
|
||||
|
@ -7,6 +7,13 @@
|
||||
Schema/Metadata API Reference: Tables/Views (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
|
||||
@ -19,13 +26,6 @@ Track/untrack a table/view in Hasura GraphQL engine.
|
||||
|
||||
Only tracked tables/views are available for querying/mutating/subscribing data over the GraphQL API.
|
||||
|
||||
.. 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.
|
||||
|
||||
.. _schema_metadata_track_table:
|
||||
|
||||
track_table
|
||||
|
@ -60,12 +60,12 @@ that the target ``users_db`` database has a ``users`` table with the fields ``id
|
||||
"name": "ordered_by_user",
|
||||
"source": "orders_db",
|
||||
"table": "orders",
|
||||
"remote_source": {
|
||||
"to_source": {
|
||||
"relationship_type": "object",
|
||||
"field_mapping": {
|
||||
"ordered_by_user_id": "id"
|
||||
},
|
||||
"source": "users_db",
|
||||
"source": "target",
|
||||
"table": "users"
|
||||
}
|
||||
}
|
||||
|
@ -4,8 +4,9 @@
|
||||
|
||||
.. _clean_up_event_data:
|
||||
|
||||
Clean up event data
|
||||
===================
|
||||
Cleaning up event data
|
||||
======================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
:depth: 1
|
||||
@ -14,7 +15,7 @@ Clean up event data
|
||||
Introduction
|
||||
------------
|
||||
|
||||
Hasura stores event data associated with Event Triggers in **the `hdb_catalog` schema of the database containing the source table**.
|
||||
Hasura stores event data associated with Event Triggers in **the "hdb_catalog" schema of the database containing the source table**.
|
||||
|
||||
If there are lots of events, the metadata tables can get huge and you may want to prune them. You can use any of the following options to prune your event data depending on your need.
|
||||
|
||||
@ -72,6 +73,7 @@ Option 4: Clear all event data for a particular event trigger only
|
||||
|
||||
Option 5: Clear everything
|
||||
--------------------------
|
||||
|
||||
.. admonition:: Warning
|
||||
|
||||
This will clear all events including yet to be delivered events.
|
||||
|
@ -4,8 +4,8 @@
|
||||
|
||||
.. _clean_up_scheduled_triggers_data:
|
||||
|
||||
Clean up scheduled triggers data
|
||||
================================
|
||||
Cleaning up scheduled triggers data
|
||||
===================================
|
||||
|
||||
.. contents:: Table of contents
|
||||
:backlinks: none
|
||||
@ -15,7 +15,7 @@ Clean up scheduled triggers data
|
||||
Introduction
|
||||
------------
|
||||
|
||||
Hasura stores event data associated with scheduled triggers in **the `hdb_catalog` schema of the Hasura metadata
|
||||
Hasura stores event data associated with scheduled triggers in **the "hdb_catalog" schema of the Hasura metadata
|
||||
database**.
|
||||
|
||||
If there are lots of events, the events tables can get huge and you may want to prune them.
|
||||
|
Loading…
Reference in New Issue
Block a user