# DatabasesEvent events

> 11 FeatherPanel plugin events on DatabasesEvent (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/databases/

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. 8 of these events are declared but no code emits them yet; they are marked not emitted.

## Setup

Import `DatabasesEvent` 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\DatabasesEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(DatabasesEvent::onDatabaseDeleted(), function ($database, $deletedBy): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:deleted ' . json_encode(['database' => $database, 'deleted_by' => $deletedBy]));
        });
    }

    public static function pluginInstall(): void
    {
    }

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

## `DatabasesEvent::onDatabasesByNodeRetrieved()`

- Name: `featherpanel:admin:databases:by:node:retrieved`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L68)

Docblock: int node id, array databases.

```php
$event->on(DatabasesEvent::onDatabasesByNodeRetrieved(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:by:node:retrieved ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabaseConnectionTested()`

- Name: `featherpanel:admin:databases:connection:tested`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L84)

Docblock: array connection data, array test results.

```php
$event->on(DatabasesEvent::onDatabaseConnectionTested(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:connection:tested ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabaseConnectionError()`

- Name: `featherpanel:admin:databases:database:connection:error`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L109)

Docblock: int database id, string error message.

```php
$event->on(DatabasesEvent::onDatabaseConnectionError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:connection:error ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabaseCreated()`

- Name: `featherpanel:admin:databases:database:created`
- emitted at 1 site
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L44)

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

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `database_id` | `$databaseId` | not declared |
| 2 | `database_data` | `$databaseData` | not declared |
| 3 | `created_by` | `$createdBy` | not declared |

When it fires (1 site)

-   [`DatabasesController::create`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/DatabasesController.php#L454)[`PUT /api/admin/databases`](https://featherpanel.com/docs/api/reference/admin/databases/#put-admin-databases)

```php
$event->on(DatabasesEvent::onDatabaseCreated(), function ($databaseId, $databaseData, $createdBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:created');
});
```

## `DatabasesEvent::onDatabaseDeleted()`

- Name: `featherpanel:admin:databases:database:deleted`
- emitted at 1 site
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L60)

Docblock: int database id, array database data.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `database` | `$database` | `int`from docblock |
| 2 | `deleted_by` | `$deletedBy` | `array`from docblock |

When it fires (1 site)

-   [`DatabasesController::delete`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/DatabasesController.php#L693)[`DELETE /api/admin/databases/{id}`](https://featherpanel.com/docs/api/reference/admin/databases/#delete-admin-databases-id)

```php
$event->on(DatabasesEvent::onDatabaseDeleted(), function ($database, $deletedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:deleted ' . json_encode(['database' => $database, 'deleted_by' => $deletedBy]));
});
```

## `DatabasesEvent::onDatabaseHealthChecked()`

- Name: `featherpanel:admin:databases:database:health:checked`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L76)

Docblock: int database id, array health data.

```php
$event->on(DatabasesEvent::onDatabaseHealthChecked(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:health:checked ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabaseNotFound()`

- Name: `featherpanel:admin:databases:database:not:found`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L101)

Docblock: int database id, string error message.

```php
$event->on(DatabasesEvent::onDatabaseNotFound(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:not:found ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabaseRetrieved()`

- Name: `featherpanel:admin:databases:database:retrieved`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L36)

Docblock: int database id, array database data.

```php
$event->on(DatabasesEvent::onDatabaseRetrieved(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:retrieved ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabaseUpdated()`

- Name: `featherpanel:admin:databases:database:updated`
- emitted at 1 site
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L52)

Docblock: int database id, array old data, array new data.

| # | Payload key | Listener parameter | Type |
| --- | --- | --- | --- |
| 1 | `database` | `$database` | `int`from docblock |
| 2 | `updated_data` | `$updatedData` | `array`from docblock |
| 3 | `updated_by` | `$updatedBy` | `array`from docblock |

When it fires (1 site)

-   [`DatabasesController::update`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/Admin/DatabasesController.php#L621)[`PATCH /api/admin/databases/{id}`](https://featherpanel.com/docs/api/reference/admin/databases/#patch-admin-databases-id)

```php
$event->on(DatabasesEvent::onDatabaseUpdated(), function ($database, $updatedData, $updatedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:updated ' . json_encode(['database' => $database, 'updated_data' => $updatedData, 'updated_by' => $updatedBy]));
});
```

## `DatabasesEvent::onDatabasesError()`

- Name: `featherpanel:admin:databases:error`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L93)

Docblock: string error message, array context.

```php
$event->on(DatabasesEvent::onDatabasesError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:error ' . json_encode($args));
});
```

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

## `DatabasesEvent::onDatabasesRetrieved()`

- Name: `featherpanel:admin:databases:retrieved`
- not emitted
- Cancel or modify: no
- [definition](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Plugins/Events/Events/DatabasesEvent.php#L28)

Docblock: array databases list.

```php
$event->on(DatabasesEvent::onDatabasesRetrieved(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:retrieved ' . json_encode($args));
});
```

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