Class SqlSchemaBuilder

Namespace

LfrlAnvil.Sql.Objects.Builders

Assembly

LfrlAnvil.Sql.Core.dll

Represents an SQL schema builder.

public abstract class SqlSchemaBuilder : SqlObjectBuilder, ISqlSchemaBuilder, ISqlObjectBuilder

Inheritance

object

SqlBuilderApi

SqlObjectBuilder

SqlSchemaBuilder

Implements

ISqlSchemaBuilder

ISqlObjectBuilder

Derived

MySqlSchemaBuilder

PostgreSqlSchemaBuilder

Inherited Members

SqlObjectBuilder.Id

SqlObjectBuilder.Database

SqlObjectBuilder.Type

SqlObjectBuilder.Name

SqlObjectBuilder.IsRemoved

SqlObjectBuilder.ReferencingObjects

SqlObjectBuilder.ToString()

SqlObjectBuilder.GetHashCode()

SqlObjectBuilder.Remove()

SqlObjectBuilder.ThrowIfRemoved()

SqlObjectBuilder.ThrowIfReferenced()

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

SqlSchemaBuilder(SqlDatabaseBuilder, string, SqlObjectBuilderCollection)

Creates a new SqlSchemaBuilder instance.

protected SqlSchemaBuilder(SqlDatabaseBuilder database, string name, SqlObjectBuilderCollection objects)

Parameters

database SqlDatabaseBuilder

Database that this schema belongs to.

name string

Object's name.

objects SqlObjectBuilderCollection

Collection of objects that belong to this schema.

Properties

CanRemove

Specifies whether or not this object can be removed.

public override bool CanRemove { get; }

Property Value

bool

Objects

Collection of objects that belong to this schema.

public SqlObjectBuilderCollection Objects { get; }

Property Value

SqlObjectBuilderCollection

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.

QuickRemoveCore()

Performs a quick removal of this object.

protected override void QuickRemoveCore()

Remarks

See QuickRemove(SqlObjectBuilder) for more information.

Exceptions

NotSupportedException

Quick removal of schemas is not supported by default.

QuickRemoveObjects()

Quick-removes all Objects.

protected void QuickRemoveObjects()

ResetAllTableAndViewInfoCache()

Resets SqlRecordSetInfo of all tables and views.

protected void ResetAllTableAndViewInfoCache()

Remarks

See ResetInfo(SqlTableBuilder) and ResetInfo(SqlViewBuilder) for more information.

SetName(string)

Changes the name of this object.

public SqlSchemaBuilder SetName(string name)

Parameters

name string

Name to set.

Returns

SqlSchemaBuilder

this.

Exceptions

SqlObjectBuilderException

When name cannot be changed.

ThrowIfDefault()

Throws an exception when this schema is the Default schema.

protected void ThrowIfDefault()

Exceptions

SqlObjectBuilderException

When this schema is the Default schema.