Class SqlSchemaBuilderCollection

Namespace

LfrlAnvil.Sql.Objects.Builders

Assembly

LfrlAnvil.Sql.Core.dll

Represents a collection of SQL schema builders.

public abstract class SqlSchemaBuilderCollection : SqlBuilderApi, ISqlSchemaBuilderCollection, IReadOnlyCollection<ISqlSchemaBuilder>, IEnumerable<ISqlSchemaBuilder>, IEnumerable

Inheritance

object

SqlBuilderApi

SqlSchemaBuilderCollection

Implements

ISqlSchemaBuilderCollection

IReadOnlyCollection<ISqlSchemaBuilder>

IEnumerable<ISqlSchemaBuilder>

IEnumerable

Derived

MySqlSchemaBuilderCollection

PostgreSqlSchemaBuilderCollection

Inherited Members

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.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SqlSchemaBuilderCollection()

Creates a new empty SqlSchemaBuilderCollection instance.

protected SqlSchemaBuilderCollection()

Properties

Count

Gets the number of elements in the collection.

public int Count { get; }

Property Value

int

The number of elements in the collection.

Database

Database that this collection belongs to.

public SqlDatabaseBuilder Database { get; }

Property Value

SqlDatabaseBuilder

Default

Default schema.

public SqlSchemaBuilder Default { get; }

Property Value

SqlSchemaBuilder

Methods

AfterCreateSchema(SqlSchemaBuilder)

Callback invoked just after the schema creation has been processed.

protected virtual void AfterCreateSchema(SqlSchemaBuilder schema)

Parameters

schema SqlSchemaBuilder

Created schema.

Contains(string)

Checks whether or not a schema with the provided name exists.

[Pure]
public bool Contains(string name)

Parameters

name string

Name to check.

Returns

bool

true when schema exists, otherwise false.

Create(string)

Creates a new schema builder.

public SqlSchemaBuilder Create(string name)

Parameters

name string

Name of the schema.

Returns

SqlSchemaBuilder

New ISqlSchemaBuilder instance.

Exceptions

SqlObjectBuilderException

When schema could not be created.

CreateSchemaBuilder(string)

Creates a new SqlSchemaBuilder instance.

protected abstract SqlSchemaBuilder CreateSchemaBuilder(string name)

Parameters

name string

Schema's name.

Returns

SqlSchemaBuilder

New SqlSchemaBuilder instance.

Get(string)

Returns a schema with the provided name.

[Pure]
public SqlSchemaBuilder Get(string name)

Parameters

name string

Name of the schema to return.

Returns

SqlSchemaBuilder

Existing schema.

Exceptions

KeyNotFoundException

When schema does not exist.

GetEnumerator()

Creates a new SqlObjectBuilderEnumerator<T> instance for this collection.

[Pure]
public SqlObjectBuilderEnumerator<SqlSchemaBuilder> GetEnumerator()

Returns

SqlObjectBuilderEnumerator<SqlSchemaBuilder>

New SqlObjectBuilderEnumerator<T> instance.

GetOrCreate(string)

Creates a new schema builder or returns an existing schema builder.

public SqlSchemaBuilder GetOrCreate(string name)

Parameters

name string

Name of the schema.

Returns

SqlSchemaBuilder

New ISqlSchemaBuilder instance or an existing schema builder.

Exceptions

SqlObjectBuilderException

When schema does not exist and could not be created.

Remove(string)

Attempts to remove a schema by its name.

public bool Remove(string name)

Parameters

name string

Name of the schema to remove.

Returns

bool

true when schema was removed, otherwise false.

TryGet(string)

Attempts to return a schema with the provided name.

[Pure]
public SqlSchemaBuilder? TryGet(string name)

Parameters

name string

Name of the schema to return.

Returns

SqlSchemaBuilder

Existing schema or null when schema does not exist.