Skip to content

Commit

Permalink
docs: add transfer documentation and update navigation in mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kremilly committed Dec 6, 2024
1 parent ed1a792 commit 9d801aa
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 1 deletion.
1 change: 0 additions & 1 deletion docs/import.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ dumpsync import -f /path/to/dump.sql
### Command Breakdown

- **dumpsync**: This is the main command to invoke the DumpSync tool.

- **import**: This subcommand initiates the import process to restore the database from the specified dump file.

### Options
Expand Down
30 changes: 30 additions & 0 deletions docs/transfer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# DumpSync Command: Transfer

To transfer a database from one server to another, you can use the following command:

```bash
dumpsync import -f /path/to/dump.sql
```

### Command Breakdown

- **dumpsync**: This is the main command to invoke the DumpSync tool.
- **transfer**: This subcommand initiates the transfer process to restore the database from the specified dump file.

### Options

- **-f /path/to/dump.sql**: Specifies the path to the dump file that you want to restore. Replace `/path/to/dump.sql` with the actual file path to your SQL dump file.

### Example

To transfer a database from a dump file located at `/backups/example_dump.sql`, you would run:

```bash
dumpsync transfer -f /backups/example_dump.sql
```

### Notes

- Ensure that the dump file exists and that you have the necessary permissions to read it.
- The transfer process will overwrite existing data in the database, so be cautious when using this command, especially if restoring to a production environment.
- It’s recommended to back up current data before performing an import to avoid accidental data loss.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ nav:
- Settings: settings.md
- Export: export.md
- Import: import.md
- Transfer: transfer.md

markdown_extensions:
- tables
Expand Down

0 comments on commit 9d801aa

Please sign in to comment.