Field Detail

• STORE_DOCUMENT_TEXT_IN_INDEX

  protected static final boolean STORE_DOCUMENT_TEXT_IN_INDEX

  Whether the text content should be stored in the Lucene index.

Constructor Detail

• FullTextLucene

  public FullTextLucene()

Method Detail

• init

  public static void init​(java.sql.Connection conn)
                   throws java.sql.SQLException

  Initializes full text search functionality for this database. This adds the following Java functions to the database:

  • FTL_CREATE_INDEX(schemaNameString, tableNameString, columnListString)
  • FTL_SEARCH(queryString, limitInt, offsetInt): result set
  • FTL_REINDEX()
  • FTL_DROP_ALL()

  It also adds a schema FTL 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 FTL_INIT FOR
        "org.h2.fulltext.FullTextLucene.init";
   CALL FTL_INIT();
   

  Parameters:

  conn - the connection

  Throws:

  java.sql.SQLException - on failure

• createIndex

  public static void createIndex​(java.sql.Connection conn,
                                 java.lang.String schema,
                                 java.lang.String table,
                                 java.lang.String columnList)
                          throws java.sql.SQLException

  Create a new full text index for a table and column list. Each table may only have one index at any time.

  Parameters:

  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)

  Throws:

  java.sql.SQLException - on failure

• dropIndex

  public static void dropIndex​(java.sql.Connection conn,
                               java.lang.String schema,
                               java.lang.String table)
                        throws java.sql.SQLException

  Drop an existing full text index for a table. This method returns silently if no index for this table exists.

  Parameters:

  conn - the connection

  schema - the schema name of the table (case sensitive)

  table - the table name (case sensitive)

  Throws:

  java.sql.SQLException - on failure

• reindex

  public static void reindex​(java.sql.Connection conn)
                      throws java.sql.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.

  Parameters:

  conn - the connection

  Throws:

  java.sql.SQLException - on failure

• dropAll

  public static void dropAll​(java.sql.Connection conn)
                      throws java.sql.SQLException

  Drops all full text indexes from the database.

  Parameters:

  conn - the connection

  Throws:

  java.sql.SQLException - on failure

• search

  public static java.sql.ResultSet search​(java.sql.Connection conn,
                                          java.lang.String text,
                                          int limit,
                                          int offset)
                                   throws java.sql.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 as returned by Lucene.

  Parameters:

  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

  Returns:

  the result set

  Throws:

  java.sql.SQLException - on failure

• searchData

  public static java.sql.ResultSet searchData​(java.sql.Connection conn,
                                              java.lang.String text,
                                              int limit,
                                              int offset)
                                       throws java.sql.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 as returned by Lucene.

  Parameters:

  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

  Returns:

  the result set

  Throws:

  java.sql.SQLException - on failure

• convertException

  protected static java.sql.SQLException convertException​(java.lang.Exception e)

  Convert an exception to a fulltext exception.

  Parameters:

  e - the original exception

  Returns:

  the converted SQL exception

• getIndexAccess

  protected static org.h2.fulltext.FullTextLucene.IndexAccess getIndexAccess​(java.sql.Connection conn)
                                                                      throws java.sql.SQLException

  Get the index writer/searcher wrapper for the given connection.

  Parameters:

  conn - the connection

  Returns:

  the index access wrapper

  Throws:

  java.sql.SQLException - on failure

• getIndexPath

  protected static java.lang.String getIndexPath​(java.sql.Connection conn)
                                          throws java.sql.SQLException

  Get the path of the Lucene index for this database.

  Parameters:

  conn - the database connection

  Returns:

  the path

  Throws:

  java.sql.SQLException - on failure

• removeIndexAccess

  protected static void removeIndexAccess​(java.lang.String indexPath)
                                   throws java.sql.SQLException

  Close the index writer and searcher and remove them from the index access set.

  Parameters:

  indexPath - the index path

  Throws:

  java.sql.SQLException - on failure

• search

  protected static java.sql.ResultSet search​(java.sql.Connection conn,
                                             java.lang.String text,
                                             int limit,
                                             int offset,
                                             boolean data)
                                      throws java.sql.SQLException

  Do the search.

  Parameters:

  conn - the database connection

  text - the query

  limit - the limit

  offset - the offset

  data - whether the raw data should be returned

  Returns:

  the result set

  Throws:

  java.sql.SQLException - on failure