Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/offline-agency/laravel-mongo-auto-sync
This package provides a better support for MongoDB relationships in Laravel Projects.
https://github.com/offline-agency/laravel-mongo-auto-sync
database hacktoberfest hacktoberfest2020 hacktoberfest2021 hacktoberfest2022 laravel mongodb relationships sync-collection
Last synced: about 16 hours ago
JSON representation
This package provides a better support for MongoDB relationships in Laravel Projects.
- Host: GitHub
- URL: https://github.com/offline-agency/laravel-mongo-auto-sync
- Owner: offline-agency
- License: mit
- Created: 2019-01-24T00:54:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T22:31:52.000Z (about 2 months ago)
- Last Synced: 2024-12-26T04:26:33.901Z (about 1 month ago)
- Topics: database, hacktoberfest, hacktoberfest2020, hacktoberfest2021, hacktoberfest2022, laravel, mongodb, relationships, sync-collection
- Language: PHP
- Homepage: https://docs.offlineagency.com/laravel-mongo-auto-sync
- Size: 623 KB
- Stars: 15
- Watchers: 4
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel MongoDB Relationships
[](https://packagist.org/packages/offline-agency/laravel-mongo-auto-sync)
[](https://packagist.org/packages/offline-agency/laravel-mongo-auto-sync)
[](https://github.com/offline-agency/laravel-mongo-auto-sync/actions/workflows/build-ci.yml)
[](LICENSE.md)
[](https://scrutinizer-ci.com/g/offline-agency/laravel-mongo-auto-sync)
[](https://styleci.io/repos/167277388)
[](https://codecov.io/gh/offline-agency/laravel-mongo-auto-sync)
This package provides a better support for [MongoDB](https://www.mongodb.com) relationships in [Laravel](https://laravel.com/) Projects.
At low level all CRUD operations has been handled by [jenssegers/laravel-mongodb](https://github.com/jenssegers/laravel-mongodb)
## Installation
```bash
composer require offline-agency/laravel-mongo-auto-sync
```
### Prerequisites
Make sure you have the MongoDB PHP driver installed. You can find installation instructions at [http://php.net/manual/en/mongodb.installation.php](http://php.net/manual/en/mongodb.installation.php)
### Package version Compatibility
| This package | Laravel | Laravel MongoDB |
|--------------|---------|-----------------|
| 1.x | 5.8.x | 3.5.x |
| 1.x | 6.x | 3.6.x |
| 2.x | 5.8.x | 3.5.x |
| 2.x | 6.x | 3.6.x |
| 2.x | 7.x | 3.7.x |
| 2.x | 8.x | 3.8.x |
| 2.x | 9.x | 3.9.x |
| 3.x | 5.8.x | 3.5.x |
| 3.x | 6.x | 3.6.x |
| 3.x | 7.x | 3.7.x |
| 3.x | 8.x | 3.8.x |
| 3.x | 9.x | 3.9.x |
### PHP Version Compatibility
- Version 1: PHP 7.1, 7.2, 7.3
- Version 2: PHP 7.4
- Version 3: PHP 7.4-8.1
## Features
- Sync changes between collection with relationships after CRUD operations
- EmbedsOne & EmbedsMany
#### Example without our package
``` php
//create a new Article with title "Game of Thrones" with Category "TV Series"
//assign data to $article
$article->save();
/*
Article::class {
'title' => 'Game of Thrones',
'category' => Category::class {
'name' => 'TV Series'
}
}
*/
//Retrieve 'TV Series' category
$category = Category::where('name', 'TV Series')->first();
/*
Category::class {
'name' => 'Game of Thrones',
'articles' => null
}
*/
```
The sub document article has not been updated with the new article. So you will need some extra code to write in order to see the new article it in the category page. The number of sync depends on the number of the relationships and on the number of the entry in every single EmbedsMany relationships.
Total updates = ∑ (entry in all EmbedsMany relationships) + ∑ (EmbedsOne relationships)
As you can see the lines of extra code can rapidly increase, and you will write many redundant code.
#### Example with our package
``` php
//create a new Article with title "Game of Thrones" with Category "TV Series"
$article->storeWithSync($request);
/*
Article::class {
'title' => 'Game of Thrones',
'category' => Category::class {
'name' => 'TV Series'
}
}
*/
//Retrieve 'TV Series' category
$category = Category::where('name', 'TV Series')->first();
/*
Category::class {
'name' => 'Game of Thrones',
'articles' => Article::class {
'title' => 'Game of Thrones'
}
}
*/
```
The sub document article has been updated with the new article, with no need of extra code :tada:
You can see the new article on the category page because the package synchronizes the information for you by reading the Model Setup.
**These example can be applied for all write operations on the database.**
- Referenced sub documents [TO DO]
- Handle sub document as Model in order to exploit Laravel ORM support during write operation (without sync feature) [TO BE TEST]
- Handle referenced sub document as Model in order to exploit Laravel ORM support during write operation (without sync feature) [TO DO]
- Advance cast field support
## Use cases
- Blog: see demo [here](https://github.com/offline-agency/laravel-mongodb-blog)
- Ecommerce
- API System for mobile application o for generated static site
- Any projects that require fast read operations and (slow) write operations that can be run on background
## Documentation
You can find the documentation [here](https://docs.offlineagency.com/laravel-mongo-auto-sync/)
## Testing
Run this command inside your project's route
``` bash
docker-compose up
```
Now run the tests with:
``` bash
composer test
```
## Roadmap :rocket:
- Refactor target synchronization to Observer pattern, so all this operation can be run on background using [Laravel Queue System](https://laravel.com/docs/5.8/queues). This will also speed up all the operations in the collection that is primary involved in write operations.
- Command Analyse Database: This command will analyse the database in order to find some relationship error.
Ex: An article with a category associated that is not present on the Category's sub document.
- Refactor **save()** method in order to handle CRUD operation on relationship also without sync.
- Support for [referenced relationships](https://docs.mongodb.com/manual/tutorial/model-referenced-one-to-many-relationships-between-documents/).
- Better support for all field types.
- DestroyWithSync() without delete sub documents on other collections.
- Add more tests.
- Nested relationships.
- Benchmark MongoDB vs Mysql (write and read operation).
- Fix typo errors.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Giacomo Fabbian](https://github.com/Giacomo92)
- [All Contributors](https://github.com/offline-agency/laravel-mongo-auto-sync/graphs/contributors)
## About us
Offline Agency is a web design agency based in Padua, Italy. You'll find an overview of our projects [on our website](https://offlineagency.it/#home).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.