diff options
Diffstat (limited to 'lib/public')
| -rw-r--r-- | lib/public/DB/Events/AddMissingIndicesEvent.php | 59 | ||||
| -rw-r--r-- | lib/public/IDBConnection.php | 5 |
2 files changed, 62 insertions, 2 deletions
diff --git a/lib/public/DB/Events/AddMissingIndicesEvent.php b/lib/public/DB/Events/AddMissingIndicesEvent.php new file mode 100644 index 00000000000..139b776b136 --- /dev/null +++ b/lib/public/DB/Events/AddMissingIndicesEvent.php @@ -0,0 +1,59 @@ +<?php + +declare(strict_types=1); +/** + * @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net + * + * @author Julius Härtl <jus@bitgrid.net + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\DB\Events; + +/** + * Event to allow apps to register information about missing database indices + * + * This event will be dispatched for checking on the admin settings and when running + * occ db:add-missing-indices which will then create those indices + * + * @since 28.0.0 + */ +class AddMissingIndicesEvent extends \OCP\EventDispatcher\Event { + /** @var array<array-key, array{tableName: string, indexName: string, columns: string[]}> */ + private array $missingIndices = []; + + /** + * @param string[] $columns + * @since 28.0.0 + */ + public function addMissingIndex(string $tableName, string $indexName, array $columns): void { + $this->missingIndices[] = [ + 'tableName' => $tableName, + 'indexName' => $indexName, + 'columns' => $columns + ]; + } + + /** + * @since 28.0.0 + * @return array<array-key, array{tableName: string, indexName: string, columns: string[]}> + */ + public function getMissingIndices(): array { + return $this->missingIndices; + } +} diff --git a/lib/public/IDBConnection.php b/lib/public/IDBConnection.php index 69ede2c8438..bfc63b2aab0 100644 --- a/lib/public/IDBConnection.php +++ b/lib/public/IDBConnection.php @@ -34,6 +34,7 @@ namespace OCP; use Doctrine\DBAL\Schema\Schema; +use OCP\DB\Events\AddMissingIndicesEvent; use OCP\DB\Exception; use OCP\DB\IPreparedStatement; use OCP\DB\IResult; @@ -46,12 +47,12 @@ use OCP\DB\QueryBuilder\IQueryBuilder; */ interface IDBConnection { /** - * @deprecated 22.0.0 this is an internal event + * @deprecated 22.0.0 this is an internal event, use {@see AddMissingIndicesEvent} instead */ public const ADD_MISSING_INDEXES_EVENT = self::class . '::ADD_MISSING_INDEXES'; /** - * @deprecated 22.0.0 this is an internal event + * @deprecated 22.0.0 this is an internal event, use {@see AddMissingIndicesEvent} instead */ public const CHECK_MISSING_INDEXES_EVENT = self::class . '::CHECK_MISSING_INDEXES'; |