FullText (H2 Database Engine 2.0.0 API)

java.lang.Object
- org.h2.fulltext.FullText

直接已知子类:

FullTextLucene
```
public class FullText
extends Object
```
This class implements the native full text search. Most methods can be called using SQL statements as well.

嵌套类概要

嵌套类
限定符和类型类和说明

static class FullText.FullTextTrigger
Trigger updates the index when a inserting, updating, or deleting a row.

嵌套类
限定符和类型	类和说明
`static class`	`FullText.FullTextTrigger` Trigger updates the index when a inserting, updating, or deleting a row.

构造器概要

构造器
构造器和说明

FullText()

构造器
构造器和说明
`FullText()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`protected static void`	`addWords(org.h2.fulltext.FullTextSettings setting, Set<String> set, Reader reader)` Add all words in the given text to the hash set.
`protected static void`	`addWords(org.h2.fulltext.FullTextSettings setting, Set<String> set, String text)` Add all words in the given text to the hash set.
`protected static String`	`asString(Object data, int type)` INTERNAL.
`static void`	`closeAll()` INTERNAL Close all fulltext settings, freeing up memory.
`static void`	`createIndex(Connection conn, String schema, String table, String columnList)` Create a new full text index for a table and column list.
`protected static SimpleResultSet`	`createResultSet(boolean data)` Create an empty search result and initialize the columns.
`static void`	`dropAll(Connection conn)` Drops all full text indexes from the database.
`static void`	`dropIndex(Connection conn, String schema, String table)` Drop an existing full text index for a table.
`protected static boolean`	`hasChanged(Object[] oldRow, Object[] newRow, int[] indexColumns)` Check if a the indexed columns of a row probably have changed.
`static void`	`init(Connection conn)` Initializes full text search functionality for this database.
`protected static String[][]`	`parseKey(Connection conn, String key)` Parse a primary key condition into the primary key columns.
`protected static String`	`quoteSQL(Object data, int type)` INTERNAL.
`static void`	`reindex(Connection conn)` Re-creates the full text index for this database.
`protected static void`	`removeAllTriggers(Connection conn, String prefix)` Remove all triggers that start with the given prefix.
`static ResultSet`	`search(Connection conn, String text, int limit, int offset)` Searches from the full text index for this database.
`protected static ResultSet`	`search(Connection conn, String text, int limit, int offset, boolean data)` Do the search.
`static ResultSet`	`searchData(Connection conn, String text, int limit, int offset)` Searches from the full text index for this database.
`protected static void`	`setColumns(int[] index, ArrayList<String> keys, ArrayList<String> columns)` Set the column indices of a set of keys.
`static void`	`setIgnoreList(Connection conn, String commaSeparatedList)` Change the ignore list.
`static void`	`setWhitespaceChars(Connection conn, String whitespaceChars)` Change the whitespace characters.
`protected static SQLException`	`throwException(String message)` Throw a SQLException with the given message.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - FullText
```
public FullText()
```
- 方法详细资料
  - init
```
public static void init(Connection conn)
                 throws SQLException
```
    Initializes full text search functionality for this database. This adds the following Java functions to the database:
    - FT_CREATE_INDEX(schemaNameString, tableNameString, columnListString)
    - FT_SEARCH(queryString, limitInt, offsetInt): result set
    - FT_REINDEX()
    - FT_DROP_ALL()
    It also adds a schema FT to the database where bookkeeping information is stored. This function may be called from a Java application, or by using the SQL statements:
```
 CREATE ALIAS IF NOT EXISTS FT_INIT FOR
      "org.h2.fulltext.FullText.init";
 CALL FT_INIT();
 
```
    参数:
    
    conn - the connection
    
    抛出:
    
    SQLException - on failure
  - createIndex
```
public static void createIndex(Connection conn,
                               String schema,
                               String table,
                               String columnList)
                        throws SQLException
```
    Create a new full text index for a table and column list. Each table may only have one index at any time.
    
    参数:
    
    conn - the connection
    
    schema - the schema name of the table (case sensitive)
    
    table - the table name (case sensitive)
    
    columnList - the column list (null for all columns)
    
    抛出:
    
    SQLException - on failure
  - reindex
```
public static void reindex(Connection conn)
                    throws SQLException
```
    Re-creates the full text index for this database. Calling this method is usually not needed, as the index is kept up-to-date automatically.
    
    参数:
    
    conn - the connection
    
    抛出:
    
    SQLException - on failure
  - dropIndex
```
public static void dropIndex(Connection conn,
                             String schema,
                             String table)
                      throws SQLException
```
    Drop an existing full text index for a table. This method returns silently if no index for this table exists.
    
    参数:
    
    conn - the connection
    
    schema - the schema name of the table (case sensitive)
    
    table - the table name (case sensitive)
    
    抛出:
    
    SQLException - on failure
  - dropAll
```
public static void dropAll(Connection conn)
                    throws SQLException
```
    Drops all full text indexes from the database.
    
    参数:
    
    conn - the connection
    
    抛出:
    
    SQLException - on failure
  - search
```
public static ResultSet search(Connection conn,
                               String text,
                               int limit,
                               int offset)
                        throws SQLException
```
    Searches from the full text index for this database. The returned result set has the following column:
    - QUERY (varchar): the query to use to get the data. The query does not include 'SELECT * FROM '. Example: PUBLIC.TEST WHERE ID = 1
    - SCORE (float) the relevance score. This value is always 1.0 for the native fulltext search.
    参数:
    
    conn - the connection
    
    text - the search query
    
    limit - the maximum number of rows or 0 for no limit
    
    offset - the offset or 0 for no offset
    
    返回:
    
    the result set
    
    抛出:
    
    SQLException - on failure
  - searchData
```
public static ResultSet searchData(Connection conn,
                                   String text,
                                   int limit,
                                   int offset)
                            throws SQLException
