database/mariadb
1
0
Fork 0
mirror of https://github.com/MariaDB/server.git synced 2025-08-08 11:22:35 +03:00
Code Activity

EXAMPLE storage engine: update comments

Browse Source
This commit is contained in:
Federico Razzoli
2023-08-14 20:56:27 +01:00
committed by Daniel Black
parent 0254eb9307
commit e666b8651a
2 changed files with 21 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
storage/example/ha_example.h
View File

@@ -62,7 +62,7 @@ public:
*/
class ha_example: public handler
{
THR_LOCK_DATA lock; ///< MySQL lock
THR_LOCK_DATA lock; ///< MariaDB lock
Example_share *share; ///< Shared lock info
Example_share *get_share(); ///< Get the share
@@ -97,7 +97,7 @@ public:
@details
part is the key part to check. First key part is 0.
If all_parts is set, MySQL wants to know the flags for the combined
If all_parts is set, MariaDB wants to know the flags for the combined
index, up to and including 'part'.
*/
ulong index_flags(uint inx, uint part, bool all_parts) const
@@ -109,7 +109,7 @@ public:
unireg.cc will call max_supported_record_length(), max_supported_keys(),
max_supported_key_parts(), uint max_supported_key_length()
to make sure that the storage engine can handle the data it is about to
send. Return *real* limits of your storage engine here; MySQL will do
send. Return *real* limits of your storage engine here; MariaDB will do
min(your_limits, MySQL_limits) automatically.
*/
uint max_supported_record_length() const { return HA_MAX_REC_LENGTH; }
@@ -117,7 +117,7 @@ public:
/** @brief
unireg.cc will call this to make sure that the storage engine can handle
the data it is about to send. Return *real* limits of your storage engine
here; MySQL will do min(your_limits, MySQL_limits) automatically.
here; MariaDB will do min(your_limits, MySQL_limits) automatically.
@details
There is no need to implement ..._key_... methods if your engine doesn't
@@ -128,7 +128,7 @@ public:
/** @brief
unireg.cc will call this to make sure that the storage engine can handle
the data it is about to send. Return *real* limits of your storage engine
here; MySQL will do min(your_limits, MySQL_limits) automatically.
here; MariaDB will do min(your_limits, MySQL_limits) automatically.
@details
There is no need to implement ..._key_... methods if your engine doesn't
@@ -139,7 +139,7 @@ public:
/** @brief
unireg.cc will call this to make sure that the storage engine can handle
the data it is about to send. Return *real* limits of your storage engine
here; MySQL will do min(your_limits, MySQL_limits) automatically.
here; MariaDB will do min(your_limits, MySQL_limits) automatically.
@details
There is no need to implement ..._key_... methods if your engine doesn't
@@ -187,7 +187,7 @@ public:
Everything below are methods that we implement in ha_example.cc.
Most of these methods are not obligatory, skip them and
MySQL will treat them as not implemented
MariaDB will treat them as not implemented
*/
/** @brief
We implement this in ha_example.cc; it's a required method.
@@ -201,50 +201,50 @@ public:
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int write_row(const uchar *buf);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int update_row(const uchar *old_data, const uchar *new_data);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int delete_row(const uchar *buf);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int index_read_map(uchar *buf, const uchar *key,
key_part_map keypart_map, enum ha_rkey_function find_flag);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int index_next(uchar *buf);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int index_prev(uchar *buf);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int index_first(uchar *buf);
/** @brief
We implement this in ha_example.cc. It's not an obligatory method;
skip it and and MySQL will treat it as not implemented.
skip it and and MariaDB will treat it as not implemented.
*/
int index_last(uchar *buf);