Skip to content

Docs: update “Delete Flow and its Data” — pgflow.delete_flow_and_data available since v0.11.0 #608

@devRokas

Description

@devRokas

Problem

The docs page “Delete Flow and its Data” currently reads like pgflow.delete_flow_and_data(flow_slug TEXT) requires manual installation / special setup.

However, this function was introduced in pgflow v0.11.0 and can be used directly.

This is confusing because:

  • Users may think they need to copy/paste custom SQL to get the function.
  • The docs don’t mention which pgflow version includes it.
  • The “Manual Installation Required” messaging may now be inaccurate.

Proposed changes

  1. Add a version note

    • Explicitly state: pgflow.delete_flow_and_data is available since pgflow v0.11.0.
  2. Clarify availability

    • Make it clear it’s a built-in helper for pgflow >= 0.11.0 (dev-only, destructive).
  3. Fix/adjust “Manual Installation Required”

    • If the function ships with pgflow migrations (>= 0.11.0), remove the manual-install aside.
    • If manual install still applies in some cases, make it conditional and explain exactly when.
  4. Add a small “Requirements” snippet

    • Example:
-- Requires pgflow >= 0.11.0
SELECT pgflow.delete_flow_and_data('analyzeWebsite');

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions