fts0priv.h

Go to the documentation of this file.

/*****************************************************************************
 
Copyright (c) 2011, 2024, Oracle and/or its affiliates.
 
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License, version 2.0, as published by the
Free Software Foundation.
 
This program is designed to work with certain software (including
but not limited to OpenSSL) that is licensed under separate terms,
as designated in a particular file or component or in included license
documentation.  The authors of MySQL hereby grant you an additional
permission to link the program and your derivative works with the
separately licensed software that they have either included with
the program or referenced in the documentation.
 
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
for more details.
 
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 
*****************************************************************************/
 
/** @file include/fts0priv.h
 Full text search internal header file
 
 Created 2011/09/02 Sunny Bains
 ***********************************************************************/
 
#ifndef INNOBASE_FTS0PRIV_H
#define INNOBASE_FTS0PRIV_H
 
#include "dict0dict.h"
#include "fts0types.h"
#include "pars0pars.h"
#include "que0que.h"
#include "que0types.h"
#include "univ.i"
 
/* The various states of the FTS sub system pertaining to a table with
FTS indexes defined on it. */
enum fts_table_state_enum {
  /* !<This must be 0 since we insert
  a hard coded '0' at create time
  to the config table */
 
  FTS_TABLE_STATE_RUNNING = 0, /*!< Auxiliary tables created OK */
 
  FTS_TABLE_STATE_OPTIMIZING, /*!< This is a substate of RUNNING */
 
  FTS_TABLE_STATE_DELETED /*!< All aux tables to be dropped when
                          it's safe to do so */
};
 
typedef enum fts_table_state_enum fts_table_state_t;
 
/** The default time to wait for the background thread. */
constexpr std::chrono::milliseconds FTS_MAX_BACKGROUND_THREAD_WAIT{10};
 
/** Maximum number of iterations to wait before we complain */
#define FTS_BACKGROUND_THREAD_WAIT_COUNT 1000
 
/** The maximum length of the config table's value column in bytes */
#define FTS_MAX_CONFIG_NAME_LEN 64
 
/** The maximum length of the config table's value column in bytes */
#define FTS_MAX_CONFIG_VALUE_LEN 1024
 
/** Approx. upper limit of ilist length in bytes. */
#define FTS_ILIST_MAX_SIZE (64 * 1024)
 
/** FTS config table name parameters */
 
/** The number of seconds after which an OPTIMIZE run will stop */
#define FTS_OPTIMIZE_LIMIT_IN_SECS "optimize_checkpoint_limit"
 
/** The next doc id */
#define FTS_SYNCED_DOC_ID "synced_doc_id"
 
/** The last word that was OPTIMIZED */
#define FTS_LAST_OPTIMIZED_WORD "last_optimized_word"
 
/** Total number of documents that have been deleted. The next_doc_id
minus this count gives us the total number of documents. */
#define FTS_TOTAL_DELETED_COUNT "deleted_doc_count"
 
/** Total number of words parsed from all documents */
#define FTS_TOTAL_WORD_COUNT "total_word_count"
 
/** Start of optimize of an FTS index */
#define FTS_OPTIMIZE_START_TIME "optimize_start_time"
 
/** End of optimize for an FTS index */
#define FTS_OPTIMIZE_END_TIME "optimize_end_time"
 
/** User specified stopword table name */
#define FTS_STOPWORD_TABLE_NAME "stopword_table_name"
 
/** Whether to use (turn on/off) stopword */
#define FTS_USE_STOPWORD "use_stopword"
 
/** State of the FTS system for this table. It can be one of
 RUNNING, OPTIMIZING, DELETED. */
#define FTS_TABLE_STATE "table_state"
 
/** The minimum length of an FTS auxiliary table names's id component
e.g., For an auxiliary table name
 
        "FTS_@<TABLE_ID@>_SUFFIX"
 
This constant is for the minimum length required to store the @<TABLE_ID@>
component.
*/
#define FTS_AUX_MIN_TABLE_ID_LENGTH 48
 
/** Maximum length of an integer stored in the config table value column. */
#define FTS_MAX_INT_LEN 32
 
/** Parse an SQL string. %s is replaced with the table's id.
 @return query graph */
