https://github.com/dvnc0/balin-queue

A small PHP database queue
https://github.com/dvnc0/balin-queue

mysql php php-queue php8 queue sqlite3

Last synced: 21 days ago
JSON representation

A small PHP database queue

• Host: GitHub
• URL: https://github.com/dvnc0/balin-queue
• Owner: dvnc0
• Created: 2024-11-25T06:54:00.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-12-13T05:46:17.000Z (22 days ago)
• Last Synced: 2024-12-13T06:28:17.628Z (22 days ago)
• Topics: mysql, php, php-queue, php8, queue, sqlite3
• Language: PHP
• Homepage:
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Balin Queue

A simple database queue for PHP.

Supports:

- MySQL/MariaDB

- SQLite3

## Installation

```bash

composer require danc0/balin-queue

```

## Config

```php

$Balin = Balin::load([

	'path' => __DIR__,

	'database' => [

		'driver' => 'sqlite',

		'name' => 'balin_queue.sqlite',

		'dsn' => 'sqlite:' . __DIR__ . '/balin_queue.sqlite'

	]

]);

```

Driver Options:

- `sqlite`

- `mysql`

A flag file is created in `path` to indicate that the queue has been created, make sure the path is writable. This is also where the sqlite database will be created if using sqlite.

## Usage

You would first create an instance of Balin somewhere with the config example above. To access the instance of Balin you would use the following code:

```php

$Balin = Balin::queue();

```

At this point you have a number of public methods you can use.

### Push to queue

`push(string $task_name, array $payload, int $priority = 99, int $max_attempts = 3, string $scheduled_at = null)`

This will push a task to the queue. Use lower numbers for higher priority. The default priority is 99. The default max attempts is 3. The default scheduled at is null. Using scheduled at will delay the task until the time specified.

### Getting a job

`pop()` 

This will return the next job in the queue. If there are no jobs in the queue it will return `null`. This will pull based on priority, scheduled at time, and created time.

`popTask(string $task_name)`

This will return the next job in the queue for the specified task name. If there are no jobs in the queue it will return `null`. This will pull based on priority, scheduled at time, and created time, but only for the specified task name.

### Update a job

`success(int $id)`

This will mark the job as successful and remove it from the queue.

`failure(int $id, string|null $scheduled_at = null)`

This will mark the job as failed and put it back in the queue. If the job has reached the max attempts it will be removed from the queue. If you pass a scheduled at time it will delay the job until that time.

`error(int $id, string $error_message)`

This will mark the job as having an error and remove it from the queue.

## Releasing orphaned jobs

`releaseLockedJobs(int $locked_max_time = 3600)`

This will release any jobs that have been locked for more than the specified time. The default is 3600 seconds (1 hour).