Search Results for

    Show / Hide Table of Contents

    Class IndexDefinition

    The index definition

    Inheritance
    object
    IndexDefinition
    Implements
    ICloneable
    ICanBeValidated
    ISupportAdditionalFeatures
    IValidatableObject
    IValidationChildren
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: FluentMigrator.Model
    Assembly: FluentMigrator.Abstractions.dll
    Syntax
    public class IndexDefinition : ICloneable, ICanBeValidated, ISupportAdditionalFeatures, IValidatableObject, IValidationChildren

    Properties

    | Edit this page View Source

    AdditionalFeatures

    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>
    | Edit this page View Source

    Columns

    Gets or sets a collection of index column definitions

    Declaration
    public virtual ICollection<IndexColumnDefinition> Columns { get; set; }
    Property Value
    Type Description
    ICollection<IndexColumnDefinition>
    | Edit this page View Source

    IsClustered

    Gets or sets a value indicating whether the index is clustered

    Declaration
    public bool IsClustered { get; set; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    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
    | Edit this page View Source

    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
    | Edit this page View Source

    SchemaName

    Gets or sets the schema name

    Declaration
    public virtual string SchemaName { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    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 Source

    Clone()

    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.

    | Edit this page View Source

    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

    | Edit this page View Source

    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.

    Implements

    ICloneable
    ICanBeValidated
    ISupportAdditionalFeatures
    IValidatableObject
    IValidationChildren

    Extension Methods

    LegacyValidationExtensions.CollectErrors(ICanBeValidated, ICollection<string>, IServiceProvider)
    LegacyValidationExtensions.TryCollectResults(ICanBeValidated, ICollection<ValidationResult>, IServiceProvider, IDictionary<object, object>)
    AdditionalFeaturesExtensions.GetAdditionalFeature<T>(ISupportAdditionalFeatures, string, Func<T>)
    AdditionalFeaturesExtensions.GetAdditionalFeature<T>(ISupportAdditionalFeatures, string, T)
    AdditionalFeaturesExtensions.SetAdditionalFeature<T>(ISupportAdditionalFeatures, string, T)
    PostgresExtensions.Using(ISupportAdditionalFeatures, Algorithm)
    • Edit this page
    • View Source
    In this article
    Back to top
    Copyright © 2018 Fluent Migrator Project
    Generated by DocFX
    Creative Commons License
    FluentMigrator Documentation by FluentMigrator Project is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.