[[nodiscard]] que_t *fts_parse_sql(
    fts_table_t *fts_table, /*!< in: FTS aux table */
    pars_info_t *info,      /*!< in: info struct, or NULL */
    const char *sql);       /*!< in: SQL string to evaluate */
 
/** Evaluate a parsed SQL statement
 @return DB_SUCCESS or error code */
[[nodiscard]] dberr_t fts_eval_sql(trx_t *trx,    /*!< in: transaction */
                                   que_t *graph); /*!< in: Parsed statement */
 
/** Construct the name of an ancillary FTS table for the given table.
 Caller must allocate enough memory(usually size of MAX_FULL_NAME_LEN)
 for param 'table_name'. */
void fts_get_table_name(
    const fts_table_t *fts_table, /*!< in: FTS aux table info */
    char *table_name);            /*!< in/out: aux table name */
 
/** Construct the name of an ancillary FTS table for the given table in
5.7 compatible format. Caller must allocate enough memory(usually size
of MAX_FULL_NAME_LEN) for param 'table_name'
@param[in]      fts_table       Auxiliary table object
@param[in,out]  table_name      aux table name */
void fts_get_table_name_5_7(const fts_table_t *fts_table, char *table_name);
 
/** Construct the column specification part of the SQL string for selecting the
 indexed FTS columns for the given table. Adds the necessary bound
 ids to the given 'info' and returns the SQL string. Examples:
 
 One indexed column named "text":
 
  "$sel0",
  info/ids: sel0 -> "text"
 
 Two indexed columns named "subject" and "content":
 
  "$sel0, $sel1",
  info/ids: sel0 -> "subject", sel1 -> "content",
 @return heap-allocated WHERE string */
[[nodiscard]] const char *fts_get_select_columns_str(
    dict_index_t *index, /*!< in: FTS index */
    pars_info_t *info,   /*!< in/out: parser info */
    mem_heap_t *heap);   /*!< in: memory heap */
 
/** define for fts_doc_fetch_by_doc_id() "option" value, defines whether
we want to get Doc whose ID is equal to or greater or smaller than supplied
ID */
#define FTS_FETCH_DOC_BY_ID_EQUAL 1
#define FTS_FETCH_DOC_BY_ID_LARGE 2
 
/** Fetch document (= a single row's indexed text) with the given
 document id.
 @return: DB_SUCCESS if fetch is successful, else error */
dberr_t fts_doc_fetch_by_doc_id(
    fts_get_doc_t *get_doc,     /*!< in: state */
    doc_id_t doc_id,            /*!< in: id of document to fetch */
    dict_index_t *index_to_use, /*!< in: caller supplied FTS index,
                                or NULL */
    ulint option,               /*!< in: search option, if it is
                                greater than doc_id or equal */
    fts_sql_callback callback,  /*!< in: callback to read
                                records */
    void *arg);                 /*!< in: callback arg */
 
/** Callback function for fetch that stores the text of an FTS document,
 converting each column to UTF-16.
 @return always false */
bool fts_query_expansion_fetch_doc(void *row,       /*!< in: sel_node_t* */
                                   void *user_arg); /*!< in: fts_doc_t* */
 
/********************************************************************
Write out a single word's data as new entry/entries in the INDEX table.
@return DB_SUCCESS if all OK. */
[[nodiscard]] dberr_t fts_write_node(
    trx_t *trx,             /*!< in: transaction */
    que_t **graph,          /*!< in: query graph */
    fts_table_t *fts_table, /*!< in: the FTS aux index */
    fts_string_t *word,     /*!< in: word in UTF-8 */
    fts_node_t *node);      /*!< in: node columns */
 
/** Check fts token
1. for ngram token, check whether the token contains any words in stopwords
2. for non-ngram token, check if it's stopword or less than fts_min_token_size
or greater than fts_max_token_size.
@param[in]      token           token string
@param[in]      stopwords       stopwords rb tree
@param[in]      is_ngram        is ngram parser
@param[in]      cs              token charset
@retval true    if it is not stopword and length in range
@retval false   if it is stopword or length not in range */
bool fts_check_token(const fts_string_t *token, const ib_rbt_t *stopwords,
                     bool is_ngram, const CHARSET_INFO *cs);
 
