ft_global.h

Go to the documentation of this file.

#ifndef FT_GLOBAL_INCLUDED
#define FT_GLOBAL_INCLUDED
 
/* Copyright (c) 2000, 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 */
 
/* Written by Sergei A. Golubchik, who has a shared copyright to this code */
 
/**
  @file include/ft_global.h
  Some definitions for full-text indices.
*/
 
/* #include "myisam.h" */
 
#include <sys/types.h>
 
#include "my_base.h"
#include "my_inttypes.h"
#include "mysql/strings/m_ctype.h"
 
#define HA_FT_MAXBYTELEN 336
#define HA_FT_MAXCHARLEN (HA_FT_MAXBYTELEN / 4)
 
#define DEFAULT_FTB_SYNTAX "+ -><()~*:\"\"&|"
 
struct FT_INFO;
struct _ft_vft {
  int (*read_next)(FT_INFO *, char *);
  float (*find_relevance)(FT_INFO *, uchar *, uint);
  void (*close_search)(FT_INFO *);
  float (*get_relevance)(FT_INFO *);
  void (*reinit_search)(FT_INFO *);
};
 
struct FT_INFO_EXT;
struct _ft_vft_ext {
  uint (*get_version)();  // Extended API version
  ulonglong (*get_flags)();
  ulonglong (*get_docid)(FT_INFO_EXT *);
  ulonglong (*count_matches)(FT_INFO_EXT *);
};
 
/* Flags for extended FT API */
#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"
 
struct FT_INFO {
  struct _ft_vft *please; /* INTERCAL style :-) */
};
 
#ifndef FT_CORE
struct FT_INFO_EXT {
  struct _ft_vft *please; /* INTERCAL style :-) */
  struct _ft_vft_ext *could_you;
};
#endif
 
extern const char *ft_stopword_file;
extern const char *ft_precompiled_stopwords[];
 
extern ulong ft_min_word_len;
extern ulong ft_max_word_len;
extern ulong ft_query_expansion_limit;
extern const char *ft_boolean_syntax;
extern struct st_mysql_ftparser ft_default_parser;
 
int ft_init_stopwords(void);
void ft_free_stopwords(void);
 
/**
  Operation types, used in FT_HINTS.
*/
 
enum ft_operation {
  FT_OP_UNDEFINED, /** Operation undefined, use of hints is impossible */
  FT_OP_NO,        /** No operation, single MATCH function */
  FT_OP_GT,        /** 'Greater than' operation */
  FT_OP_GE         /** 'Greater than or equal to' operation */
};
 
#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 */
 
/**
  Info about FULLTEXT index hints,
  passed to the storage engine.
*/
 
struct ft_hints {
  /** FULLTEXT flags, see FT_NL, etc */
  uint flags;
  /** Operation type */
  enum ft_operation op_type;
  /** Operation value */
  double op_value;
  /** LIMIT value, HA_POS_ERROR if not set */
  ha_rows limit;
};
 
FT_INFO *ft_init_search(uint, void *, uint, uchar *, uint, const CHARSET_INFO *,
                        uchar *);
bool ft_boolean_check_syntax_string(const uchar *);
 
#endif /* FT_GLOBAL_INCLUDED */