> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/server/reference/sql-structure/nosql/handlersocket/handlersocket-installation.md).

# HandlerSocket Installation

After MariaDB is installed, use the [INSTALL PLUGIN](/docs/server/reference/sql-statements/administrative-sql-statements/plugin-sql-statements/install-plugin.md) command (as the root user) to install\
the HandlerSocket plugin. This command only needs to be run once, like so:

```sql
INSTALL PLUGIN handlersocket SONAME 'handlersocket.so';
```

After installing the plugin, [SHOW PROCESSLIST](/docs/server/reference/sql-statements/administrative-sql-statements/show/show-processlist.md) shows you first need to configure some settings. All [HandlerSocket configuration options](/docs/server/reference/sql-structure/nosql/handlersocket/handlersocket-configuration-options.md) are placed in the `[mysqld]` section of your `my.cnf` file.

At least the [handlersocket\_address](/docs/server/reference/sql-structure/nosql/handlersocket/handlersocket-configuration-options.md#handlersocket_address), [handlersocket\_port](/docs/server/reference/sql-structure/nosql/handlersocket/handlersocket-configuration-options.md#handlersocket_port) and [handlersocket\_port\_wr](/docs/server/reference/sql-structure/nosql/handlersocket/handlersocket-configuration-options.md#handlersocket_port_wr) options need to be set:

```ini
handlersocket_address="127.0.0.1"
handlersocket_port="9998"
handlersocket_port_wr="9999"
```

After updating the configuration options, restart MariaDB.

On the client side, to make use of the plugin you will need to install the appropriate client library (that is, libhsclient for C++ applications and perl-Net-HandlerSocket for perl applications).

<sub>*This page is licensed: CC BY-SA / Gnu FDL*</sub>

{% @marketo/form formId="4316" %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mariadb.com/docs/server/reference/sql-structure/nosql/handlersocket/handlersocket-installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.