Edit on GitHubAppendix B: Application Properties
This section lists the application properties that are relevant to the full-text search add-on.
- cuba.ftsConfig
-
Additive property defining an FTS configuration file of the project.
The file is loaded using the
Resourcesinterface, so it can be located in classpath or in the configuration directory.Used in the Middleware block.
Example:
cuba.ftsConfig = +com/company/sample/fts.xml
All properties that are described below are runtime parameters stored in the database and available in the application code via the FtsConfig configuration interface.
- fts.enabled
-
The flag enabling the FTS functionality in the project.
Can be changed via the Enabled attribute of the
app-core.fts:type=FtsManagerJMX bean.Default value:
false
- fts.indexDir
-
An absolute path to the directory storing indexed files. If not specified, the
ftsindexsubdirectory of the application work directory (defined by the cuba.dataDir property) is used; in the default deployment configuration, it is tomcat/work/app-core/ftsindex.Default value: unspecified
- fts.indexingBatchSize
-
A number of records extracted from the indexing queue per one invocation of
processQueue().This limitation is relevant to the situation when the indexing queue contains a very large number of records, for example, after executing the
reindexAll()method of theapp-core.fts:type=FtsManagerJMX bean. In this case, indexing is done in batches, which takes more time, but creates a limited and predictable server load.Default value:
300
- fts.reindexBatchSize
-
A number of records put to the indexing queue per one invocation of
reindexNextBatch().Default value:
5000
- fts.maxSearchResults
-
The maximum number of entries in the search result.
Default value:
100