org.h2.fulltext
Class FullTextLucene

java.lang.Object
  extended by org.h2.fulltext.FullText
      extended by org.h2.fulltext.FullTextLucene

public class FullTextLucene
extends FullText

This class implements the full text search based on Apache Lucene. Most methods can be called using SQL statements as well.


Nested Class Summary
static class FullTextLucene.FullTextTrigger
          Trigger updates the index when a inserting, updating, or deleting a row.
 
Field Summary
protected static boolean STORE_DOCUMENT_TEXT_IN_INDEX
          Whether the text content should be stored in the Lucene index.
 
Fields inherited from class org.h2.fulltext.FullText
FIELD_COLUMNS, FIELD_KEYS, FIELD_SCHEMA, FIELD_SCORE, FIELD_TABLE
 
Constructor Summary
FullTextLucene()
           
 
Method Summary
protected static java.sql.SQLException convertException(java.lang.Exception e)
          Convert an exception to a fulltext exception.
static void createIndex(java.sql.Connection conn, java.lang.String schema, java.lang.String table, java.lang.String columnList)
          Create a new full text index for a table and column list.
protected static void createTrigger(java.sql.Connection conn, java.lang.String schema, java.lang.String table)
          Create the trigger.
static void dropAll(java.sql.Connection conn)
          Drops all full text indexes from the database.
protected static org.h2.fulltext.FullTextLucene.IndexAccess getIndexAccess(java.sql.Connection conn)
          Get the index writer/searcher wrapper for the given connection.
protected static java.lang.String getIndexPath(java.sql.Connection conn)
          Get the path of the Lucene index for this database.
protected static void indexExistingRows(java.sql.Connection conn, java.lang.String schema, java.lang.String table)
          Add the existing data to the index.
static void init(java.sql.Connection conn)
          Initializes full text search functionality for this database.
static void reindex(java.sql.Connection conn)
          Re-creates the full text index for this database.
protected static void removeIndexAccess(org.h2.fulltext.FullTextLucene.IndexAccess access, java.lang.String indexPath)
          Close the index writer and searcher and remove them from the index access set.
static java.sql.ResultSet search(java.sql.Connection conn, java.lang.String text, int limit, int offset)
          Searches from the full text index for this database.
protected static java.sql.ResultSet search(java.sql.Connection conn, java.lang.String text, int limit, int offset, boolean data)
          Do the search.
static java.sql.ResultSet searchData(java.sql.Connection conn, java.lang.String text, int limit, int offset)
          Searches from the full text index for this database.
 
Methods inherited from class org.h2.fulltext.FullText
addWords, addWords, asString, closeAll, createResultSet, dropIndex, hasChanged, parseKey, quoteSQL, removeAllTriggers, setColumns, setIgnoreList, throwException
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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: 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

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

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

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

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:

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

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:

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

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

createTrigger

protected static void createTrigger(java.sql.Connection conn,
                                    java.lang.String schema,
                                    java.lang.String table)
                             throws java.sql.SQLException
Create the trigger.

Parameters:
conn - the database connection
schema - the schema name
table - the table name
Throws:
java.sql.SQLException

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

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

indexExistingRows

protected static void indexExistingRows(java.sql.Connection conn,
                                        java.lang.String schema,
                                        java.lang.String table)
                                 throws java.sql.SQLException
Add the existing data to the index.

Parameters:
conn - the database connection
schema - the schema name
table - the table name
Throws:
java.sql.SQLException

removeIndexAccess

protected static void removeIndexAccess(org.h2.fulltext.FullTextLucene.IndexAccess access,
                                        java.lang.String indexPath)
                                 throws java.sql.SQLException
Close the index writer and searcher and remove them from the index access set.

Parameters:
access - the index writer/searcher wrapper
indexPath - the index path
Throws:
java.sql.SQLException

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