Skip to content

Commit

Permalink
Add "reset" to title of uninstall page and expand content (#503)
Browse files Browse the repository at this point in the history
  • Loading branch information
benjie authored Nov 8, 2024
2 parents 0ec5c7e + eff895f commit 3e6b870
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion website/docs/uninstall.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Uninstall"
title: "Uninstall/Reset"
sidebar_position: 1000
---

Expand All @@ -9,3 +9,27 @@ statement:
```sql
DROP SCHEMA graphile_worker CASCADE;
```

(If you are using an alternative schema for Graphile Worker, please update the
command accordingly.)

:::danger This may also drop some of your database functions/constraints!

Any functionality in your database that depends on Graphile Worker (according to
PostgreSQL's tracking of dependencies - see
[pg_depend](https://www.postgresql.org/docs/current/catalog-pg-depend.html) in
the PostgreSQL docs) may also be dropped by the `CASCADE`; this includes
database functions (including trigger functions), and foreign key constraints.

It's recommended to try this on a non-production environment first to see its
effects, and to do a schema-only dump of your database before and after to
compare the changes and look for unexpected consequences.

:::

:::warning Scale to zero first!

Before running this command, you should make sure there are no running Graphile
Worker instances.

:::

0 comments on commit 3e6b870

Please sign in to comment.