Class IndexDefinition
The index definition
Implements
Inherited Members
Namespace: FluentMigrator.Model
Assembly: FluentMigrator.Abstractions.dll
Syntax
public class IndexDefinition : ICloneable, ICanBeValidated, ISupportAdditionalFeatures, IValidatableObject, IValidationChildren
Properties
| Edit this page View SourceAdditionalFeatures
Gets the dictionary to store the values for additional features
Declaration
public virtual IDictionary<string, object> AdditionalFeatures { get; }
Property Value
Type | Description |
---|---|
IDictionary<string, object> |
Columns
Gets or sets a collection of index column definitions
Declaration
public virtual ICollection<IndexColumnDefinition> Columns { get; set; }
Property Value
Type | Description |
---|---|
ICollection<IndexColumnDefinition> |
IsClustered
Gets or sets a value indicating whether the index is clustered
Declaration
public bool IsClustered { get; set; }
Property Value
Type | Description |
---|---|
bool |
IsUnique
Gets or sets a value indicating whteher the index only allows unique values
Declaration
public virtual bool IsUnique { get; set; }
Property Value
Type | Description |
---|---|
bool |
Name
Gets or sets the index name
Declaration
[Required(ErrorMessageResourceType = typeof(ErrorMessages), ErrorMessageResourceName = "IndexNameCannotBeNullOrEmpty")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
SchemaName
Gets or sets the schema name
Declaration
public virtual string SchemaName { get; set; }
Property Value
Type | Description |
---|---|
string |
TableName
Gets or sets the table name
Declaration
[Required(ErrorMessageResourceType = typeof(ErrorMessages), ErrorMessageResourceName = "TableNameCannotBeNullOrEmpty")]
public virtual string TableName { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
| Edit this page View SourceClone()
Creates a new object that is a copy of the current instance.
Declaration
public object Clone()
Returns
Type | Description |
---|---|
object | A new object that is a copy of this instance. |
CollectValidationErrors(ICollection<string>)
Collect validation errors
Declaration
[Obsolete("Use the System.ComponentModel.DataAnnotations.Validator instead")]
public virtual void CollectValidationErrors(ICollection<string> errors)
Parameters
Type | Name | Description |
---|---|---|
ICollection<string> | errors | The collection of error messages |
Validate(ValidationContext)
Determines whether the specified object is valid.
Declaration
public IEnumerable<ValidationResult> Validate(ValidationContext validationContext)
Parameters
Type | Name | Description |
---|---|---|
ValidationContext | validationContext | The validation context. |
Returns
Type | Description |
---|---|
IEnumerable<ValidationResult> | A collection that holds failed-validation information. |