Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pferreirafabricio/backup-mongo-db
🗳️ A simple PowerShell script to make a backup of a MongoDB database and create a scheduled task for it on Windows
https://github.com/pferreirafabricio/backup-mongo-db
database database-script gzip mongodb mongodb-database mongodump powershell powershell-script system-schedule windows zip
Last synced: 4 days ago
JSON representation
🗳️ A simple PowerShell script to make a backup of a MongoDB database and create a scheduled task for it on Windows
- Host: GitHub
- URL: https://github.com/pferreirafabricio/backup-mongo-db
- Owner: pferreirafabricio
- License: mit
- Created: 2020-12-02T21:13:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-13T19:06:38.000Z (10 months ago)
- Last Synced: 2024-05-28T14:08:22.684Z (6 months ago)
- Topics: database, database-script, gzip, mongodb, mongodb-database, mongodump, powershell, powershell-script, system-schedule, windows, zip
- Language: PowerShell
- Homepage:
- Size: 288 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :ballot_box: Dump MongoDB Database
It's a simple script made with PowerShell to create a backup of a MongoDB database and save all collections in a `.zip` folder or `.gz` file.
## :arrows_clockwise: Creating a simple backup flow
__1.__ Verify the version of MongoDB, running:
```powershell
mongod --version
```
__2.__ If the version of your MongoDB is 4.4 or above, you will need to install de _mongodump, mongorestore_, and other tools separately. For this, follow this guide: [Installing the Database Tools on Windows](https://docs.mongodb.com/database-tools/installation/installation-windows/)
> [!NOTE]
> "Starting with MongoDB 4.4, the MongoDB Database Tools are now released separately from the MongoDB Server..."
__3.__ After the installation or if your version already has the database tools (like in version 4.2), run the following commands to guarantee that the tools are accessible by the command line:
```powershell
mongodump --help
```
```powershell
mongorestore --help
```
> [!NOTE]
> If they are not accessible, follow this guide: [Make the DB Tools available in your PATH](https://docs.mongodb.com/database-tools/installation/installation-windows/#make-the-db-tools-available-in-your-path)
__4.__ After all the process of installation/verification we will create the flow properly
__4.1__ Edit the [backupMongoDatabase.ps1](./backupMongoDatabase.ps1) script, modifying the variables:
```powershell
$databaseName = "databaseName"
$mongoDbHost = "localhost:27017"
$backupPath = "C:\Path\To\Back\Folder"
```
> [!NOTE]
> If the database requires authorization remember to use the command with __-u__ and __-p__ flags
__4.2.__ Edit the [createSystemScheduledTask.ps1](./createSystemScheduledTask.ps1) script, modifying the variable with the path of the [backupMongoDatabase](./backupMongoDatabase.ps1) script and the time that the task will run
```powershell
$scriptToExecutePath = "C:\Path\To\backupMongoDatabase.ps1"
$trigger = New-ScheduledTaskTrigger -Daily -At 1am
```
> [!NOTE]
> Change the 'databaseName' in the name and description too, for more control of which database that task will back up
__4.3.__ Finally, open the PowerShell as admin (for precaution) and enter in the folder that the ___createSystemScheduledTask.ps1___ is
```powershell
cd "C:\Path\To\WhereScriptIs"
```
__4.4.__ And execute it
```powershell
./createSystemScheduledTask.ps1
```
__4.5.__ The following output will be shown
__5.__ :white_check_mark: Success! We created a basic backup task. You can check the task in _Task Scheduler_ too:
The task:
__6.__ Test if the task is running correctly executing it manually:
```powershell
Start-ScheduledTask -TaskName 'MongoDB Backup - '
```
### :recycle: Need to restore a database using the backup?
Take a look at this discussion at _DBA Stack Exchange_: [How restore a specific database from backup using mongorestore command
](https://dba.stackexchange.com/questions/113017/how-restore-a-specific-database-from-backup-using-mongorestore-command)
## :page_with_curl: References
- [New-ScheduledTaskTrigger](https://docs.microsoft.com/en-us/powershell/module/scheduledtasks/new-scheduledtasktrigger?view=win10-ps)
- [Powershell scripts for MSSQL or MongoDB backup to Azure & AWS](https://piotrgankiewicz.com/2016/05/03/powershell-scripts-for-mssql-or-mongodb-backup-to-azure-aws/)
- [Installing the Database Tools](https://docs.mongodb.com/database-tools/installation/installation/)
- [How to find the exact version of installed MongoDB](https://stackoverflow.com/questions/38160412/how-to-find-the-exact-version-of-installed-mongodb#:~:text=To%20check%20mongodb%20version%20use%20the%20mongod%20command%20with%20%2D%2Dversion%20option.)
- [Add 'powershell' code fences where appropriate](https://github.com/MicrosoftDocs/PowerShell-Docs/issues/1511)
- [How restore a specific database from backup using mongorestore command](https://dba.stackexchange.com/questions/113017/how-restore-a-specific-database-from-backup-using-mongorestore-command)