IndexSchema Class

Article
10/22/2010

Represents a single or multicolumn index that can be used to more efficiently find items that are in the metadata store.

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.MetadataStorage.IndexSchema

Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in Microsoft.Synchronization.MetadataStorage.dll)

Syntax

'Declaration
Public Class IndexSchema
'Usage
Dim instance As IndexSchema

public class IndexSchema

public ref class IndexSchema

type IndexSchema =  class end

public class IndexSchema

The IndexSchema type exposes the following members.

Constructors

	Name	Description
	IndexSchema(IEnumerable<String>, Boolean)	Initializes a new instance of the IndexSchema class that contains the specified list of indexed field names and a value that indicates whether the index schema uniquely defines an item.
	IndexSchema(String, Boolean)	Initializes a new instance of the IndexSchema class that has the specified indexed field name and a value that indicates whether this index schema uniquely defines an item.

Top

Properties

	Name	Description
	FieldNames	Gets the list of field names that defines this index.
	IsUnique	Gets a value that indicates whether this index schema uniquely identifies an item.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Remarks

This index can be defined as unique to make sure that the index defines a single item.

The index schema is defined when the metadata is initialized for the replica by using MetadataStore.InitializeReplicaMetadata. The fields that are contained in the index schema must also exist in the custom field schema that is defined for the replica.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via