Interface ISchemaObject

Namespace

OrpheusInterfaces.Schema

Assembly

OrpheusInterfaces.dll

Base schema object interface.

public interface ISchemaObject

Properties

Action

Defines the DDL action to be taken when schema objects are executed.

DDLAction Action { get; set; }

Property Value

DDLAction

Defines the DDL action to be taken when schema objects are executed

AliasName

The schema object alias name.

string AliasName { get; set; }

Property Value

string

IsCreated

True if the schema object is created in the DB.

bool IsCreated { get; }

Property Value

bool

True if the schema object is created in the DB

RawDDL

If DDL is set all other fields and join schema objects are ignored. Dependencies still apply.

string RawDDL { get; set; }

Property Value

string

Set raw DDL for the schema object

SQLName

The name of the schema object. Could be the name of a table or a view or a stored procedure.

string SQLName { get; set; }

Property Value

string

SQL name of the schema object

Schema

Schema where the schema object belongs to.

ISchema Schema { get; set; }

Property Value

ISchema

Schema where the schema object exists

SchemaObjectsThatDependOnMe

Other schema objects that depend on this object. First it will iterate through the dependency list and run any schema object that is not yet destroyed.

List<ISchemaObject> SchemaObjectsThatDependOnMe { get; set; }

Property Value

List<ISchemaObject>

Schema objects that depend on this object

SchemaObjectsThatIDepend

Other schema objects that this object depends upon. First it will iterate through the dependency list and run any schema object that is not yet created.

List<ISchemaObject> SchemaObjectsThatIDepend { get; set; }

Property Value

List<ISchemaObject>

Schema object that this object depends upon

UniqueKey

Unique generated when the object is created and saved in the DB.

Guid UniqueKey { get; set; }

Property Value

Guid

Schema object unique key

Methods

AddDependency(ISchemaObject)

Adds a dependency to a schema object.

void AddDependency(ISchemaObject schemaObject)

Parameters

schemaObject ISchemaObject

AddDependency(Type)

Adds a dependency to a schema object based on the model type.

void AddDependency(Type modelType)

Parameters

modelType Type

AddDependency<T>()

Adds a dependency to a schema object based on the model type.

void AddDependency<T>() where T : class

Type Parameters

T

Drop()

Drops the schema object.

void Drop()

Execute()

Executes schema object.

void Execute()

GetDDLString()

Returns the DDL string to be executed.

List<string> GetDDLString()

Returns

List<string>

Get the generated DDL string for the schema object

GetSchemaType()

Gets the schema type.

SchemaObjectType GetSchemaType()

Returns

SchemaObjectType

Schema type