This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new deec63bb5b docs(contributing): how to nuke the docker-compose postgres
(#31186)
deec63bb5b is described below
commit deec63bb5bb462c8d29ce7d85e0c2628c7ce3309
Author: Maxime Beauchemin <[email protected]>
AuthorDate: Mon Dec 2 11:50:49 2024 -0800
docs(contributing): how to nuke the docker-compose postgres (#31186)
---
docs/docs/contributing/development.mdx | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/docs/docs/contributing/development.mdx
b/docs/docs/contributing/development.mdx
index 19c68c4f9d..b9b05fb890 100644
--- a/docs/docs/contributing/development.mdx
+++ b/docs/docs/contributing/development.mdx
@@ -70,6 +70,24 @@ documentation.
configured to be secure.
:::
+### Nuking the postgres database
+
+At times, it's possible to end up with your development database in a bad
state, it's
+common while switching branches that contain migrations for instance, where
the database
+version stamp that `alembic` manages is no longer available after switching
branch.
+
+In that case, the easy solution is to nuke the postgres db and start fresh.
Note that the full
+state of the database will be gone after doing this, so be cautious.
+
+```bash
+# first stop docker-compose if it's running
+docker-compose down
+# delete the volume containing the database
+docker volume rm superset_db_home
+# restart docker-compose, which will init a fresh database and load examples
+docker-compose up
+```
+
## Installing Development Tools
:::note
