{"id":14973980,"url":"https://github.com/codexshaper/database-backup-restore","last_synced_at":"2025-03-17T16:10:52.017Z","repository":{"id":56955848,"uuid":"230340818","full_name":"Codexshaper/database-backup-restore","owner":"Codexshaper","description":"Database Backup \u0026 Restore","archived":false,"fork":false,"pushed_at":"2024-11-06T18:10:27.000Z","size":307,"stargazers_count":17,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-02T13:11:20.630Z","etag":null,"topics":["backup","database-backup","dump","dumper","mongodb","mysql","pgsql","restore","sqlite3"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Codexshaper.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-26T23:25:56.000Z","updated_at":"2022-07-27T13:35:04.000Z","dependencies_parsed_at":"2025-01-06T12:31:49.908Z","dependency_job_id":"fe9a4d51-61ca-424c-a4f3-60cac7ba1db5","html_url":"https://github.com/Codexshaper/database-backup-restore","commit_stats":{"total_commits":67,"total_committers":2,"mean_commits":33.5,"dds":0.08955223880597019,"last_synced_commit":"9c0cb86d7ef000991f0441eaaacd369413bad11e"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codexshaper%2Fdatabase-backup-restore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codexshaper%2Fdatabase-backup-restore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codexshaper%2Fdatabase-backup-restore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Codexshaper%2Fdatabase-backup-restore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Codexshaper","download_url":"https://codeload.github.com/Codexshaper/database-backup-restore/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244066180,"owners_count":20392406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","database-backup","dump","dumper","mongodb","mysql","pgsql","restore","sqlite3"],"created_at":"2024-09-24T13:49:46.540Z","updated_at":"2025-03-17T16:10:51.998Z","avatar_url":"https://github.com/Codexshaper.png","language":"PHP","readme":"[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)\n[![Build Status](https://travis-ci.org/Codexshaper/database-backup-restore.svg?branch=master)](https://travis-ci.org/Codexshaper/database-backup-restore)\n[![Quality Score](https://img.shields.io/scrutinizer/g/Codexshaper/database-backup-restore.svg?style=flat-square)](https://scrutinizer-ci.com/g/Codexshaper/database-backup-restore)\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/Codexshaper/database-backup-restore.svg?style=flat-square)](https://packagist.org/packages/Codexshaper/database-backup-restore)\n\n# Description\nDatabase Backup \u0026amp; Restore\n\n[Documentation](https://codexshaper.github.io/docs/database-backup-restore/)\n\n## Authors\n\n* **Md Abu Ahsan Basir** - [github](https://github.com/maab16)\n\n# Installation\n```\ncomposer require codexshaper/database-backup-restore\n```\n\n### MySql Dump *(Note: Mustbe installed `mysqldump` in your system)*\n```\n$options    = [\n    'host'            =\u003e 'HOST',\n    'port'            =\u003e 'PORT',\n    'dbName'          =\u003e 'DATABASE_NAME',\n    'username'        =\u003e 'DATABASE_USERNAME',\n    'password'        =\u003e 'DATABASE_PASSWORD',\n    'destinationPath' =\u003e 'STORAGE_PATH_WITH_FILE_NAME', // /path/to/backups/mysql/dump\n];\n```\nUse constructor with options\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\MysqlDumper($options);\n$dumper-\u003edump();\n```\nUse create method\n```\n\\CodexShaper\\Dumper\\Drivers\\MysqlDumper::create($options)-\u003edump();\n```\n\nDynamically\n```\n\\CodexShaper\\Dumper\\Drivers\\MysqlDumper::create()\n  -\u003esetHost($host)\n  -\u003esetPort($port)\n  -\u003esetDbName($database)\n  -\u003esetUserName($username)\n  -\u003esetPassword($password)\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump();\n```\n\nArchive\n```\n\\CodexShaper\\Dumper\\Drivers\\MysqlDumper::create($options)\n  -\u003euseCompress(\"gzip\") // This command apply gzip to zip\n  -\u003edump();\n```\n\n### MySql Restore *(Note: Mustbe installed `mysql` in your system)*\n\nRestore from without archive\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\MysqlDumper($options);\n$dumper-\u003esetRestorePath($restorePath); // /path/to/backups/mysql/dump.sql \n$dumper-\u003erestore();\n```\n\nRestore from archive\n```\n\\CodexShaper\\Dumper\\Drivers\\MysqlDumper::create($options)\n  -\u003euseCompress(\"gunzip\") // this command unzip the file\n  -\u003esetRestorePath($restorePath) // /path/to/backups/mysql/dump.sql.gz\n  -\u003erestore();\n```\n\n### PgSql Dump *(Note: Mustbe installed `pg_dump` in your system)*\n```\n$options    = [\n    'host'            =\u003e 'HOST',\n    'port'            =\u003e 'PORT',\n    'dbName'          =\u003e 'DATABASE_NAME',\n    'username'        =\u003e 'DATABASE_USERNAME',\n    'password'        =\u003e 'DATABASE_PASSWORD',\n    'destinationPath' =\u003e 'STORAGE_PATH_WITH_FILE_NAME', // /path/to/backups/pgsql/dump\n];\n```\nUse constructor with options\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\PgsqlDumper($options);\n$dumper-\u003edump();\n```\nUse create method\n```\n\\CodexShaper\\Dumper\\Drivers\\PgsqlDumper::create($options)-\u003edump();\n```\n\nDynamically\n```\n\\CodexShaper\\Dumper\\Drivers\\PgsqlDumper::create()\n  -\u003esetHost($host)\n  -\u003esetPort($port)\n  -\u003esetDbName($database)\n  -\u003esetUserName($username)\n  -\u003esetPassword($password)\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump();\n```\n\nArchive\n```\n\\CodexShaper\\Dumper\\Drivers\\PgsqlDumper::create($options)\n  -\u003euseCompress(\"gzip\") // This command apply gzip to zip\n  -\u003edump();\n```\n\n### PgSql Restore *(Note: Mustbe installed `psql` in your system)*\nRestore from without archive\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\PgsqlDumper($options);\n$dumper-\u003esetRestorePath($restorePath); // /path/to/backups/pgsql/dump.sql \n$dumper-\u003erestore();\n```\n\nRestore from archive\n```\n\\CodexShaper\\Dumper\\Drivers\\PgsqlDumper::create($options)\n  -\u003euseCompress(\"gunzip\") // this command unzip the file\n  -\u003esetRestorePath($restorePath) // /path/to/backups/pgsql/dump.sql.gz\n  -\u003erestore();\n```\n\n### Sqlite Dump *(Note: Mustbe installed `sqlite3` in your system)*\n```\n$options    = [\n    'dbName'          =\u003e 'DATABASE_PATH', // /path/to/database.sqlite\n    'destinationPath' =\u003e 'STORAGE_PATH_WITH_FILE_NAME', // /path/to/backups/sqlite/dump.sql\n];\n```\nUse constructor\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\SqliteDumper($options);\n$dumper-\u003edump();\n```\nUse create method\n```\n\\CodexShaper\\Dumper\\Drivers\\SqliteDumper::create($options)-\u003edump();\n```\n\nSet Dynamically\n```\n\\CodexShaper\\Dumper\\Drivers\\SqliteDumper::create()\n  -\u003esetDbName($database)\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump();\n```\nArchive\n```\n\\CodexShaper\\Dumper\\Drivers\\SqliteDumper::create()\n  -\u003esetDbName($database)\n  -\u003esetDestinationPath($destinationPath)\n  -\u003euseCompress(\"gzip\") // This command apply gzip to zip\n  -\u003edump();\n```\n### Sqlite Restore *(Note: Mustbe installed `sqlite3` in your system)*\n```\n$options    = [\n    'dbName'          =\u003e 'DATABASE_PATH', // /path/to/database.sqlite\n    'restorePath' =\u003e 'RESTORE_PATH_WITH_FILE_NAME', // /path/to/backups/sqlite/dump.sql\n];\n```\nUse Construct\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\SqliteDumper($options);\n$dumper-\u003erestore();\n```\nUse Dynamic\n```\n\\CodexShaper\\Dumper\\Drivers\\SqliteDumper::create()\n  -\u003esetDbName($database)\n  -\u003esetRestorePath($restorePath)\n  -\u003erestore();\n```\nRestore From Archive\n```\n\\CodexShaper\\Dumper\\Drivers\\SqliteDumper::create()\n  -\u003esetDbName($database)\n  -\u003esetRestorePath($restorePath)\n  -\u003euseCompress(\"gunzip\") // This command apply gzip to zip\n  -\u003erestore();\n```\n\n### MongoDB Dump *(Note: Mustbe installed `mongodump` in your system)*\n\n```\n$options    = [\n    'host'            =\u003e 'HOST',\n    'port'            =\u003e 'PORT',\n    'dbName'          =\u003e 'DATABASE_NAME',\n    'username'        =\u003e 'DATABASE_USERNAME',\n    'password'        =\u003e 'DATABASE_PASSWORD',\n    'destinationPath' =\u003e 'STORAGE_PATH_WITH_FILE_NAME', // /path/to/backups/mongodb/dump\n];\n```\n\nUse constructor with options\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\MongoDumper($options);\n$dumper-\u003edump();\n```\nUse create method\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create($options)-\u003edump();\n```\n\nDynamically\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create()\n  -\u003esetHost($host)\n  -\u003esetPort($port)\n  -\u003esetDbName($database)\n  -\u003esetUserName($username)\n  -\u003esetPassword($password)\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump();\n```\n\nArchive\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create($options)\n  -\u003euseCompress(\"gzip\") // This command will add --archive with --gzip\n  -\u003edump();\n```\n#### Use URI\n```\n$options = [\n    'uri'             =\u003e $uri,\n    \"destinationPath\" =\u003e $destinationPath, // /path/to/backups/mongodb/dump \n];\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\MongoDumper($options);\n$dumper-\u003edump();\n```\nOR\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create(['uri' =\u003e $uri])\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump()\n```\nDynamic\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create()\n  -\u003esetUri($uri)\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump()\n```\nCompress\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create(['uri' =\u003e $uri])\n  -\u003euseCompress(\"gzip\")\n  -\u003esetDestinationPath($destinationPath)\n  -\u003edump();\n```\n\n### MongoDB Restore *(Note: Mustbe installed `mongorestore` in your system)*\n\nRestore from without archive\n```\n$dumper = new \\CodexShaper\\Dumper\\Drivers\\MongoDumper($options);\n$dumper-\u003esetRestorePath($restorePath); // /path/to/backups/mongodb/dump \n$dumper-\u003erestore();\n```\n\nUse URI\n\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create(['uri' =\u003e $uri])\n    -\u003esetRestorePath($restorePath)\n    -\u003erestore();\n```\n\nRestore from archive\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create($options)\n  -\u003euseCompress(\"gzip\")\n  -\u003esetRestorePath($restorePath) // /path/to/backups/mongodb/dump.gz\n  -\u003erestore();\n```\nRestore from archive using URI\n```\n\\CodexShaper\\Dumper\\Drivers\\MongoDumper::create(['uri' =\u003e $uri])\n  -\u003euseCompress(\"gzip\")\n  -\u003esetRestorePath($restorePath)\n  -\u003erestore();\n```\n\n### Set Dump Binary Path\n```\n// Same for other driver\n\\CodexShaper\\Dumper\\Drivers\\MysqlDumper::create($options)\n  -\u003esetCommandBinaryPath($binaryPath) // /path/to/mysql/bin\n  -\u003edump();\n```\n\n## License\n\n- **[MIT license](http://opensource.org/licenses/mit-license.php)**\n- Copyright 2019 © \u003ca href=\"https://github.com/Codexshaper/database-backup-restore/blob/master/LICENSE\" target=\"_blank\"\u003eCodexShaper\u003c/a\u003e.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodexshaper%2Fdatabase-backup-restore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodexshaper%2Fdatabase-backup-restore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodexshaper%2Fdatabase-backup-restore/lists"}