Class SqlConstraintBuilder

Namespace

LfrlAnvil.Sql.Objects.Builders

Assembly

LfrlAnvil.Sql.Core.dll

Represents an SQL constraint builder attached to a table.

public abstract class SqlConstraintBuilder : SqlObjectBuilder, ISqlConstraintBuilder, ISqlObjectBuilder

Inheritance

object

SqlBuilderApi

SqlObjectBuilder

SqlConstraintBuilder

Implements

ISqlConstraintBuilder

ISqlObjectBuilder

Derived

SqlCheckBuilder

SqlForeignKeyBuilder

SqlIndexBuilder

SqlPrimaryKeyBuilder

Inherited Members

SqlObjectBuilder.Id

SqlObjectBuilder.Database

SqlObjectBuilder.Type

SqlObjectBuilder.Name

SqlObjectBuilder.IsRemoved

SqlObjectBuilder.ReferencingObjects

SqlObjectBuilder.CanRemove

SqlObjectBuilder.GetHashCode()

SqlObjectBuilder.Remove()

SqlObjectBuilder.ThrowIfRemoved()

SqlObjectBuilder.ThrowIfReferenced()

SqlObjectBuilder.QuickRemoveCore()

SqlBuilderApi.AddReference(SqlObjectBuilder, SqlObjectBuilderReferenceSource<SqlObjectBuilder>, SqlObjectBuilder)

SqlBuilderApi.RemoveReference(SqlObjectBuilder, SqlObjectBuilderReferenceSource<SqlObjectBuilder>)

SqlBuilderApi.ClearReferences(SqlObjectBuilder)

SqlBuilderApi.AddToCollection(SqlObjectBuilderCollection, SqlObjectBuilder)

SqlBuilderApi.AddToCollection(SqlConstraintBuilderCollection, SqlConstraintBuilder)

SqlBuilderApi.ChangeNameInCollection(SqlColumnBuilderCollection, SqlColumnBuilder, string)

SqlBuilderApi.ChangeNameInCollection(SqlObjectBuilderCollection, SqlObjectBuilder, string)

SqlBuilderApi.ChangeNameInCollection(SqlConstraintBuilderCollection, SqlConstraintBuilder, string)

SqlBuilderApi.ChangeNameInCollection(SqlSchemaBuilderCollection, SqlSchemaBuilder, string)

SqlBuilderApi.RemoveFromCollection(SqlColumnBuilderCollection, SqlColumnBuilder)

SqlBuilderApi.RemoveFromCollection(SqlObjectBuilderCollection, SqlObjectBuilder)

SqlBuilderApi.RemoveFromCollection(SqlConstraintBuilderCollection, SqlConstraintBuilder)

SqlBuilderApi.RemoveFromCollection(SqlSchemaBuilderCollection, SqlSchemaBuilder)

SqlBuilderApi.ClearCollection(SqlColumnBuilderCollection)

SqlBuilderApi.ClearCollection(SqlObjectBuilderCollection)

SqlBuilderApi.ClearCollection(SqlConstraintBuilderCollection)

SqlBuilderApi.QuickRemove(SqlObjectBuilder)

SqlBuilderApi.GetObjectPool(SqlDatabaseBuilder)

SqlBuilderApi.AddCreation(SqlObjectBuilder, SqlObjectBuilder)

SqlBuilderApi.AddRemoval(SqlObjectBuilder, SqlObjectBuilder)

SqlBuilderApi.AddNameChange(SqlObjectBuilder, SqlObjectBuilder, string)

SqlBuilderApi.AddIsNullableChange(SqlColumnBuilder, bool)

SqlBuilderApi.AddTypeDefinitionChange(SqlColumnBuilder, SqlColumnTypeDefinition)

SqlBuilderApi.AddDefaultValueChange(SqlColumnBuilder, SqlExpressionNode)

SqlBuilderApi.AddComputationChange(SqlColumnBuilder, SqlColumnComputation?)

SqlBuilderApi.AddIsUniqueChange(SqlIndexBuilder, bool)

SqlBuilderApi.AddIsVirtualChange(SqlIndexBuilder, bool)

SqlBuilderApi.AddFilterChange(SqlIndexBuilder, SqlConditionNode)

SqlBuilderApi.AddPrimaryKeyChange(SqlIndexBuilder, SqlPrimaryKeyBuilder)

SqlBuilderApi.AddOnDeleteBehaviorChange(SqlForeignKeyBuilder, ReferenceBehavior)

SqlBuilderApi.AddOnUpdateBehaviorChange(SqlForeignKeyBuilder, ReferenceBehavior)

SqlBuilderApi.ResetInfo(SqlTableBuilder)

SqlBuilderApi.ResetInfo(SqlViewBuilder)

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

SqlConstraintBuilder(SqlTableBuilder, string)

Creates a new SqlConstraintBuilder instance.

protected SqlConstraintBuilder(SqlTableBuilder table, string name)

Parameters

table SqlTableBuilder

Table that this constraint is attached to.

name string

Object's name.

Properties

Table

Table that this constraint is attached to.

public SqlTableBuilder Table { get; }

Property Value

SqlTableBuilder

Methods

AfterNameChange(string)

Callback invoked just after Name change has been processed.

protected override void AfterNameChange(string originalValue)

Parameters

originalValue string

Original value.

AfterRemove()

Callback invoked just after the removal has been processed.

protected override void AfterRemove()

BeforeNameChange(string)

Callback invoked just before Name change is processed.

protected override SqlPropertyChange<string> BeforeNameChange(string newValue)

Parameters

newValue string

Value to set.

Returns

SqlPropertyChange<string>

SqlPropertyChange<T> instance associated with Name change attempt.

Exceptions

SqlObjectBuilderException

When Name of this object cannot be changed.

BeforeRemove()

Callback invoked just before the removal is processed.

protected override void BeforeRemove()

Exceptions

SqlObjectBuilderException

When this object cannot be removed.

GetDefaultName()

Creates a default name for this constraint.

[Pure]
protected abstract string GetDefaultName()

Returns

string

Default name for this constraint.

SetDefaultName()

Changes the name of this object to a default name.

public SqlConstraintBuilder SetDefaultName()

Returns

SqlConstraintBuilder

this.

Remarks

See ISqlDefaultObjectNameProvider for more information.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

SetName(string)

Changes the name of this object.

public SqlConstraintBuilder SetName(string name)

Parameters

name string

Name to set.

Returns

SqlConstraintBuilder

this.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

ToString()

Returns a string representation of this SqlConstraintBuilder instance.

[Pure]
public override string ToString()

Returns

string

String representation.