IndexBuilder Class Reference
IndexBuilder
public class IndexBuilderIndexBuilder used for building database index objects.
-
Create a value index with the given index items. The index items are a list of the properties or expressions to be indexed.
Declaration
Swift
public static func valueIndex(items: ValueIndexItem...) -> ValueIndexParameters
itemsThe index items.
Return Value
The ValueIndex.
-
Create a value index with the given index items. The index items are a list of the properties or expressions to be indexed.
Declaration
Swift
public static func valueIndex(items: [ValueIndexItem]) -> ValueIndexParameters
itemsThe index items.
Return Value
The ValueIndex.
-
Create a full-text index with the given index items. Typically the index items are the properties that are used to perform the match operation against with.
Declaration
Swift
public static func fullTextIndex(items: FullTextIndexItem...) -> FullTextIndexParameters
itemsThe index items.
Return Value
The FullTextIndex.
-
Create a full-text index with the given index items. Typically the index items are the properties that are used to perform the match operation against with.
Declaration
Swift
public static func fullTextIndex(items: [FullTextIndexItem]) -> FullTextIndexParameters
itemsThe index items.
Return Value
The FullTextIndex.
-
ENTERPRISE EDITION ONLY
Create a predictive index with the given predictive model name, input specification to the predictive model, and the properties of the prediction result.
The input given specification should be matched to the input specification given to the query prediction() function so that the predictive index can be matched and used in query.
The predictive index is different from the normal index in that the predictive index will also cache the prediction result along with creating the value index of the specified properties. If the properties are not specified, the predictive index will only cache the prediction result so that the prediction model will not be called again after indexing. If multiple properties are specified, a compound value index will be created from the the given properties.
Declaration
Swift
public static func predictiveIndex(model: String, input: ExpressionProtocol, properties: [String]? = nil) -> PredictiveIndexParameters
modelThe predictive model name.
inputThe input specification that should be matched with the input specification given to the query prediction function.
propertiesThe prediction result’s properties to be indexed.
Return Value
The predictive index.