Interface ISqlForeignKeyBuilder

Namespace

LfrlAnvil.Sql.Objects.Builders

Assembly

LfrlAnvil.Sql.Core.dll

Represents an SQL foreign key constraint builder.

public interface ISqlForeignKeyBuilder : ISqlConstraintBuilder, ISqlObjectBuilder

Inherited Members

ISqlConstraintBuilder.Table

ISqlObjectBuilder.Name

ISqlObjectBuilder.Type

ISqlObjectBuilder.Database

ISqlObjectBuilder.ReferencingObjects

ISqlObjectBuilder.IsRemoved

ISqlObjectBuilder.CanRemove

ISqlObjectBuilder.Remove()

Extension Methods

SqlObjectExtensions.IsSelfReference(ISqlForeignKeyBuilder)

SqlObjectExtensions.ToDefinitionNode(ISqlForeignKeyBuilder, SqlRecordSetNode)

Properties

OnDeleteBehavior

Specifies this foreign key's on delete behavior.

ReferenceBehavior OnDeleteBehavior { get; }

Property Value

ReferenceBehavior

OnUpdateBehavior

Specifies this foreign key's on update behavior.

ReferenceBehavior OnUpdateBehavior { get; }

Property Value

ReferenceBehavior

OriginIndex

SQL index that this foreign key originates from.

ISqlIndexBuilder OriginIndex { get; }

Property Value

ISqlIndexBuilder

ReferencedIndex

SQL index referenced by this foreign key.

ISqlIndexBuilder ReferencedIndex { get; }

Property Value

ISqlIndexBuilder

Methods

SetDefaultName()

Changes the name of this object to a default name.

ISqlForeignKeyBuilder SetDefaultName()

Returns

ISqlForeignKeyBuilder

this.

Remarks

See ISqlDefaultObjectNameProvider for more information.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

SetName(string)

Changes the name of this object.

ISqlForeignKeyBuilder SetName(string name)

Parameters

name string

Name to set.

Returns

ISqlForeignKeyBuilder

this.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

SetOnDeleteBehavior(ReferenceBehavior)

Changes OnDeleteBehavior value of this foreign key.

ISqlForeignKeyBuilder SetOnDeleteBehavior(ReferenceBehavior behavior)

Parameters

behavior ReferenceBehavior

Value to set.

Returns

ISqlForeignKeyBuilder

this.

Exceptions

SqlObjectBuilderException

When behavior cannot be changed.

SetOnUpdateBehavior(ReferenceBehavior)

Changes OnUpdateBehavior value of this foreign key.

ISqlForeignKeyBuilder SetOnUpdateBehavior(ReferenceBehavior behavior)

Parameters

behavior ReferenceBehavior

Value to set.

Returns

ISqlForeignKeyBuilder

this.

Exceptions

SqlObjectBuilderException

When behavior cannot be changed.