Skip to content

docs(website): drop manual-install instructions for delete_flow_and_data #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jumski merged 1 commit into from
Sep 4, 2026
+4 −17
Merged

docs(website): drop manual-install instructions for delete_flow_and_data #668

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions pkgs/website/src/content/docs/build/delete-flows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@ next:
label: Operate
---

import { Aside, Code, CardGrid, LinkCard } from "@astrojs/starlight/components";
import deleteFlowFunctionCode from '@/../../core/supabase/tests/_shared/delete_flow_and_data.sql.raw?raw';
import { Aside, CardGrid, LinkCard } from "@astrojs/starlight/components";

During development, you may want to completely remove a flow and all its data to make breaking changes, clean up test data, or start fresh after experimenting. This operation is destructive and should **only be used in development environments**.

Expand All @@ -25,7 +24,9 @@ This permanently deletes all flow data including:

## Using the Delete Function

The delete function accepts a flow slug parameter and removes all associated data:
`pgflow.delete_flow_and_data` is a built-in helper installed automatically by pgflow migrations. It is available since pgflow v0.10.0, so there is no manual SQL setup.

The function accepts a flow slug parameter and removes all associated data:

```sql
pgflow.delete_flow_and_data(flow_slug TEXT)
Expand All @@ -39,20 +40,6 @@ SELECT pgflow.delete_flow_and_data('analyzeWebsite');

This deletes the flow definition, all runs, queued messages, and task outputs for the specified flow.

## Installing the Function

<Aside type="caution" title="Manual Installation Required">
This function is not included in default pgflow migrations to prevent accidental deployment to production. It has been thoroughly unit tested, but you must manually add it to your development database using the SQL in the [Delete Function](#the-delete-function) section below.
</Aside>

Install by running the SQL directly in your database using `psql` or Supabase Studio.

## The Delete Function

Run this SQL to install the delete function:

<Code lang="sql" code={deleteFlowFunctionCode} />

## After Deleting

Once you've deleted the flow:
Expand Down
Loading