Inheritance diagram for Minimal:

[legend]

Collaboration diagram for Minimal:

Static Public Member Functions
	DeleteIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Deletes the iFind index for the row.

_.Library.RegisteredObject	Embedded ()
	Return an instance of the embedded Find class, initialized with the index' parameters.

_.Library.Binary	Find (_.Library.Binary pSearch, _.Library.Integer pOption, _.Library.String pLanguage, _.Library.String pSynonymOption)
	Searches for matches based on the iFind index. More...

	InsertIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Inserts the iFind index for the row. More...

_.Library.String	Normalize (_.Library.String pQuery, _.Library.String pLanguage)
	This method will normalize the query of iFind.Find.Basic based on the dictionary defined iFind.Index.Basic.

	PurgeIndex ()
	Purges the iFind index.

	UpdateIndex (_.Library.RawString pID, _.Library.Binary pArg)
	Updates the iFind index for the row.

Static Public Member Functions inherited from FunctionalIndex
	DeleteIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when an existing instance of a class is deleted.

	InsertIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when a new instance of a class is inserted into the database.

	SegmentFinalize (_.Library.RawString pIndexBuffer, _.Library.RawString pStartID, _.Library.RawString pEndID)
	This method is called when the index builder is finalizing a segment. More...

	SegmentInitialize (_.Library.RawString pIndexBuffer, _.Library.RawString pStartID, _.Library.RawString pEndID)
	This method is called by the parallel index build to initialize an index segment when constructing. More...

	UpdateIndex (_.Library.RawString pID, _.Library.Binary pArg)
	This method is invoked when an existing instance of a class is updated.

Static Public Attributes
	IFINDADVANCEDSQLPREFIX = None

	IFINDMAPPINGS = None

	IFINDSHAREDDATALOCATION = None
	This parameter enables specifying whether words, entities and similar data should be written. More...

	IGNOREPUNCTUATION = None

	INDEXOPTION = None
	Specific indexing options to use when processing records. More...

	LANGUAGE = None
	Language to use when indexing records. More...

	LOWER = None
	Whether or not to convert content to lowercase before indexing. More...

	STEMMINGCONFIG = None

	SUPPORTSSHARDING = None
	This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be. More...

	TRANSFORMATIONSPEC = None

	USERDICTIONARY = None

Static Public Attributes inherited from FunctionalIndex
	SUPPORTSSHARDING = None
	This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be. More...

Detailed Description

This class offers a subset of the full-text search capabilities brought by <class>iFind.Index.Basic</class> with a minimal storage footprint. The following Basic features are not available for a Minimal index:

Positional search: e.g. "[five tickets]", "[aspirin ? daily]</li> <li>Cooccurence search: e.g. "[ketchup, mayonaise, 5]"
Highlighting search results
Ranking search results

See the class reference of <class>iFind.Index.Basic</class> for a detailed overview of available search capabilities.

Member Function Documentation

◆ Find()

_.Library.Binary Find	(	_.Library.Binary	pSearch,
		_.Library.Integer	pOption,
		_.Library.String	pLanguage,
		_.Library.String	pSynonymOption
	)

static

Searches for matches based on the iFind index.

This function can be accessed more conveniently

through the following syntax:

SELECT * FROM MyPackage.Table WHERE ID FIND search_index(index_name, pSearch [, pOption [, pLanguage]])

◆ InsertIndex()

InsertIndex	(	_.Library.RawString	pID,
		_.Library.Binary	pArg
	)

static

Inserts the iFind index for the row.

THROW: This method throws exceptions.

Member Data Documentation

◆ IFINDADVANCEDSQLPREFIX

IFINDADVANCEDSQLPREFIX = None

static

This class offers a subset of the full-text search capabilities brought by <class>iFind.Index.Basic</class> with a minimal storage footprint. The following Basic features are not available for a Minimal index:

Positional search: e.g. "[five tickets]", "[aspirin ? daily]</li> <li>Cooccurence search: e.g. "[ketchup, mayonaise, 5]"
Highlighting search results
Ranking search results

See the class reference of <class>iFind.Index.Basic</class> for a detailed overview of available search capabilities.

When generating SQL projections of iFind index data using the <parameter>IFINDMAPPINGS</parameter>),

this parameter overrides the naming of those classes, using this parameter's value instead of the default [class_name]_[index_name] prefix. The projections will still be created in the [package_name]_[class_name] package.

