Skip to content

Check plugin version, install and uninstall

Info

Plugins approach is described in detail in this page.

Plugins are versioned like any other code artifact in Sidra. The code of the plugins can be installed from the web, just by clicking on a plugin icon from the connectors gallery. Once this plugin code is available in Sidra API, it will be possible to invoke any plugin methods (e.g. execute) to perform data intake creations or any other operation managed by plugins.

To check that the installed version of a plugin is the most recent, we need to invoke Sidra API. It is recommended to have always the latest available version installed from any given plugin.

How to check the currently installed version of a plugin

The installed connectors version in a given installation can be checked through the endpoint /api/plugins/{pluginType}/installed.

Plugin install endpoint

By default, we keep the default value of 0 for the parameter pluginType, and we execute the call. This type of plugin represents a plugin of type connector.

A possible method response would be the following one:

Plugin install response

From this information, we need to check that the installed version for each plugin is the most recent one. For this, we make a call to the endpoint /api/plugins/{pluginType}/available, keeping, as in the previous case, the value 0 for the parameter pluginType.

Plugin available endpoint

Once executed this call, the response will return all the available versions for each plugin. We will need to verify that the versionNumber of the installed plugins matches that of the highest versionNumber in the property versions (this appears below the property logo for each plugin). For example, in this case, for the SQL Server connector plugin, the versionNumber installed is the 1.0.22, whereas the Azure SQL version is 1.0.24.

If we check the versions list of the last endpoint, we will see that it is the most recent version.

  • For Azure SQL:

Plugin Azure SQL version

  • For SQL Server:

Plugin SQL Server version

Plugin version update

If we find a most recent version than the currently installed, that is available, we will need to update that version. For this, first we will uninstall the plugin and we will install again with the most recent version.

The endpoint to uninstall is /api/plugins/{pluginType}/{pluginVersionId}/uninstall.

Next, we show an example on how to uninstall the SQL Server connector plugin:

Plugin version uninstall

The parameter pluginVersionId corresponds to the id property returned for each connector in the endpoint /api/plugins/{pluginType}/installed in the above section.

Plugin version uninstall response

Once uninstalled, we will proceed with the installation of the most recent version of the plugin, by using the endpoint /api/plugins/{pluginType}/{pluginVersionId}/install with the most recent version.

We should take the id property of the most recent version in the list of available plugins (/api/plugins/{pluginType}/available).

Plugin version install


Last update: 2022-02-10
Back to top