Skip navigation links

Learn about new MySQL releases, technical articles, events and more.

Subscribe Now »
MySQL 5.1: mysql/src/5.1-dbg/include/mysql/plugin.h File Reference

mysql/src/5.1-dbg/include/mysql/plugin.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


Classes

struct  st_mysql_show_var
struct  st_mysql_plugin
struct  st_mysql_ftparser_boolean_info
struct  st_mysql_ftparser_param
struct  st_mysql_ftparser
struct  st_mysql_storage_engine

Defines

#define MYSQL_PLUGIN_INTERFACE_VERSION   0x0001
#define MYSQL_UDF_PLUGIN   0
#define MYSQL_STORAGE_ENGINE_PLUGIN   1
#define MYSQL_FTPARSER_PLUGIN   2
#define MYSQL_MAX_PLUGIN_TYPE_NUM   3
#define __attribute__(A)
#define __MYSQL_DECLARE_PLUGIN(NAME, VERSION, PSIZE, DECLS)
#define mysql_declare_plugin(NAME)
#define mysql_declare_plugin_end   ,{0,0,0,0,0,0,0,0,0}}
#define SHOW_VAR_FUNC_BUFF_SIZE   1024
#define MYSQL_FTPARSER_INTERFACE_VERSION   0x0100
#define MYSQL_FTFLAGS_NEED_COPY   1
#define MYSQL_HANDLERTON_INTERFACE_VERSION   (MYSQL_VERSION_ID << 8)

Typedefs

typedef int(*) mysql_show_var_func (void *, struct st_mysql_show_var *, char *)
typedef st_mysql_ftparser_boolean_info MYSQL_FTPARSER_BOOLEAN_INFO
typedef st_mysql_ftparser_param MYSQL_FTPARSER_PARAM

Enumerations

enum  enum_mysql_show_type {
  SHOW_UNDEF, SHOW_BOOL, SHOW_INT, SHOW_LONG,
  SHOW_LONGLONG, SHOW_CHAR, SHOW_CHAR_PTR, SHOW_ARRAY,
  SHOW_FUNC
}
enum  enum_ftparser_mode { MYSQL_FTPARSER_SIMPLE_MODE = 0, MYSQL_FTPARSER_WITH_STOPWORDS = 1, MYSQL_FTPARSER_FULL_BOOLEAN_INFO = 2 }
enum  enum_ft_token_type {
  FT_TOKEN_EOF = 0, FT_TOKEN_WORD = 1, FT_TOKEN_LEFT_PAREN = 2, FT_TOKEN_RIGHT_PAREN = 3,
  FT_TOKEN_STOPWORD = 4
}

Define Documentation

#define __attribute__ ( A   ) 

Definition at line 35 of file plugin.h.

#define __MYSQL_DECLARE_PLUGIN ( NAME,
VERSION,
PSIZE,
DECLS   ) 

Value:

