View Source

Class DatabaseSchemaResult

Represents ...

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Migrations.Install

Assembly: Umbraco.Infrastructure.dll

Syntax

public class DatabaseSchemaResult

Constructors

DatabaseSchemaResult()

Initializes a new instance of the DatabaseSchemaResult class, representing the result of a database schema operation during installation.

Declaration

public DatabaseSchemaResult()

Properties

Errors

Gets the list of errors encountered during the database schema installation. Each tuple contains the error code (as a string) and the corresponding error message.

Declaration

public List<Tuple<string, string>> Errors { get; }

Property Value

Type	Description
List<Tuple<string, string>>

TableDefinitions

Gets a collection of TableDefinition objects that describe the tables in the current database schema.

Declaration

public List<TableDefinition> TableDefinitions { get; }

Property Value

Type	Description
List<TableDefinition>

ValidColumns

Gets the collection of column names that are valid according to the current database schema.

Declaration

public List<string> ValidColumns { get; }

Property Value

Type	Description
List<string>

ValidConstraints

Gets a list of database schema constraints that are considered valid.

Declaration

public List<string> ValidConstraints { get; }

Property Value

Type	Description
List<string>

ValidIndexes

Gets a list of index names that are valid according to the current database schema.

Declaration

public List<string> ValidIndexes { get; }

Property Value

Type	Description
List<string>

ValidTables

Gets a list of table names that are considered valid in the current database schema.

Declaration

public List<string> ValidTables { get; }

Property Value

Type	Description
List<string>

Methods

DetermineHasInstalledVersion()

Determines whether the database contains an installed version.

Declaration

public bool DetermineHasInstalledVersion()

Returns

Type	Description
bool	true if the database contains at least one valid table; otherwise, false.

Remarks

A database contains an installed version when it contains at least one valid table.

GetSummary()

Gets a summary of the schema validation result

Declaration

public string GetSummary()

Returns

Type	Description
string	A string containing a human readable string with a summary message