Handlers

​

What are Handlers?

At the heart of the MindsDB philosophy lies the belief that predictive insights are best leveraged when produced as close as possible to the data layer. Usually, this data layer is a SQL-compatible database, but it could also be a non-SQL database, data stream, or any other tool that interacts with data stored somewhere else.

The above description fits an enormous set of tools used across the software industry. The complexity increases further by bringing Machine Learning into the equation, as the set of popular ML tools is similarly huge. We aim to support most technology stacks, requiring a simple integration procedure so that anyone can easily contribute the necessary glue to enable any predictive system for usage within data layers.

This motivates the concept of handlers, which is an abstraction for the two types of entities mentioned above: data layers and ML frameworks. Handlers are meant to enforce a common and sufficient set of behaviors that all MindsDB-compatible entities should support. By creating a handler, the target system is effectively integrated into the wider MindsDB ecosystem.

​

Types of Handlers

​

Data Handlers

Data handlers act as a bridge to any database. You use data handlers to connect data sources, including databases and applications, using the CREATE DATABASE command. So you can reach data from any database that has its handler implemented within MindsDB.

​

Machine Learning (ML) Handlers

ML handlers act as a bridge to any ML framework. You use ML handlers to create ML engines using the CREATE ML_ENGINE command. So you can expose ML models from any supported ML engine as an AI table.

​

Handlers in the MindsDB Repository

The source code for integrations is located in the main MindsDB repository under the /integrations directory.

integrations                      # Contains handlers' source codes
├─ handlers/                      # Each handler has its own handler directory
│  ├─ mysql_handler/              # MySQL integration code
│  ├─ lightwood_handler/          # Lightwood integration code
│  ├─  .../                       # Other handlers
├─ handlers_client/               # Handler clients directory
│  ├─ db_client/              
│  ├─ ml_client/              
├─ libs/                          # Handler libraries directory
│  ├─ base.py                     # Each handler class inherits from one of the base classes
└─ utilities                      # Handler utility directory
│  ├─ install.py                  # Script that installs all handler dependencies

​

Structure of a Handler

In technical terms, a handler is a self-contained Python package having everything required for MindsDB to interact with it. It includes aspects like dependencies, unit tests, and continuous integration logic. It is up to the author to determine the nature of the package, for example, closed or open source, version control, and more. Although, we encourage opening pull requests to expand the default set of supported tools.

The entry point for a data handler is a class definition that should inherit directly from the mindsdb.integrations.libs.base.DatabaseHandler class and thus indirectly from the mindsdb.integrations.libs.base.BaseHandler class, which defines all the methods that must be overwritten in order to achieve a functional implementation.

And the entry point for an ML handler is a class definition that should inherit from the mindsdb.integrations.libs.base.BaseMLEngine class, which defines all the methods that must be overwritten in order to achieve a functional implementation.

​

Things to Remember

Here are a few points to keep in mind while implementing a handler.

​

Handlers Inherit from Base Classes

Inherit from the DatabaseHandler class when adding a new data handler. For more info, visit our doc page here.

Inherit from the BaseMLEngine class when adding a new ML handler. For more info, visit our doc page here.

​

Parsing SQL

Whenever you want to parse a string that contains SQL, we strongly recommend using the mindsdb_sql package. It provides a parser that fully supports the MindsDB SQL dialect and partially the standard SQL dialect. There is also a render feature to map other dialects into the already supported ones.

​

Formatting Output

In the case of data handlers, when it comes to building the response of the public methods, the output should be wrapped by the mindsdb.integrations.libs.response.HandlerResponse or mindsdb.integrations.libs.response.HandlerStatusResponse class. These classes are used by the MindsDB executioner to orchestrate and coordinate multiple handler instances in parallel.

And in the case of ML handlers, output wrapping is automatically done by an intermediate wrapper, the BaseMLEngineExec class, so the contributor wouldn’t need to worry about it.