PHPackages                             carmelosantana/coqui-toolkit-dokploy-database - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. carmelosantana/coqui-toolkit-dokploy-database

ActiveLibrary[Database & ORM](/categories/database)

carmelosantana/coqui-toolkit-dokploy-database
=============================================

Dokploy database management toolkit for Coqui — manage Postgres, MySQL, MariaDB, MongoDB, and Redis databases, backup policies, and S3-compatible backup destinations via the Dokploy REST API.

v0.1.1(1mo ago)00MITPHPPHP ^8.4

Since Apr 9Pushed 1mo agoCompare

[ Source](https://github.com/carmelosantana/coqui-dokploy-database)[ Packagist](https://packagist.org/packages/carmelosantana/coqui-toolkit-dokploy-database)[ RSS](/packages/carmelosantana-coqui-toolkit-dokploy-database/feed)WikiDiscussions main Synced yesterday

READMEChangelogDependencies (4)Versions (3)Used By (0)

Dokploy Database Toolkit
========================

[](#dokploy-database-toolkit)

Manage Dokploy databases, database backups, and S3-compatible backup destinations through [Coqui](https://github.com/coquibot/coqui).

Supports **PostgreSQL**, **MySQL**, **MariaDB**, **MongoDB**, and **Redis** — all five Dokploy-managed database types via a unified interface.

Requirements
------------

[](#requirements)

- PHP 8.4+
- [coquibot/coqui-toolkit-dokploy](https://github.com/coquibot/coqui-toolkit-dokploy) ^1.0 (provides `DokployClient`)

Installation
------------

[](#installation)

```
composer require coquibot/coqui-toolkit-dokploy-database
```

The toolkit is auto-discovered by Coqui — no additional configuration needed.

Credentials
-----------

[](#credentials)

The toolkit requires the same Dokploy API credentials as the parent toolkit:

KeyDescription`DOKPLOY_API_URL`Base URL of your Dokploy instance (e.g. `https://dokploy.example.com`)`DOKPLOY_API_TOKEN`API token — generate one in **Dokploy → Settings → API / Tokens**Coqui will prompt for these automatically if they're missing.

Tools
-----

[](#tools)

### `dokploy_database`

[](#dokploy_database)

Unified management for all five Dokploy database types.

ActionDescription`create`Create a new database instance`get`Get database details by ID`search`Search databases by name`start`Start a stopped database`stop`Stop a running database`deploy`Trigger a deployment`change_status`Change database status`update`Update database configuration`reload`Reload database settings`rebuild`Rebuild database container`move`Move to a different environment`delete`Remove a database`save_ports`Configure external port`save_env`Update environment variables**Type parameter:** `postgres`, `mysql`, `mariadb`, `mongo`, `redis`

**Create parameters by type:**

Parameterpostgresmysqlmariadbmongoredis`name`✓✓✓✓✓`environmentId`✓✓✓✓✓`databasePassword`✓✓✓✓✓`databaseName`✓✓✓`databaseUser`✓✓✓✓`databaseRootPassword`✓✓`dockerImage`✓✓✓✓✓`description`✓✓✓✓✓### `dokploy_db_backup`

[](#dokploy_db_backup)

Database-specific backup policies and manual triggers.

ActionDescription`get`Get backup policy details`create`Create a backup policy`update`Update a backup policy`delete`Remove a backup policy`run`Trigger a manual backup`list_files`List available backup files**Supported database types:** `postgres`, `mysql`, `mariadb`, `mongo`

> Redis does not support Dokploy-managed backups.

### `dokploy_destination`

[](#dokploy_destination)

Manage S3-compatible backup storage destinations.

ActionDescription`list`List all destinations`get`Get destination details`create`Create a new S3 destination`update`Update destination config`delete`Remove a destination`test_connection`Verify S3 connectivityExample Workflows
-----------------

[](#example-workflows)

### Provision a PostgreSQL database

[](#provision-a-postgresql-database)

```
dokploy_database(type: "postgres", action: "create", name: "app-db",
    environmentId: "env123", databaseName: "myapp",
    databaseUser: "appuser", databasePassword: "s3cret")

```

### Set up automated backups

[](#set-up-automated-backups)

```
# 1. Create an S3 destination
dokploy_destination(action: "create", name: "s3-prod",
    accessKey: "AKIA...", secretAccessKey: "...",
    bucket: "backups", region: "us-east-1",
    endpoint: "https://s3.amazonaws.com")

# 2. Test connectivity
dokploy_destination(action: "test_connection", destinationId: "dest123")

# 3. Create a daily backup policy
dokploy_db_backup(action: "create", databaseType: "postgres",
    postgresId: "pg123", destinationId: "dest123",
    schedule: "0 3 * * *", prefix: "prod-daily")

# 4. Trigger a manual backup
dokploy_db_backup(action: "run", backupId: "bk123", databaseType: "postgres")

```

### Manage database lifecycle

[](#manage-database-lifecycle)

```
# Stop for maintenance
dokploy_database(type: "mysql", action: "stop", databaseId: "mysql456")

# Update environment
dokploy_database(type: "mysql", action: "save_env",
    databaseId: "mysql456", env: "MYSQL_MAX_CONNECTIONS=200")

# Start and deploy
dokploy_database(type: "mysql", action: "start", databaseId: "mysql456")
dokploy_database(type: "mysql", action: "deploy", databaseId: "mysql456")

```

Gated Operations
----------------

[](#gated-operations)

The following operations require user confirmation (unless `--auto-approve` is active):

ToolGated Actions`dokploy_database``delete`, `rebuild`, `stop``dokploy_db_backup``delete`, `run``dokploy_destination``delete`Relationship to `coqui-toolkit-dokploy`
---------------------------------------

[](#relationship-to-coqui-toolkit-dokploy)

This package extends the base Dokploy toolkit. The base toolkit handles:

- Projects, applications, compose services
- Deployments, Docker containers, domains
- **Web server and compose** backups

This package adds:

- All five database types (postgres, mysql, mariadb, mongo, redis)
- **Database-specific** backups
- S3 backup destinations

Both toolkits share the same `DokployClient` and credentials — install both for full Dokploy coverage.

Development
-----------

[](#development)

```
composer install
composer analyse   # PHPStan level 8
composer test      # Pest tests
```

License
-------

[](#license)

MIT

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance94

Actively maintained with recent releases

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity42

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

2

Last Release

32d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/597820?v=4)[Carmelo Santana](/maintainers/carmelosantana)[@carmelosantana](https://github.com/carmelosantana)

---

Top Contributors

[![carmelosantana](https://avatars.githubusercontent.com/u/597820?v=4)](https://github.com/carmelosantana "carmelosantana (2 commits)")

---

Tags

databasebackupmysqlpostgresmariadbredismongodbtoolkitphp-agentscoquidokploy

###  Code Quality

TestsPest

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/carmelosantana-coqui-toolkit-dokploy-database/health.svg)

```
[![Health](https://phpackages.com/badges/carmelosantana-coqui-toolkit-dokploy-database/health.svg)](https://phpackages.com/packages/carmelosantana-coqui-toolkit-dokploy-database)
```

###  Alternatives

[scienta/doctrine-json-functions

A set of extensions to Doctrine that add support for json query functions.

58523.9M36](/packages/scienta-doctrine-json-functions)[phpbu/phpbu

PHP Backup utility.

1.3k89.0k4](/packages/phpbu-phpbu)[apix/cache

A thin PSR-6 cache wrapper with a generic interface to various caching backends emphasising cache taggging and indexing to Redis, Memcached, PDO/SQL, APC and other adapters.

114542.8k6](/packages/apix-cache)[rybakit/phive-queue

$queue->push('I can be popped off after', '10 minutes');

16441.5k1](/packages/rybakit-phive-queue)[chillerlan/php-database

An extensible database wrapper and query builder.

431.2k2](/packages/chillerlan-php-database)[moharrum/laravel-adminer

Adminer database management tool for your Laravel application.

451.0k](/packages/moharrum-laravel-adminer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)