/** Initialize a document. */
void fts_doc_init(fts_doc_t *doc); /*!< in: doc to initialize */
 
/** Do a binary search for a doc id in the array
 @return +ve index if found -ve index where it should be
         inserted if not found */
[[nodiscard]] int fts_bsearch(fts_update_t *array, /*!< in: array to sort */
                              int lower,        /*!< in: lower bound of array*/
                              int upper,        /*!< in: upper bound of array*/
                              doc_id_t doc_id); /*!< in: doc id to lookup */
/** Free document. */
void fts_doc_free(fts_doc_t *doc); /*!< in: document */
 
/** Free fts_optimizer_word_t instanace.*/
void fts_word_free(fts_word_t *word); /*!< in: instance to free.*/
 
/** Read the rows from the FTS inde
 @return DB_SUCCESS or error code */
dberr_t fts_index_fetch_nodes(
    trx_t *trx,               /*!< in: transaction */
    que_t **graph,            /*!< in: prepared statement */
    fts_table_t *fts_table,   /*!< in: FTS aux table */
    const fts_string_t *word, /*!< in: the word to fetch */
    fts_fetch_t *fetch);      /*!< in: fetch callback.*/
 
/** Compare two fts_trx_table_t instances, we actually compare the
table id's here.
@param[in]      v1      id1
@param[in]      v2      id2
@return < 0 if n1 < n2, 0 if n1 == n2, > 0 if n1 > n2 */
static inline int fts_trx_table_cmp(const void *v1, const void *v2);
 
/** Compare a table id with a trx_table_t table id.
@param[in]      p1      id1
@param[in]      p2      id2
@return < 0 if n1 < n2, 0 if n1 == n2, > 0 if n1 > n2 */
static inline int fts_trx_table_id_cmp(const void *p1, const void *p2);
 
/** Commit a transaction.
 @return DB_SUCCESS if all OK */
dberr_t fts_sql_commit(trx_t *trx); /*!< in: transaction */
 
/** Rollback a transaction.
 @return DB_SUCCESS if all OK */
dberr_t fts_sql_rollback(trx_t *trx); /*!< in: transaction */
 
/** Get value from config table. The caller must ensure that enough
 space is allocated for value to hold the column contents
 @return DB_SUCCESS or error code */
dberr_t fts_config_get_value(
    trx_t *trx,             /* transaction */
    fts_table_t *fts_table, /*!< in: the indexed FTS table */
    const char *name,       /*!< in: get config value for
                            this parameter name */
    fts_string_t *value);   /*!< out: value read from
                            config table */
/** Get value specific to an FTS index from the config table. The caller
 must ensure that enough space is allocated for value to hold the
 column contents.
 @return DB_SUCCESS or error code */
[[nodiscard]] dberr_t fts_config_get_index_value(
    trx_t *trx,           /*!< transaction */
    dict_index_t *index,  /*!< in: index */
    const char *param,    /*!< in: get config value
                          for this parameter name */
    fts_string_t *value); /*!< out: value read
                         from config table */
 
/** Set the value in the config table for name.
 @return DB_SUCCESS or error code */
dberr_t fts_config_set_value(
    trx_t *trx,                 /*!< transaction */
    fts_table_t *fts_table,     /*!< in: the indexed FTS table */
    const char *name,           /*!< in: get config value for
                                this parameter name */
    const fts_string_t *value); /*!< in: value to update */
 
/** Set an ulint value in the config table.
 @return DB_SUCCESS if all OK else error code */
[[nodiscard]] dberr_t fts_config_set_ulint(
    trx_t *trx,             /*!< in: transaction */
    fts_table_t *fts_table, /*!< in: the indexed FTS table */
    const char *name,       /*!< in: param name */
    ulint int_value);       /*!< in: value */
 
/** Set the value specific to an FTS index in the config table.
 @return DB_SUCCESS or error code */
[[nodiscard]] dberr_t fts_config_set_index_value(
    trx_t *trx,           /*!< transaction */
    dict_index_t *index,  /*!< in: index */
    const char *param,    /*!< in: get config value
                          for this parameter name */
    fts_string_t *value); /*!< out: value read
                         from config table */
 
#ifdef FTS_OPTIMIZE_DEBUG
/** Get an ulint value from the config table.
 @return DB_SUCCESS or error code */
