Full-Text-Index.md

Lucene Full Text Index

Full text index can be created using the OrientDB SQL syntax as written here. Specify the index engine to use the lucene full text capabilities.

Starting from OrientDB 2.0, Lucene plugin is part of the OrientDB distribution.

Syntax:

CREATE INDEX <name> ON <class-name> (prop-names) FULLTEXT ENGINE LUCENE

Example

CREATE INDEX City.name ON City (name) FULLTEXT ENGINE LUCENE

Index can also be created on n-properties:

Example:

CREATE INDEX City.name_description ON City (name,description) FULLTEXT ENGINE LUCENE

This will create a basic lucene index on the properties specified. If the analyzer is not specified, the default will be the StandardAnalyzer. To use a different analyzer use the field analyzer in the metadata JSON object in the CREATE INDEX syntax.

Example:

CREATE INDEX City.name ON City (name) FULLTEXT ENGINE LUCENE METADATA {"analyzer":"org.apache.lucene.analysis.en.EnglishAnalyzer"}

The Index can also be created with the Java API. Example:

OSchema schema = databaseDocumentTx.getMetadata().getSchema();
OClass oClass = schema.createClass("Foo");
oClass.createProperty("name", OType.STRING);
oClass.createIndex("City.name", "FULLTEXT", null, null, "LUCENE", new String[] { "name"});

How to query a Full Text Index

The full text index can be queried using the custom operator LUCENE using the Query Parser Syntax of Lucene. Example:

SELECT * FROM V WHERE name LUCENE "test*"

will look for test, tests, tester, etc..

Working with multiple field

To query multiple fields use this special syntax:

SELECT * FROM Class WHERE [prop1,prop2] LUCENE "query"

If query is a plain string the engine will parse the query using MultiFieldQueryParser on each indexed field.

To execute a more complex query on each fields surround your query with () parenthesis, to address specific field.

Example:

SELECT * FROM Class WHERE [prop1,prop2] LUCENE "(prop1:foo AND props2:bar)"

With this syntax the engine parse the query using the QueryParser.

Create a manual Lucene Index

Starting from 2.1 the plugin support index creation without the need of a class

To create a manual index use this syntax

CREATE INDEX <name> FULLTEXT ENGINE LUCENE  [<key-type>] [METADATA {<metadata>}]

Example

create index Manual FULLTEXT ENGINE LUCENE STRING,STRING

You can then insert values in index with insert into the index:

insert into index:manual (key,rid) values(['Enrico','Rome'],#5:0)

and query the index

select from index:manual where key LUCENE 'Enrico'