feat(dev): Add documentation for new AddMissingIndicesEvent

Signed-off-by: Julius Härtl <jus@bitgrid.net>
nextcloud · Jul 14, 2023 · af4ae52 · af4ae52
1 parent 49177ac
commit af4ae52
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_28.rst b/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_28.rst
@@ -51,6 +51,7 @@ Due to the popularity of CLI tools for development of Nextcloud apps, the likeli
 Added APIs
 ^^^^^^^^^^
 
+* ``\OCP\DB\Events\AddMissingIndicesEvent`` to add missing indices to the database schema.
 * ``\OCP\Mail\IMessage::setSubject`` to set an email subject. See :ref:`email` for an example.
 * ``\OCP\Mail\IMessage::setHtmlBody`` and ``\OCP\Mail\IMessage::setPlainBody`` to set an email body See :ref:`email` for an example.
 * ``\OCP\IEventSourceFactory`` to create a ``OCP\IEventSource`` instance.

diff --git a/developer_manual/basics/events.rst b/developer_manual/basics/events.rst
@@ -446,6 +446,17 @@ It is an event that allows apps to notify other components about an interaction
 
 Emitters should add at least one identifier (uid, email, federated cloud ID) of the recipient of the interaction.
 
+``\OCP\DB\Events\AddMissingIndicesEvent``
+************************************************
+
+.. versionadded:: 28
+
+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 or can be used
+to generate the SQL statements for manual execution.
+
 ``\OCP\DirectEditing\RegisterDirectEditorEvent``
 ************************************************