DEV Community

AndySqlman
AndySqlman

Posted on

Working with Plugins in SQLMessenger

Starting from SQLMessenger version 2.3, the plugin feature has been introduced. We package some universal or complex functions into plugins. You only need to install these plugins in SQLMessenger to immediately enable the desired functions. For example, the SQLTelebot mentioned in How to Send Telegram Messages Using SQL Statements is a SQLMessenger plugin. After installing this plugin, you can quickly enable Telegram message receiving and sending within SQLMessenger.

The SQLTelebot plugin for SQLMessenger

The SQLTelebot plugin for SQLMessenger

 

Benefits of Using Plugins

(1) For your complex functional requirements, we package the pre-configured tasks and initialization scripts into a plugin installer. You only need one-click installation to use the corresponding functions – simple and hassle-free.

(2) Plugins have independent configuration interfaces, allowing you to configure and manage functions easily and intuitively.

(3) You can view all source code of plugins, helping you understand technical details in depth.

(4) When a plugin is no longer needed, you can uninstall it to free up system resources.

Installing Plugins

Before using a plugin, you must install it in your SQLMessenger system. For standard plugins, go to Task Manager, click "Plugin Management", find the required plugin in the list, and click the "Install" button on the right to open the installation interface.

Install plugins in

Install plugins in "Plugin Management"

 
For custom plugins we provide, go to Task Manager, click the "Import Task" button, and select the plugin installation file (with .pkg extension) we sent you to open the installation interface.

Install plugins via

Install plugins via "Import Task"

 
On the plugin installation page, you can view the function description, manual, and support information. Click "Start Installation" in the bottom-right corner to install the plugin.
The plugin installation interface

The plugin installation interface

 

Plugin installed successfully

Plugin installed successfully

 

Using Plugins

After the plugin is installed, you can click the shortcut icon it creates on the MainPage to open its management interface, where you can configure and manage the plugin.

Click the shortcut icon on the MainPage to open the plugin

Click the shortcut icon on the MainPage to open the plugin

 
The SQLTelebot plugin management interface

The SQLTelebot plugin management interface

 
Note: For detailed usage, please refer to the documentation of the corresponding plugin.
 

Uninstalling Plugins

If a plugin is no longer in use, you can uninstall it to free system resources. Go to Task Manager, click "Plugin Management", find the plugin, and click "Uninstall" on the right.

Uninstall plugin

Uninstall plugin

 
Note: When uninstalling a plugin, the system only removes plugin tasks, not plugin data. To re-enable the plugin, simply reinstall it.
 

FAQ

  • Are plugins charged separately?
    Standard plugins are free. Simple custom requirements are usually free. For high-complexity, high-workload requirements, we will decide whether to charge after evaluating development effort.

  • Can plugins be updated? How?
    Plugins support updates. When a new version is available, uninstall the old version and reinstall the new one. Plugin data will not be deleted during uninstallation.

  • Can I develop my own plugins?
    Plugin development is relatively complex, so user-developed plugins are not currently supported. We will simplify the development process in the future, allowing you to create your own plugins. For now, we recommend submitting your requirements to our team for development.

  • Will installing multiple plugins affect system performance?
    Generally not. Plugins consume only a small amount of resources when running tasks; they use almost no resources when idle. If too many plugins run simultaneously, you can uninstall unused ones to ensure smooth performance.

Reposted from https://www.sqlmessenger.com/docreader.html?id=602

Top comments (0)