◆ IFINDMAPPINGS

IFINDMAPPINGS = None

static

When this parameter is set to 1, additional SQL projections will be created upon compiling

the class. These are accessible as read-only tables in a package named [package_name]_[class_name] and have names starting with [class_name]_index_name.

By default, the following mappings are generated for an iFind.Index.Minimal index:

[class_name]_[index_name]_WordRec: stores which words appear in each record in this index. See also <class>iFind.Index.AbstractWordRec</class>.

Additional classes will be generated automatically, based on your index class and parameters. See the class reference for subclasses for more details.

◆ IFINDSHAREDDATALOCATION

IFINDSHAREDDATALOCATION = None

static

This parameter enables specifying whether words, entities and similar data should be written.

to the shared iFind.Word, iFind.Entity and similar tables (<parameter>IFINDSHAREDDATALOCATION</parameter>="NAMESPACE", default), or whether it should be stored in index-specific tables (<parameter>IFINDSHAREDDATALOCATION</parameter>="INDEX"). In the latter case, mappings will be generated for these tables if <parameter>IFINDMAPPINGS</parameter> is set to 1.

◆ IGNOREPUNCTUATION

IGNOREPUNCTUATION = None

static

This parameter controls whether leading and trailing punctuation is ignored in its

entirety or not for this index and associated searches. If set to 0, the index will also track words with adjacent punctuation to enable specifically searching for those occurrences.

◆ INDEXOPTION

INDEXOPTION = None

static

Specific indexing options to use when processing records.

0 = Do not store compounds or stems
1 = Store word-level stems
2 = Store word-level compounds and stems

See also <class>iKnow.Stemmer</class> and <class>iKnow.Stemming.DecompoundUtils</class> for more details on stemming or decompounding, or <parameter>TRANSFORMATIONSPEC</parameter> for advanced options to use custom transformations.

◆ LANGUAGE

LANGUAGE = None

static

Language to use when indexing records.

Use "*" to enable automatic language detection.

◆ LOWER

LOWER = None

static

Whether or not to convert content to lowercase before indexing.

When set to 1 (default), searches are always case-insensitive. When set to 0, searching will be case-sensitive.

◆ STEMMINGCONFIG

STEMMINGCONFIG = None

static

This parameter can be used to override the default stemming implementation when

<parameter>INDEXOPTION</parameter> > 0. To do so, set this parameter to a saved <class>iKnow.Stemming.Configuration</class> instance. This parameter has no effect if <parameter>INDEXOPTION</parameter> = 0.

This parameter is for advanced use only and empty by default.

◆ SUPPORTSSHARDING

SUPPORTSSHARDING = None

static

This parameter can be set to 1 if the implementation of the filing interface and the SQL query interface can be.

executed on a shard server. The default is 0. If a sharded class attempts to use a functional index where SUPPORTSSHARDING = 0, a class compiler error will be returned.

◆ TRANSFORMATIONSPEC

TRANSFORMATIONSPEC = None

static

This parameter defines the word transformation(s) to apply to input text, such as stemming, decompounding

and other operations for "normalizing" words, so searches can scan these normalized forms rather than the literal forms.
This parameter cannot be set in conjunction with the <parameter>INDEXOPTION</parameter> and/or <parameter>STEMMINGCONFIG</parameter> parameters, which are shorthands for configuring stemming and decompounding options and overriding the default configurations for those.
This parameter also allows using custom transformations by specifying the name of a class that inherits from <class>iFind.Transformation.Abstract</class>, optionally followed by a colon and string that will be passed onto the Transform method of the transformation class if it accepts any parameters.

◆ USERDICTIONARY

USERDICTIONARY = None

static

This parameter controls which user dictionary should be used to rewrite or annotate text before

it is processed by the NLP engine. See NLP User Dictionaries in the NLP documentation.

This parameter is for advanced use only and empty by default.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ Find()

◆ InsertIndex()

Member Data Documentation

◆ IFINDADVANCEDSQLPREFIX

◆ IFINDMAPPINGS

◆ IFINDSHAREDDATALOCATION

◆ IGNOREPUNCTUATION

◆ INDEXOPTION

◆ LANGUAGE

◆ LOWER

◆ STEMMINGCONFIG

◆ SUPPORTSSHARDING

◆ TRANSFORMATIONSPEC

◆ USERDICTIONARY