Table of contents

• Introduction
• Install
  • Overview
  • Install options
• Upgrade / Migrate
  • Upgrade Search and Insight Engine
  • Migrate Search Services
• Configure
  • Overview
  • Properties
  • Secure keys
  • Solr security
  • Solr sharding
    • Sharding overview
    • Set up
  • Solr replication
  • OpenSearch
  • Filtered search
  • Transactional metadata query
  • Performance recommendations
  • Indexing recommendations
• Administer
  • Overview
  • Monitor
  • SOLR Admin REST API
• Using
  • Reports and dashboards
  • SQL commands
  • Full text search reference
    • title
  • Sample Insight Zeppelin SQL
  • JDBC driver

Full text search reference

%(cm:name cm:title cm:description ia:whatEvent ia:descriptionEvent lnk:title lnk:description TEXT)

term^2.4"phrase"^3term~0.8^4=term^3~term^4cm:name:(big * yellow)^41..2^2[1 TO 2]^2yellow AND (car OR bus)^3

NOW+2MONTHS

NOW-1DAY

NOW/HOUR

NOW+6MONTHS+3DAYS/DAY

1972-05-20T17:33:18.772Z+6MONTHS+3DAYS/DAY

big yellow bananabig OR yellow OR bananaTEXT:big TEXT:yellow TEXT:bananaTEXT:big OR TEXT:yellow OR TEXT:banana

cm:my content:my name