[[nodiscard]] dberr_t fts_config_get_index_ulint(
    trx_t *trx,          /*!< in: transaction */
    dict_index_t *index, /*!< in: FTS index */
    const char *name,    /*!< in: param name */
    ulint *int_value);   /*!< out: value */
 
/** Set an ulint value int the config table.
 @return DB_SUCCESS or error code */
[[nodiscard]] dberr_t fts_config_set_index_ulint(
    trx_t *trx,          /*!< in: transaction */
    dict_index_t *index, /*!< in: FTS index */
    const char *name,    /*!< in: param name */
    ulint int_value);    /*!< in: value */
#endif                   /* FTS_OPTIMIZE_DEBUG */
 
/** Get an ulint value from the config table.
 @return DB_SUCCESS or error code */
dberr_t fts_config_get_ulint(
    trx_t *trx,             /*!< in: transaction */
    fts_table_t *fts_table, /*!< in: the indexed FTS table */
    const char *name,       /*!< in: param name */
    ulint *int_value);      /*!< out: value */
 
/** Search cache for word.
 @return the word node vector if found else NULL */
[[nodiscard]] const ib_vector_t *fts_cache_find_word(
    const fts_index_cache_t *index_cache, /*!< in: cache to search */
    const fts_string_t *text);            /*!< in: word to search for */
 
/** Append deleted doc ids to vector and sort the vector. */
void fts_cache_append_deleted_doc_ids(
    const fts_cache_t *cache, /*!< in: cache to use */
    ib_vector_t *vector);     /*!< in: append to this vector */
/** Wait for the background thread to start. We poll to detect change
of state, which is acceptable, since the wait should happen only
once during startup.
@param[in] table table to which the thread is attached
@param[in] max_wait Time to wait. If set to 0 then it disables timeout checking
@return true if the thread started else false (i.e timed out) */
bool fts_wait_for_background_thread_to_start(
    dict_table_t *table, std::chrono::microseconds max_wait);
/** Search the index specific cache for a particular FTS index.
 @return the index specific cache else NULL */
[[nodiscard]] fts_index_cache_t *fts_find_index_cache(
    const fts_cache_t *cache,   /*!< in: cache to search */
    const dict_index_t *index); /*!< in: index to search for */
 
/** Write the table id to the given buffer (including final NUL). Buffer must
be at least FTS_AUX_MIN_TABLE_ID_LENGTH bytes long.
@param[in]      id              a table/index id
@param[in]      str             buffer to write the id to
@return number of bytes written */
static inline int fts_write_object_id(ib_id_t id, char *str);
 
/** Read the table id from the string generated by fts_write_object_id().
@param[out] id  Table ID.
@param[in]  str Buffer to read from.
@return true if parse successful */
[[nodiscard]] static inline bool fts_read_object_id(ib_id_t *id,
                                                    const char *str);
 
/** Get the table id.
 @return number of bytes written */
[[nodiscard]] int fts_get_table_id(
    const fts_table_t *fts_table, /*!< in: FTS Auxiliary table */
    char *table_id);              /*!< out: table id, must be at least
                                 FTS_AUX_MIN_TABLE_ID_LENGTH bytes
                                 long */
 
/** Add the table to add to the OPTIMIZER's list. */
void fts_optimize_add_table(dict_table_t *table); /*!< in: table to add */
 
/** Construct the prefix name of an FTS table.
 @return own: table name, must be freed with ut::free() */
[[nodiscard]] char *fts_get_table_name_prefix(
    const fts_table_t *fts_table); /*!< in: Auxiliary table type */
 
/** Add node positions. */
void fts_cache_node_add_positions(
    fts_cache_t *cache,      /*!< in: cache */
    fts_node_t *node,        /*!< in: word node */
    doc_id_t doc_id,         /*!< in: doc id */
    ib_vector_t *positions); /*!< in: fts_token_t::positions */
 
/** Create the config table name for retrieving index specific value.
 @return index config parameter name */
[[nodiscard]] char *fts_config_create_index_param_name(
    const char *param,          /*!< in: base name of param */
    const dict_index_t *index); /*!< in: index for config */
 
#include "fts0priv.ic"
 
#endif /* INNOBASE_FTS0PRIV_H */