int VERSION= MYSQL_PLUGIN_INTERFACE_VERSION;                                  \
int PSIZE= sizeof(struct st_mysql_plugin);                                    \
struct st_mysql_plugin DECLS[]= {

Definition at line 46 of file plugin.h.

#define mysql_declare_plugin ( NAME   ) 

Value:

__MYSQL_DECLARE_PLUGIN(NAME, \
                 builtin_ ## NAME ## _plugin_interface_version, \
                 builtin_ ## NAME ## _sizeof_struct_st_plugin, \
                 builtin_ ## NAME ## _plugin)

Definition at line 57 of file plugin.h.

#define mysql_declare_plugin_end   ,{0,0,0,0,0,0,0,0,0}}

Definition at line 63 of file plugin.h.

#define MYSQL_FTFLAGS_NEED_COPY   1

Definition at line 218 of file plugin.h.

Referenced by ft_add_word(), and ft_init_nlq_search().

#define MYSQL_FTPARSER_INTERFACE_VERSION   0x0100

Definition at line 105 of file plugin.h.

#define MYSQL_FTPARSER_PLUGIN   2

Definition at line 31 of file plugin.h.

Referenced by mysql_declare_plugin(), and open_binary_frm().

#define MYSQL_HANDLERTON_INTERFACE_VERSION   (MYSQL_VERSION_ID << 8)

Definition at line 295 of file plugin.h.

#define MYSQL_MAX_PLUGIN_TYPE_NUM   3

Definition at line 32 of file plugin.h.

Referenced by plugin_add(), plugin_find_internal(), plugin_free(), and plugin_init().

#define MYSQL_PLUGIN_INTERFACE_VERSION   0x0001

Definition at line 24 of file plugin.h.

Referenced by free_plugin_mem(), and plugin_dl_add().

#define MYSQL_STORAGE_ENGINE_PLUGIN   1

Definition at line 30 of file plugin.h.

Referenced by fill_schema_engines(), fill_schema_files(), ha_close_connection(), ha_commit_or_rollback_by_xid(), ha_drop_database(), ha_flush_logs(), ha_known_exts(), ha_panic(), ha_recover(), ha_release_temporary_latches(), ha_resolve_by_name(), ha_show_status(), ha_start_consistent_snapshot(), mysql_declare_plugin(), mysqld_show_storage_engines(), and plugin_finalize().

#define MYSQL_UDF_PLUGIN   0

Definition at line 29 of file plugin.h.

#define SHOW_VAR_FUNC_BUFF_SIZE   1024

Definition at line 81 of file plugin.h.

Referenced by show_status_array().

Typedef Documentation

typedef struct st_mysql_ftparser_boolean_info MYSQL_FTPARSER_BOOLEAN_INFO

typedef struct st_mysql_ftparser_param MYSQL_FTPARSER_PARAM

typedef int(*) mysql_show_var_func(void *, struct st_mysql_show_var *, char *)

Definition at line 82 of file plugin.h.

Enumeration Type Documentation

enum enum_ft_token_type

Enumerator:
FT_TOKEN_EOF 
FT_TOKEN_WORD 
FT_TOKEN_LEFT_PAREN 
FT_TOKEN_RIGHT_PAREN 
FT_TOKEN_STOPWORD 

Definition at line 156 of file plugin.h.

00157 {
00158   FT_TOKEN_EOF= 0,
00159   FT_TOKEN_WORD= 1,
00160   FT_TOKEN_LEFT_PAREN= 2,
00161   FT_TOKEN_RIGHT_PAREN= 3,
00162   FT_TOKEN_STOPWORD= 4
00163 };

enum enum_ftparser_mode

Enumerator:
MYSQL_FTPARSER_SIMPLE_MODE 
MYSQL_FTPARSER_WITH_STOPWORDS 
MYSQL_FTPARSER_FULL_BOOLEAN_INFO 

Definition at line 108 of file plugin.h.

00109 {
00110 /*
00111   Fast and simple mode.  This mode is used for indexing, and natural
00112   language queries.
00113 
00114   The parser is expected to return only those words that go into the
00115   index. Stopwords or too short/long words should not be returned. The
00116   'boolean_info' argument of mysql_add_word() does not have to be set.
00117 */
00118   MYSQL_FTPARSER_SIMPLE_MODE= 0,
00119 
00120 /*
00121   Parse with stopwords mode.  This mode is used in boolean searches for
00122   "phrase matching."
00123 
00124   The parser is not allowed to ignore words in this mode.  Every word
00125   should be returned, including stopwords and words that are too short
00126   or long.  The 'boolean_info' argument of mysql_add_word() does not
00127   have to be set.
00128 */
00129   MYSQL_FTPARSER_WITH_STOPWORDS= 1,
00130 
00131 /*
00132   Parse in boolean mode.  This mode is used to parse a boolean query string.
00133 
00134   The parser should provide a valid MYSQL_FTPARSER_BOOLEAN_INFO
00135   structure in the 'boolean_info' argument to mysql_add_word().
00136   Usually that means that the parser should recognize boolean operators
00137   in the parsing stream and set appropriate fields in
00138   MYSQL_FTPARSER_BOOLEAN_INFO structure accordingly.  As for
00139   MYSQL_FTPARSER_WITH_STOPWORDS mode, no word should be ignored.
00140   Instead, use FT_TOKEN_STOPWORD for the token type of such a word.
00141 */
00142   MYSQL_FTPARSER_FULL_BOOLEAN_INFO= 2
00143 };

enum enum_mysql_show_type

Enumerator:
SHOW_UNDEF 
SHOW_BOOL 
SHOW_INT 
SHOW_LONG 
SHOW_LONGLONG 
SHOW_CHAR 
SHOW_CHAR_PTR 
SHOW_ARRAY 
SHOW_FUNC 

Definition at line 68 of file plugin.h.

00069 {
00070   SHOW_UNDEF, SHOW_BOOL, SHOW_INT, SHOW_LONG,
00071   SHOW_LONGLONG, SHOW_CHAR, SHOW_CHAR_PTR,
00072   SHOW_ARRAY, SHOW_FUNC
00073 };

Generated on Sat Sep 9 01:46:29 2006 for MySQL 5.1 by  doxygen 1.4.7