Class PostgreSqlForeignKeyBuilder

Namespace

LfrlAnvil.PostgreSql.Objects.Builders

Assembly

LfrlAnvil.PostgreSql.dll

Represents an SQL foreign key constraint builder.

public sealed class PostgreSqlForeignKeyBuilder : SqlForeignKeyBuilder, ISqlForeignKeyBuilder, ISqlConstraintBuilder, ISqlObjectBuilder

Inheritance

object

SqlBuilderApi

SqlObjectBuilder

SqlConstraintBuilder

SqlForeignKeyBuilder

PostgreSqlForeignKeyBuilder

Implements

ISqlForeignKeyBuilder

ISqlConstraintBuilder

ISqlObjectBuilder

Inherited Members

SqlForeignKeyBuilder.OriginIndex

SqlForeignKeyBuilder.ReferencedIndex

SqlForeignKeyBuilder.OnDeleteBehavior

SqlForeignKeyBuilder.OnUpdateBehavior

SqlConstraintBuilder.ToString()

SqlObjectBuilder.Id

SqlObjectBuilder.Type

SqlObjectBuilder.Name

SqlObjectBuilder.IsRemoved

SqlObjectBuilder.ReferencingObjects

SqlObjectBuilder.CanRemove

SqlObjectBuilder.GetHashCode()

SqlObjectBuilder.Remove()

SqlObjectBuilder.ThrowIfRemoved()

SqlObjectBuilder.ThrowIfReferenced()

object.Equals(object)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

PostgreSqlObjectExtensions.ForPostgreSql(ISqlForeignKeyBuilder, Action<PostgreSqlForeignKeyBuilder>)

Remarks

PostgreSqlDialect implementation.

Properties

Database

Database that this object belongs to.

public PostgreSqlDatabaseBuilder Database { get; }

Property Value

PostgreSqlDatabaseBuilder

Table

Table that this constraint is attached to.

public PostgreSqlTableBuilder Table { get; }

Property Value

PostgreSqlTableBuilder

Methods

SetDefaultName()

Changes the name of this object to a default name.

public PostgreSqlForeignKeyBuilder SetDefaultName()

Returns

PostgreSqlForeignKeyBuilder

this.

Remarks

See ISqlDefaultObjectNameProvider for more information.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

SetName(string)

Changes the name of this object.

public PostgreSqlForeignKeyBuilder SetName(string name)

Parameters

name string

Name to set.

Returns

PostgreSqlForeignKeyBuilder

this.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

SetOnDeleteBehavior(ReferenceBehavior)

Changes OnDeleteBehavior value of this foreign key.

public PostgreSqlForeignKeyBuilder SetOnDeleteBehavior(ReferenceBehavior behavior)

Parameters

behavior ReferenceBehavior

Value to set.

Returns

PostgreSqlForeignKeyBuilder

this.

Exceptions

SqlObjectBuilderException

When behavior cannot be changed.

SetOnUpdateBehavior(ReferenceBehavior)

Changes OnUpdateBehavior value of this foreign key.

public PostgreSqlForeignKeyBuilder SetOnUpdateBehavior(ReferenceBehavior behavior)

Parameters

behavior ReferenceBehavior

Value to set.

Returns

PostgreSqlForeignKeyBuilder

this.

Exceptions

SqlObjectBuilderException

When behavior cannot be changed.