MySQL 9.0.0
Source Code Documentation
ft_global.h File Reference

Some definitions for full-text indices. More...

#include <sys/types.h>
#include "my_base.h"
#include "my_inttypes.h"
#include "mysql/strings/m_ctype.h"

Go to the source code of this file.

Classes

struct  _ft_vft
 
struct  _ft_vft_ext
 
struct  FT_INFO
 
struct  FT_INFO_EXT
 
struct  ft_hints
 Info about FULLTEXT index hints, passed to the storage engine. More...
 

Macros

#define HA_FT_MAXBYTELEN   336
 
#define HA_FT_MAXCHARLEN   (HA_FT_MAXBYTELEN / 4)
 
#define DEFAULT_FTB_SYNTAX   "+ -><()~*:\"\"&|"
 
#define FTS_ORDERED_RESULT   (1LL << 1)
 
#define FTS_DOCID_IN_RESULT   (1LL << 2)
 
#define FTS_DOC_ID_COL_NAME   "FTS_DOC_ID"
 
#define FTS_NGRAM_PARSER_NAME   "ngram"
 
#define FT_NL   0 /** Normal mode */
 
#define FT_BOOL   1 /** Boolean mode */
 
#define FT_SORTED   2 /** perform internal sorting by rank */
 
#define FT_EXPAND   4 /** query expansion */
 
#define FT_NO_RANKING   8 /** skip rank calculation */
 

Enumerations

enum  ft_operation { FT_OP_UNDEFINED , FT_OP_NO , FT_OP_GT , FT_OP_GE }
 Operation types, used in FT_HINTS. More...
 

Functions

int ft_init_stopwords (void)
 
void ft_free_stopwords (void)
 
FT_INFOft_init_search (uint, void *, uint, uchar *, uint, const CHARSET_INFO *, uchar *)
 
bool ft_boolean_check_syntax_string (const uchar *)
 

Variables

const char * ft_stopword_file
 
const char * ft_precompiled_stopwords []
 
ulong ft_min_word_len
 
ulong ft_max_word_len
 
ulong ft_query_expansion_limit
 
const char * ft_boolean_syntax
 
struct st_mysql_ftparser ft_default_parser
 

Detailed Description

Some definitions for full-text indices.

Macro Definition Documentation

◆ DEFAULT_FTB_SYNTAX

#define DEFAULT_FTB_SYNTAX   "+ -><()~*:\"\"&|"

◆ FT_BOOL

#define FT_BOOL   1 /** Boolean mode */

◆ FT_EXPAND

#define FT_EXPAND   4 /** query expansion */

◆ FT_NL

#define FT_NL   0 /** Normal mode */

◆ FT_NO_RANKING

#define FT_NO_RANKING   8 /** skip rank calculation */

◆ FT_SORTED

#define FT_SORTED   2 /** perform internal sorting by rank */

◆ FTS_DOC_ID_COL_NAME

#define FTS_DOC_ID_COL_NAME   "FTS_DOC_ID"

◆ FTS_DOCID_IN_RESULT

#define FTS_DOCID_IN_RESULT   (1LL << 2)

◆ FTS_NGRAM_PARSER_NAME

#define FTS_NGRAM_PARSER_NAME   "ngram"

◆ FTS_ORDERED_RESULT

#define FTS_ORDERED_RESULT   (1LL << 1)

◆ HA_FT_MAXBYTELEN

#define HA_FT_MAXBYTELEN   336

◆ HA_FT_MAXCHARLEN

#define HA_FT_MAXCHARLEN   (HA_FT_MAXBYTELEN / 4)

Enumeration Type Documentation

◆ ft_operation

Operation types, used in FT_HINTS.

Enumerator
FT_OP_UNDEFINED 
FT_OP_NO 

Operation undefined, use of hints is impossible.

FT_OP_GT 

No operation, single MATCH function.

FT_OP_GE 

'Greater than' operation

'Greater than or equal to' operation

Function Documentation

◆ ft_boolean_check_syntax_string()

bool ft_boolean_check_syntax_string ( const uchar str)

◆ ft_free_stopwords()

void ft_free_stopwords ( void  )

◆ ft_init_search()

FT_INFO * ft_init_search ( uint  flags,
void *  info,
uint  keynr,
uchar query,
uint  query_len,
const CHARSET_INFO cs,
uchar record 
)

◆ ft_init_stopwords()

int ft_init_stopwords ( void  )

Variable Documentation

◆ ft_boolean_syntax

const char* ft_boolean_syntax
extern

◆ ft_default_parser

struct st_mysql_ftparser ft_default_parser
extern

◆ ft_max_word_len

ulong ft_max_word_len
extern

◆ ft_min_word_len

ulong ft_min_word_len
extern

◆ ft_precompiled_stopwords

const char* ft_precompiled_stopwords[]
extern

◆ ft_query_expansion_limit

ulong ft_query_expansion_limit
extern

◆ ft_stopword_file

const char* ft_stopword_file
extern