MySQL 8.3.0
Source Code Documentation
ha_example.h File Reference

The ha_example engine is a stubbed storage engine for example purposes only; it does nothing at this point. More...

#include <sys/types.h>
#include "my_base.h"
#include "my_compiler.h"
#include "my_inttypes.h"
#include "sql/handler.h"
#include "thr_lock.h"

Go to the source code of this file.

Classes

class  Example_share
 Example_share is a class that will be shared among all open handlers. More...
 
class  ha_example
 Class definition for the storage engine. More...
 

Detailed Description

The ha_example engine is a stubbed storage engine for example purposes only; it does nothing at this point.

Its purpose is to provide a source code illustration of how to begin writing new storage engines; see also /storage/example/ha_example.cc.

Note
Please read ha_example.cc before reading this file. Reminder: The example storage engine implements all methods that are required* to be implemented. For a full list of all methods that you can implement, see handler.h.
See also
/sql/handler.h and /storage/example/ha_example.cc