Download the PHP package ebs/parents-one-time-operations without Composer
On this page you can find all versions of the php package ebs/parents-one-time-operations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ebs/parents-one-time-operations
More information about ebs/parents-one-time-operations
Files in ebs/parents-one-time-operations
Package parents-one-time-operations
Short Description Run operations once after deployment - just like you do it with migrations!
License MIT
Homepage https://github.com/timokoerber/laravel-one-time-operations
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package parents-one-time-operations
Laravel One-Time Operations
Run operations once after deployment - just like you do it with migrations!
Take your CI/CD to the next Level with Laravel One-Time Operations! 🚀
Create specific classes for a one-time usage, that can be executed automatically after each deployment. Same as migrations they get processed once and then never again. Perfect for seeding or updating some data instantly after some database changes or feature updates.
This package is for you if...
- you regularly need to update specific data after you deployed new code
- you often execute jobs just only one single time after a deployment
- you sometimes forget to execute that one specific job and stuff gets crazy
- your code gets cluttered with jobs, that are not being used anymore
- your co-workers always need to be reminded to execute that one job after some database changes
- you often seed or process data in a migration file (which is a big no-no!)
Installation
Require this package with composer:
Create the required table in your database:
Now you're all set!
Commands
Create operation files
Process operations
Show operations
Tutorials
CI/CD & Deployment-Process
The One-Time Operations work exactly like Laravel Migrations. Just process the operations after your code was deployed and the migrations were migrated. You can make it part of your deployment script like this:
Edit config
By default, the following elements will be created in your project:
- the table
operationsin your database - the directory
operationsin your project root directory
If you want to use a different settings just publish and edit the config file:
This will create the file config/one-time-operations.php with the following content.
Make changes as you like.
Create One-Time Operation files
To create a new operation file execute the following command:
This will create a file like operations/XXXX_XX_XX_XXXXXX_awesome_operation.php with the following content.
Provide your code in the process() method, for example:
By default, the operation is being processed asyncronously (based on your configuration) by dispatching the job OneTimeOperationProcessJob.
You can also execute the code syncronously by setting the $async flag to false.
(this is only recommended for small operations, since the processing of these operations should be part of the deployment process)
Processing the operations
Use the following call to process all new operation files.
Your code will be executed, and you will find all the processed operations in the operations table:
| id | name | dispatched | processed_at |
|---|---|---|---|
| 1 | XXXX_XX_XX_XXXXXX_awesome_operation | async | 2015-10-21 07:28:00 |
After that, this operation will not be processed anymore.
Dispatching Jobs syncronously or asyncronously
For each operation a OneTimeOperationProcessJob is being dispatched,
either with dispatch() oder dispatchSync() based on the $async attribute in the operation file.
By providing the --sync or --async option with the operations:process command, you can force a syncronously/asyncronously execution and ignore the attribute:
Hint! If operation:process is part of your deployment process, it is not recommended to process the operations syncronously,
since an error in your operation could make your whole deployment fail.
Re-run an operation
If something went wrong (or if you just feel like it), you can process an operation again by providing the name of the operation as parameter in operations:process.
Testing the operation
You might want to test your code a couple of times before flagging the operation as "processed". Provide the --test flag to run the command again and again.
Showing all operations
So you don't have to check the database or the directory for the existing operations,
you can show a list with operations:show.
Filter the list with the available filters pending, processed and disposed.
pending- Operations, that have not been processed yetprocessed- Operations, that have been processeddisposed- Operations, that have been processed and the files were already deleted
Deleting operations
The whole idea of this package is, that you can dispose the operations once they were executed, so your project won't be cluttered with files and code, you won't be using anymore.
So you just need to delete the files from your repository
The deleted operations will be shown as DISPOSED when you call operations:show, so you still have a history on all the processed operations.
Testing
License
Copyright © Timo Körber | www.timokoerber.com
Laravel One-Time Operations is open-sourced software licensed under the MIT license.
