Extending MySQL 5.7

Abstract

This document describes what you need to know when working on the MySQL 5.7 code. To track or contribute to MySQL development, follow the instructions in Installing MySQL Using a Development Source Tree. If you are interested in MySQL internals, you should also join the MySQL Community Slack. Feel free to ask questions about the code and to send patches that you would like to contribute to the MySQL project!

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Document generated on: 2025-05-30 (revision: 82263)

Table of Contents

Preface and Legal Notices

1 Introduction

2 MySQL Threads

3 The MySQL Test Suite

4 The MySQL Plugin API

4.1 Types of Plugins

4.2 Plugin API Characteristics

4.3 Plugin API Components

4.4 Writing Plugins

4.4.1 Overview of Plugin Writing

4.4.2 Plugin Data Structures

4.4.3 Compiling and Installing Plugin Libraries

4.4.4 Writing Full-Text Parser Plugins

4.4.5 Writing Daemon Plugins

4.4.6 Writing INFORMATION_SCHEMA Plugins

4.4.7 Writing Semisynchronous Replication Plugins

4.4.8 Writing Audit Plugins

4.4.9 Writing Authentication Plugins

4.4.10 Writing Password-Validation Plugins

4.4.11 Writing Protocol Trace Plugins

4.4.12 Writing Keyring Plugins

5 MySQL Services for Plugins

6 Adding Functions to MySQL

6.1 Adding a Native Function

6.2 Adding a Loadable Function

7 Porting MySQL

Index