Interface INeosSchema

Namespace

GroupeIsa.Neos.Migration.Schema

Assembly

GroupeIsa.Neos.Migration.Abstractions.dll

Provides the functionalities of a schema.

public interface INeosSchema

Properties

CheckConstraints

Gets check constraints.

List<INeosCheckConstraint> CheckConstraints { get; }

Property Value

List<INeosCheckConstraint>

ClusterVersion

Gets or sets the cluster version the schema was generated with.

string? ClusterVersion { get; set; }

Property Value

string

Columns

Gets columns.

List<INeosColumn> Columns { get; }

Property Value

List<INeosColumn>

ExcludedTableNames

Gets excluded table names.

List<string> ExcludedTableNames { get; }

Property Value

List<string>

ForeignKeys

Gets foreign keys.

List<INeosForeignKey> ForeignKeys { get; }

Property Value

List<INeosForeignKey>

Indexes

Gets indexes.

List<INeosIndex> Indexes { get; }

Property Value

List<INeosIndex>

NeosVersion

Gets or sets the Neos framework version the schema was generated with.

string? NeosVersion { get; set; }

Property Value

string

PrimaryKeys

Gets the primary keys.

List<INeosPrimaryKey> PrimaryKeys { get; }

Property Value

List<INeosPrimaryKey>

SchemaName

Gets or sets the schema name.

string SchemaName { get; set; }

Property Value

string

SchemaVersion

Gets or sets the schema version.

string? SchemaVersion { get; set; }

Property Value

string

Tables

Gets tables.

List<INeosTable> Tables { get; }

Property Value

List<INeosTable>

Views

Gets views.

List<INeosView> Views { get; }

Property Value

List<INeosView>

Methods

Clone()

Clones the schema.

INeosSchema Clone()

Returns

INeosSchema

The cloned schema.

WithCheckConstraint(INeosCheckConstraint)

Adds a check constraint.

INeosSchema WithCheckConstraint(INeosCheckConstraint checkConstraint)

Parameters

checkConstraint INeosCheckConstraint

The check constraint.

Returns

INeosSchema

A NeosSchema.

WithColumn(INeosColumn)

Adds a neos column.

INeosSchema WithColumn(INeosColumn neosColumn)

Parameters

neosColumn INeosColumn

The neos column.

Returns

INeosSchema

A NeosSchema.

WithColumn(string, string, ColumnType, bool)

Adds a neos column.

INeosSchema WithColumn(string tableName, string name, ColumnType type, bool nullable = true)

Parameters

tableName string

The table name.

name string

The name.

type ColumnType

The type.

nullable bool

If true, nullable.

Returns

INeosSchema

A NeosSchema.

WithForeignKey(INeosForeignKey)

Adds a foreign key.

INeosSchema WithForeignKey(INeosForeignKey neosForeignKey)

Parameters

neosForeignKey INeosForeignKey

The neos foreign key.

Returns

INeosSchema

A NeosSchema.

WithIndex(INeosIndex)

Adds an index.

INeosSchema WithIndex(INeosIndex neosIndex)

Parameters

neosIndex INeosIndex

The neos index.

Returns

INeosSchema

A NeosSchema.

WithLowerCasing()

Changes the case of all names in the schema to lower case.

INeosSchema WithLowerCasing()

Returns

INeosSchema

A NeosSchema.

WithPrimaryKey(INeosPrimaryKey)

Adds a primary key.

INeosSchema WithPrimaryKey(INeosPrimaryKey neosPrimaryKey)

Parameters

neosPrimaryKey INeosPrimaryKey

The neos primary key.

Returns

INeosSchema

A NeosSchema.

WithTable(INeosTable)

Adds a neos table.

INeosSchema WithTable(INeosTable neosTable)

Parameters

neosTable INeosTable

The neos table.

Returns

INeosSchema

A NeosSchema.

WithTable(string)

Adds a neos table.

INeosSchema WithTable(string tableName)

Parameters

tableName string

The neos table name.

Returns

INeosSchema

A NeosSchema.

WithUpperCasing()

Changes the case of all names in the schema to upper case.

INeosSchema WithUpperCasing()

Returns

INeosSchema

A NeosSchema.