graphql-engine/docs/graphql/core/actions/logs-clean-up.rst
hasura-bot c3712067e8 docs: add a guide on how to clean up action logs (close #4935)
GITHUB_PR_NUMBER: 6229
GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/6229

Co-authored-by: Funmilayo E. Olaiya <35759534+codeliezel@users.noreply.github.com>
Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com>
GitOrigin-RevId: 54e6a3569481671610ea93c6ced6a6b42924c022
2021-02-02 08:06:10 +00:00

58 lines
1.7 KiB
ReStructuredText

.. meta::
:description: Clean up async action logs
:keywords: hasura, docs, action, clean up, async actions
.. _action_logs_clean_up:
Cleaning up async action logs
=============================
.. contents:: Table of contents
:backlinks: none
:depth: 1
:local:
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.
You can use any of the following options to prune your logs depending on your need.
.. admonition:: Warning
- Deleting logs is irreversible, so be careful with these actions.
- Deleting logs while subscriptions for the response might still be open may result into the loss of data and ``null`` values been returned.
The table involved
------------------
There is a specific table for action logs that is managed by Hasura:
- ``hdb_catalog.hdb_action_log``: This table stores all captured action logs.
Option 1: Delete log of a particular action invocation
------------------------------------------------------
.. code-block:: SQL
DELETE FROM hdb_catalog.hdb_action_log WHERE id = '<async-action-id>';
Option 2: Delete all logs of a specific action
----------------------------------------------
.. code-block:: SQL
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
-------------------------
.. code-block:: SQL
DELETE FROM hdb_catalog.hdb_action_log;