MySQL 8.4.2
Source Code Documentation
fts_query_t Struct Reference

State of an FTS query. More...

Public Attributes

mem_heap_theap
 Heap to use for allocations. More...
 
trx_ttrx
 The query transaction. More...
 
dict_index_tindex
 The FTS index to search. More...
 
fts_table_t fts_common_table
 
fts_table_t fts_index_table
 FTS auxiliary index table def. More...
 
ulint total_size
 total memory size used by query More...
 
fts_doc_ids_tdeleted
 Deleted doc ids that need to be filtered from the output. More...
 
fts_ast_node_troot
 Abstract syntax tree. More...
 
fts_ast_node_tcur_node
 Current tree node. More...
 
ib_rbt_tword_map
 Matched word map for searching by word. More...
 
word_vector_tword_vector
 Matched word vector for searching by index. More...
 
ib_rbt_tdoc_ids
 The current set of matching doc ids, elements are of type fts_ranking_t. More...
 
ib_rbt_tintersection
 The doc ids that were found in doc_ids, this tree will become the new doc_ids, elements are of type fts_ranking_t. More...
 
que_tread_nodes_graph
 
fts_ast_oper_t oper
 Current boolean mode operator. More...
 
bool collect_positions
 
ulint flags
 Specify the full text search type, such as boolean search, phrase search, proximity search etc. More...
 
ulint distance
 The proximity distance of a phrase search. More...
 
doc_id_t lower_doc_id
 Lowest doc id in doc_ids. More...
 
doc_id_t upper_doc_id
 Highest doc id in doc_ids. More...
 
bool boolean_mode
 true if boolean mode query More...
 
ib_vector_tmatched
 Array of matching documents (fts_match_t) to search for a phrase. More...
 
ib_vector_t ** match_array
 Used for proximity search, contains position info for each matched word in the word list. More...
 
uint64_t total_docs
 The total number of documents. More...
 
ulint total_words
 The total number of words. More...
 
dberr_t error
 Error code if any, that is encountered during query processing. More...
 
ib_rbt_tword_freqs
 RB tree of word frequencies per document, its elements are of type fts_word_freq_t. More...
 
ib_rbt_twildcard_words
 words with wildcard More...
 
bool multi_exist
 multiple FTS_EXIST oper More...
 
st_mysql_ftparserparser
 fts plugin parser More...
 
ulonglong limit
 limit value for the fts query More...
 
ulonglong n_docs
 number of docs fetched by query. More...
 
ulint nested_exp_count
 number of nested sub expression limit More...
 

Detailed Description

State of an FTS query.

Member Data Documentation

◆ boolean_mode

bool fts_query_t::boolean_mode

true if boolean mode query

◆ collect_positions

bool fts_query_t::collect_positions

◆ cur_node

fts_ast_node_t* fts_query_t::cur_node

Current tree node.

◆ deleted

fts_doc_ids_t* fts_query_t::deleted

Deleted doc ids that need to be filtered from the output.

◆ distance

ulint fts_query_t::distance

The proximity distance of a phrase search.

These doc ids are used as a boundary condition when searching the FTS index rows

◆ doc_ids

ib_rbt_t* fts_query_t::doc_ids

The current set of matching doc ids, elements are of type fts_ranking_t.

◆ error

dberr_t fts_query_t::error

Error code if any, that is encountered during query processing.

◆ flags

ulint fts_query_t::flags

Specify the full text search type, such as boolean search, phrase search, proximity search etc.

◆ fts_common_table

fts_table_t fts_query_t::fts_common_table

◆ fts_index_table

fts_table_t fts_query_t::fts_index_table

FTS auxiliary index table def.

◆ heap

mem_heap_t* fts_query_t::heap

Heap to use for allocations.

◆ index

dict_index_t* fts_query_t::index

The FTS index to search.

FTS auxiliary common table def

◆ intersection

ib_rbt_t* fts_query_t::intersection

The doc ids that were found in doc_ids, this tree will become the new doc_ids, elements are of type fts_ranking_t.

Prepared statement to read the nodes from the FTS INDEX

◆ limit

ulonglong fts_query_t::limit

limit value for the fts query

◆ lower_doc_id

doc_id_t fts_query_t::lower_doc_id

Lowest doc id in doc_ids.

◆ match_array

ib_vector_t** fts_query_t::match_array

Used for proximity search, contains position info for each matched word in the word list.

◆ matched

ib_vector_t* fts_query_t::matched

Array of matching documents (fts_match_t) to search for a phrase.

◆ multi_exist

bool fts_query_t::multi_exist

multiple FTS_EXIST oper

◆ n_docs

ulonglong fts_query_t::n_docs

number of docs fetched by query.

This is to restrict the result with limit value

◆ nested_exp_count

ulint fts_query_t::nested_exp_count

number of nested sub expression limit

◆ oper

fts_ast_oper_t fts_query_t::oper

Current boolean mode operator.

true if we want to collect the word positions within the document

◆ parser

st_mysql_ftparser* fts_query_t::parser

fts plugin parser

◆ read_nodes_graph

que_t* fts_query_t::read_nodes_graph

◆ root

fts_ast_node_t* fts_query_t::root

Abstract syntax tree.

◆ total_docs

uint64_t fts_query_t::total_docs

The total number of documents.

◆ total_size

ulint fts_query_t::total_size

total memory size used by query

◆ total_words

ulint fts_query_t::total_words

The total number of words.

◆ trx

trx_t* fts_query_t::trx

The query transaction.

◆ upper_doc_id

doc_id_t fts_query_t::upper_doc_id

Highest doc id in doc_ids.

◆ wildcard_words

ib_rbt_t* fts_query_t::wildcard_words

words with wildcard

◆ word_freqs

ib_rbt_t* fts_query_t::word_freqs

RB tree of word frequencies per document, its elements are of type fts_word_freq_t.

◆ word_map

ib_rbt_t* fts_query_t::word_map

Matched word map for searching by word.

◆ word_vector

word_vector_t* fts_query_t::word_vector

Matched word vector for searching by index.


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