Language

StringIndex Class

Definition

Represents the server-maintained string-index status for a Column. It is an inferred, read-only child object.

public sealed class StringIndex : Microsoft.AnalysisServices.Tabular.MetadataObject
type StringIndex = class
    inherit MetadataObject
Public NotInheritable Class StringIndex
Inherits MetadataObject
Inheritance
StringIndex

Remarks

This metadata object is only supported when the compatibility level of the database is at 1707 or above.

Constructors

Name Description
StringIndex()

Create a new instance of the StringIndex class with default settings.

Properties

Name Description
Column

A reference to the Column object that owns this StringIndex.

IsRemoved

A Boolean specifying whether this object was removed from an object tree.

(Inherited from MetadataObject)
Model

Gets the Tabular model that contains this object.

(Inherited from MetadataObject)
ModifiedTime

The time that the StringIndex state was last modified.

ObjectType

Gets the type of object.

(Inherited from MetadataObject)
Parent

Gets the parent of the current MetadataObject.

(Inherited from MetadataObject)
RefreshedTime

The time that StringIndex processing or reconciliation last completed successfully.

State

Provides information on the state of the StringIndex. Ready means the configured indexing behavior is satisfied, including when persistence is disabled by the Column behavior, the index is structurally inapplicable, the dictionary is empty, or the persisted artifact is current. CalculationNeeded means an Explicit or Full persisted index is missing or stale. DependencyError means the owning Column is in an error state. Other values are not applicable to StringIndex.

Methods

Name Description
Clone()

Creates a new, full copy of a StringIndex object.

CopyFrom(StringIndex)
Obsolete.

Deprecated. Use CopyTo method instead.

CopyTo(StringIndex)

Copies a StringIndex object to the specified object.

Validate()

This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only.

(Inherited from MetadataObject)

Applies to