MySQL 8.0.39
Source Code Documentation
fts_doc_t Struct Reference

This type represents a single document field. More...

#include <fts0types.h>

Public Attributes

fts_string_t text
 document text More...
 
bool found
 true if the document was found successfully in the database More...
 
ib_rbt_ttokens
 This is filled when the document is tokenized. More...
 
ib_alloc_tself_heap
 An instance of this type is allocated from this heap along with any objects that have the same lifespan, most notably the vector of token positions. More...
 
CHARSET_INFOcharset
 Document's charset info. More...
 
st_mysql_ftparserparser
 fts plugin parser More...
 
bool is_ngram
 Whether it is a ngram parser. More...
 
ib_rbt_tstopwords
 Stopwords. More...
 

Detailed Description

This type represents a single document field.

When fulltext index spans multiple columns, the entire document (all indexed text in a row) is comprised of multiple fields, one per indexed column.

Member Data Documentation

◆ charset

CHARSET_INFO* fts_doc_t::charset

Document's charset info.

◆ found

bool fts_doc_t::found

true if the document was found successfully in the database

◆ is_ngram

bool fts_doc_t::is_ngram

Whether it is a ngram parser.

◆ parser

st_mysql_ftparser* fts_doc_t::parser

fts plugin parser

◆ self_heap

ib_alloc_t* fts_doc_t::self_heap

An instance of this type is allocated from this heap along with any objects that have the same lifespan, most notably the vector of token positions.

◆ stopwords

ib_rbt_t* fts_doc_t::stopwords

Stopwords.

◆ text

fts_string_t fts_doc_t::text

document text

◆ tokens

ib_rbt_t* fts_doc_t::tokens

This is filled when the document is tokenized.

Tokens; indexed by fts_string_t*, cells are of type fts_token_t*


The documentation for this struct was generated from the following file: