# ServerDatabaseEvent events

> 4 FeatherPanel plugin events on ServerDatabaseEvent (3 emitted by the core): the event names, the arguments each listener gets, where they fire and a PHP listener for each.

Source: https://featherpanel.com/docs/plugins/events/server-database/

Part of the [plugin events reference](https://featherpanel.com/docs/plugins/events/). Listeners get the payload values as positional arguments in the order shown, cannot cancel the action, and must catch their own exceptions. 1 of these events are declared but no code emits them yet; they are marked not emitted.

## Setup

Import `ServerDatabaseEvent` in your entry class and register listeners in `processEvents()`:

```php
<?php

namespace App\Addons\myplugin;

use App\App;
use App\Plugins\AppPlugin;
use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\ServerDatabaseEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(ServerDatabaseEvent::onServerDatabaseUpdated(), function ($userUuid, $serverUuid, $databaseId): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:updated ' . json_encode(['user_uuid' => $userUuid, 'server_uuid' => $serverUuid, 'database_id' => $databaseId]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}
```

## `ServerDatabaseEvent::onServerDatabaseCreated()`

- Name: `featherpanel:user:server:database:created`
- emitted at 2 sites
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerDatabaseEvent.php#L28)

Docblock: string server uuid, array database data. (the emitter passes 3 values, see the table)

Same event name as `ServerEvent::onServerDatabaseCreated()`. A listener on either method receives the emits of both.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `user_uuid` | `$userUuid` | not declared |
| 2 | `server_uuid` | `$serverUuid` | not declared |
| 3 | `database_id` | `$databaseId` | not declared |

When it fires (2 sites)

-   [`ServerDatabaseController::createServerDatabase`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerDatabaseController.php#L493)[`POST /api/user/servers/{uuidShort}/databases`](https://featherpanel.com/docs/api/reference/user/server/databases/#post-user-servers-uuidShort-databases)
-   [`CreateDatabaseTool::execute`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Services/Chatbot/Tools/CreateDatabaseTool.php#L189)

```php
$event->on(ServerDatabaseEvent::onServerDatabaseCreated(), function ($userUuid, $serverUuid, $databaseId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:created');
});
```

## `ServerDatabaseEvent::onServerDatabaseDeleted()`

- Name: `featherpanel:user:server:database:deleted`
- emitted at 3 sites
- 2 payload shapes
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerDatabaseEvent.php#L44)

Docblock: string server uuid, int database id. (the emitter passes 3 values, see the table)

Same event name as `ServerEvent::onServerDatabaseDeleted()`. A listener on either method receives the emits of both.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `user_uuid` | `$userUuid` | not declared |
| 2 | `server_uuid` | `$serverUuid` | not declared |
| 3 | `database_id` | `$databaseId` | `int` |

| Arguments passed | Emitted from |
| --- | --- |
| `user_uuid`, `server_uuid`, `database_id` | 
`ServerDatabaseController::deleteServerDatabase`

`DeleteDatabaseTool::execute`

 |
| `user_uuid`, `server_uuid`, `database_id`, `bulk` | 

`ServerDatabaseController::bulkDeleteServerDatabases`

 |

When it fires (3 sites)

-   [`ServerDatabaseController::deleteServerDatabase`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerDatabaseController.php#L757)[`DELETE /api/user/servers/{uuidShort}/databases/{databaseId}`](https://featherpanel.com/docs/api/reference/user/server/databases/#delete-user-servers-uuidShort-databases-databaseId)
-   [`ServerDatabaseController::bulkDeleteServerDatabases`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerDatabaseController.php#L922)[`DELETE /api/user/servers/{uuidShort}/databases/bulk-delete`](https://featherpanel.com/docs/api/reference/user/server/databases/#delete-user-servers-uuidShort-databases-bulk-delete)
-   [`DeleteDatabaseTool::execute`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Services/Chatbot/Tools/DeleteDatabaseTool.php#L192)

```php
$event->on(ServerDatabaseEvent::onServerDatabaseDeleted(), function ($userUuid, $serverUuid, $databaseId, ...$rest): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:deleted ' . json_encode(['database_id' => $databaseId]));
});
```

## `ServerDatabaseEvent::onServerDatabaseError()`

- Name: `featherpanel:user:server:database:error`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerDatabaseEvent.php#L53)

Docblock: string error message, array context.

```php
$event->on(ServerDatabaseEvent::onServerDatabaseError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:error ' . json_encode($args));
});
```

No code emits this event yet, so the arguments are unknown. The listener accepts any.

## `ServerDatabaseEvent::onServerDatabaseUpdated()`

- Name: `featherpanel:user:server:database:updated`
- emitted at 2 sites
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/ServerDatabaseEvent.php#L36)

Docblock: string server uuid, int database id, array updated data.

Same event name as `ServerEvent::onServerDatabaseUpdated()`. A listener on either method receives the emits of both.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `user_uuid` | `$userUuid` | `string`from docblock |
| 2 | `server_uuid` | `$serverUuid` | `int`from docblock |
| 3 | `database_id` | `$databaseId` | `int` |

When it fires (2 sites)

-   [`ServerDatabaseController::updateServerDatabase`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/ServerDatabaseController.php#L637)[`PATCH /api/user/servers/{uuidShort}/databases/{databaseId}`](https://featherpanel.com/docs/api/reference/user/server/databases/#patch-user-servers-uuidShort-databases-databaseId)
-   [`UpdateDatabaseTool::execute`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Services/Chatbot/Tools/UpdateDatabaseTool.php#L180)

```php
$event->on(ServerDatabaseEvent::onServerDatabaseUpdated(), function ($userUuid, $serverUuid, $databaseId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:updated ' . json_encode(['user_uuid' => $userUuid, 'server_uuid' => $serverUuid, 'database_id' => $databaseId]));
});
```