diff --git a/README.md b/README.md index 61cf6b50..cc64ef01 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,10 @@ $ docker cp /path/to/your/backup.json container_name:/path/inside/container/back $ docker-compose -f local.yml run --rm django python manage.py loaddata /path/inside/the/container/backup.json $ docker-compose -f local.yml run --rm django python manage.py migrate ``` +### Restoring the Database from a SQL Dump +If the JSON file is particularly large (>1.5GB), Docker might struggle with this method. In such cases, you can use SQL dump and restore commands as an alternative, as described [here](./SQLDumpRestoration.md). + + ## Additional Commands @@ -191,8 +195,7 @@ Documented [here](https://github.com/NASA-IMPACT/sde-indexing-helper/wiki/How-to ## Adding New Features/Fixes -1. Start with a [GitHub issue](https://github.com/NASA-IMPACT/sde-indexing-helper/issues). -2. Use the GitHub CLI to create branches and pull requests (`gh issue develop -c `). +We welcome contributions to improve the project! Before you begin, please take a moment to review our [Contributing Guidelines](./CONTRIBUTING.md). These guidelines will help you understand the process for submitting new features, bug fixes, and other improvements. ## Job Creation diff --git a/SQLDumpRestoration.md b/SQLDumpRestoration.md index 49e78994..6b4792be 100644 --- a/SQLDumpRestoration.md +++ b/SQLDumpRestoration.md @@ -29,10 +29,14 @@ $ docker exec -it 23d33f22cc43 bash 3. Create a connection to the database. ``` -psql -U VnUvMKBSdkoFIETgLongnxYHrYVJKufn -d sde_indexing_helper +psql -U -d ``` -4. Ensure that the database `sde_indexing_helper` is empty. +**Note**: +- For local deployment, refer to the `.envs/.local/.postgres` file for the `POSTGRES_USER` and `POSTGRES_DB` variables. +- For production deployment, refer to the `.envs/.production/.postgres` file. + +4. Ensure that the database `` is empty. Here's an example: ``` sde_indexing_helper-# \c @@ -44,8 +48,8 @@ Did not find any relations. If the database is not empty, delete its contents to create a fresh database: ``` -sde_indexing_helper=# \c postgres -You are now connected to database "postgres" as user "VnUvMKBSdkoFIETgLongnxYHrYVJKufn". +sde_indexing_helper=# \c postgres //connect to a different database before dropping +You are now connected to database "postgres" as user "VnUvMKBSdk....". postgres=# DROP DATABASE sde_indexing_helper; DROP DATABASE postgres=# CREATE DATABASE sde_indexing_helper; @@ -62,13 +66,13 @@ docker cp /local/path/backup.sql 23d33f22cc43:/ 6. Import the SQL dump into the PostgreSQL container. ``` -psql -U VnUvMKBSdkoFIETgLongnxYHrYVJKufn -d sde_indexing_helper -f backup.sql +psql -U -d -f backup.sql ``` **Note**: To create a SQL dump of your PostgreSQL database, use the following command: ``` -pg_dump -U VnUvMKBSdkoFIETgLongnxYHrYVJKufn -W -F p -f backup.sql sde_indexing_helper +pg_dump -U -W -F p -f backup.sql ``` 7. Bring up all containers at once, and create a superuser account for logging in.