alfresco.cross.locale.property.0={http://www.alfresco.org/model/content/1.0}namealfresco.cross.locale.property.1={http://www.alfresco.org/model/content/1.0}lockOwner

alfresco.cross.locale.datatype.0={http://www.alfresco.org/model/dictionary/1.0}textalfresco.cross.locale.datatype.1={http://www.alfresco.org/model/dictionary/1.0}contentalfresco.cross.locale.datatype.2={http://www.alfresco.org/model/dictionary/1.0}mltext

field:termfield:"phrase"=field:exact~field:expand

When you search in multi-value fields there are additional options available than forSearch in fields. To search in multi-value fields your properties must haveMultiple values enabled, for more seeCreate a property.

The following example queries are executed using a sample multi-valued property"mul:os" that stores values"MacOS" and"Linux".

mul:os:"MacOS"

Returns the document because"MacOS" is one of the values of the property.

mul:os:("MacOS" AND "Windows")

Does not return a document because the property doesn’t contain the value"Windows".

mul:os:("MacOS" OR "Windows")

Returns the document because"MacOS" is one of the values of the property, even though"Windows" is not.

Mixed FTS ID behavior

This relates to the priority defined on properties in the data dictionary, which can be both tokenized or untokenized.

Explicit priority is set by prefixing the query with “=” for identifier pattern matches.

The tilde (~) can be used to force tokenization.

Search for fuzzy matching

Alfresco supports fuzzy searches based on the Lucene default Levenshtein Distance.

To do a fuzzy search use the tilde (~) symbol at the end of a single word term with a parameter between 0 and 1 to specify the required similarity. Use a value closer to 1 for higher similarity.

For example, to search for a term similar in spelling toroam use the fuzzy search:

roam~0.9

This search will find terms likefoam,roaming, androams.

Search for grouping

Use parentheses to encapsulateOR statements for the search engine to execute them properly.

TheOR operator is executed as “I would like at least one of these terms”.

Groupings of terms are made using( and ). Groupings of all query elements are supported in general. Groupings are also supported after a field - field group.

The query elements in field groups all apply to the same field and cannot include a field.

(big OR large) AND banana  title:((big OR large) AND banana)

Search query literals

When you search, entries are generally a term or a phrase. The string representation you type in will be transformed to the appropriate type for each property when executing the query. For convenience, there are numeric literals but string literals can also be used.

Date formatting

You can specify either a particular date or a date literal. A date literal is a fixed expression that represents a relative range of time, for example last month, this week, or next year.

dateTime field values are stored as Coordinated Universal Time (UTC). The date fields represent a point in time with millisecond precision. For date field formatting, Solr usesDateTimeFormatter.ISO_INSTANT. The ISO instant formatter formats an instant in Coordinated Universal Time (UTC), for example:

YYYY-MM-DDThh:mm:ssZ

where,

• YYYY is the year.
• MM is the month.
• DD is the day of the month.
• hh is the hour of the day as on a 24-hour clock.
• mm is minutes.
• ss is seconds.
• Z is a literalZ character indicating that this string representation of the date is in UTC.

Note: No time zone can be specified. The string representation of dates is always expressed in UTC, for example:

1972-05-20T17:33:18Z

String literals

String literals for phrases can be enclosed in double quotes or single quotes. Java single character anduXXXX-based escaping are supported within these literals.

Integer and decimal literals conform to the Java definitions.

Dates as any other literal can be expressed as a term or phrase. Dates are in the format...... Any or all of the time can be truncated.

In range queries, strings, term, and phrases that do not parse to valid type instance for the property are treated as open ended.

test:integer[ 0 TO MAX] matches anything positive

Search for negation

You can narrow your search results by excluding words with theNOT syntax.

Single terms, phrases, and so on can be combined using “NOT” in upper, lower, or mixed case, or prefixed with “!” or “-”.

These queries search for nodes that contain the termsyellow in any content.

yellow NOT bananayellow !bananayellow -bananaNOT yellow banana-yellow banana!yellow banana

TheNOT operator can only be used for string keywords; it doesn’t work for numerals or dates.

Prefixing any search qualifier with a- excludes all results that are matched by that qualifier.

Search for optional, mandatory, and excluded elements of a query

Sometimes AND and OR are not enough. If you want to find documents that must contain the term “car”, score those with the term “red” higher, but do not match those just containing “red”.

The following example finds documents that contain the term “car”, score those with the term “red” higher, but does not match those just containing “red”:

+car |red

Note: At least one element of a query must match (or not match) for there to be any results.

AllAND andOR constructs can be expressed with these operators.

Search for a phrase

Phrases are enclosed in double quotes. Any embedded quotes can be escaped using ``. If no field is specified then the default TEXT field will be used, as with searches for a single term.

The whole phrase will be tokenized before the search according to the appropriate data dictionary definition(s).

"big yellow banana"

Search for operator precedence

Operator precedence is SQL-like (not Java-like). When there is more than one logical operator in a statement, and they are not explicitly grouped using parentheses,NOT is evaluated first, thenAND, and finallyOR.

The following shows the operator precedence from highest to lowest:

"[, ], <, >()~ (prefix and postfix), =^+, |, -NOT,ANDOR

AND andOR can be combined with+,|,- with the following meanings:

Embed queries in CMIS

These examples show how to embed queries in CMIS.

Embedded in CMIS contains()

- strict queriesSELECT * FROM Document WHERE CONTAINS("zebra")SELECT * FROM Document WHERE CONTAINS("quick")- Alfresco extensionsSELECT * FROM Document D WHERE CONTAINS(D, 'cmis:name:\'Tutorial\'')SELECT cmis:name as BOO FROM Document D WHERE CONTAINS('BOO:\'Tutorial\'')

Search Service

ResultSet results = searchService.query(storeRef, SearchService.LANGUAGE_FTS_ALFRESCO, "quick");

SearchService.LANGUAGE_FTS_ALFRESCO = "fts-alfresco"

Node Browser

FTS is supported in the node browser.

JavaScript

search{   query: string,          mandatory, in appropriate format and encoded for the given language   store: string,          optional, defaults to 'workspace://SpacesStore'   language: string,       optional, one of: lucene, xpath, jcr-xpath, fts-alfresco - defaults to 'lucene'   templates: [],          optional, Array of query language template objects (see below) - if supported by the language    sort: [],               optional, Array of sort column objects (see below) - if supported by the language   page: object,           optional, paging information object (see below) - if supported by the language   namespace: string,      optional, the default namespace for properties   defaultField: string,   optional, the default field for query elements when not explicit in the query   onerror: string         optional, result on error - one of: exception, no-results - defaults to 'exception'}sort{   column: string,         mandatory, sort column in appropriate format for the language   ascending: boolean      optional, defaults to false}page{   maxItems: int,          optional, max number of items to return in result set   skipCount: int          optional, number of items to skip over before returning results}template{   field: string,          mandatory, custom field name for the template   template: string        mandatory, query template replacement for the template}

For example:

 var def =  {     query: "cm:name:test*",     language: "fts-alfresco"  };  var results = search.query(def);

Templates

FTS is not supported in FreeMarker.

Search for proximity

Google-style proximity is supported.

To specify proximity for fields, use grouping.

big * appleTEXT:(big * apple)big *(3) appleTEXT:(big *(3) apple)

Search query templates

The FTS query language supports query templates. These are intended to help when building application specific searches.

A template is a query but with additional support to specify template substitution.

• %field

  Insert the parse tree for the currentftstest and replace all references to fields in the current parse tree with the supplied field.

• %(field1, field2)%(field1 field2)

  (The comma is optional.) Create a disjunction, and for each field, add the parse tree for the currentftstest to the disjunction, and then replace all references to fields in the current parse tree with the current field from the list.

Templates can refer to other templates.

nameAndTitle -> %(cm:name, cm:title)nameAndTitleAndDesciption -> %(nameAndTitle, cm:description)

Search for ranges

Inclusive ranges can be specified in Google-style. There is an extended syntax for more complex ranges. Unbounded ranges can be defined using MIN and MAX for numeric and date types and “u0000” and “FFFF” for text (anything that is invalid).

TEXT:apple..bananamy:int:[0 TO 10]my:float:2.5..3.5my:float:0..MAXmt:text:[l TO "uFFFF"]

Search for a single term

Single terms are tokenized before the search according to the appropriate data dictionary definition(s).

If you do not specify a field, it will search in the content and properties. This is a shortcut for searching all properties of type content. Terms can not contain a whitespace.

bananaTEXT:banana

Both of these queries will find any nodes with the word “banana” in any property of typed:content.

If the appropriate data dictionary definition(s) for the field supports both FTS and untokenized search, then FTS search will be used. FTS will include synonyms if the analyzer generates them. Terms cannot contain whitespace.

Search for spans and positions

Spans and positions are not implemented. Positions will depend on tokenization.

Anything more detailed than one *(2) two are arbitrarily dependent on the tokenization. An identifier and pattern matching, or dual FTS and ID tokenization, might be the answer in these cases.

term[^] - startterm[$] - endterm[position]

These are of possible use but excluded for now. Lucene surround extensions:

and(terms etc)99w(terms etc)97n(terms etc)

Search for term expansion

To force tokenization and term expansion, prefix the term with~.

For a property with both ID and FTS indexes, where the ID index is the default, force the use of the FTS index.

~running

Search for wildcards

Wildcards are supported in terms, phrases, and exact phrases using* to match zero, one, or more characters and? to match a single character.

The* wildcard character can appear on its own and implies Google-style. The “anywhere after” wildcard pattern can be combined with the= prefix for identifier based pattern matching. Search will return and highlight any word that begins with the root of the word truncated by the* wildcard character.

The following will all find the term apple.

TEXT:app?eTEXT:app*TEXT:*ppleappl?*ple=*ple"ap*le""***le""?????"

When performing a search that includes a wildcard character, it is best to wrap your search term in double quotation marks. This ensures all metadata and content are searched.

Edit this page