```
    Searches from the full text index for this database. The result contains the primary key data as an array. The returned result set has the following columns:
    - SCHEMA (varchar): the schema name. Example: PUBLIC
    - TABLE (varchar): the table name. Example: TEST
    - COLUMNS (array of varchar): comma separated list of quoted column names. The column names are quoted if necessary. Example: (ID)
    - KEYS (array of values): comma separated list of values. Example: (1)
    - SCORE (float) the relevance score. This value is always 1.0 for the native fulltext search.
    参数:
    
    conn - the connection
    
    text - the search query
    
    limit - the maximum number of rows or 0 for no limit
    
    offset - the offset or 0 for no offset
    
    返回:
    
    the result set
    
    抛出:
    
    SQLException - on failure
  - setIgnoreList
```
public static void setIgnoreList(Connection conn,
                                 String commaSeparatedList)
                          throws SQLException
```
    Change the ignore list. The ignore list is a comma separated list of common words that must not be indexed. The default ignore list is empty. If indexes already exist at the time this list is changed, reindex must be called.
    
    参数:
    
    conn - the connection
    
    commaSeparatedList - the list
    
    抛出:
    
    SQLException - on failure
  - setWhitespaceChars
```
public static void setWhitespaceChars(Connection conn,
                                      String whitespaceChars)
                               throws SQLException
```
    Change the whitespace characters. The whitespace characters are used to separate words. If indexes already exist at the time this list is changed, reindex must be called.
    
    参数:
    
    conn - the connection
    
    whitespaceChars - the list of characters
    
    抛出:
    
    SQLException - on failure
  - asString
```
protected static String asString(Object data,
                                 int type)
                          throws SQLException
```
    INTERNAL. Convert the object to a string.
    
    参数:
    
    data - the object
    
    type - the SQL type
    
    返回:
    
    the string
    
    抛出:
    
    SQLException - on failure
  - createResultSet
```
protected static SimpleResultSet createResultSet(boolean data)
```
    Create an empty search result and initialize the columns.
    
    参数:
    
    data - true if the result set should contain the primary key data as an array.
    
    返回:
    
    the empty result set
  - parseKey
```
protected static String[][] parseKey(Connection conn,
                                     String key)
```
    Parse a primary key condition into the primary key columns.
    
    参数:
    
    conn - the database connection
    
    key - the primary key condition as a string
    
    返回:
    
    an array containing the column name list and the data list
  - quoteSQL
```
protected static String quoteSQL(Object data,
                                 int type)
                          throws SQLException
```
    INTERNAL. Convert an object to a String as used in a SQL statement.
    
    参数:
    
    data - the object
    
    type - the SQL type
    
    返回:
    
    the SQL String
    
    抛出:
    
    SQLException - on failure
  - removeAllTriggers
```
protected static void removeAllTriggers(Connection conn,
                                        String prefix)
                                 throws SQLException
```
    Remove all triggers that start with the given prefix.
    
    参数:
    
    conn - the database connection
    
    prefix - the prefix
    
    抛出:
    
    SQLException - on failure
  - setColumns
```
protected static void setColumns(int[] index,
                                 ArrayList<String> keys,
                                 ArrayList<String> columns)
                          throws SQLException
```
    Set the column indices of a set of keys.
    
    参数:
    
    index - the column indices (will be modified)
    
    keys - the key list
    
    columns - the column list
    
    抛出:
    
    SQLException - on failure
  - search
```
protected static ResultSet search(Connection conn,
                                  String text,
                                  int limit,
                                  int offset,
                                  boolean data)
                           throws SQLException
```
    Do the search.
    
    参数:
    
    conn - the database connection
    
    text - the query
    
    limit - the limit
    
    offset - the offset
    
    data - whether the raw data should be returned
    
    返回:
    
    the result set
    
    抛出:
    
    SQLException - on failure
  - addWords
```
protected static void addWords(org.h2.fulltext.FullTextSettings setting,
                               Set<String> set,
                               Reader reader)
```
    Add all words in the given text to the hash set.
    
    参数:
    
    setting - the fulltext settings
    
    set - the hash set
    
    reader - the reader
  - addWords
```
protected static void addWords(org.h2.fulltext.FullTextSettings setting,
                               Set<String> set,
                               String text)
```
    Add all words in the given text to the hash set.
    
    参数:
    
    setting - the fulltext settings
    
    set - the hash set
    
    text - the text
  - hasChanged
```
protected static boolean hasChanged(Object[] oldRow,
                                    Object[] newRow,
                                    int[] indexColumns)
```
    Check if a the indexed columns of a row probably have changed. It may return true even if the change was minimal (for example from 0.0 to 0.00).
    
    参数:
    
    oldRow - the old row
    
    newRow - the new row
    
    indexColumns - the indexed columns
    
    返回:
    
    true if the indexed columns don't match
  - closeAll
```
public static void closeAll()
```
    INTERNAL Close all fulltext settings, freeing up memory.
  - throwException
```
protected static SQLException throwException(String message)
                                      throws SQLException
```
    Throw a SQLException with the given message.
    
    参数:
    
    message - the message
    
    返回:
    
    never returns normally
    
    抛出:
    
    SQLException - the exception

类 FullText

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

FullText

方法详细资料

init

createIndex

reindex

dropIndex

dropAll

search

searchData

setIgnoreList

setWhitespaceChars

asString

createResultSet

parseKey

quoteSQL

removeAllTriggers

setColumns

search

addWords

addWords

hasChanged

closeAll

throwException